jsonapi_parameters 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3245b44f39068e448c0acbf8ad822ebe3891133cfde009c4b6411d3b9a50f1b
-  data.tar.gz: cfc79502f187a3f9453f9b3ba952128e00114a7cc47ea5aaf6047ba5484c49cc
+  metadata.gz: 02a88091cd1b68f0f385e97308b9b5ed213fe640f5f4831d0e83227cbb24fc98
+  data.tar.gz: 56dc70b94dac08359d21703245e1f5a8b7864bf9a0ec4b487b68057121fcac60
 SHA512:
-  metadata.gz: 1f2504172943defbcd2bfbd86eca1134ca2da0193f6f89e0f315ba931372864b545e9005266251982c0e6b167e004a8202a1ca95954837b1b1796e7f4148897b
-  data.tar.gz: f13ad5d8f443e1cd010c133152b50791d876c44b32385d4009318b94e4f29c437d55a02882737bc57237d171e68f8f1802d52976596d13bd0cf60167cc9403ea
+  metadata.gz: b2ec520d45378a5c44c59f6eb37fd2d809e200eb0203d200d3b388a94dbfacfe0dfab9c1578f5ea446aba52de63deeb618e7baf9263c38573ac406cdedadf9bf
+  data.tar.gz: e9a193c2d58b04be662ae0481d9dc1ff451dbd49b44f7d4b18f0698b99c1958e843c66cb8659bf304db8ed649ac996643738dc6041f466ebc15492f2b330d5cf

data/README.md

@@ -1,6 +1,10 @@
 # JsonApi::Parameters
 Simple JSON:API compliant parameters translator.
 
