jsonapi_parameters 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6555a67a071e9f66fe99064c4f0db8e102b846506996724885ee020a7c433885
+  data.tar.gz: 49c73fb6120db15c1b92c17e1d5353d38b9e8da51d3baaad77fe4274d06db7e2
+SHA512:
+  metadata.gz: '093733d461f89c9d566b70576bec51132699b3bb6a883fc7a132795a829aea8faeb0831cb18002c122df82d826becedd65e251291954ea1972b8eeeca9a184ac'
+  data.tar.gz: d31cf2eccb58666e87eefb06c3a7537d83bfea06858850aa8ac093dbdf7ec52e782bf904c2f43306a14beef2dfa6931444dddc52e1cd2854e9cae502f6f6d75c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 marahin
+
+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,80 @@
+# JsonApi::Parameters
+Simple JSON:API compliant parameters translator.
+
+#### 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. 
+
+#### The solution
+
+As we couldn't find any gem that would make it easier in Rails to use these structures, we decided to create something that will work for us - a translator that transforms JSON:API compliant request parameter strucure into a Railsy structure.
+
+## Usage
+
+### Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi_parameters'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install jsonapi_parameters
+```
+
+### Rails
+
+Usually your strong parameters in controller are invoked this way:
+
+```ruby
+def create
+  model = Model.new(create_params)
+  
+  if model.save
+    ...
+  else
+    head 500
+  end
+end
+
+private
+
+def create_params
+  params.require(:model).permit(:name)
+end
+```
+
+With jsonapi_parameters, the difference is just the params:
+
+```ruby
+def create_params
+  params.to_jsonapi.require(:model).permit(:name)
+end
+```    
+
+### Plain Ruby / outside Rails
+
+```ruby
+
+params = { # JSON:API compliant parameters here
+	# ...
+}
+
+class Translator
+  include JsonApi::Parameters
+end
+translator = Translator.new
+
+translator.jsonapify(params)
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsonApiParameters'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/jsonapi_parameters.rb

@@ -0,0 +1,4 @@
+require 'jsonapi_parameters/parameters'
+require 'jsonapi_parameters/translator'
+require 'jsonapi_parameters/core_ext'
+require 'jsonapi_parameters/version'

data/lib/jsonapi_parameters/core_ext.rb

@@ -0,0 +1 @@
+require_relative 'core_ext/action_controller/parameters'

data/lib/jsonapi_parameters/core_ext/action_controller/parameters.rb

@@ -0,0 +1,9 @@
+require 'action_controller'
+
+class ActionController::Parameters
+  include JsonApi::Parameters
+
+  def to_jsonapi
+    @to_jsonapi ||= self.class.new jsonapify(self)
+  end
+end

data/lib/jsonapi_parameters/parameters.rb

@@ -0,0 +1,4 @@
+module JsonApi
+  module Parameters
+  end
+end

data/lib/jsonapi_parameters/translator.rb

@@ -0,0 +1,101 @@
+module JsonApi::Parameters
+  def jsonapify(params)
+    jsonapi_translate(params)
+  end
+
+  private
+
+  def jsonapi_translate(params)
+    params = params.to_unsafe_h if params.is_a?(ActionController::Parameters)
+
+    return params if params.nil? || params.empty?
+
+    @jsonapi_unsafe_hash = params.deep_symbolize_keys
+
+    formed_parameters
+  end
+
+  def formed_parameters
+    @formed_parameters ||= {}.tap do |param|
+      param[jsonapi_main_key.to_sym] = jsonapi_main_body
+    end
+  end
+
+  def jsonapi_main_key
+    @jsonapi_unsafe_hash.dig(:data, :type)&.singularize || ''
+  end
+
+  def jsonapi_main_body
+    jsonapi_unsafe_params.tap do |param|
+      jsonapi_relationships.each do |relationship_key, relationship_value|
+        key, val = case relationship_value
+                   when Array
+                     handle_to_many_relation(relationship_key, relationship_value)
+                   when Hash
+                     handle_to_one_relation(relationship_key, relationship_value)
+                   else
+                     raise jsonapi_not_implemented_err
+                   end
+        param[key] = val
+      end
+    end
+  end
+
+  def jsonapi_unsafe_params
+    @jsonapi_unsafe_params ||= @jsonapi_unsafe_hash.dig(:data, :attributes) || {}
+  end
+
+  def jsonapi_included
+    @jsonapi_included ||= @jsonapi_unsafe_hash[:included] || []
+  end
+
+  def jsonapi_relationships
+    @jsonapi_relationships ||= @jsonapi_unsafe_hash.dig(:data, :relationships) || []
+  end
+
+  def handle_to_many_relation(relationship_key, relationship_value)
+    key = "#{relationship_key.to_s.pluralize}_attributes".to_sym
+
+    val = relationship_value.map do |relationship_value|
+      related_id = relationship_value.dig(:data, :id)
+      related_type = relationship_value.dig(:data, :type)
+
+      included_object = find_included_object(
+        related_id: related_id, related_type: related_type
+      ) || {}
+
+      included_object.delete(:type)
+
+      included_object[:attributes].merge(id: related_id)
+    end
+
+    [key, val]
+  end
+
+  def handle_to_one_relation(relationship_key, relationship_value)
+    related_id = relationship_value.dig(:data, :id)
+    related_type = relationship_key.to_s
+
+    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?
+
+    included_object.delete(:type)
+    ["#{related_type.singularize}_attributes".to_sym, included_object]
+  end
+
+  def find_included_object(related_id:, related_type:)
+    jsonapi_included.find do |included_object_enum|
+      included_object_enum[:id] &&
+        included_object_enum[:id] == related_id &&
+        included_object_enum[:type] &&
+        included_object_enum[:type] == related_type
+    end
+  end
+
+  def jsonapi_not_implemented_err
+    NotImplementedError.new('relationship member must either be an Array or a Hash')
+  end
+end

data/lib/jsonapi_parameters/version.rb

@@ -0,0 +1,3 @@
+module JsonApi::Parameters
+  VERSION = '0.0.2'.freeze
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- marahin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+description: JsonApi::Parameters allows you to easily translate JSON:API compliant
+  parameters to a structure expected by Rails.
+email:
+- me@marahin.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/jsonapi_parameters.rb
+- lib/jsonapi_parameters/core_ext.rb
+- lib/jsonapi_parameters/core_ext/action_controller/parameters.rb
+- lib/jsonapi_parameters/parameters.rb
+- lib/jsonapi_parameters/translator.rb
+- lib/jsonapi_parameters/version.rb
+homepage: https://github.com/visualitypl/jsonapi_parameters
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Translator for JSON:API compliant parameters
+test_files: []