joyful_jsonapi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3023d4ad8aa2d35260a0dc07c0247ade526226a6458336a7c2bbe042c1c9d3fc
-  data.tar.gz: 49580fe090e6559854e28ce2dfe7b61b69339dd8fc111cb4a201585b3fe7b368
+  metadata.gz: 6fb92058dd71bffaec9a8fb8e71670d163b51dfe297020ad7a62354727d7cbf8
+  data.tar.gz: b8b430ddcf6538c78a71fe28d3572a26144caf523e1b1cb96eeee70733a9800e
 SHA512:
-  metadata.gz: 6e37505284fe9bb04c1c5e066f71b385379846e282dbca9f75f62e4062ace40c188401827cbf65cc1105dfb330a7180064c58eeabfee72a24a3d824979700ae2
-  data.tar.gz: 283a2724159ea20606782a78dac8646e89bf0c01d975b6d6f987650d9349218748657f6c2f3417e678aca89e7414e675b18aa3b11c68e0f9b294d1c3ade7cfe5
+  metadata.gz: ebec1d176ec3e436467aa9be6e6021f0a8fe3624ef0848c9c53959c7fafd7bdd2f9c0b169edcbf5db7ed3e0639f3f3628b718cb23a3c431cfb2f15a3d4b0eac4
+  data.tar.gz: f4d808158c19fb325365638f68f6d64c607d72254ffaa0fa6e26a6c6ec0bfda6b9bcf665b4b04b90fa36f718274f8fb6e1c5592e7a4ec8fe64fdc849d3803481

data/README.md

@@ -54,6 +54,7 @@ Fast JSON API serialized 250 records in 3.01 ms
         - [Using ActiveSupport::Concern](#using-activesupportconcern)
         - [Using Plain Old Ruby](#using-plain-old-ruby)
     - [Customizable Options](#customizable-options)
+    - [Parsing Incoming Params](#parsing-incoming-params)
     - [Instrumentation](#instrumentation)
   - [Contributing](#contributing)
     - [Running Tests](#running-tests)
@@ -549,6 +550,34 @@ serializer | Set custom Serializer for a relationship | ```has_many :actors, ser
 polymorphic | Allows different record types for a polymorphic association | ```has_many :targets, polymorphic: true```
 polymorphic | Sets custom record types for each object class in a polymorphic association | ```has_many :targets, polymorphic: { Person => :person, Group => :group }```
 
+### Parsing Incoming Params
+
+It's easy enough to parse incoming JSON:API parameters with regular strong params:
+
+```
+params.require(:data).require(:attributes).permit(:foo, :bar, :baz)
+```
+
+However when you introduce relationships it gets complicated. Joyful JSON:API ships a simple controller macro for turning a jsonapi incoming payload into a rails-friendly one.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include JoyfulJsonapi::ParameterParser
+end
+```
+
+Then in your resource specific controller you can do this:
+
+```ruby
+class FoosController < ApplicationController
+  translate_jsonapi_params only: %w(create update)
+
+  def foo_params
+    params.require(:foo).permit(:bar, :baz)
+  end
+end
+```
+
 ### Instrumentation
 
 `fast_jsonapi` also has builtin [Skylight](https://www.skylight.io/) integration. To enable, add the following to an initializer:

data/lib/joyful_jsonapi.rb

@@ -3,8 +3,11 @@
 module JoyfulJsonapi
   require 'joyful_jsonapi/object_serializer'
   require 'joyful_jsonapi/error_serializer'
+  require 'joyful_jsonapi/parameters'
+
   if defined?(::Rails)
     require 'joyful_jsonapi/railtie'
+    require 'joyful_jsonapi/parameter_parser'
   elsif defined?(::ActiveRecord)
     require 'extensions/has_one'
   end

data/lib/joyful_jsonapi/parameter_parser.rb

@@ -0,0 +1,14 @@
+module JoyfulJsonapi
+  module ParameterParser
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def translate_jsonapi_params(options)
+        before_actions options do
+          @_params = JoyfulJsonapi::Parameters.new(params)
+                                              .to_action_controller_params
+        end
+      end
+    end
+  end
+end

data/lib/joyful_jsonapi/parameters.rb

@@ -0,0 +1,52 @@
+require 'action_controller/metal/strong_parameters'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/string/inflections'
+
+module JoyfulJsonapi
+  class Parameters
+    def initialize(original_params)
+      @jsonapi_params = original_params.to_unsafe_h.with_indifferent_access
+      @rails_params = {_jsonapi_document: @jsonapi_params}.with_indifferent_access
+    end
+
+    def to_action_controller_params
+      populate_root_key
+      extract_attributes
+      extract_relationships
+      finalize
+    end
+
+    private
+
+    def populate_root_key
+      rails_attribute_hash
+    end
+
+    def extract_attributes
+      @jsonapi_params[:data][:attributes].each do |k,v|
+        rails_attribute_hash[k.underscore] = v
+      end
+    end
+
+    def extract_relationships
+      relationship_params = @jsonapi_params[:data][:relationships].dup
+      rails_relationship_hash = {}
+      (relationship_params || {}).each do |name, jsonapi_relationship_object|
+        rails_relationship_hash["#{name.underscore}_id"] = jsonapi_relationship_object[:data][:id]
+      end
+      rails_attribute_hash.merge!(rails_relationship_hash)
+    end
+
+    def rails_attribute_hash
+      @rails_params[type_key] ||= {} 
+    end
+
+    def type_key
+      @type_key ||= @jsonapi_params[:data][:type].singularize.underscore
+    end
+
+    def finalize
+      ActionController::Parameters.new(@rails_params)
+    end
+  end
+end

data/lib/joyful_jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JoyfulJsonapi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: joyful_jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bradley Temple
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +237,8 @@ files:
 - lib/joyful_jsonapi/link.rb
 - lib/joyful_jsonapi/multi_to_json.rb
 - lib/joyful_jsonapi/object_serializer.rb
+- lib/joyful_jsonapi/parameter_parser.rb
+- lib/joyful_jsonapi/parameters.rb
 - lib/joyful_jsonapi/railtie.rb
 - lib/joyful_jsonapi/relationship.rb
 - lib/joyful_jsonapi/serialization_core.rb