+[![Gem Version](https://badge.fury.io/rb/jsonapi_parameters.svg)](https://badge.fury.io/rb/jsonapi_parameters)
+[![Maintainability](https://api.codeclimate.com/v1/badges/84fd5b548eea8d7e18af/maintainability)](https://codeclimate.com/github/visualitypl/jsonapi_parameters/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/84fd5b548eea8d7e18af/test_coverage)](https://codeclimate.com/github/visualitypl/jsonapi_parameters/test_coverage)
+
 #### The problem
 
 JSON:API standard specifies not only responses (that can be handled nicely, using gems like [fast_jsonapi from Netflix](https://github.com/Netflix/fast_jsonapi)), but also the request structure. 
@@ -60,6 +64,209 @@ def create_params
 end
 ```
 
+#### Relationships
+
+JsonApi::Parameters supports ActiveRecord relationship parameters, including [nested attributes](https://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html).
+
+Relationship parameters are being read from two optional trees:  
+
+* `relationships`,
+* `included`
+
+If you provide any related resources in the `relationships` table, this gem will also look for corresponding, `included` resources and their attributes. Thanks to that this gem supports nested attributes, and will try to translate these included resources and pass them along.
+
+##### belongs_to
+
+Passing a resource that is a single entity in relationships tree will make JsonApi::Parameters assume that it is a `belongs_to` relationship. 
+
+###### Without included entity
+Example:
+
+```
+class Movie < ActiveRecord::Model
+    belongs_to :director
+end
+```
+
+Request body:
+
+```
+{
+    data: {
+        type: 'movies',
+        attributes: {
+          title: 'The Terminator',
+        },
+        relationships: {
+          director: {
+            data: {
+              id: 682, type: 'directors'
+            }
+          }
+        }
+    }
+}
+```
+
+Will translate to:
+
+```
+{
+  movie: {
+    title: 'The Terminator',
+    director_id: 682
+  }
+}
+```
+
+
+###### With included entity:
+Example:
+
+```
+class Movie < ActiveRecord::Model
+    belongs_to :director
+    
+    accepts_nested_attributes_for :director
+end
+```
+
+Request body:
+```
+{
+    data: {
+        type: 'movies',
+        attributes: {
+          title: 'The Terminator',
+        },
+        relationships: {
+          director: {
+            data: {
+              id: 682, type: 'directors'
+            }
+          }
+        }
+    },
+    included: [
+        {
+            type: 'directors',
+            id: 682,
+            attributes: { 
+                name: 'Some guy'
+            }
+        }
+    ]
+}
+```
+
+Will translate to:   
+```
+{
+  movie: {
+    title: 'The Terminator',
+    director_attributes: { id: 682, name: 'Some guy' }
+  }
+}
+```
+
+##### has_many
+
+Passing a resource that is a an array of entities in relationships tree will make JsonApi::Parameters assume that it is a `has_many` relationship. 
+
+###### Without included entity
+Example:
+
+```
+class Movie < ActiveRecord::Model
+    has_many :genres
+end
+```
+
+Request body:
+
+```
+{
+    data: {
+        type: 'movies',
+        attributes: {
+          title: 'The Terminator',
+        },
+        relationships: {
+          genres: [{
+            data: {
+              id: 1, type: 'genres'
+            },
+            data: {
+              id: 2, type: 'genres'
+            },
+          }]
+        }
+    }
+}
+```
+
+Will translate to:
+
+```
+{
+  movie: {
+    title: 'The Terminator',
+    genre_ids: [1, 2]
+  }
+}
+```
+
+
+###### With included entity:
+Example:
+
+```
+class Movie < ActiveRecord::Model
+    has_many :genres
+    
+    accepts_nested_attributes_for :genres
+end
+```
+
+Request body:
+```
+{
+    data: {
+        type: 'movies',
+        attributes: {
+          title: 'The Terminator',
+        },
+        relationships: {
+          genres: [{
+            data: {
+              id: 1, type: 'genres'
+            }
+          }]
+        }
+    },
+    included: [
+        {
+            type: 'genre',
+            id: 1,
+            attributes: { 
+                name: 'Genre one'
+            }
+        }
+    ]
+}
+```
+
+Will translate to:   
+```
+{
+  movie: {
+    title: 'The Terminator',
+    genres_attributes: [{ id: 1, name: 'Genre one' }]
+  }
+}
+```
+
+
 #### Casing
 
 If the input is in a different convention than `:snake`, you should specify that.

data/Rakefile

@@ -15,13 +15,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+task :default => :spec

data/lib/jsonapi_parameters.rb

@@ -2,3 +2,5 @@ require 'jsonapi_parameters/parameters'
 require 'jsonapi_parameters/translator'
 require 'jsonapi_parameters/core_ext'
 require 'jsonapi_parameters/version'
+
+require 'active_support/inflector'

data/lib/jsonapi_parameters/core_ext.rb

@@ -1,2 +1,2 @@
-require_relative 'core_ext/action_controller/parameters'
-require_relative 'core_ext/action_dispatch/http/mime_type'
+require 'jsonapi_parameters/core_ext/action_controller/parameters'
+require 'jsonapi_parameters/core_ext/action_dispatch/http/mime_type'

data/lib/jsonapi_parameters/translator.rb

@@ -1,4 +1,6 @@
 module JsonApi::Parameters
+  include ActiveSupport::Inflector
+
   def jsonapify(params, naming_convention: :snake)
     jsonapi_translate(params, naming_convention: naming_convention)
   end
@@ -60,9 +62,9 @@ module JsonApi::Parameters
   end
 
   def handle_to_many_relation(relationship_key, relationship_value)
-    key = "#{relationship_key.to_s.pluralize}_attributes".to_sym
+    with_inclusion = true
 
-    val = relationship_value.map do |relationship_value|
+    vals = relationship_value.map do |relationship_value|
       related_id = relationship_value.dig(:id)
       related_type = relationship_value.dig(:type)
 
@@ -70,26 +72,46 @@ module JsonApi::Parameters
         related_id: related_id, related_type: related_type
       ) || {}
 
-      included_object.delete(:type)
+      # If at least one related object has not been found in `included` tree,
+      # we should not attempt to "#{relationship_key}_attributes" but
+      # "#{relationship_key}_ids" instead.
+      with_inclusion = with_inclusion ? !included_object.empty? : with_inclusion
+
+      if with_inclusion
+        included_object.delete(:type)
+        included_object[:attributes].merge(id: related_id)
+      else
+        relationship_value.dig(:id)
+      end
+    end
 
-      included_object[:attributes].merge(id: related_id)
+    # We may have smells in our value array as `with_inclusion` may have been changed at some point
+    # but not in the beginning.
+    # Because of that we should clear it and make sure the results are unified (e.g. array of ids)
+    unless with_inclusion
+      vals.map do |val|
+        val.dig(:attributes, :id) if val.is_a?(Hash)
+      end
     end
 
-    [key, val]
+    key = with_inclusion ? "#{pluralize(relationship_key)}_attributes".to_sym : "#{singularize(relationship_key)}_ids".to_sym
+
+    [key, vals]
   end
 
   def handle_to_one_relation(relationship_key, relationship_value)
     related_id = relationship_value.dig(:id)
-    related_type = relationship_key.to_s
+    related_type = relationship_value.dig(:type)
 
     included_object = find_included_object(
       related_id: related_id, related_type: related_type
-    )
+    ) || {}
 
-    return ["#{related_type.singularize}_id".to_sym, related_id] if included_object.nil?
+    return ["#{singularize(relationship_key)}_id".to_sym, related_id] if included_object.empty?
 
     included_object.delete(:type)
-    ["#{related_type.singularize}_attributes".to_sym, included_object]
+    included_object = included_object[:attributes].merge(id: related_id)
+    ["#{singularize(relationship_key)}_attributes".to_sym, included_object]
   end
 
   def find_included_object(related_id:, related_type:)

data/lib/jsonapi_parameters/version.rb

@@ -1,3 +1,5 @@
-module JsonApi::Parameters
-  VERSION = '0.2.0'.freeze
+module JsonApi
+  module Parameters
+    VERSION = '0.3.0'.freeze
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Visuality
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,6 +235,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 description: JsonApi::Parameters allows you to easily translate JSON:API compliant
   parameters to a structure expected by Rails.
 email: