jsonapi_deserializer 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2fdf9fafbdfca4001e1524366b2f6e53248df5ca
-  data.tar.gz: 9e9965c7da3e9e1bdda4df87d07fe8dc57358a98
+SHA256:
+  metadata.gz: e7cdae31765c3a976edac1f14e45aed9c05aa824fe59cc551355748ec5033ada
+  data.tar.gz: 9b19152a529e0ec488c3aad1f14dee437d254a2123e5f3229dfec0a03c567306
 SHA512:
-  metadata.gz: d178b73585336cb6cc0776c09aa61c9669fbdbba1f03fb59a2e61232959c6275da02737cdc3d302d456e00257f82bccce08ce0ec6d8394f3587a31beba4381aa
-  data.tar.gz: 7c1aab7ff2908b3479d8d852def4ea0fa3e60234db48f6528257ab5fe77f639332985dd3b4b58e76376e70bbba16178852dc388da33089755551f64fbe6400f0
+  metadata.gz: 1c3d041f8ee139429d98156b61ac942bbded37651eba0b55837471d9ce060fce4d9508ff398b2b631b7fba45c18884f3dcc1f8f26c2472013407c69b439f9a25
+  data.tar.gz: bf0b3d7db9ba4889ab9d736926d14870d2c17dfd311fba03dde8da2a4f4b962b792bb12edd3e63a816ed69586016c41be76b7242c1696820da7a29a6163093d3

data/README.md

