json_api_deserializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ea4c75b7feec885eccd2c1da4e893343432652c118dd9e0a54aa17661fe91a0
+  data.tar.gz: 5e7b2fb6b6ad99e3fa4743fd8a37a0b42f3356d40e0de95558a12dfdec44d896
+SHA512:
+  metadata.gz: 3e13c55af8ea36b8920e03d45a39181a8cc632ca6bfdb8be93f887240e1c0fdecc6624ab9db08d157845cf4220afa836dd0b9d53095fae46133861d61b78faee
+  data.tar.gz: ce696c38d23044bbb687456e2bea57dabda40971ed41fbb7666d6b395cddcada0b4ad30088c3ab6a4e68d2f691de57d5ff5837f0de000166e09fe025ee7477b8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in json_api_deserializer.gemspec
+
+group :development do
+  gem 'pry'
+  gem 'rubocop'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    json_api_deserializer (0.1.0)
+      activesupport
+      case_transform
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    case_transform (0.2)
+      activesupport
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    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.3)
+      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)
+    rubocop (0.69.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  json_api_deserializer!
+  pry
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nick Palaniuk
+
+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,59 @@
+# Json Api Deserializer
+
+> This is the deserializer code from [ActiveModelSerializers](https://github.com/rails-api/active_model_serializers) for the JSON API spec
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_deserializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_deserializer
+
+## API
+
+`JsonApiDeserializer.parse({}, [options])`
+
+options = `:only, :except, :keys, :polymorphic`
+
+## Usage
+
+```ruby
+JsonApiDeserializer.parse({
+  'data' => {
+    'type' => 'photos',
+    'id' => 'zorglub',
+    'attributes' => {
+      'title' => 'Ember Hamster',
+      'src' => 'http://example.com/images/productivity.png'
+    }
+  })
+
+=> { title: 'Ember Hamster', src: 'http://example.com/images/productivity.png' }
+```
+
+```ruby
+JsonApiDeserializer.parse({
+  'data' => {
+    'type' => 'photos',
+    'id' => 'zorglub',
+    'attributes' => {
+      'title' => 'Ember Hamster',
+      'src' => 'http://example.com/images/productivity.png'
+    }
+  }, only: [:title])
+
+=> { title: 'Ember Hamster' }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nikkypx/json_api_deserializer

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_deserializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_api_deserializer.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_api_deserializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_api_deserializer"
+  spec.version       = JsonApiDeserializer::VERSION
+  spec.authors       = ["Nicholas Palaniuk"]
+  spec.email         = ["npalaniuk+github@gmail.com"]
+
+  spec.summary       = %q{Deserializer for JSON API spec}
+  spec.description   = %q{Deserializer for JSON API spec}
+  spec.homepage      = "https://github.com/nikkypx/json_api_deserializer"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "case_transform"
+  spec.add_dependency "activesupport"
+end

data/lib/json_api_deserializer.rb

@@ -0,0 +1,208 @@
+require 'json_api_deserializer/version'
+require 'active_support/all'
+require 'case_transform'
+
+module JsonApiDeserializer
+  InvalidDocument = Class.new(ArgumentError)
+
+  module_function
+
+  # Transform a JSON API document, containing a single data object,
+  # into a hash that is ready for ActiveRecord::Base.new() and such.
+  # Raises InvalidDocument if the payload is not properly formatted.
+  #
+  # @param [Hash|ActionController::Parameters] document
+  # @param [Hash] options
+  #   only: Array of symbols of whitelisted fields.
+  #   except: Array of symbols of blacklisted fields.
+  #   keys: Hash of translated keys (e.g. :author => :user).
+  #   polymorphic: Array of symbols of polymorphic fields.
+  # @return [Hash]
+  #
+  # @example
+  #   document = {
+  #     data: {
+  #       id: 1,
+  #       type: 'post',
+  #       attributes: {
+  #         title: 'Title 1',
+  #         date: '2015-12-20'
+  #       },
+  #       associations: {
+  #         author: {
+  #           data: {
+  #             type: 'user',
+  #             id: 2
+  #           }
+  #         },
+  #         second_author: {
+  #           data: nil
+  #         },
+  #         comments: {
+  #           data: [{
+  #             type: 'comment',
+  #             id: 3
+  #           },{
+  #             type: 'comment',
+  #             id: 4
+  #           }]
+  #         }
+  #       }
+  #     }
+  #   }
+  #
+  #   parse(document) #=>
+  #     # {
+  #     #   title: 'Title 1',
+  #     #   date: '2015-12-20',
+  #     #   author_id: 2,
+  #     #   second_author_id: nil
+  #     #   comment_ids: [3, 4]
+  #     # }
+  #
+  #   parse(document, only: [:title, :date, :author],
+  #                   keys: { date: :published_at },
+  #                   polymorphic: [:author]) #=>
+  #     # {
+  #     #   title: 'Title 1',
+  #     #   published_at: '2015-12-20',
+  #     #   author_id: '2',
+  #     #   author_type: 'people'
+  #     # }
+  #
+  def parse!(document, options = {})
+    parse(document, options) do |invalid_payload, reason|
+      fail InvalidDocument, "Invalid payload (#{reason}): #{invalid_payload}"
+    end
+  end
+
+  # Same as parse!, but returns an empty hash instead of raising InvalidDocument
+  # on invalid payloads.
+  def parse(document, options = {})
+    # document = document.dup.permit!.to_h if document.is_a?(ActionController::Parameters)
+
+    validate_payload(document) do |invalid_document, reason|
+      yield invalid_document, reason if block_given?
+      return {}
+    end
+
+    primary_data = document['data']
+    attributes = primary_data['attributes'] || {}
+    attributes['id'] = primary_data['id'] if primary_data['id']
+    relationships = primary_data['relationships'] || {}
+
+    filter_fields(attributes, options)
+    filter_fields(relationships, options)
+
+    hash = {}
+    hash.merge!(parse_attributes(attributes, options))
+    hash.merge!(parse_relationships(relationships, options))
+
+    hash
+  end
+
+  # Checks whether a payload is compliant with the JSON API spec.
+  #
+  # @api private
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def validate_payload(payload)
+    unless payload.is_a?(Hash)
+      yield payload, 'Expected hash'
+      return
+    end
+
+    primary_data = payload['data']
+    unless primary_data.is_a?(Hash)
+      yield payload, { data: 'Expected hash' }
+      return
+    end
+
+    attributes = primary_data['attributes'] || {}
+    unless attributes.is_a?(Hash)
+      yield payload, { data: { attributes: 'Expected hash or nil' } }
+      return
+    end
+
+    relationships = primary_data['relationships'] || {}
+    unless relationships.is_a?(Hash)
+      yield payload, { data: { relationships: 'Expected hash or nil' } }
+      return
+    end
+
+    relationships.each do |(key, value)|
+      unless value.is_a?(Hash) && value.key?('data')
+        yield payload, { data: { relationships: { key => 'Expected hash with :data key' } } }
+      end
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+
+  # @api private
+  def filter_fields(fields, options)
+    if (only = options[:only])
+      fields.slice!(*Array(only).map(&:to_s))
+    elsif (except = options[:except])
+      fields.except!(*Array(except).map(&:to_s))
+    end
+  end
+
+  # @api private
+  def field_key(field, options)
+    (options[:keys] || {}).fetch(field.to_sym, field).to_sym
+  end
+
+  # @api private
+  def parse_attributes(attributes, options)
+    transform_keys(attributes, options)
+      .map { |(k, v)| { field_key(k, options) => v } }
+      .reduce({}, :merge)
+  end
+
+  # Given an association name, and a relationship data attribute, build a hash
+  # mapping the corresponding ActiveRecord attribute to the corresponding value.
+  #
+  # @example
+  #   parse_relationship(:comments, [{ 'id' => '1', 'type' => 'comments' },
+  #                                  { 'id' => '2', 'type' => 'comments' }],
+  #                                 {})
+  #    # => { :comment_ids => ['1', '2'] }
+  #   parse_relationship(:author, { 'id' => '1', 'type' => 'users' }, {})
+  #    # => { :author_id => '1' }
+  #   parse_relationship(:author, nil, {})
+  #    # => { :author_id => nil }
+  # @param [Symbol] assoc_name
+  # @param [Hash] assoc_data
+  # @param [Hash] options
+  # @return [Hash{Symbol, Object}]
+  #
+  # @api private
+  def parse_relationship(assoc_name, assoc_data, options)
+    prefix_key = field_key(assoc_name, options).to_s.singularize
+    hash =
+      if assoc_data.is_a?(Array)
+        { "#{prefix_key}_ids".to_sym => assoc_data.map { |ri| ri['id'] } }
+      else
+        { "#{prefix_key}_id".to_sym => assoc_data ? assoc_data['id'] : nil }
+      end
+
+    polymorphic = (options[:polymorphic] || []).include?(assoc_name.to_sym)
+    if polymorphic
+      hash["#{prefix_key}_type".to_sym] = assoc_data.present? ? assoc_data['type'].classify : nil
+    end
+
+    hash
+  end
+
+  # @api private
+  def parse_relationships(relationships, options)
+    transform_keys(relationships, options)
+      .map { |(k, v)| parse_relationship(k, v['data'], options) }
+      .reduce({}, :merge)
+  end
+
+  # @api private
+  def transform_keys(hash, options)
+    transform = options[:key_transform] || :underscore
+    CaseTransform.send(transform, hash)
+  end
+end

data/lib/json_api_deserializer/version.rb

@@ -0,0 +1,3 @@
+module JsonApiDeserializer
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: json_api_deserializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Palaniuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: case_transform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deserializer for JSON API spec
+email:
+- npalaniuk+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_api_deserializer.gemspec
+- lib/json_api_deserializer.rb
+- lib/json_api_deserializer/version.rb
+homepage: https://github.com/nikkypx/json_api_deserializer
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Deserializer for JSON API spec
+test_files: []