jsonapi-object-mapper 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f9a7b828f1b92f507cc28cf7eb65cbf697042669846a11ac0099aa6b6f24b6
-  data.tar.gz: 9dfb0ad00761af92d00c87062fb60399f19989f3f13d989abd7c046676509896
+  metadata.gz: b23420a89f5d55965dafc872b3a84b78562d654981c7f3ff1f1524a90b42b8b7
+  data.tar.gz: 817b0c84ab3638e11a4b7540ccffdf3f8bd7dea40f046c884a77ada0d39712b4
 SHA512:
-  metadata.gz: 7cd208aa8aa699060367018cd73e0c8263e3f45839de720e6983a8400c8c4056c1300e846c3933729c227f3c03e37107a02f2b829a899d84b9aa24a6f9d276fd
-  data.tar.gz: 637cf774585df3d34fc84aa64d6f252066135c1df09316e797dbf2c71732ffbe74b98b844e7cfc7c469c9a7b8954888b6a256f310c29d7225535f730a5b8d9f5
+  metadata.gz: 001f695018d0ac217632c7f070789e378377b371113ec0ae13f1871cda73d088ad92d4980d28d0d5f04c23d4b3dd9f09818108a786732436cb454b560ce31273
+  data.tar.gz: e12ddd6228e415944ac1c8b19f62a7f64ca53ce62cf08a6e6beb77eff67a0625f968d80e4b8d6f840f8e9485a26a5340233df2eb36839051150ac26af888ae64

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.9.0 - August 5th 2018
+  - Added document `links` support.
+  
+## 0.0.0 to 0.8.1
+  - Added initial support for parsing `has_many`, `has_one` / `belongs_to` relationships into class functions
+  - Added initial support for parsing relationship resources with a responses `included` block. Using the `embed_with` option for relationships.
+  - Added initial support for parsing data attributes into class functions.
+  - Added Error handling support

data/lib/jsonapi-object-mapper/deserialize/collection.rb

@@ -9,7 +9,7 @@ module JsonAPIObjectMapper
       include Enumerable
       include JsonAPIObjectMapper::Parser::Errors
 
-      attr_accessor :collection_data
+      attr_reader :collection_data, :links
 
       def_delegators :@collection_data, :first, :last, :[]
 
@@ -17,11 +17,12 @@ module JsonAPIObjectMapper
         raise InvalidResource unless klass.is_a?(Class)
         raise InvalidParser   unless parser.is_a?(JsonAPIObjectMapper::Parser::Document)
         @errors            = parser.errors
+        @links             = parser.links
         @collection_data   =
           if document_invalid?
             []
           else
-            Array(parser.document["data"]).map do |doc|
+            Array(parser.document_data).map do |doc|
               klass.new(parser, document: doc)
             end
           end.freeze
@@ -29,15 +30,28 @@ module JsonAPIObjectMapper
         freeze
       end
 
-      def to_hash
-        @collection_data.map(&:to_hash)
-      end
-
       def each
         @collection_data.each do |data|
           yield data
         end
       end
+
+      def inspect
+        "#<#{self.class}:0x#{object_id.to_s(16)}, "\
+        "@errors=#{@errors.inspect}, "\
+        "@links=#{@links.inspect}, "\
+        "@data=#{@collection_data.map(&:inspect)}>"\
+      end
+      alias to_s inspect
+
+      def to_hash
+        {}.tap do |hash|
+          hash[:data]   = @collection_data.map(&:to_hash)
+          hash[:links]  = @links.to_h unless @links.nil?
+          hash[:errors] = @errors unless valid?
+        end
+      end
+      alias to_h to_hash
     end
   end
 end

data/lib/jsonapi-object-mapper/deserialize/dsl.rb

@@ -77,9 +77,13 @@ module JsonAPIObjectMapper
         end
         alias to_h to_hash
 
-        def to_s
-          to_hash.to_s
+        def inspect
+          "#<#{self.class}:0x#{object_id.to_s(16)}, "\
+          "@errors = #{@errors.inspect}, "\
+          "attributes = #{@_class_attributes.inspect}, "\
+          "relationships = #{@_class_relationships.inspect}>"
         end
+        alias to_s inspect
 
         protected
 

data/lib/jsonapi-object-mapper/deserialize/resource.rb

@@ -10,6 +10,8 @@ module JsonAPIObjectMapper
       include JsonAPIObjectMapper::Parser::Errors
       extend DSL
 
+      attr_reader :links
+
       class << self
         attr_accessor :rel_has_one_blocks, :rel_has_many_blocks, :rel_options, :attr_blocks, :id_block, :type_block
       end
@@ -34,7 +36,7 @@ module JsonAPIObjectMapper
 
       def self.load(document)
         parser = JsonAPIObjectMapper::Parser::Document.new(document)
-        if parser.document["data"].is_a?(Array) || parser.invalid?
+        if parser.contains_data_array? || parser.invalid?
           Collection.new(parser, klass: self)
         else
           new(parser)
@@ -48,6 +50,7 @@ module JsonAPIObjectMapper
 
         if document_valid?
           @includes      = parser.includes
+          @links         = parser_links(parser)
           @data          = document_data(parser, document)
           @id            = @data["id"]
           @type          = @data["type"]
@@ -66,7 +69,11 @@ module JsonAPIObjectMapper
       private
 
       def document_data(parser, document)
