jsonapi-ruby-deserializer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87661b3017acff3a4787abcb1fcdb5c45ca72e5f3ca163736cd180a84f76ecca
-  data.tar.gz: 28bf0faff7c346f78449f04070de6e8585ace8e47977069850c94e8575347925
+  metadata.gz: db1eb037f321f4d8c4b7d6014211ad7453df543de53f7692c64b71a911f16bb8
+  data.tar.gz: eccd199e84b86e923faad083a71dc371dd867f8648a9295885ec312501b5ef75
 SHA512:
-  metadata.gz: 34b5146462a3fcaa99b3fc42b8271c9bbcdf4bfef9ae7aa62641d4d0ed061e41ca5f5b457d08a44bb34f4f083fdb86ed3b2686c0ac1da409d60ba53510e06222
-  data.tar.gz: 7056d3de97a4d9f4c0abeb609690b1e9d8a386b79050254f6a53e5b4e3f165a5a235da33f4a19fb3670dd76de0a9fd0529176140cfde662e2b76e62482963bed
+  metadata.gz: 24c3bdd1d7e9424776dac864a1a2b30ec6a9669125df9fe162a03eec63ee8be80287df510e70c84fe578df63a085d74047b978e1653f7b97017b2abd14da2534
+  data.tar.gz: c6c010c8599dda0ad98734530c8c1331096b347168d1dbd24e1281e400d680c5ec8bc6c654f0540bbe74688299859be18e9ce8b2fab4d971cfde9b5917991446

data/README.md

@@ -20,8 +20,10 @@ document = JSONAPI::Ruby::Deserializer::Document.new(hash)
 
 document.data.type
 # => "articles"
-document.data.title
+document.data.attributes.title
 # => "Lorem Ipsum"
+document.data.attributes.to_h
+# => {"title"=>"Lorem Ipsum"}
 ```
 
 ### Advanced example:
@@ -30,58 +32,79 @@ hash = {"meta"=>{"license"=>"MIT", "authors"=>["James Smith", "Maria Hernandez"]
 document = JSONAPI::Ruby::Deserializer::Document.new(hash)
 ```
 
-#### Attributes
+#### Data
 ```ruby
 document.data[0].id
 # => "1"
 
 document.data[0].type
 # => "articles"
+```
 
-document.data[0].title
+#### Attributes
+```ruby
+document.data[0].attributes.title
 # => "JSON:API paints my bikeshed!"
 
-document.data[0].attributes
+document.data[0].attributes.to_h
 # => {"title"=>"JSON:API paints my bikeshed!"}
 
-document.data[0].comments.data[0].body
+document.data[0].relationships.comments.data[0].attributes.body
 # => "First!"
 
-document.data[0].comments.data[0].attributes
+document.data[0].relationships.comments.data[0].attributes.to_h
 # => {"body"=>"First!"}
 ```
 
-#### One-to-one relation
+#### One-to-one relations
 ```ruby
-document.data[0].author.data.id
+document.data[0].relationships.author.data.id
 # => "9"
 
-document.data[0].author.data.first_name
+document.data[0].relationships.author.data.attributes.first_name
 # => "Dan"
+
+document.data[0].relationships.author.data.attributes.to_h
+# => {"first_name"=>"Dan", "last_name"=>"Gebhardt", "twitter"=>"dgeb"}
 ```
 
-#### One-to-many relation
+#### One-to-many relations
 ```ruby
-document.data[0].comments.data[0].id
+document.data[0].relationships.comments.data[0].id
 # => "5"
 
-document.data[0].comments.data[0].body
+document.data[0].relationships.comments.data[0].attributes.body
 # => "First!"
+
+document.data[0].relationships.comments.data[0].attributes.to_h
+# => {"body"=>"First!"}
 ```
 
-#### Nested relation
+#### Nested relations
 ```ruby
-document.data[0].comments.data[1].author.data.first_name
+document.data[0].relationships.comments.data[1].relationships.author.data.id
+# => "9"
+
+document.data[0].relationships.comments.data[1].relationships.author.data.attributes.first_name
 # => "Dan"
 
-document.data[0].comments.data[1].author.data.attributes
+document.data[0].relationships.comments.data[1].relationships.author.data.attributes.to_h
 # => {"first_name"=>"Dan", "last_name"=>"Gebhardt", "twitter"=>"dgeb"}
 ```
 
