JSONAPI Ruby Deserializer

Makes work with JSON::API compound documents easy

Status

CircleCI  

Installation

gem 'jsonapi-ruby-deserializer'

gem install jsonapi-ruby-deserializer

Usage

Simple example:

hash = {"data"=>{"type"=>"articles", "attributes"=>{"title"=>"Lorem Ipsum"}}}
document = JSONAPI::Ruby::Deserializer::Document.new(hash)

document.data.type
# => "articles"
document.data.title
# => "Lorem Ipsum"

Advanced example:

hash = {"meta"=>{"license"=>"MIT", "authors"=>["James Smith", "Maria Hernandez"]}, "links"=>{"self"=>"http://example.com/articles", "next"=>"http://example.com/articles?page[offset]=2", "last"=>"http://example.com/articles?page[offset]=10"}, "data"=>[{"type"=>"articles", "id"=>"1", "attributes"=>{"title"=>"JSON:API paints my bikeshed!"}, "relationships"=>{"author"=>{"links"=>{"self"=>"http://example.com/articles/1/relationships/author", "related"=>"http://example.com/articles/1/author"}, "data"=>{"type"=>"people", "id"=>"9"}}, "comments"=>{"links"=>{"self"=>"http://example.com/articles/1/relationships/comments", "related"=>"http://example.com/articles/1/comments"}, "data"=>[{"type"=>"comments", "id"=>"5"}, {"type"=>"comments", "id"=>"12"}]}}, "links"=>{"self"=>"http://example.com/articles/1"}}], "included"=>[{"type"=>"people", "id"=>"9", "attributes"=>{"first_name"=>"Dan", "last_name"=>"Gebhardt", "twitter"=>"dgeb"}, "links"=>{"self"=>"http://example.com/people/9"}}, {"type"=>"comments", "id"=>"5", "attributes"=>{"body"=>"First!"}, "relationships"=>{"author"=>{"data"=>{"type"=>"people", "id"=>"2"}}}, "links"=>{"self"=>"http://example.com/comments/5"}}, {"type"=>"comments", "id"=>"12", "attributes"=>{"body"=>"I like XML better"}, "relationships"=>{"author"=>{"data"=>{"type"=>"people", "id"=>"9"}}}, "links"=>{"self"=>"http://example.com/comments/12"}}]}
document = JSONAPI::Ruby::Deserializer::Document.new(hash)

Attributes

document.data[0].id
# => "1"

document.data[0].type
# => "articles"

document.data[0].title
# => "JSON:API paints my bikeshed!"

document.data[0].attributes
# => {"title"=>"JSON:API paints my bikeshed!"}

document.data[0].comments.data[0].body
# => "First!"

document.data[0].comments.data[0].attributes
# => {"body"=>"First!"}

One-to-one relation

document.data[0].author.data.id
# => "9"

document.data[0].author.data.first_name
# => "Dan"

One-to-many relation

document.data[0].comments.data[0].id
# => "5"

document.data[0].comments.data[0].body
# => "First!"

Nested relation

document.data[0].comments.data[1].author.data.first_name
# => "Dan"

document.data[0].comments.data[1].author.data.attributes
# => {"first_name"=>"Dan", "last_name"=>"Gebhardt", "twitter"=>"dgeb"}

Meta

document.meta.authors
# => ["James Smith", "Maria Hernandez"]

document.links.self
# => "http://example.com/articles"

document.data[0].author.links.self
# => "http://example.com/articles/1/relationships/author"

document.data[0].author.data.links.self
# => "http://example.com/people/9"

List relationships

document.data[0].relationships
# => ["author", "comments"]

License

jsonapi-ruby-deserializer is released under the MIT License.