jsonapi-ruby-deserializer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a473a252ab221a5c0255245b93754578587559abe8d02f91596fc525b16f5e44
-  data.tar.gz: 9aed91c511f2624dacc4138ee17af5910c8bf95a1c2753048f7183f1f720b0d0
+  metadata.gz: 87661b3017acff3a4787abcb1fcdb5c45ca72e5f3ca163736cd180a84f76ecca
+  data.tar.gz: 28bf0faff7c346f78449f04070de6e8585ace8e47977069850c94e8575347925
 SHA512:
-  metadata.gz: ef4edc5e8637ae62d623679427f293a70e913edee5fa3dffc93ebfd042b9ee83fbcb93a8832414863dfcf22f1bf928af8ab3af9e0c33c7e8b30415d05355f51c
-  data.tar.gz: 43e39863d66835c4e4f72339cb47002fb77587e2586fc1dddde9b68d661855f53bcaed50c566ad9032ebd3f12af0fd34480ba0d862c8f49c8396c2cfc4eb52b6
+  metadata.gz: 34b5146462a3fcaa99b3fc42b8271c9bbcdf4bfef9ae7aa62641d4d0ed061e41ca5f5b457d08a44bb34f4f083fdb86ed3b2686c0ac1da409d60ba53510e06222
+  data.tar.gz: 7056d3de97a4d9f4c0abeb609690b1e9d8a386b79050254f6a53e5b4e3f165a5a235da33f4a19fb3670dd76de0a9fd0529176140cfde662e2b76e62482963bed

data/README.md

@@ -5,14 +5,23 @@ Makes work with [JSON::API compound documents](https://jsonapi.org/format/#docum
 [![CircleCI](https://circleci.com/gh/igatto/jsonapi-ruby-deserializer/tree/main.svg?style=shield&circle-token=20af9c492f5ee96fb66bffb1236b11e979549d54)](https://circleci.com/gh/igatto/jsonapi-ruby-deserializer/tree/main)  
 
 ## Installation
+```
+gem 'jsonapi-ruby-deserializer'
+```
+```
+gem install jsonapi-ruby-deserializer
+```
 
 ## Usage
 ### Simple example:
 ```ruby
 hash = {"data"=>{"type"=>"articles", "attributes"=>{"title"=>"Lorem Ipsum"}}}
 document = JSONAPI::Ruby::Deserializer::Document.new(hash)
+
+document.data.type
+# => "articles"
 document.data.title
-=> "Lorem Ipsum"
+# => "Lorem Ipsum"
 ```
 
 ### Advanced example:
@@ -23,29 +32,50 @@ document = JSONAPI::Ruby::Deserializer::Document.new(hash)
 
 #### Attributes
 ```ruby
-document.data[0].attributes
-# => {"title"=>"JSON:API paints my bikeshed!"}
+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
 ```ruby
-document.data[0].author.first_name
+document.data[0].author.data.id
+# => "9"
+
+document.data[0].author.data.first_name
 # => "Dan"
 ```
 
 #### One-to-many relation
 ```ruby
-document.data[0].comments[0].body
+document.data[0].comments.data[0].id
+# => "5"
+
+document.data[0].comments.data[0].body
 # => "First!"
 ```
 
-#### Access to relation through another relation
+#### Nested relation
 ```ruby
-document.data[0].comments[1].author.first_name
+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
@@ -59,8 +89,17 @@ document.meta.authors
 document.links.self
 # => "http://example.com/articles"
 
-document.data[0].relationships['author'].links.self
+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
+```ruby
+document.data[0].relationships
+# => ["author", "comments"]
 ```
 
 ## License

data/lib/jsonapi-ruby-deserializer.rb

@@ -2,6 +2,4 @@ require 'jsonapi-ruby-deserializer/resource'
 require 'jsonapi-ruby-deserializer/document'
 require 'jsonapi-ruby-deserializer/links'
 require 'jsonapi-ruby-deserializer/meta'
-require 'jsonapi-ruby-deserializer/relationship'
-require 'jsonapi-ruby-deserializer/data'
 require 'jsonapi-ruby-deserializer/errors'

data/lib/jsonapi-ruby-deserializer/document.rb

@@ -57,7 +57,17 @@ module JSONAPI
           (Array(@data) + @included).each do |resource|
             next if resource.relationships.nil?
 
-            resource.link_data!(@index)
+            resource.relationships.each do |relation|
+              resource.send(relation.to_sym).data = merge_relations!(resource.send(relation.to_sym).data)
+            end
+          end
+        end
+
+        def merge_relations!(data)
+          if data.kind_of?(Array)
+            data.map { |element| index[[element.type, element.id]] }
+          else
+            index[[data.type, data.id]]
           end
         end
       end

data/lib/jsonapi-ruby-deserializer/resource.rb

@@ -14,14 +14,16 @@ module JSONAPI
           @type = data['type']
           @attributes = data['attributes']
           @links = parse_links!(data['links'])
-          parse!(@attributes)
+          parse!(@attributes) if @attributes
           parse_relationships!(data['relationships']) if data['relationships']
         end
 
         def parse_relationships!(relationships)
-          @relationships = {}
-          (relationships || {}).map do |key, h|
-            @relationships[key] = Relationship.new(h)
+          @relationships = []
+          relationships.map do |key, h|
+            @relationships << key
+            self.class.send(:attr_accessor, key)
+            instance_variable_set("@#{key}", Document.new(h))
           end
         end
 
@@ -31,13 +33,6 @@ module JSONAPI
           Links.new(data)
         end
 
-        def link_data!(index)
-          @relationships.each do |relation_name, relation_body|
-            self.class.send(:attr_accessor, relation_name)
-            instance_variable_set("@#{relation_name}", fetch_relation(relation_body.data, index))
-          end
-        end
-
         def fetch_relation(data, index)
           if data.kind_of?(Array)
             data.map { |element| index[[element.type, element.id]] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-ruby-deserializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Grzegorz Płóciniak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -46,13 +46,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/jsonapi-ruby-deserializer.rb
-- lib/jsonapi-ruby-deserializer/data.rb
 - lib/jsonapi-ruby-deserializer/document.rb
 - lib/jsonapi-ruby-deserializer/errors.rb
 - lib/jsonapi-ruby-deserializer/links.rb
 - lib/jsonapi-ruby-deserializer/meta.rb
 - lib/jsonapi-ruby-deserializer/parser.rb
-- lib/jsonapi-ruby-deserializer/relationship.rb
 - lib/jsonapi-ruby-deserializer/resource.rb
 homepage: https://github.com/igatto/jsonapi-ruby-deserializer
 licenses:

data/lib/jsonapi-ruby-deserializer/data.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'jsonapi-ruby-deserializer/parser'
-
-module JSONAPI
-  module Ruby
-    module Deserializer
-      class Data
-        include JSONAPI::Ruby::Deserializer::Parser
-        attr_accessor :id, :type
-
-        def initialize(data)
-          @id = data['id']
-          @type = data['type']
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi-ruby-deserializer/relationship.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'jsonapi-ruby-deserializer/parser'
-
-module JSONAPI
-  module Ruby
-    module Deserializer
-      class Relationship
-        include JSONAPI::Ruby::Deserializer::Parser
-        attr_accessor :data, :included, :links, :attributes
-
-        def initialize(data)
-          @data = parse_data!(data['data'])
-          @links = parse_links!(data['links'])
-          @meta = parse_meta!(data['meta'])
-        end
-
-        def parse_data!(data)
-          return nil if data.nil?
-
-          data.kind_of?(Array) ? data.map! { |h| Data.new(h) } : Data.new(data)
-        end
-
-        def parse_links!(data)
-          return nil if data.nil?
-
-          Links.new(data)
-        end
-
-        def parse_meta!(data)
-          return nil if data.nil?
-
-          Meta.new(data)
-        end
-      end
-    end
-  end
-end