-        document.nil? ? (parser.document["data"] || parser.document) : (document["data"] || document)
+        document.nil? ? parser.document_data : (document["data"] || document)
+      end
+
+      def parser_links(parser)
+        parser.links unless parser.contains_data_array?
       end
 
       def deserialize!

data/lib/jsonapi-object-mapper/parser/document.rb

@@ -8,19 +8,35 @@ module JsonAPIObjectMapper
     class Document
       include Errors
 
-      attr_accessor :document, :includes
+      attr_reader :document, :includes, :links
 
       def initialize(document)
-        @document = (document.is_a?(String) ? ::Oj.load(document) : document).freeze
-        @includes = IncludedResources.load(@document["included"])
-        @errors   = deserialize_errors!.freeze
+        parsed_document = (document.is_a?(String) ? ::Oj.load(document) : document)
+        @includes       = IncludedResources.load(parsed_document.delete("included"))
+        @links          = deserialize_links(parsed_document.delete("links")).freeze
+        @document       = parsed_document.freeze
+        @errors         = deserialize_errors!.freeze
         freeze
       end
 
+      def document_data
+        @document["data"] || @document
+      end
+
+      def contains_data_array?
+        document_data.is_a?(Array)
+      end
+
       def deserialize_errors!
         return [] unless @document.key?("errors")
         Set.new(@document["errors"]) { |error| OpenStruct.new(error) }
       end
+
+      def deserialize_links(links)
+        links&.each_with_object(OpenStruct.new) do |(key, value), struct|
+          struct[key.to_s.tr("-", "_")] = value
+        end
+      end
     end
   end
 end

data/lib/jsonapi-object-mapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonAPIObjectMapper
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/deserialize/collection_spec.rb

@@ -79,6 +79,25 @@ module JsonAPIObjectMapper
             expect(result.source).to include("pointer" => "name")
           end
         end
+
+        context "Links" do
+          let(:foo_bar_klass) { Class.new(JsonAPIObjectMapper::Deserialize::Resource) }
+          subject { described_class.new(parser, klass: foo_bar_klass).links }
+
+          context "Results do not include links" do
+            it { is_expected.to be_nil }
+          end
+
+          it_behaves_like "it contains links" do
+            let!(:payload) { payload_links.merge("data" => [{ "id" => "1", "type" => "foobar" }]) }
+
+            it "Should not include links in the children of data resources" do
+              results = described_class.new(parser, klass: foo_bar_klass)
+              expect(results.first.id).to eq("1")
+              expect(results.first.links).to be_nil
+            end
+          end
+        end
       end
     end
   end

data/spec/deserialize/link_examples.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_examples_for "it contains links" do
+  let(:payload_links) do
+    {
+      "links" => {
+        "total-pages" => 14,
+        "self"        => "https://some-random-api.com/search?name=me?page=2",
+        "first"       => "https://some-random-api.com/search?name=me?page=1",
+        "last"        => "https://some-random-api.com/search?name=me?page=14",
+        "prev"        => "https://some-random-api.com/search?name=me?page=1",
+        "next"        => "https://some-random-api.com/search?name=me?page=3",
+      },
+    }
+  end
+
+  let(:payload) { payload_links }
+
+  it { is_expected.to be_a(OpenStruct).and(be_frozen) }
+  its(:total_pages) { is_expected.to eq(14) }
+  its(:self)        { is_expected.to eq("https://some-random-api.com/search?name=me?page=2") }
+  its(:first)       { is_expected.to eq("https://some-random-api.com/search?name=me?page=1") }
+  its(:last)        { is_expected.to eq("https://some-random-api.com/search?name=me?page=14") }
+  its(:prev)        { is_expected.to eq("https://some-random-api.com/search?name=me?page=1") }
+  its(:next)        { is_expected.to eq("https://some-random-api.com/search?name=me?page=3") }
+end

data/spec/deserialize/resource_spec.rb

@@ -191,6 +191,18 @@ module JsonAPIObjectMapper
           end
         end
       end
+
+      describe "Links" do
+        let(:foo_bar_klass) { Class.new(described_class) }
+        subject { foo_bar_klass.load(payload).links }
+
+        it_behaves_like "it contains links"
+
+        context "Response does not contain links" do
+          let(:payload) { {} }
+          it { is_expected.to be_nil }
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
+require "rspec/its"
 require "jsonapi-object-mapper"
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require File.expand_path(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-object-mapper
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - George Protacio-Karaszi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Digests JSON-API responses to plain old ruby objects
 email:
 - georgekaraszi@gmail.com
@@ -73,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - lib/jsonapi-object-mapper.rb
 - lib/jsonapi-object-mapper/deserialize/collection.rb
@@ -84,6 +99,7 @@ files:
 - lib/jsonapi-object-mapper/parser/included_resources.rb
 - lib/jsonapi-object-mapper/version.rb
 - spec/deserialize/collection_spec.rb
+- spec/deserialize/link_examples.rb
 - spec/deserialize/resource_spec.rb
 - spec/jsonapi_object_mapper_spec.rb
 - spec/spec_helper.rb
@@ -113,6 +129,7 @@ specification_version: 4
 summary: Digests JSON-API responses to plain old ruby objects
 test_files:
 - spec/deserialize/collection_spec.rb
+- spec/deserialize/link_examples.rb
 - spec/deserialize/resource_spec.rb
 - spec/jsonapi_object_mapper_spec.rb
 - spec/spec_helper.rb