request_handler 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f080519adc7f75f22de23333a3a0056538422d09
-  data.tar.gz: 12e57d56a1b7e384e76e868805db60fb1ec65771
+  metadata.gz: 20f2c124b0691c7cbff62564b2321b72540198c2
+  data.tar.gz: e74b4037669ef74419b45aeb90ce128be13b6103
 SHA512:
-  metadata.gz: d67dd542766a8792ab0c084c3d7f24a6867e7811497e3452378a31af61d6ecb502abc335bd135bbf368a0188e305c23f15b108f4916f658e5b8975554fd492f0
-  data.tar.gz: 18f1534788d306a99eeff74365bc5e779b09e2a40d827826fe171ac4e1e4487c1a623e1ae8de4a22b530ffc19db1cb2564a44c109f8504c6a49078fbd3ee0067
+  metadata.gz: 4ab799a4c910ce2363459e7c13d456f506afd10d9e826a83f49ee34ba9a0f8ec1e8162a0779369a1df0d6b3ae253b9bbc517805a5c533ffcc1d9081578223828
+  data.tar.gz: c2d187403ca7c3f394d685f6ed8999a08d2a17bab13942d8badf9295bca9a2dfd05f7b5d5421943e3a397d5a40a29e60dcd5723c9911ff3b8cf7a79febe4d931

data/CHANGELOG.md

@@ -3,6 +3,10 @@ Changelog
 
 ## master
 
+## 0.14.0
+
+- support generic query params
+
 ## 0.13.0
 
 - sidecar resources for multipart requests can be labeled with required

data/README.md

@@ -42,6 +42,9 @@ Please note that pagination only considers options that are configured on the
 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.
+
 ```ruby
 require "dry-validation"
 require "request_handler"
@@ -78,6 +81,14 @@ class DemoHandler < RequestHandler::Base
       # options({foo: "bar"}) # also works for hash options instead of procs
     end
 
+    query do
+      schema(
+        Dry::Validation.Form do
+          optional(:name).filled(:str?)
+        end
+      )
+    end
+
     body do
       schema(
         Dry::Validation.JSON do

data/lib/request_handler/base.rb

@@ -8,6 +8,7 @@ require 'request_handler/header_parser'
 require 'request_handler/body_parser'
 require 'request_handler/multipart_parser'
 require 'request_handler/fieldsets_parser'
+require 'request_handler/query_parser'
 require 'request_handler/helper'
 require 'confstruct'
 module RequestHandler
@@ -65,6 +66,10 @@ module RequestHandler
       @fieldsets_params ||= parse_fieldsets_params
     end
 
+    def query_params
+      @query_params ||= parse_query_params
+    end
+
     # @abstract Subclass is expected to implement #to_dto
     # !method to_dto
     #   take the parsed values and return as application specific data transfer object
@@ -121,6 +126,14 @@ module RequestHandler
                           required: lookup('fieldsets.required') || []).run
     end
 
+    def parse_query_params
+      QueryParser.new(
+        params:         params,
+        schema:         lookup!('query.schema'),
+        schema_options: execute_options(lookup('query.options'))
+      ).run
+    end
+
     def fetch_defaults(key, default)
       value = lookup(key)
       return default if value.nil?

data/lib/request_handler/query_parser.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'request_handler/schema_parser'
+require 'request_handler/error'
+module RequestHandler
+  class QueryParser < SchemaParser
+    RESERVED_KEYS = %w[fields filter include page sort].freeze
+
+    def initialize(params:, schema:, schema_options: {})
+      super(schema: schema, schema_options: schema_options)
+      @query = params.dup
+      RESERVED_KEYS.each { |key| query.delete(key) }
+    end
+
+    def run
+      validate_schema(query)
+    end
+
+    private
+
+    attr_reader :query
+  end
+end

data/lib/request_handler/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Andreas Eger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -270,6 +270,7 @@ files:
 - lib/request_handler/multipart_parser.rb
 - lib/request_handler/option_parser.rb
 - lib/request_handler/page_parser.rb
+- lib/request_handler/query_parser.rb
 - lib/request_handler/schema_parser.rb
 - lib/request_handler/sort_option.rb
 - lib/request_handler/sort_option_parser.rb
@@ -295,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: shared base for request_handler using dry-* gems