@@ -38,6 +38,19 @@ one_deserialized = JSONApi::Deserializer.new(response).deserialized_hash
 # one_deserialized.name == 'fluffy'
 ```
 
+## Configuration
+
+Version 1.3.1 introduces the ability to configure the gem using an initializer file and block with following options:
+
+```
+JSONApi::Deserializer.configure do |config|
+  config.supports_lids = true
+end
+```
+
+Above are all options for configuration with the default of each configuration option.
+
+`supports_lids` - will include a `lid` key in each deserialized hash record. See JSONAPI spec '> 1.1' for more information on lids.
 
 ## Development
 

data/jsonapi_deserializer.gemspec

@@ -2,12 +2,13 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jsonapi_deserializer/version'
+require 'jsonapi_deserializer/configuration'
 
 Gem::Specification.new do |spec|
   spec.name          = "jsonapi_deserializer"
   spec.version       = JSONApi::Deserializer::VERSION
   spec.authors       = ["Trek Glowacki"]
-  spec.email         = ["trek@popularpays.com"]
+  spec.email         = ["trek.glowacki@gmail.com"]
 
   spec.summary       = "Deserialize your json-api payloads into easy-to-use hashes with attribute properties."
   spec.homepage      = "https://github.com/PopularPays/jsonapi_deserializer"
@@ -18,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", ">= 1.10", "< 3.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
 
-  spec.add_runtime_dependency "hashie"
+  spec.add_runtime_dependency "hashie", "< 4.0"
   spec.add_runtime_dependency "activesupport"
 end

data/lib/jsonapi_deserializer/configuration.rb

@@ -0,0 +1,23 @@
+module JSONApi
+  class Deserializer
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    class Configuration
+      attr_accessor :support_lids
+
+      def initialize
+        @support_lids = true
+      end
+    end
+  end
+end

data/lib/jsonapi_deserializer/version.rb

@@ -1,5 +1,5 @@
 module JSONApi
   class Deserializer
-    VERSION = "1.0.0"
+    VERSION = "1.3.1"
   end
 end

data/lib/jsonapi_deserializer.rb

@@ -1,6 +1,7 @@
-require "hashie"
-require "active_support/core_ext/hash/indifferent_access"
-require "jsonapi_deserializer/version"
+require 'hashie'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'jsonapi_deserializer/version'
+require 'jsonapi_deserializer/configuration'
 
 module JSONApi
   class Deserializer
@@ -8,8 +9,15 @@ module JSONApi
       include Hashie::Extensions::MethodAccess
       include Hashie::Extensions::IndifferentAccess
 
-      def initialize(hash)
-        hash[:id] = hash[:id].to_s
+      def initialize(source_hash = nil, default = nil, &blk)
+
+        if source_hash[:id]
+          source_hash[:id] = source_hash[:id].to_s
+        end
+
+        if source_hash[:lid]
+          source_hash[:lid] = source_hash[:lid].to_s
+        end
         super
       end
     end
@@ -18,11 +26,43 @@ module JSONApi
       include Hashie::Extensions::MethodAccess
       include Hashie::Extensions::IndifferentAccess
       include Hashie::Extensions::DeepFetch
+
+      def initialize(source_hash = nil, default = nil, &blk)
+        if source_hash[:id]
+          source_hash[:id] = source_hash[:id].to_s
+        end
+
+        if source_hash[:lid]
+          source_hash[:lid] = source_hash[:lid].to_s
+        end
+        super
+      end
+    end
+
+    class Store
+      def initialize
+        @db = {}
+      end
+
+      def set(type, id, lid, record)
+        per_type = @db[type] ||= {}
+        identifier = id || lid
+
+        per_type[identifier.to_s] = record
+      end
+
+      def get(type, id, lid)
+        per_type = @db[type]
+        return nil unless per_type
+
+        identifier = id || lid
+        per_type[identifier.to_s]
+      end
     end
 
     def initialize(response)
-      @response = response.with_indifferent_access
-      @store = {}
+      @response = response.is_a?(Hash) ? response.with_indifferent_access : response
+      @store = Store.new
 
       all_data = ([] << @response[:data] << @response[:included]).flatten.compact
       store_records(all_data)
@@ -31,10 +71,11 @@ module JSONApi
 
     def deserialized_hash
       data = @response[:data]
+
       if data.is_a? Array
-        data.map { |datum| @store[datum[:type]][datum[:id].to_s] }
+        data.map { |datum| @store.get(datum[:type], datum[:id], datum[:lid]) }
       else
-        @store[data[:type]][data[:id].to_s]
+        @store.get(data[:type], data[:id], data[:lid])
       end
     end
 
@@ -42,26 +83,24 @@ module JSONApi
 
     def store_records(data)
       data.each do |datum|
-        type = datum[:type]
-        per_type = @store[type] ||= {}
-        record = Record.new(id: datum[:id].to_s, type: datum[:type]).merge(datum[:attributes] || {})
+        record = if self.class.configuration.support_lids
+          Record.new(id: datum[:id], lid: datum[:lid]).merge(datum[:attributes] || {})
+        else
+          Record.new(id: datum[:id]).merge(datum[:attributes] || {})
+        end
 
-        per_type[record.id] = record
+        @store.set(datum[:type], datum[:id], datum[:lid], record)
       end
     end
 
     def find_association(association)
       return nil unless association
-      if @store[association[:type]] && @store[association[:type]][association[:id].to_s]
-        @store[association[:type]][association[:id].to_s]
-      else
-        Assocation.new(association)
-      end
+      @store.get(association[:type], association[:id], association[:lid]) || Assocation.new(association)
     end
 
     def build_associations(data)
       data.each do |datum|
-        record = @store[datum[:type]][datum[:id].to_s]
+        record = @store.get(datum[:type], datum[:id], datum[:lid])
 
         relationships = datum[:relationships] || {}
         relationships.each do |relationship_name, relationship|

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_deserializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Trek Glowacki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +62,16 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +88,7 @@ dependencies:
         version: '0'
 description: 
 email:
-- trek@popularpays.com
+- trek.glowacki@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -99,6 +105,7 @@ files:
 - bin/setup
 - jsonapi_deserializer.gemspec
 - lib/jsonapi_deserializer.rb
+- lib/jsonapi_deserializer/configuration.rb
 - lib/jsonapi_deserializer/version.rb
 homepage: https://github.com/PopularPays/jsonapi_deserializer
 licenses:
@@ -119,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Deserialize your json-api payloads into easy-to-use hashes with attribute