jsonapi-ruby-deserializer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a473a252ab221a5c0255245b93754578587559abe8d02f91596fc525b16f5e44
+  data.tar.gz: 9aed91c511f2624dacc4138ee17af5910c8bf95a1c2753048f7183f1f720b0d0
+SHA512:
+  metadata.gz: ef4edc5e8637ae62d623679427f293a70e913edee5fa3dffc93ebfd042b9ee83fbcb93a8832414863dfcf22f1bf928af8ab3af9e0c33c7e8b30415d05355f51c
+  data.tar.gz: 43e39863d66835c4e4f72339cb47002fb77587e2586fc1dddde9b68d661855f53bcaed50c566ad9032ebd3f12af0fd34480ba0d862c8f49c8396c2cfc4eb52b6

data/README.md

@@ -0,0 +1,67 @@
+# JSONAPI Ruby Deserializer
+Makes work with [JSON::API compound documents](https://jsonapi.org/format/#document-compound-documents) easy
+
+## Status
+[![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
+
+## Usage
+### Simple example:
+```ruby
+hash = {"data"=>{"type"=>"articles", "attributes"=>{"title"=>"Lorem Ipsum"}}}
+document = JSONAPI::Ruby::Deserializer::Document.new(hash)
+document.data.title
+=> "Lorem Ipsum"
+```
+
+### Advanced example:
+```ruby
+hash = {"meta"=>{"license"=>"MIT", "authors"=>["James Smith", "Maria Hernandez"]}, "links"=>{"self"=>"http://example.com/articles", "next"=>"http://example.com/articles?page[offset]=2", "last"=>"http://example.com/articles?page[offset]=10"}, "data"=>[{"type"=>"articles", "id"=>"1", "attributes"=>{"title"=>"JSON:API paints my bikeshed!"}, "relationships"=>{"author"=>{"links"=>{"self"=>"http://example.com/articles/1/relationships/author", "related"=>"http://example.com/articles/1/author"}, "data"=>{"type"=>"people", "id"=>"9"}}, "comments"=>{"links"=>{"self"=>"http://example.com/articles/1/relationships/comments", "related"=>"http://example.com/articles/1/comments"}, "data"=>[{"type"=>"comments", "id"=>"5"}, {"type"=>"comments", "id"=>"12"}]}}, "links"=>{"self"=>"http://example.com/articles/1"}}], "included"=>[{"type"=>"people", "id"=>"9", "attributes"=>{"first_name"=>"Dan", "last_name"=>"Gebhardt", "twitter"=>"dgeb"}, "links"=>{"self"=>"http://example.com/people/9"}}, {"type"=>"comments", "id"=>"5", "attributes"=>{"body"=>"First!"}, "relationships"=>{"author"=>{"data"=>{"type"=>"people", "id"=>"2"}}}, "links"=>{"self"=>"http://example.com/comments/5"}}, {"type"=>"comments", "id"=>"12", "attributes"=>{"body"=>"I like XML better"}, "relationships"=>{"author"=>{"data"=>{"type"=>"people", "id"=>"9"}}}, "links"=>{"self"=>"http://example.com/comments/12"}}]}
+document = JSONAPI::Ruby::Deserializer::Document.new(hash)
+```
+
+#### Attributes
+```ruby
+document.data[0].attributes
+# => {"title"=>"JSON:API paints my bikeshed!"}
+
+document.data[0].title
+# => "JSON:API paints my bikeshed!"
+```
+
+#### One-to-one relation
+```ruby
+document.data[0].author.first_name
+# => "Dan"
+```
+
+#### One-to-many relation
+```ruby
+document.data[0].comments[0].body
+# => "First!"
+```
+
+#### Access to relation through another relation
+```ruby
+document.data[0].comments[1].author.first_name
+# => "Dan"
+```
+
+#### Meta
+```ruby
+document.meta.authors
+# => ["James Smith", "Maria Hernandez"]
+```
+
+#### Links
+```ruby
+document.links.self
+# => "http://example.com/articles"
+
+document.data[0].relationships['author'].links.self
+# => "http://example.com/articles/1/relationships/author"
+```
+
+## License
+jsonapi-ruby-deserializer is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/jsonapi-ruby-deserializer.rb

@@ -0,0 +1,7 @@
+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/data.rb

@@ -0,0 +1,19 @@
+# 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/document.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Ruby
+    module Deserializer
+      class Document
+        attr_accessor :data, :included, :meta, :links, :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'])
+          @meta = parse_meta!(document['meta'])
+          @errors = parse_errors!(document['errors'])
+          link_data! if link_data
+        end
+
+        def parse_resource!(data)
+          return if data.nil?
+
+          data.kind_of?(Array) ? data.map! { |h| Resource.new(h) } : Resource.new(data)
+        end
+
+        def parse_links!(data)
+          return if data.nil?
+
+          Links.new(data)
+        end
+
+        def parse_meta!(data)
+          return if data.nil?
+
+          Meta.new(data)
+        end
+
+        def create_index!
+          return if @included.nil?
+
+          {}.tap do |h|
+            @included.each do |resource|
+              resource_identifier = [resource.type, resource.id]
+              h[resource_identifier] = resource
+            end
+          end
+        end
+
+        def parse_errors!(data)
+          return if data.nil?
+
+          data.kind_of?(Array) ? data.map! { |h| Errors.new(h) } : Errors.new(data)
+        end
+
+        def link_data!
+          return if @included.nil?
+
+          (Array(@data) + @included).each do |resource|
+            next if resource.relationships.nil?
+
+            resource.link_data!(@index)
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Ruby
+    module Deserializer
+      module Parser
+        def parse!(data)
+          data.each do |field, value|
+            instance_variable_set("@#{field}", value)
+            self.class.send(:attr_accessor, field.to_sym)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# 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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'jsonapi-ruby-deserializer/parser'
+
+module JSONAPI
+  module Ruby
+    module Deserializer
+      class Resource
+        include JSONAPI::Ruby::Deserializer::Parser
+        attr_accessor :id, :type, :attributes, :relationships, :links
+
+        def initialize(data)
+          @id = data['id']
+          @type = data['type']
+          @attributes = data['attributes']
+          @links = parse_links!(data['links'])
+          parse!(@attributes)
+          parse_relationships!(data['relationships']) if data['relationships']
+        end
+
+        def parse_relationships!(relationships)
+          @relationships = {}
+          (relationships || {}).map do |key, h|
+            @relationships[key] = Relationship.new(h)
+          end
+        end
+
+        def parse_links!(data)
+          return if data.nil?
+
+          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]] }
+          else
+            index[[data.type, data.id]]
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-ruby-deserializer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Grzegorz Płóciniak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Makes work with JSON::API compound documents easy
+email: grzegorzsend@gmail.com
+executables: []
+extensions: []
+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:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: JSON API Ruby deserializer
+test_files: []