+#### List relationships
+```ruby
+document.data[0].relationships.to_a
+# => ["author", "comments"]
+```
+
 #### Meta
 ```ruby
 document.meta.authors
 # => ["James Smith", "Maria Hernandez"]
+
+document.meta.to_h
+# => {"license"=>"MIT", "authors"=>["James Smith", "Maria Hernandez"]}
 ```
 
 #### Links
@@ -89,17 +112,23 @@ document.meta.authors
 document.links.self
 # => "http://example.com/articles"
 
-document.data[0].author.links.self
+document.data[0].relationships.author.links.self
 # => "http://example.com/articles/1/relationships/author"
 
-document.data[0].author.data.links.self
+document.data[0].relationships.author.data.links.self
 # => "http://example.com/people/9"
+
+document.data[0].relationships.author.data.links.to_h
+# => {"self"=>"http://example.com/people/9"}
 ```
 
-#### List relationships
+#### jsonapi
 ```ruby
-document.data[0].relationships
-# => ["author", "comments"]
+document.jsonapi.version
+# => "1.0"
+
+document.jsonapi.to_h
+# => {"version"=>"1.0"}
 ```
 
 ## License

data/lib/jsonapi-ruby-deserializer.rb

@@ -3,3 +3,6 @@ require 'jsonapi-ruby-deserializer/document'
 require 'jsonapi-ruby-deserializer/links'
 require 'jsonapi-ruby-deserializer/meta'
 require 'jsonapi-ruby-deserializer/errors'
+require 'jsonapi-ruby-deserializer/jsonapi'
+require 'jsonapi-ruby-deserializer/attributes'
+require 'jsonapi-ruby-deserializer/relationships'

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jsonapi-ruby-deserializer/parser'
+
+module JSONAPI
+  module Ruby
+    module Deserializer
+      class Attributes
+        include JSONAPI::Ruby::Deserializer::Parser
+
+        def initialize(data)
+          parse!(data)
+        end
+      end
+    end
+  end
+end

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

@@ -4,38 +4,45 @@ module JSONAPI
   module Ruby
     module Deserializer
       class Document
-        attr_accessor :data, :included, :meta, :links, :index, :errors
+        attr_accessor :jsonapi, :meta, :links, :data, :included, :index, :errors
 
         def initialize(document, link_data: true)
-          @included = parse_resource!(document['included']) if document['included']
-          @index = create_index!
-          @data = parse_resource!(document['data'])
-          @links = parse_links!(document['links'])
+          @jsonapi = parse_jsonapi!(document['jsonapi'])
           @meta = parse_meta!(document['meta'])
+          @links = parse_links!(document['links'])
+          @data = parse_resource!(document['data'])
+          @included = parse_resource!(document['included'])
+          @index = create_index!
           @errors = parse_errors!(document['errors'])
           link_data! if link_data
         end
 
         def parse_resource!(data)
-          return if data.nil?
+          return if data.nil? || data.empty?
 
           data.kind_of?(Array) ? data.map! { |h| Resource.new(h) } : Resource.new(data)
         end
 
         def parse_links!(data)
-          return if data.nil?
+          return if data.nil? || data.empty?
 
           Links.new(data)
         end
 
         def parse_meta!(data)
-          return if data.nil?
+          return if data.nil? || data.empty?
 
           Meta.new(data)
         end
 
+        def parse_jsonapi!(data)
+          return if data.nil? || data.empty?
+
+          Jsonapi.new(data)
+        end
+
         def create_index!
-          return if @included.nil?
+          return if @included.nil? || @included.empty?
 
           {}.tap do |h|
             @included.each do |resource|
@@ -46,28 +53,28 @@ module JSONAPI
         end
 
         def parse_errors!(data)
-          return if data.nil?
+          return if data.nil? || data.empty?
 
           data.kind_of?(Array) ? data.map! { |h| Errors.new(h) } : Errors.new(data)
         end
 
         def link_data!
-          return if @included.nil?
+          return if @included.nil? || @included.empty?
 
           (Array(@data) + @included).each do |resource|
-            next if resource.relationships.nil?
+            next if resource.relationships.to_a.empty?
 
-            resource.relationships.each do |relation|
-              resource.send(relation.to_sym).data = merge_relations!(resource.send(relation.to_sym).data)
+            resource.relationships.to_a.each do |relation|
+              resource.relationships.send(relation.to_sym).data = fetch_relation(resource.relationships.send(relation.to_sym).data)
             end
           end
         end
 
-        def merge_relations!(data)
+        def fetch_relation(data)
           if data.kind_of?(Array)
-            data.map { |element| index[[element.type, element.id]] }
+            data.map { |element| index[[element.type, element.id]] || element }
           else
-            index[[data.type, data.id]]
+            index[[data.type, data.id]] || data
           end
         end
       end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jsonapi-ruby-deserializer/parser'
+
+module JSONAPI
+  module Ruby
+    module Deserializer
+      class Jsonapi
+        include JSONAPI::Ruby::Deserializer::Parser
+
+        def initialize(data)
+          parse!(data)
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,10 @@ module JSONAPI
   module Ruby
     module Deserializer
       module Parser
+        attr_accessor :to_h
+
         def parse!(data)
+          @to_h = data
           data.each do |field, value|
             instance_variable_set("@#{field}", value)
             self.class.send(:attr_accessor, field.to_sym)

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'jsonapi-ruby-deserializer/parser'
+
+module JSONAPI
+  module Ruby
+    module Deserializer
+      class Relationships
+        include JSONAPI::Ruby::Deserializer::Parser
+        attr_accessor :to_a
+
+        def initialize(data)
+          @to_a = []
+          data.map do |key, h|
+            @to_a << key
+            self.class.send(:attr_accessor, key)
+            instance_variable_set("@#{key}", Document.new(h))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,38 +7,39 @@ module JSONAPI
     module Deserializer
       class Resource
         include JSONAPI::Ruby::Deserializer::Parser
-        attr_accessor :id, :type, :attributes, :relationships, :links
+        attr_accessor :id, :type, :attributes, :relationships, :links, :meta
 
         def initialize(data)
           @id = data['id']
           @type = data['type']
-          @attributes = data['attributes']
+          @attributes = parse_attributes!(data['attributes'])
           @links = parse_links!(data['links'])
-          parse!(@attributes) if @attributes
-          parse_relationships!(data['relationships']) if data['relationships']
+          @meta = parse_meta!(data['meta'])
+          @relationships = parse_relationships!(data['relationships'])
         end
 
-        def parse_relationships!(relationships)
-          @relationships = []
-          relationships.map do |key, h|
-            @relationships << key
-            self.class.send(:attr_accessor, key)
-            instance_variable_set("@#{key}", Document.new(h))
-          end
+        def parse_relationships!(data)
+          return if data.nil? || data.empty?
+
+          Relationships.new(data)
         end
 
         def parse_links!(data)
-          return if data.nil?
+          return if data.nil? || data.empty?
 
           Links.new(data)
         end
 
-        def fetch_relation(data, index)
-          if data.kind_of?(Array)
-            data.map { |element| index[[element.type, element.id]] }
-          else
-            index[[data.type, data.id]]
-          end
+        def parse_meta!(data)
+          return if data.nil? || data.empty?
+
+          Meta.new(data)
+        end
+
+        def parse_attributes!(data)
+          return if data.nil? || data.empty?
+
+          Attributes.new(data)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-ruby-deserializer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Grzegorz Płóciniak
@@ -46,11 +46,14 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/jsonapi-ruby-deserializer.rb
+- lib/jsonapi-ruby-deserializer/attributes.rb
 - lib/jsonapi-ruby-deserializer/document.rb
 - lib/jsonapi-ruby-deserializer/errors.rb
+- lib/jsonapi-ruby-deserializer/jsonapi.rb
 - lib/jsonapi-ruby-deserializer/links.rb
 - lib/jsonapi-ruby-deserializer/meta.rb
 - lib/jsonapi-ruby-deserializer/parser.rb
+- lib/jsonapi-ruby-deserializer/relationships.rb
 - lib/jsonapi-ruby-deserializer/resource.rb
 homepage: https://github.com/igatto/jsonapi-ruby-deserializer
 licenses: