Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greena13/rails-request
Convert JSON and JavaScript objects to Rails-friendly formats
https://github.com/greena13/rails-request
converter javascript rails rest-api update
Last synced: 13 days ago
JSON representation
Convert JSON and JavaScript objects to Rails-friendly formats
- Host: GitHub
- URL: https://github.com/greena13/rails-request
- Owner: greena13
- License: isc
- Created: 2017-02-14T07:51:34.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-12T07:13:53.000Z (almost 7 years ago)
- Last Synced: 2024-10-13T16:51:15.011Z (about 1 month ago)
- Topics: converter, javascript, rails, rest-api, update
- Language: JavaScript
- Size: 45.9 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rails-request
[]()
[](https://travis-ci.org/greena13/rails-request)
[](https://github.com/greena13/rails-request/blob/master/LICENSE)
Utility for producing a Rails-compatible object from a JavaScript or JSON one; perfect for create (POST) or update (PUT) endpoints.
## Usage
```javascript
import railsRequest from 'rails-request';
const railsObject = railsRequest(obj);
```
## Creation objects
By default, calling `rails-request` with a JavaScript object will recursively convert your object to one that uses Rails-friendly attribute names and conventions. In particular:
* Attribute names will be snake cased
* A `_attributes` suffix will be added to all nested objects if not already present
* Arrays of nested objects will be converted to hashes with index keys
```javascript
const jsObject = {
userName: 'user123',
address: {
line1: '1 Street',
line2: 'City, Country'
},
achievementIds: [3,5],
photos: [
{ id: 23, url: 'http://url.com/123' },
{ id: 25, url: 'http://url.com/123' }
]
};
const railsObject = railsRequest(jsObject);
railsObject === {
user_name: 'user123',
address_attributes: {
line1: '1 Street',
line2: 'City, Country'
},
achievement_ids: [3,5],
photos_attributes: {
0: { id: 23, url: 'http://url.com/123' },
1: { id: 25, url: 'http://url.com/123' }
}
}
```
### Customising creation objects
You can start to deviate from Rail's conventions if you need to do so by passing options as a second argument.
#### Setting nested attribute suffix
```javascript
const jsObject = {
userName: 'user123',
address: {
line1: '1 Street',
line2: 'City, Country'
},
achievementIds: [3,5],
photos: [
{ id: 23, url: 'http://url.com/123' },
{ id: 25, url: 'http://url.com/123' }
]
};
const railsObject = railsRequest(jsObject, { nestedAttributesSuffix: false });
railsObject === {
user_name: 'user123',
address: {
line1: '1 Street',
line2: 'City, Country'
},
achievement_ids: [3,5],
photos: {
0: { id: 23, url: 'http://url.com/123' },
1: { id: 25, url: 'http://url.com/123' }
}
}
const railsObject = railsRequest(jsObject, { nestedAttributesSuffix: '_fields' });
railsObject === {
user_name: 'user123',
address_fields: {
line1: '1 Street',
line2: 'City, Country'
},
achievement_ids: [3,5],
photos_fields: {
0: { id: 23, url: 'http://url.com/123' },
1: { id: 25, url: 'http://url.com/123' }
}
}
```
#### Changing attribute name format
Currently only `camelCase` and `snakeCase` (default) are supported.
```javascript
const jsObject = {
userName: 'user123',
address: {
line1: '1 Street',
line2: 'City, Country'
},
achievementIds: [3,5],
photos: [
{ id: 23, url: 'http://url.com/123' },
{ id: 25, url: 'http://url.com/123' }
]
};
const railsObject = railsRequest(jsObject, { attributeFormat: 'camelCase' });
railsObject === {
userName: 'user123',
addressAttributes: {
line1: '1 Street',
line2: 'City, Country'
},
achievementIds: [3,5],
photosAttributes: {
0: { id: 23, url: 'http://url.com/123' },
1: { id: 25, url: 'http://url.com/123' }
}
}
```
## Update Objects
`rails-request` provides a `diff` option for generating update objects, which:
* Returns only the changes between two objects to reduce request payload
* Always includes identifier fields when needed
* Correctly sets destroy objects when nested objects have been removed from arrays
```javascript
const jsObject = {
userName: 'user123',
address: {
id: 3,
line1: '1 Street',
line2: 'City, Country'
},
achievementIds: [3,5],
photos: [
{ id: 23, url: 'http://url.com/123' },
{ id: 25, url: 'http://url.com/123' }
]
};
const newJsObject = {
userName: 'user4',
address: {
id: 3,
line1: '2 Street',
line2: 'City, Country'
},
achievementIds: [3,5,7],
photos: [
{ id: 25, url: 'http://url.com/123' }
]
};
const railsObject = railsRequest(newJsObject, { diff: jsObject });
railsObject === {
user_name: 'user4',
address_attributes: {
id: 3,
line1: '2 Street'
},
achievement_ids: [3,5,7],
photos_attributes: [
{ id: 23, _destroy: 1 }
]
}
```
### Customising update objects
Like creation objects, you can customise update objects if you need to. In addition to those listed below, you can also use any of the options mentioned above for creation objects.
#### Changing identifier fields
By default, `rails-request` will use `id` as the only identifier field. You can add extra fields, or use alternative fields if you wish:
```javascript
const jsObject = {
photos: [
{ externalId: 23, url: 'http://url.com/123' },
{ externalId: 25, url: 'http://url.com/123' }
]
};
const newJsObject = {
photos: [
{ externalId: 25, url: 'http://url.com/123' }
]
};
const railsObject = railsRequest(newJsObject, { diff: jsObject, identifiers: [ 'externalId'] });
railsObject === {
photos_attributes: [
{ external_id: 23, _destroy: 1 }
]
}
```
#### Customising destroy objects
```javascript
const jsObject = {
photos: [
{ id: 23, url: 'http://url.com/123' },
{ id: 25, url: 'http://url.com/123' }
]
};
const newJsObject = {
photos: [
{ id: 25, url: 'http://url.com/123' }
]
};
const railsObject = railsRequest(newJsObject, { diff: jsObject, destroyAttributeValue: true });
railsObject === {
photos_attributes: [
{ id: 23, _destroy: true }
]
};
const railsObject = railsRequest(newJsObject, { diff: jsObject, destroyAttributeName: 'delete' });
railsObject === {
photos_attributes: [
{ id: 23, delete: 1 }
]
};
```
## Running the test suite
```bash
npm run tests
```