jsonapi.rb 1.4.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850595e9b5bf8986638858acb52e4a64f4882dab
-  data.tar.gz: ff03ece83d7e7a167a8ff58014e010d59eeeb224
+  metadata.gz: b3492c86c9c8e6353590ddd3adad00d0e554e440
+  data.tar.gz: e4f87cea9894b17a0da2214c809fafa0fcebf1aa
 SHA512:
-  metadata.gz: d5ab4e7832394a0ba81c95d3995afb1795915629273cfc00a65f573405a98935f943f3b6a0637e7200e0f34f983681b87facf71c48eac28f207a0fe5e3dc2d81
-  data.tar.gz: b70da22e0a92a35333ea9d82ee63ae639c529c8eb751597ab43c0ecfe25ab0956070df89a0930ecce8b62a64a23a889f5db3bb52a6e410ac83e3137682529033
+  metadata.gz: fdf8daac2d2c4a163dd345f4040fc580dae562a32e5e9300a38712fd08e3e58dc0b88ffbbb044e3a2a6eeb5ac10263fa53fd73aeee7763c7abe940d3e9673f9a
+  data.tar.gz: 25d316c614bf7801fd7a5a7b701e285368acd05f8cb0e048c621a720f00752bcf3dfa113ff9d1dfe8c8921b269a556a52a88b7bedc1db81e42300bd901fb3d91

data/.github/main.workflow

@@ -2,9 +2,9 @@ workflow "Tests" {
   on = "push"
   resolves = [
     "rspec-ruby2.3_rails4",
-    "rspec-ruby2.3_rails5",
     "rspec-ruby2.6_rails4",
-    "rspec-ruby2.6_rails5"
+    "rspec-ruby2.6_rails5",
+    "rspec-ruby2.6_rails6"
   ]
 }
 
