request_handler 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 260df33b16a2f025b11b533242b0e01c6394277a
+  data.tar.gz: 198e45ed88918f7cd9284dfd3e6b9a38b0131b50
+SHA512:
+  metadata.gz: 5575e87a8d2be849138d622f596094eb09819f36a464ae36b1e7ebee096e1b1962ef78120ec900353b9d6bf22bfdd9634eace53e4e127878558b69e4c77b190e
+  data.tar.gz: ded86848d0ffdc9b20858cb0d4268c0ccbe5542cb64692bc9c4a0e6790caa62028b9e37289238fc62c2ad3c5709bca007f394f719a3dd30ec2007c006f87520e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--format p
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# minitest specifics
+AllCops:
+  TargetRubyVersion: 2.3
+Metrics/LineLength:
+  Max: 119
+Metrics/MethodLength:
+  Exclude:
+    - test/**/*
+Style/ClassAndModuleChildren:
+  Exclude:
+    - test/**/*
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.6.0
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+Changelog
+===
+
+## master
+- rename gem (dry-request_handler --> request_handler)
+- remove env based config for logger
+
+## 0.7.1
+
+- fix usage of struct to be unambiguous if dry-struct is used
+
+## 0.7
+
+- 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
+
+- support for fieldsets
+
+## 0.5
+
+- `default_size` is now mandatory
+- `default_size` and `max_size` now must be Integers
+
+## 0.4
+
+fix error messages to also work with nested error messages
+
+## 0.3
+
+sort_params returns an array of dtos now `DataTransferObject.new(field: "test", directions: :asc)`
+
+## 0.2
+
+version bump for publishing
+
+## 0.1
+
+Initial Gem

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dry-request_handler.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+
+    # Turnip features and steps
+    watch(%r{^spec/acceptance/(.+)\.feature$})
+    watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+      Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+    end
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--auto-correct'] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Runtastic
+
+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,118 @@
+# RequestHandler
+
+This gem allows easy and dry handling of requests based on the dry-validation gem for validation and
+data coersion. It allows to handle headers, filters, include_options, sorting and of course to
+validate the body.
+
+## ToDo
+
+- update documentation
+- identify missing features compared to [jsonapi](https://jsonapi.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_handler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install request_handler
+
+## Usage
+
+To set up a handler, you need to extend the `Dry::RequestHandler::Base class`, providing at least the options block and a to_dto method with the parts you want to use.
+To use it, create a new instance of the handler passing in the request, after that you can use the handler.dto method to process and access the data.
+Here is a short example, check `spec/integration/request_handler_spec.rb` for a detailed one.
+
+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.
+
+```ruby
+require "dry-validation"
+require "request_handler"
+class DemoHandler < RequestHandler::Base
+  options do
+    # pagination settings
+    page do
+      default_size 10
+      max_size 20
+      comments do
+        default_size 20
+        max_size 100
+      end
+    end
+    # access with handler.page_params
+
+    # include options
+    include_options do
+      allowed Dry::Types["strict.string"].enum("comments", "author")
+    end
+    # access with handler.include_params
+
+    # sort options
+    sort_options do
+      allowed Dry::Types["strict.string"].enum("age", "name")
+    end
+    # access with handler.sort_params
+
+    # filters
+    filter do
+      schema(
+        Dry::Validation.Form do
+          configure do
+            option :foo
+          end
+          required(:name).filled(:str?)
+        end
+      )
+      additional_url_filter %i(user_id id)
+      options(->(_handler, _request) { { foo: "bar" } })
+      # options({foo: "bar"}) # also works for hash options instead of procs
+    end
+    # access with handler.filter_params
+
+    # body
+    body do
+      schema(
+        Dry::Validation.JSON do
+          configure do
+            option :foo
+          end
+          required(:id).filled(:str?)
+        end
+      )
+      options(->(_handler, _request) { { foo: "bar" } })
+      # options({foo: "bar"}) # also works for hash options instead of procs
+    end
+    # access via handler.body_params
+
+    # also available: handler.headers
+
+    def to_dto
+      OpenStruct.new(
+        body:    body_params,
+        page:    page_params,
+        include: include_params,
+        filter:  filter_params,
+        sort:    sort_params,
+        headers: headers
+      )
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/runtastic/request_handler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+
+task :init do
+  Rake::Task['rubocop:install'].execute
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+namespace :rubocop do
+  desc 'Install Rubocop as pre-commit hook'
+  task :install do
+    require 'rubocop_runner'
+    RubocopRunner.install
+  end
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/ci

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -eo pipefail
+IFS=$'\n\t'
+
+gem=${PWD##*/}
+rubies=( "jruby-9.1.5.0" "ruby-2.3.1")
+
+run() {
+  ruby -v
+  bundle install --quiet
+  bundle exec rspec spec
+}
+
+if command -v rvm 2>/dev/null; then
+  [[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm" # Load RVM function
+  for r in "${rubies[@]}"
+  do
+    rvm use $r@$gem --create
+    run
+  done
+elif command -v rbenv 2>/dev/null; then
+  for r in "${rubies[@]}"
+  do
+    export RBENV_VERSION=$r
+    run
+  done
+  unset RBENV_VERSION
+else
+  run
+fi

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'request_handler'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
+bundle exec rake init

data/lib/request_handler.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'request_handler/version'
+require 'request_handler/base'
+require 'confstruct'
+require 'dry-validation'
+require 'multi_json'
+require 'logger'
+
+module RequestHandler
+  class << self
+    def configure(&block)
+      @configuration.configure(&block)
+    end
+
+    def configuration
+      @configuration ||= ::Confstruct::Configuration.new do
+        logger Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/request_handler/base.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+require 'request_handler/filter_handler'
+require 'request_handler/page_handler'
+require 'request_handler/include_option_handler'
+require 'request_handler/sort_option_handler'
+require 'request_handler/header_handler'
+require 'request_handler/body_handler'
+require 'request_handler/field_set_handler'
+require 'request_handler/helper'
+require 'confstruct'
+module RequestHandler
+  class Base
+    class << self
+      def options(&block)
+        @config ||= ::Confstruct::Configuration.new
+        @config.configure(&block)
+      end
+
+      def inherited(subclass)
+        return if @config.nil?
+        subclass.config = @config.deep_copy
+      end
+
+      attr_accessor :config
+    end
+    def initialize(request:)
+      raise MissingArgumentError, request: 'is missing' if request.nil?
+      @request = request
+    end
+
+    def filter_params
+      @filter_params ||= handle_filter_params
+    end
+
+    def page_params
+      @page_params ||= PageHandler.new(
+        params:      params,
+        page_config: config.lookup!('page')
+      ).run
+    end
+
+    def include_params
+      @include_params ||= handle_include_params
+    end
+
+    def sort_params
+      @sort_params ||= handle_sort_params
+    end
+
+    def headers
+      @headers ||= HeaderHandler.new(env: request.env).run
+    end
+
+    def body_params
+      @body_params ||= handle_body_params
+    end
+
+    def field_set_params
+      @field_set_params ||= handle_field_set_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
+
+    private
+
+    attr_reader :request
+
+    def handle_filter_params
+      defaults = fetch_defaults('filter.defaults', {})
+      defaults.merge(FilterHandler.new(
+        params:                params,
+        schema:                config.lookup!('filter.schema'),
+        additional_url_filter: config.lookup!('filter.additional_url_filter'),
+        schema_options:        execute_options(config.lookup!('filter.options'))
+      ).run)
+    end
+
+    def handle_include_params
+      defaults = fetch_defaults('include_options.defaults', [])
+      result = IncludeOptionHandler.new(
+        params:               params,
+        allowed_options_type: config.lookup!('include_options.allowed')
+      ).run
+      result.empty? ? defaults : result
+    end
+
+    def handle_sort_params
+      defaults = fetch_defaults('sort_options.defaults', [])
+      result = SortOptionHandler.new(
+        params:               params,
+        allowed_options_type: config.lookup!('sort_options.allowed')
+      ).run
+      result.empty? ? defaults : result
+    end
+
+    def handle_body_params
+      defaults = fetch_defaults('body.defaults', {})
+      defaults.merge(BodyHandler.new(
+        request:        request,
+        schema:         config.lookup!('body.schema'),
+        schema_options: execute_options(config.lookup!('body.options'))
+      ).run)
+    end
+
+    def handle_field_set_params
+      FieldSetHandler.new(params:   params,
+                          allowed:  config.lookup!('field_set.allowed'),
+                          required: config.lookup!('field_set.required')).run
+    end
+
+    def fetch_defaults(key, default)
+      value = config.lookup!(key)
+      return default if value.nil?
+      return value unless value.respond_to?(:call)
+      value.call(request)
+    end
+
+    def execute_options(options)
+      return {} if options.nil?
+      return options unless options.respond_to?(:call)
+      options.call(self, request)
+    end
+
+    def params
+      raise MissingArgumentError, params: 'is missing' if request.params.nil?
+      raise ExternalArgumentError, params: 'must be a Hash' unless request.params.is_a?(Hash)
+      @params ||= Helper.deep_transform_keys_in_object(request.params) { |k| k.tr('.', '_') }
+    end
+
+    def config
+      self.class.instance_variable_get('@config')
+    end
+  end
+end

data/lib/request_handler/body_handler.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'request_handler/schema_handler'
+require 'request_handler/error'
+module RequestHandler
+  class BodyHandler < SchemaHandler
+    def initialize(request:, schema:, schema_options: {})
+      raise MissingArgumentError, "request.body": 'is missing' if request.body.nil?
+      super(schema: schema, schema_options: schema_options)
+      @request = request
+    end
+
+    def run
+      validate_schema(flattened_request_body)
+    end
+
+    private
+
+    def flattened_request_body
+      body = request_body['data']
+      body.merge!(body.delete('attributes') { {} })
+      relationships = flatten_relationship_resource_linkages(body.delete('relationships') { {} })
+      body.merge!(relationships)
+      body
+    end
+
+    def flatten_relationship_resource_linkages(relationships)
+      relationships.each_with_object({}) do |(k, v), memo|
+        resource_linkage = v['data']
+        next if resource_linkage.nil?
+        memo[k] = resource_linkage
+      end
+    end
+
+    def request_body
+      b = request.body
+      b.rewind
+      b = b.read
+      b.empty? ? {} : MultiJson.load(b)
+    end
+
+    attr_reader :request
+  end
+end

data/lib/request_handler/error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module RequestHandler
+  class BaseError < StandardError
+    attr_reader :errors
+    def initialize(errors)
+      @errors = errors
+      super(message)
+    end
+
+    def message
+      errors.map do |key, value|
+        "#{key}: #{value}"
+      end.join(', ')
+    end
+  end
+  class InternalBaseError < BaseError
+  end
+  class ExternalBaseError < BaseError
+  end
+  class MissingArgumentError < InternalBaseError
+  end
+  class ExternalArgumentError < ExternalBaseError
+  end
+  class InternalArgumentError < InternalBaseError
+  end
+  class SchemaValidationError < ExternalBaseError
+  end
+  class OptionNotAllowedError < ExternalBaseError
+  end
+  class NoConfigAvailableError < InternalBaseError
+  end
+end

data/lib/request_handler/field_set_handler.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'request_handler/schema_handler'
+require 'request_handler/error'
+module RequestHandler
+  class FieldSetHandler
+    def initialize(params:, allowed: {}, required: [])
+      @params = params
+      allowed.each_value do |option|
+        raise InternalArgumentError, allowed: 'must be a Enum' unless option.is_a?(Dry::Types::Enum)
+      end
+      @allowed = allowed
+      raise InternalArgumentError, allowed: 'must be an Array' unless required.is_a?(Array)
+      @required = required
+    end
+
+    def run
+      fields = params['fields']
+      raise_missing_fields_param unless fields
+
+      field_set = fields.to_h.each_with_object({}) do |(type, values), memo|
+        type = type.to_sym
+        raise_invalid_field_option(type)
+        memo[type] = parse_options(type, values)
+      end
+      check_required_field_set_types(field_set)
+    end
+
+    private
+
+    def parse_options(type, values)
+      values.split(',').map! do |option|
+        parse_option(type, option)
+      end
+    end
+
+    def parse_option(type, option)
+      allowed[type].call(option).to_sym
+    rescue Dry::Types::ConstraintError
+      raise ExternalArgumentError, field_set: "invalid field: <#{option}> for type: #{type}"
+    end
+
+    def check_required_field_set_types(field_set)
+      return field_set if (required - field_set.keys).empty?
+      raise ExternalArgumentError, field_set: 'missing required field_set parameter'
+    end
+
+    def raise_invalid_field_option(type)
+      return if allowed&.key?(type)
+      raise OptionNotAllowedError, field_set: "field_set for type: #{type} not allowed"
+    end
+
+    def raise_missing_fields_param
+      return if required.nil? || required.empty?
+      raise ExternalArgumentError, field_set: 'missing required fields options'
+    end
+
+    attr_reader :params, :allowed, :required
+  end
+end

data/lib/request_handler/filter_handler.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'request_handler/schema_handler'
+require 'request_handler/error'
+module RequestHandler
+  class FilterHandler < SchemaHandler
+    def initialize(params:, schema:, additional_url_filter:, schema_options: {})
+      super(schema: schema, schema_options: schema_options)
+      @filter = params.fetch('filter') { {} }
+      raise ExternalArgumentError, filter: 'must be a Hash' unless @filter.is_a?(Hash)
+      Array(additional_url_filter).each do |key|
+        key = key.to_s
+        raise build_error(key) unless @filter[key].nil?
+        @filter[key] = params.fetch(key) { nil }
+      end
+    end
+
+    def run
+      validate_schema(filter)
+    end
+
+    private
+
+    def build_error(_key)
+      InternalArgumentError.new(filter: 'the filter key was set twice')
+    end
+
+    attr_reader :filter
+  end
+end

data/lib/request_handler/header_handler.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'request_handler/error'
+module RequestHandler
+  class HeaderHandler
+    def initialize(env:)
+      raise MissingArgumentError, env: 'is missing' if env.nil?
+      @headers = Helper.deep_transform_keys_in_object(env.select { |k, _v| k.start_with?('HTTP_') }) do |k|
+        k[5..-1].downcase.to_sym
+      end
+    end
+
+    def run
+      headers
+    end
+
+    private
+
+    attr_reader :headers
+  end
+end

data/lib/request_handler/helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module RequestHandler
+  module Helper
+    # extracted out of active_support
+    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb#L143
+    def deep_transform_keys_in_object(object, &block)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), result|
+          result[yield(key)] = deep_transform_keys_in_object(value, &block)
+        end
+      when Array
+        object.map { |e| deep_transform_keys_in_object(e, &block) }
+      else
+        object
+      end
+    end
+    module_function :deep_transform_keys_in_object
+  end
+end

data/lib/request_handler/include_option_handler.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'request_handler/option_handler'
+require 'request_handler/error'
+module RequestHandler
+  class IncludeOptionHandler < OptionHandler
+    def run
+      return [] unless params.key?('include')
+      options = fetch_options
+      raise ExternalArgumentError, include: 'must not contain a space' if options.include? ' '
+      allowed_options(options.split(','))
+    end
+
+    def allowed_options(options)
+      options.map do |option|
+        begin
+          allowed_options_type&.call(option)
+        rescue Dry::Types::ConstraintError
+          raise OptionNotAllowedError, option.to_sym => 'is not an allowed include option'
+        end
+        option.to_sym
+      end
+    end
+
+    def fetch_options
+      raise ExternalArgumentError, include_options: 'query paramter must not be empty' if empty_param?('include')
+      params.fetch('include') { '' }
+    end
+  end
+end

data/lib/request_handler/option_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'request_handler/error'
+module RequestHandler
+  class OptionHandler
+    def initialize(params:, allowed_options_type:)
+      @params = params
+      @allowed_options_type = allowed_options_type
+      raise InternalArgumentError, allowed_options_type: 'must be a Enum' unless enum?
+    end
+
+    private
+
+    def enum?
+      @allowed_options_type.class.equal?(Dry::Types::Enum)
+    end
+
+    def empty_param?(param)
+      params.fetch(param) { nil } == ''
+    end
+    attr_reader :params, :allowed_options_type
+  end
+end

data/lib/request_handler/page_handler.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+require 'request_handler/error'
+module RequestHandler
+  class PageHandler
+    def initialize(params:, page_config:)
+      missing_arguments = []
+      missing_arguments << { params: 'is missing' } if params.nil?
+      missing_arguments << { page_config: 'is missing' } if page_config.nil?
+      raise MissingArgumentError, missing_arguments unless missing_arguments.empty?
+      @page_options = params.fetch('page') { {} }
+      raise ExternalArgumentError, page: 'must be a Hash' unless @page_options.is_a?(Hash)
+      @config = page_config
+    end
+
+    def run
+      base = { number: extract_number, size: extract_size }
+      cfg = config.keys.reduce(base) do |memo, key|
+        next memo if TOP_LEVEL_PAGE_KEYS.include?(key)
+        memo.merge!("#{key}_number".to_sym => extract_number(prefix: key),
+                    "#{key}_size".to_sym   => extract_size(prefix: key))
+      end
+      check_for_missing_options(cfg)
+      cfg
+    end
+
+    private
+
+    TOP_LEVEL_PAGE_KEYS = Set.new([:default_size, :max_size])
+    attr_reader :page_options, :config
+
+    def check_for_missing_options(config)
+      missing_arguments = page_options.keys - config.keys.map(&:to_s)
+      warn 'client sent unknown option ' + missing_arguments.to_s unless missing_arguments.empty?
+    end
+
+    def extract_number(prefix: nil)
+      number_string = lookup_nested_params_key('number', prefix) || 1
+      error_msg = { :"#{prefix}_number" => 'must be a positive Integer' }
+      check_int(string: number_string, error_msg: error_msg)
+    end
+
+    def extract_size(prefix: nil)
+      size = fetch_and_check_size(prefix)
+      default_size = fetch_and_check_default_size(prefix)
+      return default_size if size.nil?
+      apply_max_size_constraint(size, prefix)
+    end
+
+    def fetch_and_check_default_size(prefix)
+      default_size = lookup_nested_config_key('default_size', prefix)
+      raise NoConfigAvailableError, "#{prefix}_size".to_sym => 'has no default_size' if default_size.nil?
+      error_msg = { :"#{prefix}_size" => 'must be a positive Integer' }
+      raise InternalArgumentError, error_msg unless default_size.is_a?(Integer) && default_size.positive?
+      default_size
+    end
+
+    def fetch_and_check_size(prefix)
+      size_string = lookup_nested_params_key('size', prefix)
+      return nil if size_string.nil?
+      error_msg = { :"#{prefix}_size" => 'must be a positive Integer' }
+      check_int(string: size_string, error_msg: error_msg) unless size_string.nil?
+    end
+
+    def check_int(string:, error_msg:)
+      output = Integer(string)
+      raise ExternalArgumentError, error_msg unless output.positive?
+      output
+    rescue ArgumentError
+      raise ExternalArgumentError, error_msg
+    end
+
+    def apply_max_size_constraint(size, prefix)
+      max_size = lookup_nested_config_key('max_size', prefix)
+      case max_size
+      when Integer
+        [max_size, size].min
+      when nil
+        warn "#{prefix} max_size config not set"
+        size
+      else
+        raise InternalArgumentError, "#{prefix} max_size".to_sym => 'must be a positive Integer'
+      end
+    end
+
+    def lookup_nested_config_key(key, prefix)
+      key = prefix ? "#{prefix}.#{key}" : key
+      config.lookup!(key)
+    end
+
+    def lookup_nested_params_key(key, prefix)
+      key = prefix ? "#{prefix}_#{key}" : key
+      page_options.fetch(key, nil)
+    end
+
+    def warn(message)
+      ::RequestHandler.configuration.logger.warn(message)
+    end
+  end
+end

data/lib/request_handler/schema_handler.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require 'request_handler/error'
+module RequestHandler
+  class SchemaHandler
+    def initialize(schema:, schema_options: {})
+      missing_arguments = []
+      missing_arguments << { schema: 'is missing' } if schema.nil?
+      missing_arguments << { schema_options: 'is missing' } if schema_options.nil?
+      raise MissingArgumentError, missing_arguments if missing_arguments.length.positive?
+      raise InternalArgumentError, schema: 'must be a Schema' unless schema.is_a?(Dry::Validation::Schema)
+      @schema = schema
+      @schema_options = schema_options
+    end
+
+    private
+
+    def validate_schema(data)
+      raise MissingArgumentError, data: 'is missing' if data.nil?
+      validator = validate(data)
+      validation_failure?(validator)
+      validator.output
+    end
+
+    def validate(data)
+      if schema_options.empty?
+        schema.call(data)
+      else
+        schema.with(schema_options).call(data)
+      end
+    end
+
+    def validation_failure?(validator)
+      return unless validator.failure?
+      errors = validator.errors.each_with_object({}) do |(k, v), memo|
+        add_note(v, k, memo)
+      end
+      raise SchemaValidationError, errors
+    end
+
+    def add_note(v, k, memo)
+      memo[k] = if v.is_a? Array
+                  v.join(' ')
+                elsif v.is_a? Hash
+                  v.each { |(val, key)| add_note(val, key, memo) }
+                end
+      memo
+    end
+
+    attr_reader :schema, :schema_options
+  end
+end

data/lib/request_handler/sort_option.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RequestHandler
+  SortOption = ::Struct.new(:field, :direction)
+end

data/lib/request_handler/sort_option_handler.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'request_handler/option_handler'
+require 'request_handler/error'
+require 'request_handler/sort_option'
+module RequestHandler
+  class SortOptionHandler < OptionHandler
+    def run
+      return [] unless params.key?('sort')
+      sort_options = parse_options(fetch_options)
+      raise ExternalArgumentError, sort_options: 'must be unique' if duplicates?(sort_options)
+      sort_options
+    end
+
+    def fetch_options
+      raise ExternalArgumentError, sort_options: 'the query paramter must not be empty' if empty_param?('sort')
+      params.fetch('sort') { '' }.split(',')
+    end
+
+    def parse_options(options)
+      options.map do |option|
+        name, order = parse_option(option)
+        allowed_option(name)
+        SortOption.new(name, order)
+      end
+    end
+
+    def parse_option(option)
+      raise ExternalArgumentError, sort_options: 'must not contain a space' if option.include? ' '
+      if option.start_with?('-')
+        [option[1..-1], :desc]
+      else
+        [option, :asc]
+      end
+    end
+
+    def allowed_option(name)
+      allowed_options_type&.call(name)
+    rescue Dry::Types::ConstraintError
+      raise OptionNotAllowedError, name.to_sym => 'is not an allowed sort option'
+    end
+
+    def duplicates?(options)
+      !options.uniq!(&:field).nil?
+    end
+  end
+end

data/lib/request_handler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RequestHandler
+  VERSION = '0.8.0'
+end

data/request_handler.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_handler/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'request_handler'
+  spec.version       = RequestHandler::VERSION
+  spec.authors       = ['Andreas Eger', 'Raphael Hetzel']
+  spec.email         = ['andreas.eger@runtastic.com', 'raphael.hetzel@runtastic.com']
+
+  spec.summary       = 'shared base for request_handler using dry-* gems'
+  spec.description   = 'shared base for request_handler using dry-* gems'
+  spec.homepage      = 'https://github.com/runtastic/request_handler'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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 'confstruct', '~> 1.0.2'
+  spec.add_dependency 'multi_json', '~> 1.12'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'fuubar', '~> 2.2'
+
+  spec.add_development_dependency 'rubocop_runner', '~> 2.0'
+  spec.add_development_dependency 'rubocop', '~> 0.46.0'
+
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: request_handler
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Andreas Eger
+- Raphael Hetzel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: confstruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop_runner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: shared base for request_handler using dry-* gems
+email:
+- andreas.eger@runtastic.com
+- raphael.hetzel@runtastic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ci
+- bin/console
+- bin/setup
+- lib/request_handler.rb
+- lib/request_handler/base.rb
+- lib/request_handler/body_handler.rb
+- lib/request_handler/error.rb
+- lib/request_handler/field_set_handler.rb
+- lib/request_handler/filter_handler.rb
+- lib/request_handler/header_handler.rb
+- lib/request_handler/helper.rb
+- lib/request_handler/include_option_handler.rb
+- lib/request_handler/option_handler.rb
+- lib/request_handler/page_handler.rb
+- lib/request_handler/schema_handler.rb
+- lib/request_handler/sort_option.rb
+- lib/request_handler/sort_option_handler.rb
+- lib/request_handler/version.rb
+- request_handler.gemspec
+homepage: https://github.com/runtastic/request_handler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: shared base for request_handler using dry-* gems
+test_files: []