request_handler 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bdc41be4882152511b384885eb59192f5173abb7f08e9f2c32f06030c571821
-  data.tar.gz: 910f9f1a2a227c1536c3153857eca1906313a6594d6e66c13989fdb78ef6af39
+  metadata.gz: fb27be2f216ddde5e61c75588e2fcd838ec4d252919fac9761372f63d1187c80
+  data.tar.gz: dbac14a26b2de68aa1d7cf506622f849bc77a2b949424db1ffa33d70a9bbf76c
 SHA512:
-  metadata.gz: c0ee7d6b5160d2f8e4a5c33501aecc4cbd43c6c8d1cbb7dd54a6ecd3700ddedf7f600dffc3b6985775b3f7fae4d077a88774b3f6d3762c7a1f79e386162e190d
-  data.tar.gz: b912e9cde9288dee5e004c1ad71e9f0a9e985e7bc5ff4fe742b1284078ab7c35d882a757b3ae4235b3d5968fc12f29c1c3c6d37ee106960661134e3a36441042
+  metadata.gz: fac2d974663982067de6d60c16e47e63bca678925f29b6d4ccbc4e25857929ca85f7da1512c61215bd01b502c145846d738c6aa3590b21f395e39eadd6f119d6
+  data.tar.gz: 7656a364baaa0ccc75a179682541e0fe3052972b4272f1f6ced7dedf7ba06e925cbc0936f41d9cadff6b984666e04add629ea96f0d282c25e31bc871090f57d9

data/.travis.yml

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

data/CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
 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).
 
-## [Unreleased]
+## [1.2.0] - 2019-04-15
+### Added
+- Apart from dry-validation, now definition or any other validation library can be used
 
 ## [1.1.0] - 2018-07-13
 ### Changed

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/README.md

@@ -8,12 +8,6 @@ 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.
 
-## dry-gem dependency
-
-Version 1.1 removes the strict dependency to dry-types v0.11 & dry-validation v0.11 and allows usage of newer versions of dry-gems. This gem uses these gems but only a very small interface with them therefore this gem itself is usually not impacted by smaller breaking changes each minor version of the dry-gems might introduce.
-
-**Please check your applications compatibility with each dry-types version and pin versions as necessary**
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,6 +24,33 @@ Or install it yourself as:
 
     $ gem install request_handler
 
+## Configuration
+
+The default logger and separator can be changed globally:
+
+```ruby
+RequestHandler.configure do
+  logger Logger.new(STDERR)
+  separator '____'
+  validation_engine RequestHandler::Validation::DryEngine
+end
+```
+
+### Validation Engine
+Per default this gem uses the `DryEngine` which relies on dry-validation. All
+examples in this Readme assume you are using this default engine. However
+you can also use the builtin `DefinitionEngine`, which uses [Definition](https://github.com/Goltergaul/definition) as validation library:
+
+```ruby
+RequestHandler.configure do
+  require 'request_handler/validation/definition_engine'
+  validation_engine RequestHandler::Validation::DefinitionEngine
+end
+```
+
+You can also implement your own engine to use any other library, by implementing
+the abstract class `RequestHandler::Validation::Engine`
+
 ## Usage
 
 To set up a handler, you need create a class which inherits from
@@ -235,18 +256,6 @@ 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.
 
-### Configuration
-
-The default logger and separator can be changed globally by using
-`RequestHandler.configure {}`.
-
-```ruby
-RequestHandler.configure do
-  logger Logger.new(STDERR)
-  separator '____'
-end
-```
-
 ### Caveats
 
 It is currently expected that _url_ parameter are already parsed and included in
@@ -263,23 +272,23 @@ 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.
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Run `bundle exec rspec` to run the tests.
 
 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).
+`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](http://contributor-covenant.org) code of conduct.
+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 [code of conduct][cc].
 
 ## License
+The gem is available as open source under [the terms of the MIT License][mit].
 
-The gem is available as open source under the terms of
-the [MIT License](http://opensource.org/licenses/MIT).
+[mit]: https://choosealicense.com/licenses/mit/
+[cc]: ../CODE_OF_CONDUCT.md

data/lib/request_handler.rb

@@ -2,6 +2,7 @@
 
 require 'request_handler/version'
 require 'request_handler/base'
+require 'request_handler/validation/dry_engine'
 require 'confstruct'
 require 'dry-validation'
 require 'multi_json'
@@ -17,11 +18,16 @@ module RequestHandler
       @configuration ||= ::Confstruct::Configuration.new do
         logger Logger.new(STDOUT)
         separator '__'
+        validation_engine Validation::DryEngine
       end
     end
 
     def separator
       configuration.separator
     end
+
+    def engine
+      configuration.validation_engine
+    end
   end
 end

data/lib/request_handler/fieldsets_parser.rb

@@ -8,8 +8,8 @@ module RequestHandler
       @params = params
       allowed.reject! { |_k, v| v == false }
       allowed.each_value do |option|
-        raise InternalArgumentError, allowed: 'must be a Enum or a Boolean' unless
-              option.is_a?(Dry::Types::Enum) || option.is_a?(TrueClass)
+        raise InternalArgumentError, allowed: 'must be a Schema or a Boolean' unless
+          RequestHandler.engine.valid_schema?(option) || option.is_a?(TrueClass)
       end
       @allowed = allowed
       raise InternalArgumentError, required: 'must be an Array' unless required.is_a?(Array)
@@ -39,9 +39,9 @@ module RequestHandler
       if allowed[type] == true
         option.to_sym
       else
-        allowed[type].call(option).to_sym
+        RequestHandler.engine.validate!(option, allowed[type]).output.to_sym
       end
-    rescue Dry::Types::ConstraintError
+    rescue Validation::Error
       raise FieldsetsParamsError, fieldsets: "invalid field: <#{option}> for type: #{type}"
     end
 

data/lib/request_handler/include_option_parser.rb

@@ -15,8 +15,8 @@ module RequestHandler
       options.map do |option|
         option.gsub!('.', ::RequestHandler.separator)
         begin
-          allowed_options_type.call(option).to_sym
-        rescue Dry::Types::ConstraintError
+          RequestHandler.engine.validate!(option, allowed_options_type).output.to_sym
+        rescue Validation::Error
           raise OptionNotAllowedError, option.to_sym => 'is not an allowed include option'
         end
       end

data/lib/request_handler/option_parser.rb

@@ -6,13 +6,13 @@ module RequestHandler
     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?
+      raise InternalArgumentError, allowed_options_type: 'must be a Schema' unless schema?
     end
 
     private
 
-    def enum?
-      @allowed_options_type.class.equal?(Dry::Types::Enum)
+    def schema?
+      RequestHandler.engine.valid_schema?(@allowed_options_type)
     end
 
     def empty_param?(param)

data/lib/request_handler/schema_parser.rb

@@ -8,7 +8,7 @@ module RequestHandler
       missing_arguments << { schema: 'is missing' } if schema.nil?
       missing_arguments << { schema_options: 'is missing' } if schema_options.nil?
       raise MissingArgumentError, missing_arguments unless missing_arguments.empty?
-      raise InternalArgumentError, schema: 'must be a Schema' unless schema.is_a?(Dry::Validation::Schema)
+      raise InternalArgumentError, schema: 'must be a Schema' unless RequestHandler.engine.valid_schema?(schema)
       @schema = schema
       @schema_options = schema_options
     end
@@ -17,22 +17,17 @@ module RequestHandler
 
     def validate_schema(data, with: schema)
       raise MissingArgumentError, data: 'is missing' if data.nil?
-      data = deep_symbolize_keys(data) if with.rules.keys.first.is_a?(Symbol)
       validator = validate(data, schema: with)
       validation_failure?(validator)
       validator.output
     end
 
     def validate(data, schema:)
-      if schema_options.empty?
-        schema.call(data)
-      else
-        schema.with(schema_options).call(data)
-      end
+      RequestHandler.engine.validate(data, schema, options: schema_options)
     end
 
     def validation_failure?(validator)
-      return unless validator.failure?
+      return if validator.valid?
       errors = validator.errors.each_with_object({}) do |(k, v), memo|
         add_note(v, k, memo)
       end
@@ -48,19 +43,6 @@ module RequestHandler
       memo
     end
 
-    def deep_symbolize_keys(hash)
-      mem = {}
-      hash.map do |key, value|
-        if value.is_a?(Hash)
-          value = deep_symbolize_keys(value)
-        elsif value.is_a?(Array)
-          value.map! { |v| v.is_a?(Hash) ? deep_symbolize_keys(v) : v }
-        end
-        mem[key.to_sym] = value
-      end
-      mem
-    end
-
     attr_reader :schema, :schema_options
   end
 end

data/lib/request_handler/sort_option_parser.rb

@@ -36,8 +36,8 @@ module RequestHandler
     end
 
     def allowed_option(name)
-      allowed_options_type.call(name)
-    rescue Dry::Types::ConstraintError
+      RequestHandler.engine.validate!(name, allowed_options_type).output
+    rescue Validation::Error
       raise OptionNotAllowedError, name.to_sym => 'is not an allowed sort option'
     end
 

data/lib/request_handler/validation/definition_engine.rb

@@ -0,0 +1,26 @@
+require_relative 'errors'
+require_relative 'engine'
+require_relative 'result'
+require 'active_support/core_ext/hash/keys'
+
+module RequestHandler
+  module Validation
+    class DefinitionEngine < Engine
+      def self.valid_schema?(definition)
+        definition.is_a?(::Definition::Types::Base)
+      end
+
+      def self.validate(value, schema, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        value = value.deep_symbolize_keys if value.is_a?(Hash)
+        result = schema.conform(value)
+        Result.new(output: result.value, errors: result.error_hash)
+      end
+
+      def self.validate!(value, schema, options: {})
+        validate(value, schema, options).tap do |result|
+          raise Validation::Error unless result.valid?
+        end
+      end
+    end
+  end
+end

data/lib/request_handler/validation/dry_engine.rb

@@ -0,0 +1,42 @@
+require_relative 'errors'
+require_relative 'engine'
+require_relative 'result'
+require 'active_support/core_ext/hash/keys'
+
+module RequestHandler
+  module Validation
+    class DryEngine < Engine
+      def self.valid_schema?(schema)
+        schema.respond_to?(:call)
+      end
+
+      def self.validate(value, schema, options: {})
+        value = value.deep_symbolize_keys if schema.respond_to?(:rules) &&
+                                             schema.rules.keys.first.is_a?(Symbol)
+        result = if options.empty?
+                   schema.call(value)
+                 else
+                   schema.with(options).call(value)
+                 end
+
+        to_result(result)
+      rescue Dry::Types::ConstraintError => e
+        Result.new(output: nil, errors: { '' => e })
+      end
+
+      def self.validate!(value, schema, options: {})
+        validate(value, schema, options).tap do |result|
+          raise Validation::Error unless result.valid?
+        end
+      end
+
+      def self.to_result(result)
+        if result.is_a?(Dry::Validation::Result)
+          Result.new(output: result.output, errors: result.errors)
+        else
+          Result.new(output: result, errors: {})
+        end
+      end
+    end
+  end
+end

data/lib/request_handler/validation/engine.rb

@@ -0,0 +1,24 @@
+
+require_relative 'errors'
+
+module RequestHandler
+  module Validation
+    class Engine
+      def self.valid_schema?(_schema)
+        raise NotImplementedError
+      end
+
+      def self.validate(_value, _schema, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        raise NotImplementedError
+      end
+
+      def self.validate!(_value, _schema, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_accessor :value, :schema, :options
+    end
+  end
+end

data/lib/request_handler/validation/errors.rb

@@ -0,0 +1,5 @@
+module RequestHandler
+  module Validation
+    class Error < StandardError; end
+  end
+end

data/lib/request_handler/validation/result.rb

@@ -0,0 +1,17 @@
+
+module RequestHandler
+  module Validation
+    class Result
+      attr_accessor :errors, :output
+
+      def initialize(errors:, output:)
+        self.errors = errors
+        self.output = output
+      end
+
+      def valid?
+        errors.empty?
+      end
+    end
+  end
+end

data/lib/request_handler/version.rb

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

data/request_handler.gemspec

@@ -7,14 +7,14 @@ require 'request_handler/version'
 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.authors       = ['Andreas Eger', 'Dominik Goltermann']
+  spec.email         = ['andreas.eger@runtastic.com', 'dominik.goltermann@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.2'
+  spec.required_ruby_version = '~> 2.4'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'confstruct', '~> 1.0.2'
   spec.add_dependency 'multi_json', '~> 1.12'
+  spec.add_dependency 'activesupport', '> 4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'fuubar', '~> 2.2'
@@ -44,4 +45,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rubocop'
 
   spec.add_development_dependency 'rack'
+
+  spec.add_development_dependency 'definition', '~> 0.5'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andreas Eger
-- Raphael Hetzel
+- Dominik Goltermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -79,20 +79,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -247,10 +261,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: definition
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: shared base for request_handler using dry-* gems
 email:
 - andreas.eger@runtastic.com
-- raphael.hetzel@runtastic.com
+- dominik.goltermann@runtastic.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -260,10 +288,11 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Dangerfile
 - Gemfile
 - Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/ci
@@ -288,6 +317,11 @@ files:
 - lib/request_handler/schema_parser.rb
 - lib/request_handler/sort_option.rb
 - lib/request_handler/sort_option_parser.rb
+- lib/request_handler/validation/definition_engine.rb
+- lib/request_handler/validation/dry_engine.rb
+- lib/request_handler/validation/engine.rb
+- lib/request_handler/validation/errors.rb
+- lib/request_handler/validation/result.rb
 - lib/request_handler/version.rb
 - request_handler.gemspec
 homepage: https://github.com/runtastic/request_handler
@@ -302,7 +336,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="