https://github.com/mkon/ja2r
JSON-API to ruby object conversion
https://github.com/mkon/ja2r
json json-api ruby
Last synced: 23 days ago
JSON representation
JSON-API to ruby object conversion
- Host: GitHub
- URL: https://github.com/mkon/ja2r
- Owner: mkon
- License: mit
- Created: 2018-07-09T16:44:00.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T11:45:53.000Z (about 2 months ago)
- Last Synced: 2025-03-24T12:21:51.628Z (about 1 month ago)
- Topics: json, json-api, ruby
- Language: Ruby
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JA2R
[](https://badge.fury.io/rb/ja2r)
[](https://depfu.com/github/mkon/ja2r?project_id=5963)
JASON-API to Ruby Object
Converts a JSON-API payload into a ruby object which supports navigation over relationships.
## Usage
```ruby
json = <<-JSON
{
"data":{
"id":"1001",
"type":"persons",
"attributes":{
"name":"Bart"
},
"relationships":{
"sister":{
"data":{
"id":"1002",
"type":"persons"
}
}
}
},
"included":[
{
"id":"1002",
"type":"persons",
"attributes":{
"name":"Lisa"
}
}
]
}
JSON
bart = JA2R.parse(JSON.parse(json))
bart.sister.name # Lisa
```
## Options
You can pass options to `JA2R#parse` as second argument. Currently the only supported options are:
| Name | Type | Description |
|---------------|---------|------------------------------------------------------------------------------------------------------------------------|
| safe_traverse | boolean | When setting this option to true, unknown relationships or attributes will return nil instead of raising NoMethodError |
Example:
```ruby
bart = JA2R.parse(hash, safe_traverse: true)
bart.uncle&.name # nil
```