@@ -12,6 +12,7 @@ action "rspec-ruby2.3_rails4" {
   uses = "docker://ruby:2.3-alpine"
   env = {
     RAILS_VERSION = "~> 4"
+    SQLITE3_VERSION = "~> 1.3.6"
   }
   args = [
     "sh", "-c",
@@ -19,11 +20,12 @@ action "rspec-ruby2.3_rails4" {
   ]
 }
 
-action "rspec-ruby2.3_rails5" {
-  uses = "docker://ruby:2.3-alpine"
+action "rspec-ruby2.6_rails4" {
+  uses = "docker://ruby:2.6-alpine"
   needs = ["rspec-ruby2.3_rails4"]
   env = {
-    RAILS_VERSION = "~> 5"
+    RAILS_VERSION = "~> 4"
+    SQLITE3_VERSION = "~> 1.3.6"
   }
   args = [
     "sh", "-c",
@@ -31,11 +33,11 @@ action "rspec-ruby2.3_rails5" {
   ]
 }
 
-action "rspec-ruby2.6_rails4" {
+action "rspec-ruby2.6_rails5" {
   uses = "docker://ruby:2.6-alpine"
-  needs = ["rspec-ruby2.3_rails5"]
+  needs = ["rspec-ruby2.6_rails4"]
   env = {
-    RAILS_VERSION = "~> 4"
+    RAILS_VERSION = "~> 5"
   }
   args = [
     "sh", "-c",
@@ -43,11 +45,11 @@ action "rspec-ruby2.6_rails4" {
   ]
 }
 
-action "rspec-ruby2.6_rails5" {
+action "rspec-ruby2.6_rails6" {
   uses = "docker://ruby:2.6-alpine"
-  needs = ["rspec-ruby2.6_rails4"]
+  needs = ["rspec-ruby2.6_rails5"]
   env = {
-    RAILS_VERSION = "~> 5"
+    RAILS_VERSION = "~> 6.0.0.rc1"
   }
   args = [
     "sh", "-c",

data/Gemfile

@@ -3,5 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in jsonapi.gemspec
 gemspec
 
-gem 'jsonapi-rspec', github: 'stas/jsonapi-rspec'
-gem 'rails', ENV['RAILS_VERSION']
+gem 'jsonapi-rspec', git: 'https://github.com/stas/jsonapi-rspec.git'

data/Gemfile.lock

@@ -1,5 +1,5 @@
 GIT
-  remote: git://github.com/stas/jsonapi-rspec.git
+  remote: https://github.com/stas/jsonapi-rspec.git
   revision: f223a3d5531cf2c0ce2f90aa8dac2bae46b2d499
   specs:
     jsonapi-rspec (0.0.2)
@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    jsonapi.rb (1.4.5)
+    jsonapi.rb (1.5.0)
       fast_jsonapi (~> 1.5)
       rack
       ransack
@@ -90,9 +90,8 @@ GEM
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
-    parser (2.6.2.1)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    psych (3.1.0)
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -148,16 +147,15 @@ GEM
       rspec-mocks (~> 3.8.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.67.2)
+    rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-performance (1.1.0)
-      rubocop (>= 0.67.0)
+    rubocop-performance (1.2.0)
+      rubocop (>= 0.68.0)
     rubocop-rails_config (0.5.1)
       railties (>= 3.0)
       rubocop (~> 0.60)
@@ -174,7 +172,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
+    sqlite3 (1.4.1)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -201,7 +199,7 @@ DEPENDENCIES
   rubocop-performance
   rubocop-rails_config
   simplecov
-  sqlite3 (~> 1.3.6)
+  sqlite3
   yardstick
 
 BUNDLED WITH

data/README.md

@@ -74,6 +74,7 @@ Or install it yourself as:
  * [Filtering and sorting](#filtering-and-sorting)
    * [Sorting using expressions](#sorting-using-expressions)
  * [Pagination](#pagination)
+ * [Deserialization](#deserialization)
 
 ---
 
@@ -303,8 +304,38 @@ use the `jsonapi_pagination_meta` method:
 
     { pagination: pagination } if pagination.present?
   end
+
+```
+### Deserialization
+
+`JSONAPI::Deserialization` provides a helper to transform a `JSONAPI` document
+into a flat dictionary that can be used to update an `ActiveRecord::Base` model.
+
+Here's an example using the `jsonapi_deserialize` helper:
+
+```ruby
+class MyController < ActionController::Base
+  include JSONAPI::Deserialization
+
+  def update
+    model = MyModel.find(params[:id])
+
+    if model.update(jsonapi_deserialize(only: [:attr1, :rel_one]))
+      render jsonapi: model
+    else
+      render jsonapi_errors: model.errors, status: :unprocessable_entity
+    end
+  end
+end
 ```
 
+The `jsonapi_deserialize` helper accepts the following options:
+
+ * `only`: returns exclusively attributes/relationship data in the provided list
+ * `except`: returns exclusively attributes/relationship which are not in the list
+ * `polymorphic`: will add and detect the `_type` attribute and class to the
+   defined list of polymorphic relationships
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies.

data/Rakefile

@@ -4,6 +4,14 @@ require 'rubocop/rake_task'
 require 'yaml'
 require 'yardstick'
 
+# TODO: Remove once merged...
+#       https://github.com/toshimaru/rubocop-rails_config/pull/43
+require 'rubocop'
+module RuboCop
+  Config::OBSOLETE_COPS = Config::OBSOLETE_COPS.dup
+  Config::OBSOLETE_COPS.delete('Layout/FirstParameterIndentation')
+end
+
 desc('Documentation stats and measurements')
 task('qa:docs') do
   yaml = YAML.load_file(File.expand_path('../.yardstick.yml', __FILE__))

data/jsonapi.rb.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
+  spec.add_development_dependency 'rails', ENV['RAILS_VERSION']
+  spec.add_development_dependency 'sqlite3', ENV['SQLITE3_VERSION']
   spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-rails'

data/lib/jsonapi.rb

@@ -2,6 +2,7 @@ require 'jsonapi/errors'
 require 'jsonapi/fetching'
 require 'jsonapi/filtering'
 require 'jsonapi/pagination'
+require 'jsonapi/deserialization'
 require 'jsonapi/rails'
 require 'jsonapi/version'
 

data/lib/jsonapi/deserialization.rb

@@ -0,0 +1,66 @@
+require 'active_support/inflector'
+
+module JSONAPI
+  # Helpers to transform a JSON API document, containing a single data object,
+  # into a hash that can be used to create an [ActiveRecord::Base] instance.
+  #
+  # Initial version from the `active_model_serializers` support for JSONAPI.
+  module Deserialization
+    private
+
+    # Returns a transformed dictionary following [ActiveRecord::Base] specs
+    #
+    # @param [Hash|ActionController::Parameters] document
+    # @param [Hash] options
+    #   only: Array of symbols of whitelisted fields.
+    #   except: Array of symbols of blacklisted fields.
+    #   polymorphic: Array of symbols of polymorphic fields.
+    # @return [Hash]
+    def jsonapi_deserialize(document, options = {})
+      if document.is_a?(ActionController::Parameters)
+        primary_data = document.dup.require(:data).permit!.as_json
+      elsif document.is_a?(Hash)
+        primary_data = (document.as_json['data'] || {}).deep_dup
+      else
+        return {}
+      end
+
+      # Transform keys and any option values.
+      options = options.as_json
+      ['only', 'except', 'polymorphic'].each do |opt_name|
+        opt_value = options[opt_name]
+        options[opt_name] = Array(opt_value).map(&:to_s) if opt_value
+      end
+
+      relationships = primary_data['relationships'] || {}
+      parsed = primary_data['attributes'] || {}
+      parsed['id'] = primary_data['id'] if primary_data['id']
+
+      # Remove unwanted items from a dictionary.
+      if options['only']
+        [parsed, relationships].map { |hsh| hsh.slice!(*options['only']) }
+      elsif options['except']
+        [parsed, relationships].map { |hsh| hsh.except!(*options['except']) }
+      end
+
+      relationships.map do |assoc_name, assoc_data|
+        assoc_data = (assoc_data || {})['data'] || {}
+        rel_name = ActiveSupport::Inflector.singularize(assoc_name)
+
+        if assoc_data.is_a?(Array)
+          parsed["#{rel_name}_ids"] = assoc_data.map { |ri| ri['id'] }.compact
+          next
+        end
+
+        parsed["#{rel_name}_id"] = assoc_data['id']
+
+        if (options['polymorphic'] || []).include?(assoc_name)
+          rel_type = ActiveSupport::Inflector.classify(assoc_data['type'].to_s)
+          parsed["#{rel_name}_type"] = rel_type
+        end
+      end
+
+      parsed
+    end
+  end
+end

data/lib/jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JSONAPI
-  VERSION = '1.4.5'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi.rb
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Stas Suscov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_jsonapi
@@ -84,16 +84,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +226,7 @@ files:
 - jsonapi.rb.gemspec
 - lib/jsonapi.rb
 - lib/jsonapi/active_model_error_serializer.rb
+- lib/jsonapi/deserialization.rb
 - lib/jsonapi/error_serializer.rb
 - lib/jsonapi/errors.rb
 - lib/jsonapi/fetching.rb