jsonapi-bulk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99657970e729e534670d205a76a073dea51bd81c
+  data.tar.gz: 1b5b9edccfc7b1d1cfff3bbe52881a5aaca5ac1f
+SHA512:
+  metadata.gz: a7619c81136090d829a4875a5d61d8703b92ecafc577cd3e2308e32e11bd81dbf67bc59c52eea4cdde183b7ed526dc6414bb908880957d5fbda2589551c55238
+  data.tar.gz: 40f24fb8c5eab96553ab58bb65d0ebad8561b8a4700cc171b1f01fee392345d7beeb44626364bf2c62b6bcb6cdef94ecfe650d29539d87027184b1739c92e360

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Hypemarks Inc.
+
+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 @@
+# jsonapi-bulk

data/lib/jsonapi/bulk/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+
+module JSONAPI
+  module Bulk
+    # @private
+    class Railtie < ::Rails::Railtie
+      initializer 'jsonapi-bulk.init' do |app|
+        ActiveSupport.on_load(:action_controller) do
+          require 'jsonapi/rails/controller/bulk_deserialization'
+          include ::JSONAPI::Rails::Controller::BulkDeserialization
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/bulk/version.rb

@@ -0,0 +1,5 @@
+module JSONAPI
+  module Bulk
+    VERSION = '0.1.0'
+  end
+end

data/lib/jsonapi/bulk.rb

@@ -0,0 +1,6 @@
+require 'jsonapi/bulk/railtie'
+
+module JSONAPI
+  module Bulk
+  end
+end

data/lib/jsonapi/parser/bulk.rb

@@ -0,0 +1,22 @@
+require 'jsonapi/parser/document'
+
+module JSONAPI
+  module Parser
+    class Bulk
+      # Validate the structure of a bulk resource create/update payload.
+      #
+      # @param [Hash] document The input JSONAPI document.
+      # @raise [JSONAPI::Parser::InvalidDocument] if document is invalid.
+      def self.parse!(document)
+        Document.ensure!(document.is_a?(Hash),
+                         'A JSON object MUST be at the root of every JSONAPI ' \
+                         'request and response containing data.')
+        Document.ensure!(document.keys == ['data'].freeze &&
+                         document['data'].is_a?(Array),
+                         'The request MUST include an array of resource objects ' \
+                         'as primary data.')
+        document['data'].each { |data| Document.parse_primary_resource!(data) }
+      end
+    end
+  end
+end

data/lib/jsonapi/rails/controller/bulk_deserialization.rb

@@ -0,0 +1,50 @@
+require 'jsonapi/parser'
+require 'jsonapi/parser/bulk'
+require 'jsonapi/rails/deserializable_resource'
+require 'jsonapi/rails/controller/deserialization'
+
+module JSONAPI
+  module Rails
+    module Controller
+      module BulkDeserialization
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def deserializable_resource(key, options = {}, &block)
+            options = options.dup
+            klass = options.delete(:class) ||
+                    Class.new(JSONAPI::Rails::DeserializableResource, &block)
+            bulk = options.delete(:bulk) || false
+
+            before_action(options) do |controller|
+              hash = controller.params.to_unsafe_hash.with_indifferent_access[:_jsonapi]
+              if hash.nil?
+                JSONAPI::Rails.logger.warn do
+                  "Unable to deserialize #{key} because no JSON API payload was" \
+                  " found. (#{controller.controller_name}##{params[:action]})"
+                end
+                next
+              end
+
+              ActiveSupport::Notifications
+                .instrument('parse.jsonapi-rails',
+                            key: key, payload: hash, class: klass) do
+                if bulk && controller.request.headers['Content-Type'] =~ /;\s?ext=bulk\b/
+                  JSONAPI::Parser::Bulk.parse!(hash)
+                  resources = hash[:data].map { |data| klass.new(data) }
+                  controller.request.env[JSONAPI::Rails::Controller::Deserialization::JSONAPI_POINTERS_KEY] = resources.first.reverse_mapping
+                  controller.params[key.to_sym] = resources.map(&:to_hash)
+                else
+                  JSONAPI::Parser::Resource.parse!(hash)
+                  resource = klass.new(hash[:data])
+                  controller.request.env[JSONAPI::Rails::Controller::Deserialization::JSONAPI_POINTERS_KEY] = resource.reverse_mapping
+                  controller.params[key.to_sym] = resource.to_hash
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-bulk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francois Deschenes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: jsonapi-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ''
+email:
+- fdeschenes@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jsonapi/bulk.rb
+- lib/jsonapi/bulk/railtie.rb
+- lib/jsonapi/bulk/version.rb
+- lib/jsonapi/parser/bulk.rb
+- lib/jsonapi/rails/controller/bulk_deserialization.rb
+homepage: https://github.com/hypemarks/jsonapi-bulk
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []