request_handler 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20f2c124b0691c7cbff62564b2321b72540198c2
-  data.tar.gz: e74b4037669ef74419b45aeb90ce128be13b6103
+SHA256:
+  metadata.gz: 3ec28a9872f4f531acc1942ec45f37aecb057f2857cf50aa26dede690625c13f
+  data.tar.gz: b2c4c2c0131ab55a364265ded644e0151d338e2a2f505d8dd68e9ea35f16a753
 SHA512:
-  metadata.gz: 4ab799a4c910ce2363459e7c13d456f506afd10d9e826a83f49ee34ba9a0f8ec1e8162a0779369a1df0d6b3ae253b9bbc517805a5c533ffcc1d9081578223828
-  data.tar.gz: c2d187403ca7c3f394d685f6ed8999a08d2a17bab13942d8badf9295bca9a2dfd05f7b5d5421943e3a397d5a40a29e60dcd5723c9911ff3b8cf7a79febe4d931
+  metadata.gz: 7fe42bb5f624fa531353554ce192e6577299eabec6d66ef465adb6efc995869568173b075c40498fca292d9e248776dd8a3b4bfdc8939e741f9e2a3d1af96160
+  data.tar.gz: 0a87c3d8751372650e5ef31f9fd5bdd1421f0472e623f28f1316e8255c88d4e6b06aef2732b54deb7f3f3ce7ca254fffca979a445f265becaf03913710e151c1

data/.travis.yml

@@ -1,10 +1,12 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-  - jruby-9.1.12.0
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - jruby-9.1.17.0
+  - jruby-9.2.0.0
 jdk:
   - oraclejdk8
 env:
@@ -12,21 +14,27 @@ env:
   - "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
 matrix:
   exclude:
-    - rvm: 2.2.7
+    - rvm: 2.2.10
       jdk: oraclejdk8
       env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-    - rvm: 2.3.4
+    - rvm: 2.3.7
       jdk: oraclejdk8
       env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-    - rvm: 2.4.1
+    - rvm: 2.4.4
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+    - rvm: 2.5.1
       jdk: oraclejdk8
       env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
   allow_failures:
-    - rvm: jruby-9.1.12.0
+    - rvm: jruby-9.1.17.0
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+    - rvm: jruby-9.2.0.0
       jdk: oraclejdk8
       env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
 before_install:
   - gem update --system
-  - gem install bundler -v 1.15.1
+  - gem install bundler -v 1.16.2
 before_script:
   - bundle exec danger

data/CHANGELOG.md

@@ -1,18 +1,28 @@
-Changelog
-===
+# Changelog
+All notable changes to this project will be documented in this file.
 
-## master
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 0.14.0
+## [Unreleased]
+
+## [0.15.0] - 2018-06-20
+### Added
+- JsonParser for non-jsonapi documents in body an multipart files
+
+### Changed
+- changelog format (previous logs kept mostly the same)
+
+## [0.14.0] - 2017-09-11
 
 - support generic query params
 
-## 0.13.0
+## [0.13.0] - 2017-07-28
 
 - sidecar resources for multipart requests can be labeled with required
 - **remove** support for sidepushing via `included` array in request body.
 
-## 0.12.0
+## [0.12.0] - 2017-05-19
 
 - support for multipart-requests
 - update rubocop and fix danger check
@@ -21,65 +31,67 @@ Changelog
 - no need for 'required' field in fieldsets_parser anymore
 - throw different errors for each parser, all new errors inherit from ExternalArgumentError
 
-## 0.11.0
+## [0.11.0] - 2017-03-17
 
-- Parse `included` array from request body
-- Body no longer accepts a default
+- parse `included` array from request body
+- body no longer accepts a default
 
-## 0.10.0
+## [0.10.0] - 2017-02-16
 
 - raise an error if mandatory options are missing in the handler configuration
-- Transform param keys to string before substitution
+- transform param keys to string before substitution
 - make gem compatible with ruby 2.1
 - add danger
 - raise an ExternalArgumentError if the body does not contain data
 
-## 0.9.1
+## [0.9.1] - 2017-01-31
 
 - fix configure method
 
-## 0.9.0
+## [0.9.0] - 2017-01-31
 
 - change nesting separator from `_` to `__` and use it consistently (also in sorting fields)
 - make separator configurable
 
 
-## 0.8.0
+## [0.8.0] - 2017-01-10
+
 - rename gem (dry-request_handler --> request_handler)
 - remove env based config for logger
 
-## 0.7.1
+## [0.7.1] - 2017-01-04
 
 - fix usage of struct to be unambiguous if dry-struct is used
 
-## 0.7
+## [0.7.0] - 2017-01-03
 
 - fix error message building
 - sort_params returns an array of SortOption structs now
 - general `headers` method for all headers (removes `authorization_headers` method)
 - sort and include options will use only the values from the request if they exist and the defaults if there are no values set in the request
 
-## 0.6
+## [0.6.0] - 2016-12-14
 
 - support for fieldsets
 
-## 0.5
+## [0.5.0] - 2016-11-29
 
 - `default_size` is now mandatory
 - `default_size` and `max_size` now must be Integers
 
-## 0.4
+## [0.4.0] - 2016-11-16
 
 fix error messages to also work with nested error messages
 
-## 0.3
+## [0.3.0] - 2016-11-08
 
 sort_params returns an array of dtos now `DataTransferObject.new(field: "test", directions: :asc)`
 
-## 0.2
+## [0.2.1] - 2016-11-02
 
 version bump for publishing
 
-## 0.1
-
-Initial Gem
+[Unreleased]: https://github.com/runtastic/request_handler/compare/v0.15.0...HEAD
+[0.15.0]: https://github.com/runtastic/request_handler/compare/v0.14.0...v0.15.0
+[0.14.0]: https://github.com/runtastic/request_handler/compare/v0.13.0...v0.14.0
+[0.13.0]: https://github.com/runtastic/request_handler/compare/v0.12.0...v0.13.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Runtastic
+Copyright (c) 2018 runtastic GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -43,7 +43,15 @@ server (at least an empty configuration block int the page block), other options
 sent by the client are ignored and will cause a warning.
 
 Generic query params can be added by using the `query` block. This may be useful
-if parameters should be validated which cannot be assigned to other predefined option blocks.
+if parameters should be validated which cannot be assigned to other predefined
+option blocks.
+
+A `type` param can be passed in the `body` block, or the `resource` block in
+[multipart requests](#multipart-requests) (like `question` in the example below).
+You can pass either a symbol or a string.
+At the moment there are only "jsonapi" and "json" available for `type`. This
+defines if the JsonApiDocumentParser or JsonParser is used.
+If nothing is defined, JsonApiDocumentParser will be used by default.
 
 ```ruby
 require "dry-validation"
@@ -90,6 +98,7 @@ class DemoHandler < RequestHandler::Base
     end
 
     body do
+      type :jsonapi
       schema(
         Dry::Validation.JSON do
           configure do
@@ -161,7 +170,7 @@ sort_options = SortOption.new(:posts__published_on, :asc)
 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 requires a question (which will be uploaded as a json-file) and accepts 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
@@ -170,15 +179,16 @@ class CreateQuestionHandler < RequestHandler::Base
     multipart do
       question do
         required true
+        type "json"
         schema(
           Dry::Validation.JSON do
             required(:id).filled(:str?)
             required(:type).filled(:str?)
-            required(:content).filled(:str?) 
+            required(:content).filled(:str?)
           end
         )
       end
-      
+
       file do
         # no validation necessary
       end
@@ -195,27 +205,23 @@ end
 Assuming that the request consists of a json file `question.json` containing  
 ``` json
 {
-  "data": {
-    "id": "1",
-    "type": "questions",
-    "attributes": {
-      "content": "How much is the fish?"
-    }
-  }
+  "id": "1",
+  "type": "questions",
+  "content": "How much is the fish?"
 }
-``` 
+```
 
 and an additional file `image.png`, the resulting `multipart_params` will be the following:
 
 ``` ruby
 {
-  question: 
+  question:
     {
       id:      '1',
       type:    'questions',
       content: 'How much is the fish?'
     },
-  file: 
+  file:
     {
       filename: 'image.png',
       type:     'application/octet-stream'
@@ -226,7 +232,7 @@ and an additional file `image.png`, the resulting `multipart_params` will be the
 }
 ```
 
-Please note that each part's content has to be uploaded as a separate file currently. 
+Please note that each part's content has to be uploaded as a separate file currently.
 
 ### Configuration
 

data/lib/request_handler/base.rb

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

data/lib/request_handler/body_parser.rb

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

data/lib/request_handler/document_parser.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'request_handler/json_api_document_parser'
+require 'request_handler/json_parser'
+
+module RequestHandler
+  module DocumentParser
+    module_function
+
+    def new(**args)
+      type = args.delete(:type)
+      type = type.to_sym unless type.nil?
+      PARSER_MAPPING
+        .fetch(type) { raise InternalArgumentError.new(detail: "parser for type '#{type}' not found") }
+        .new(args)
+    end
+
+    PARSER_MAPPING = {
+      nil       => JsonApiDocumentParser, # no config defaults to jsonapi
+      :jsonapi  => JsonApiDocumentParser,
+      :json     => JsonParser
+    }.freeze
+  end
+end

data/lib/request_handler/json_parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'request_handler/schema_parser'
+require 'request_handler/error'
+module RequestHandler
+  class JsonParser < SchemaParser
+    def initialize(document:, schema:, schema_options: {})
+      raise MissingArgumentError, "json": 'no content sent in document' if document.nil?
+      super(schema: schema, schema_options: schema_options)
+      @document = document
+    end
+
+    def run
+      validate_schema(document)
+    end
+
+    attr_reader :document
+  end
+end

data/lib/request_handler/multipart_parser.rb

@@ -2,8 +2,8 @@
 
 require 'request_handler/error'
 require 'request_handler/schema_parser'
-require 'request_handler/error'
-require 'request_handler/json_api_document_parser'
+require 'request_handler/document_parser'
+
 module RequestHandler
   class MultipartsParser
     def initialize(request:, multipart_config:)
@@ -35,8 +35,11 @@ module RequestHandler
     end
 
     def parse_data(name)
-      JsonApiDocumentParser.new(
-        document:         load_json(name),
+      data = load_json(name)
+      type = lookup("#{name}.type")
+      DocumentParser.new(
+        type:             type,
+        document:         data,
         schema:           lookup("#{name}.schema"),
         schema_options:   execute_options(lookup("#{name}.options"))
       ).run

data/lib/request_handler/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Andreas Eger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -260,6 +260,7 @@ files:
 - lib/request_handler.rb
 - lib/request_handler/base.rb
 - lib/request_handler/body_parser.rb
+- lib/request_handler/document_parser.rb
 - lib/request_handler/error.rb
 - lib/request_handler/fieldsets_parser.rb
 - lib/request_handler/filter_parser.rb
@@ -267,6 +268,7 @@ files:
 - lib/request_handler/helper.rb
 - lib/request_handler/include_option_parser.rb
 - lib/request_handler/json_api_document_parser.rb
+- lib/request_handler/json_parser.rb
 - lib/request_handler/multipart_parser.rb
 - lib/request_handler/option_parser.rb
 - lib/request_handler/page_parser.rb
@@ -296,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: shared base for request_handler using dry-* gems