simple-jsonapi-deserializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 980fce8cc9deb0eed44e09bf5a0157695511c4326cd3a46996765fafad7f67e2
+  data.tar.gz: b220ec286904182dac33abf44ffab207d1e130cce5a8e82f0a0d9a80be601b48
+SHA512:
+  metadata.gz: 91b4be24bff49bc7488bace9a390b34808e9e60d2a5557d8808fce67c743dedf1f04bd57d88df5b95f2ca9a67e4318bb049022dabf513438ced57be66a1f1f0b
+  data.tar.gz: 9624fe3086ba808588cee162df42c65a44ad7ae348f400260e24eeecd817b16b42885fab93d42f71746b721e7f1f1711c816c60e8f129d81acb0c08ba4d3340e

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Exclude:
+    - '**/*.rb'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'simple-jsonapi-deserializer.gemspec'

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2018-09-18
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    simple-jsonapi-deserializer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_snapshot_matcher (0.1.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.8.0, >= 3.0.0)
+  rspec_snapshot_matcher (~> 0.1.0)
+  rubocop (~> 0.52.0)
+  simple-jsonapi-deserializer!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Gerrit Seger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# simple-jsonapi-deserializer
+
+Painless, zero config JSON API deserialization.
+
+## Installation
+
+Add to you application's Gemfile
+
+```ruby
+gem 'simple-jsonapi-deserializer'
+```
+
+and install
+
+```sh
+$ bundle
+```
+
+or install it directly
+
+```shell
+$ gem install 'simple-jsonapi-deserializer'
+```
+
+## Usage
+
+```ruby
+SimpleJSONAPIDeserializer.deserialize(json_api_hash)
+```
+
+## Examples
+
+```ruby
+json_api_hash = {
+  'data' => {
+    'id' => '1234',
+    'type' => 'planets',
+    'attributes' => {
+      'name' => 'Earth'
+    },
+    'relationships' => {
+      'satellites' => {
+        'data' => [
+          {
+            'id' => '914',
+            'type' => 'satellites'
+          }
+        ]
+      }
+    }
+  },
+  'include' => [
+    {
+      'id' => '914',
+      'type' => 'satellites',
+      'attributes' => {
+        'name' => 'Moon'
+      }
+    }
+  ]
+}
+
+SimpleJSONAPIDeserializer.deserialize(json_api_hash)
+
+# =>
+# {
+#   "id" => "1234",
+#   "type" => "planets",
+#   "name" => "Earth",
+#   "satellites" => [
+#     {
+#       "id" => "914"
+#       "type" => "satellites",
+#       "name" => "Moon",
+#     }
+#   ]
+# }
+```
+
+## License
+
+MIT

data/lib/simple_jsonapi_deserializer.rb

@@ -0,0 +1,14 @@
+require 'simple_jsonapi_deserializer/deserializer'
+require 'simple_jsonapi_deserializer/parse_error'
+require 'simple_jsonapi_deserializer/resource'
+require 'simple_jsonapi_deserializer/resource/cache'
+require 'simple_jsonapi_deserializer/resource/includes'
+require 'simple_jsonapi_deserializer/version'
+
+module SimpleJSONAPIDeserializer
+  class << self
+    def deserialize(resource)
+      Deserializer.new(resource).deserialize
+    end
+  end
+end

data/lib/simple_jsonapi_deserializer/deserializer.rb

@@ -0,0 +1,35 @@
+module SimpleJSONAPIDeserializer
+  class Deserializer
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def deserialize
+      return Resource.new(data, includes, cache).deserialize unless data.is_a?(Array)
+
+      data.map do |resource|
+        Resource
+          .new(resource, includes, cache)
+          .deserialize(without_attributes: true)
+      end
+    rescue TypeError, NoMethodError => e
+      raise ParseError, e
+    end
+
+    private
+
+    attr_reader :resource
+
+    def cache
+      Resource::Cache.new
+    end
+
+    def data
+      resource['data'] || {}
+    end
+
+    def includes
+      Resource::Includes.new(resource['include'] || [])
+    end
+  end
+end

data/lib/simple_jsonapi_deserializer/parse_error.rb

@@ -0,0 +1,3 @@
+module SimpleJSONAPIDeserializer
+  class ParseError < StandardError; end
+end

data/lib/simple_jsonapi_deserializer/resource.rb

@@ -0,0 +1,91 @@
+module SimpleJSONAPIDeserializer
+  class Resource
+    def initialize(resource, includes, cache)
+      @resource = resource
+      @includes = includes
+      @cache = cache
+    end
+
+    def deserialize(without_attributes: false, without_relationships: false)
+      {}.tap do |deserialized_resource|
+        deserialized_resource.merge!(attributes) unless without_attributes
+        deserialized_resource.merge!(deserialized_relationships) unless without_relationships
+        deserialized_resource['type'] = type if type
+        deserialized_resource['id'] = id if id
+      end
+    end
+
+    def id
+      resource['id']
+    end
+
+    def type
+      resource['type']
+    end
+
+    private
+
+    attr_reader :cache, :includes, :resource
+
+    def attributes
+      resource['attributes'] || {}
+    end
+
+    def relationships
+      resource['relationships'] || {}
+    end
+
+    def deserialized_relationships
+      {}.tap do |deserialized_relationships|
+        relationships.each do |key, value|
+          data = value['data']
+
+          deserialized_relationships[key] = if data.is_a?(Array)
+                                              deserialize_relationships(data)
+                                            else
+                                              deserialize_relationship(data)
+                                            end
+        end
+      end
+    end
+
+    def deserialize_relationships(relationships)
+      relationships.map do |relationship|
+        deserialize_relationship(relationship)
+      end
+    end
+
+    def deserialize_relationship(relationship)
+      id = relationship['id']
+      type = relationship['type']
+      cached_resource = read_from_cache(id, type)
+      included_resource = read_from_includes(id, type)
+
+      return cached_resource if cached_resource
+
+      deserialize_and_cache_relationship(included_resource || relationship)
+    end
+
+    def deserialize_and_cache_relationship(relationship)
+      resource = Resource.new(relationship, includes, cache)
+
+      write_to_cache(resource.id, resource.type, resource.deserialize(without_relationships: true))
+
+      resource.deserialize.tap do |deserialized_resource|
+        write_to_cache(resource.id, resource.type, deserialized_resource)
+      end
+    end
+
+    def read_from_includes(id, type)
+      includes.find(id, type)
+    end
+
+    def write_to_cache(id, type, deserialized_resource)
+      cache.cache(id, type, deserialized_resource)
+    end
+
+    def read_from_cache(id, type)
+      cache.find(id, type)
+    end
+  end
+end

data/lib/simple_jsonapi_deserializer/resource/cache.rb

@@ -0,0 +1,26 @@
+module SimpleJSONAPIDeserializer
+  class Resource
+    class Cache
+      def initialize
+        @cached_resources = {}
+      end
+
+      def cache(id, type, deserialized_resource)
+        cached_resources[type] ||= {}
+        cached_resources[type][id] = deserialized_resource
+      end
+
+      def cached?(id, type)
+        cached_resource(id, type)
+      end
+
+      def find(id, type)
+        cached_resources.dig(type, id)
+      end
+
+      private
+
+      attr_reader :cached_resources
+    end
+  end
+end

data/lib/simple_jsonapi_deserializer/resource/includes.rb

@@ -0,0 +1,29 @@
+module SimpleJSONAPIDeserializer
+  class Resource
+    class Includes
+      def initialize(includes)
+        @includes = includes
+      end
+
+      def find(id, type)
+        indexed_includes.dig(type, id)
+      end
+
+      private
+
+      attr_reader :includes
+
+      def indexed_includes
+        @indexed_includes ||= {}.tap do |indexed_includes|
+          includes.each do |included_resource|
+            id = included_resource['id']
+            type = included_resource['type']
+
+            indexed_includes[type] = {} unless indexed_includes[type]
+            indexed_includes[type][id] = included_resource
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_deserializer/version.rb

@@ -0,0 +1,3 @@
+module SimpleJSONAPIDeserializer
+  VERSION = '0.1.0'.freeze
+end

data/simple-jsonapi-deserializer.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_jsonapi_deserializer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'simple-jsonapi-deserializer'
+  gem.version       = SimpleJSONAPIDeserializer::VERSION
+  gem.summary       = 'JSON API resource deserialization.'
+  gem.description   = 'Straight forward, painless, zero config deserialization of JSON API resources.'
+  gem.license       = 'MIT'
+  gem.authors       = ['Gerrit Seger']
+  gem.email         = 'gerrit.seger@gmail.com'
+  gem.homepage      = 'https://rubygems.org/gems/simple-jsonapi-deserializer'
+
+  gem.files         = `git ls-files`.split($/)
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/", '')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule, subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rspec', '~> 3.8.0', '>= 3.0.0'
+  gem.add_development_dependency 'rspec_snapshot_matcher', '~> 0.1.0'
+  gem.add_development_dependency 'rubocop', '~> 0.52.0'
+end