request_handler 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6cf97cca0464ee4cd04d685441600aadfa55197
-  data.tar.gz: dde5d38dac0cf15bb3103a78862219d0fcc26925
+  metadata.gz: f080519adc7f75f22de23333a3a0056538422d09
+  data.tar.gz: 12e57d56a1b7e384e76e868805db60fb1ec65771
 SHA512:
-  metadata.gz: 9d0f9d84f1864af7c3ba99ae27d225ba3fcb6afc8e35c447916e5ef9d84eb7438cc861295429fd715f7667f5fc5689c27d4923b1c8cb185a12d53eea7f7fce11
-  data.tar.gz: afdf18bfb0c580d0a63a4053a6717a5d78cd69f154e9d93de058e190461a6707d31c62abd30e8b6d84116a96b7b0d2dc3f172581581d74d9b039e03eeaa6894e
+  metadata.gz: d67dd542766a8792ab0c084c3d7f24a6867e7811497e3452378a31af61d6ecb502abc335bd135bbf368a0188e305c23f15b108f4916f658e5b8975554fd492f0
+  data.tar.gz: 18f1534788d306a99eeff74365bc5e779b09e2a40d827826fe171ac4e1e4487c1a623e1ae8de4a22b530ffc19db1cb2564a44c109f8504c6a49078fbd3ee0067

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.2.7
   - 2.3.4
   - 2.4.1
-  - jruby-9.1.8.0
+  - jruby-9.1.12.0
 jdk:
   - oraclejdk8
 env:
@@ -22,11 +22,11 @@ matrix:
       jdk: oraclejdk8
       env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
   allow_failures:
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       jdk: oraclejdk8
       env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
 before_install:
   - gem update --system
-  - gem install bundler -v 1.14.6
+  - gem install bundler -v 1.15.1
 before_script:
   - bundle exec danger

data/CHANGELOG.md

@@ -3,6 +3,11 @@ Changelog
 
 ## master
 
+## 0.13.0
+
+- sidecar resources for multipart requests can be labeled with required
+- **remove** support for sidepushing via `included` array in request body.
+
 ## 0.12.0
 
 - support for multipart-requests

data/README.md

@@ -146,136 +146,11 @@ include_options = [:posts__comments]
 sort_options = SortOption.new(:posts__published_on, :asc)
 ```
 
-### Included relations
-
-Sometimes you want to create a single resource with its relations in a single
-request, ensuring that everything or nothing at all is created.  However, the
-current JSON API specification does not mention anything about how to achieve
-this at all, it is expected that all associated resources already exist.  
-`request_handler` attempts to solve this problem by allowing the request body
-to contain an `included` array with all the resources that have to be created.
-
-#### Example
-
-With this request handler:
-
-```ruby
-class CreateQuestionHandler < RequestHandler::Base
-  options do
-    body do
-      schema(
-        Dry::Validation.JSON do
-          required(:id).filled(:str?)
-          required(:type).filled(:str?)
-          required(:content).filled(:str?)
-
-          optional(:media).schema do
-            required(:id).filled(:str?)
-            required(:type).filled(:str?)
-          end
-        end
-      )
-
-      included do
-        media(
-          Dry::Validation.JSON do
-            required(:id).filled(:str?)
-            required(:type).filled(:str?)
-            required(:url).filled(:str?)
-
-            optional(:categories).schema do
-              required(:id).filled(:str?)
-              required(:type).filled(:str?)
-            end
-          end
-        )
-      end
-    end
-  end
-
-  def to_dto
-    # see the resulting body_params below
-    { body: body_params }
-  end
-end
-```
-
-The following JSON object including its included items is validated with the
-defined schema:
-
-``` json
-{
-  "data": {
-    "id": "1",
-    "type": "questions",
-    "attributes": {
-      "content": "How much is the fish?"
-    },
-    "relationships": {
-      "media": {
-          "data": {
-            "id": "image-123456",
-            "type": "media"
-          }
-        }
-      }
-    }
-  },
-  "included": [
-    {
-      "id": "image-123456",
-      "type": "media",
-      "attributes": {
-        "url": "https://example.com/fish.jpg"
-      },
-      "relationships": {
-        "categories": {
-          "data": {
-            "id": "123",
-            "type": "categories"
-          }
-        }
-      }
-    }
-  ]
-}
-```
-
-The resulting `body_params` will be this:
-
-``` ruby
-[
-  # The first object is the main resource object, i.e. the one that is about to
-  # be created
-  {
-    id:      '1',
-    type:    'questions',
-    content: 'How much is the fish?'
-    media:   [
-      {
-        id:   'image-123456',
-        type: 'media'
-      }
-    ]
-  },
-  # The remaining objects are every included object, validated with the schema
-  # defined above
-  {
-    id:         'image-123456',
-    type:       'media',
-    url:        'https://example.com/fish.jpg',
-    categories: {
-      id:   '123',
-      type: 'categories'
-    }
-  }
-]
-```
-
 ### Multipart requests
 It is also possible to process and validate multipart requests, consisting of an arbitrary number of parts.
+You can require specific resources, all the other listed resources are optional
 
-The following request handler accepts a question (which will be uploaded as a json-file) and an additional 
+The following request handler requires a question (which will be uploaded as a json-file) and accepts an additional 
 file related to the question
 
 ```ruby
@@ -283,6 +158,7 @@ class CreateQuestionHandler < RequestHandler::Base
   options do
     multipart do
       question do
+        required true
         schema(
           Dry::Validation.JSON do
             required(:id).filled(:str?)

data/lib/request_handler/base.rb

@@ -104,8 +104,7 @@ module RequestHandler
       BodyParser.new(
         request:          request,
         schema:           lookup!('body.schema'),
-        schema_options:   execute_options(lookup('body.options')),
-        included_schemas: lookup('body.included')
+        schema_options:   execute_options(lookup('body.options'))
       ).run
     end
 

data/lib/request_handler/body_parser.rb

@@ -5,20 +5,18 @@ require 'request_handler/error'
 require 'request_handler/json_api_document_parser'
 module RequestHandler
   class BodyParser
-    def initialize(request:, schema:, schema_options: {}, included_schemas: {})
+    def initialize(request:, schema:, schema_options: {})
       raise MissingArgumentError, "request.body": 'is missing' if request.body.nil?
       @request = request
       @schema = schema
       @schema_options = schema_options
-      @included_schemas = included_schemas
     end
 
     def run
       JsonApiDocumentParser.new(
         document: request_body,
         schema: schema,
-        schema_options: schema_options,
-        included_schemas: included_schemas
+        schema_options: schema_options
       ).run
     end
 
@@ -31,6 +29,6 @@ module RequestHandler
       b.empty? ? {} : MultiJson.load(b)
     end
 
-    attr_reader :request, :schema, :schema_options, :included_schemas
+    attr_reader :request, :schema, :schema_options
   end
 end

data/lib/request_handler/json_api_document_parser.rb

@@ -4,21 +4,15 @@ require 'request_handler/schema_parser'
 require 'request_handler/error'
 module RequestHandler
   class JsonApiDocumentParser < SchemaParser
-    def initialize(document:, schema:, schema_options: {}, included_schemas: {})
+    def initialize(document:, schema:, schema_options: {})
       raise MissingArgumentError, "data": 'is missing' if document.nil?
       super(schema: schema, schema_options: schema_options)
       @document = document
-      @included_schemas = included_schemas
     end
 
     def run
-      resource, *included = flattened_document
-      unless included_schemas?
-        raise SchemaValidationError, included: 'must be empty' unless included.empty?
-        return validate_schema(resource)
-      end
-
-      validate_schemas(resource, included)
+      resource = flattened_document
+      validate_schema(resource)
     end
 
     private
@@ -27,7 +21,7 @@ module RequestHandler
       resource = document.fetch('data') do
         raise BodyParamsError, resource: 'must contain data'
       end
-      [flatten_resource!(resource), *parse_included]
+      flatten_resource!(resource)
     end
 
     def flatten_resource!(resource)
@@ -44,27 +38,6 @@ module RequestHandler
       end
     end
 
-    def parse_included
-      included = document.fetch('included') { [] }
-      included.each do |hsh|
-        flatten_resource!(hsh)
-      end
-    end
-
-    def included_schemas?
-      !(included_schemas.nil? || included_schemas.empty?)
-    end
-
-    def validate_schemas(resource, included)
-      schemas = [validate_schema(resource)]
-      included_schemas.each do |type, schema|
-        included.select { |inc| inc['type'] == type.to_s }.each do |inc|
-          schemas << validate_schema(inc, with: schema)
-        end
-      end
-      schemas
-    end
-
-    attr_reader :document, :included_schemas
+    attr_reader :document
   end
 end

data/lib/request_handler/multipart_parser.rb

@@ -16,20 +16,21 @@ module RequestHandler
     end
 
     def run
-      multipart_config.keys.each_with_object({}) do |name, memo|
-        params.fetch(name.to_s) { raise MultipartParamsError, multipart: 'missing' }
-        memo[name] = parse_part(name)
+      multipart_config.each_with_object({}) do |(name, config), memo|
+        raise MultipartParamsError, multipart: "#{name} missing" if config[:required] && !params.key?(name.to_s)
+        next if params[name.to_s].nil?
+        memo[name] = parse_part(name.to_s)
       end
     end
 
     private
 
     def parse_part(name)
-      params[name.to_s].fetch(:tempfile) { raise MultipartParamsError, multipart_file: 'missing' }
+      params[name].fetch(:tempfile) { raise MultipartParamsError, multipart_file: 'missing' }
       if lookup("#{name}.schema")
         parse_data(name)
       else
-        params[name.to_s]
+        params[name]
       end
     end
 
@@ -37,19 +38,21 @@ module RequestHandler
       JsonApiDocumentParser.new(
         document:         load_json(name),
         schema:           lookup("#{name}.schema"),
-        schema_options:   execute_options(lookup("#{name}.options")),
-        included_schemas: lookup("#{name}.included")
+        schema_options:   execute_options(lookup("#{name}.options"))
       ).run
     end
 
     def load_json(name)
-      MultiJson.load(multipart_file(name).read)
+      file = multipart_file(name)
+      file.rewind
+      file = file.read
+      MultiJson.load(file)
     rescue MultiJson::ParseError
-      raise MultipartParamsError, multipart_file: 'invalid'
+      raise MultipartParamsError, multipart_file: 'invalid JSON'
     end
 
     def multipart_file(name)
-      params[name.to_s][:tempfile]
+      params[name][:tempfile]
     end
 
     def lookup(key)

data/lib/request_handler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequestHandler
-  VERSION = '0.12.0'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/request_handler.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-validation', '~> 0.10.4'
+  spec.add_dependency 'dry-validation', '~> 0.11.0'
+  spec.add_dependency 'dry-types', '~> 0.11.0'
+
   spec.add_dependency 'confstruct', '~> 1.0.2'
   spec.add_dependency 'multi_json', '~> 1.12'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Andreas Eger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -17,14 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: confstruct
   requirement: !ruby/object:Gem::Requirement
@@ -281,7 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: shared base for request_handler using dry-* gems