request_handler 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 252b6dd26a2f9989d6bb8782a7cfec3c745db91d
-  data.tar.gz: 95efc2b338c327105d3bd1e6836c92848d1d51c8
+  metadata.gz: 1d0758f2d7885ad1d5bc730ab95fbc00428effed
+  data.tar.gz: bc11401b7013aa968bd7d22a4d86b674fedf147f
 SHA512:
-  metadata.gz: 348b442311e1f02780bb6e6207534dd00d23a614d443a384240fb1814853df6f996f59cad3eecd463a88763c732a16f4a1621e95a061068b6d058cebfbc56f65
-  data.tar.gz: 941fd8a4714ff60b793475125b0e74fe2187f669ca603cd2821f8bcbf59fa41191e41a32f3eb9189acbff46ed6bb3f0a4b4c2e6aaa882c50279b189208bd589a
+  metadata.gz: e9d5ab0fd020c635be86bfd6c028768c9c6eb6c9e401be243bb3118c7a4e98f1af7db529cf44d5e41fcd178562c805042cc8a60d96a26ce5554cfcc2004da0d8
+  data.tar.gz: 5273a2cbf95cb99f33d243f174832a9597a27b0280785b0ea39f5a4ee0d6e3fd8bf2478b80b4e170d92658c5d41901e3b78fda8224c2190c7a7c2c6cbda58a91

data/CHANGELOG.md

@@ -3,6 +3,11 @@ Changelog
 
 ## master
 
+## 0.11.0
+
+- Parse `included` array from request body
+- Body no longer accepts a default
+
 ## 0.10.0
 
 - raise an error if mandatory options are missing in the handler configuration

data/README.md

@@ -90,17 +90,17 @@ class DemoHandler < RequestHandler::Base
       options(->(_handler, _request) { { foo: "bar" } })
       # options({foo: "bar"}) # also works for hash options instead of procs
     end
+  end
 
-    def to_dto
-      OpenStruct.new(
-        body:    body_params,
-        page:    page_params,
-        include: include_params,
-        filter:  filter_params,
-        sort:    sort_params,
-        headers: headers
-      )
-    end
+  def to_dto
+    OpenStruct.new(
+      body:    body_params,
+      page:    page_params,
+      include: include_params,
+      filter:  filter_params,
+      sort:    sort_params,
+      headers: headers
+    )
   end
 end
 
@@ -146,6 +146,132 @@ 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'
+    }
+  }
+]
+```
+
 ### Configuration
 
 The default logger and separator can be changed globally by using

data/lib/request_handler/base.rb

@@ -95,12 +95,12 @@ module RequestHandler
     end
 
     def parse_body_params
-      defaults = fetch_defaults('body.defaults', {})
-      defaults.merge(BodyParser.new(
-        request:        request,
-        schema:         lookup!('body.schema'),
-        schema_options: execute_options(lookup('body.options'))
-      ).run)
+      BodyParser.new(
+        request:          request,
+        schema:           lookup!('body.schema'),
+        schema_options:   execute_options(lookup('body.options')),
+        included_schemas: lookup('body.included')
+      ).run
     end
 
     def parse_fieldsets_params

data/lib/request_handler/body_parser.rb

@@ -3,14 +3,21 @@ require 'request_handler/schema_parser'
 require 'request_handler/error'
 module RequestHandler
   class BodyParser < SchemaParser
-    def initialize(request:, schema:, schema_options: {})
+    def initialize(request:, schema:, schema_options: {}, included_schemas: {})
       raise MissingArgumentError, :"request.body" => 'is missing' if request.body.nil?
       super(schema: schema, schema_options: schema_options)
       @request = request
+      @included_schemas = included_schemas
     end
 
     def run
-      validate_schema(flattened_request_body)
+      body, *included = flattened_request_body
+      unless included_schemas?
+        raise SchemaValidationError, included: 'must be empty' unless included.empty?
+        return validate_schema(body)
+      end
+
+      validate_schemas(body, included)
     end
 
     private
@@ -19,10 +26,13 @@ module RequestHandler
       body = request_body.fetch('data') do
         raise ExternalArgumentError, body: 'must contain data'
       end
-      body.merge!(body.delete('attributes') { {} })
-      relationships = flatten_relationship_resource_linkages(body.delete('relationships') { {} })
-      body.merge!(relationships)
-      body
+      [flatten_resource!(body), *parse_included]
+    end
+
+    def flatten_resource!(resource)
+      resource.merge!(resource.delete('attributes') { {} })
+      relationships = flatten_relationship_resource_linkages(resource.delete('relationships') { {} })
+      resource.merge!(relationships)
     end
 
     def flatten_relationship_resource_linkages(relationships)
@@ -33,6 +43,13 @@ module RequestHandler
       end
     end
 
+    def parse_included
+      included = request_body.fetch('included') { [] }
+      included.each do |hsh|
+        flatten_resource!(hsh)
+      end
+    end
+
     def request_body
       b = request.body
       b.rewind
@@ -40,6 +57,20 @@ module RequestHandler
       b.empty? ? {} : MultiJson.load(b)
     end
 
-    attr_reader :request
+    def included_schemas?
+      !(included_schemas.nil? || included_schemas.empty?)
+    end
+
+    def validate_schemas(body, included)
+      schemas = [validate_schema(body)]
+      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 :request, :included_schemas
   end
 end

data/lib/request_handler/schema_parser.rb

@@ -14,14 +14,14 @@ module RequestHandler
 
     private
 
-    def validate_schema(data)
+    def validate_schema(data, with: schema)
       raise MissingArgumentError, data: 'is missing' if data.nil?
-      validator = validate(data)
+      validator = validate(data, schema: with)
       validation_failure?(validator)
       validator.output
     end
 
-    def validate(data)
+    def validate(data, schema:)
       if schema_options.empty?
         schema.call(data)
       else

data/lib/request_handler/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Andreas Eger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation