request_handler 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6f03be51da1bccf44ba08a55724d6cd68c8dd43817e5b1e74f427b9ae1164f7
-  data.tar.gz: 942131e22d64ee316f7e7c690c9c1a6af0d5c589459d2bc77786e86a940fe342
+  metadata.gz: 84a7da676c652eb23c13f36d57e89b8808909c404a6874fb76b2f7c56a72b8f7
+  data.tar.gz: 8aeea4b06cfacba6ef4553974c07e705b6482753cd49bb3322d18c1a86faeb1b
 SHA512:
-  metadata.gz: f50ec83b0dc218d07d9f9703f929696f761dfd812e2a1dd5230d2e901f20ac1c4141d8674a332d08ecf3297dd7e3a3af4514e7330e37d341db92efc1dc660714
-  data.tar.gz: 7e0b0d58b1f0fd697432c9e3f0fb4447b983510bc643acde7713db1c3bc8de23a4209bd45e80ce9f255458ba0c83c5dbd9f22eca672280c98363e85a6cd3c429
+  metadata.gz: f9ac556ccfe78a670a5733cae9cb1ca2b3030119150feab16b73953336621e25657f6f9598c8e50d93cd9fcae05c633d65a9c96f6002c6fd09d3789706a92b24
+  data.tar.gz: f1d9f617c904954c7029d3d065ddeb2ab19f6a232b9f54bc2e03d528f0be02e77edec90971002c003bad1bfbd8fc4f01094c562526c3baa80c7bc54ea8fcb2f0

data/.circleci/config.yml

@@ -19,7 +19,6 @@ common_steps: &common_steps
         - vendor/bundle
 
   - run: ruby -v
-  - run: bundle exec danger
   - run: 
       name: run tests
       command: |
@@ -42,24 +41,24 @@ common_steps: &common_steps
 
 version: 2
 jobs:
-  ruby-2.4:
+  ruby-2.6:
     docker:
-      - image: circleci/ruby:2.4
+      - image: circleci/ruby:2.6
     steps:
       *common_steps
-  ruby-2.5:
+  ruby-2.7:
     docker:
-      - image: circleci/ruby:2.5
+      - image: circleci/ruby:2.7
     steps:
       *common_steps
-  jruby-9.2:
+  jruby-9.3:
     docker:
-      - image: circleci/jruby:9.2
+      - image: circleci/jruby:9.3
     steps:
       *common_steps
-  jruby-9.2-indy:
+  jruby-9.3-indy:
     docker:
-      - image: circleci/jruby:9.2
+      - image: circleci/jruby:9.3
     environment:
       JRUBY_OPTS: '-Xcompile.invokedynamic=true'
     steps:
@@ -69,7 +68,7 @@ workflows:
   version: 2
   build:
     jobs:
-      - ruby-2.4
-      - ruby-2.5
-      - jruby-9.2
-      - jruby-9.2-indy
+      - ruby-2.6
+      - ruby-2.7
+      - jruby-9.3
+      - jruby-9.3-indy

data/CHANGELOG.md

@@ -4,6 +4,20 @@ 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]
+
+## [2.2.0] - 2022-02-25
+### Changed
+- The definition engine now makes use of the translated error messages to return more useful messages
+
+## [2.1.1] - 2021-06-14
+### Fixed
+- Change error object's source attribute from `param` to `parameters` to align with JSONAPI specification
+
+## [2.1.0] - 2020-04-01
+### Added
+- Headers validation
+
 ## [2.0.0] - 2019-11-19
 ### Changed
 - BREAKING: Required configuration of validation engine

data/README.md

@@ -82,7 +82,7 @@ the abstract class `RequestHandler::Validation::Engine`
 To set up a handler, you need create a class which inherits from
 `RequestHandler::Base`, 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
+handler passing in the request, after that you can use the handler.to_dto method to
 process and access the data. Here is a short example, check
 `spec/integration/request_handler_spec.rb` for a detailed one.
 
@@ -249,7 +249,7 @@ class CreateQuestionHandler < RequestHandler::Base
 end
 ```
 
-Assuming that the request consists of a json file `question.json` containing  
+Assuming that the request consists of a json file `question.json` containing
 ``` json
 {
   "id": "1",
@@ -472,6 +472,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/runtas
 This project is intended to be a safe, welcoming space for collaboration, and
 contributors are expected to adhere to the [code of conduct][cc].
 
+Check out our [career page](https://www.runtastic.com/career/) if you'd like to work with us.
+
 ## License
 The gem is available as open source under [the terms of the MIT License][mit].
 

data/lib/request_handler/base.rb

@@ -51,7 +51,7 @@ module RequestHandler
     end
 
     def headers
-      @headers ||= HeaderParser.new(env: request.env).run
+      @headers ||= parse_headers
     end
 
     def body_params
@@ -105,6 +105,21 @@ module RequestHandler
       result.empty? ? defaults : result
     end
 
+    def parse_headers
+      HeaderParser.new(header_parser_params).run
+    end
+
+    def header_parser_params
+      params = { env: request.env }
+
+      return params if config.nil?
+
+      params.merge(
+        schema:         config.lookup('headers.schema'),
+        schema_options: execute_options(config.lookup('headers.options'))
+      )
+    end
+
     def parse_body_params
       BodyParser.new(
         request:          request,

data/lib/request_handler/builder/fieldsets_resource_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "request_handler/builder/base"
+require 'request_handler/builder/base'
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/headers_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'request_handler/builder/base'
+
+module RequestHandler
+  module Builder
+    class HeadersBuilder < Base
+      Headers = Struct.new(:schema, :options)
+
+      def create_klass_struct
+        @result = Headers.new
+      end
+
+      def schema(value)
+        @result.schema = value
+      end
+
+      def options(value)
+        @result.options = value
+      end
+    end
+  end
+end

data/lib/request_handler/builder/options_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'request_handler/builder/base'
+require 'request_handler/builder/headers_builder'
 require 'request_handler/builder/page_builder'
 require 'request_handler/builder/include_options_builder'
 require 'request_handler/builder/sort_options_builder'
@@ -14,7 +15,7 @@ module RequestHandler
   module Builder
     class OptionsBuilder < Base
       Options = Struct.new(:page, :include_options, :sort_options, :filter, :query, :body,
-                           :multipart, :fieldsets)
+                           :multipart, :fieldsets, :headers)
 
       def create_klass_struct
         @result = Options.new
@@ -52,6 +53,10 @@ module RequestHandler
         @result.fieldsets = build_fieldsets(&block)
       end
 
+      def headers(&block)
+        @result.headers = build_headers(&block)
+      end
+
       def build_page(&block)
         Docile.dsl_eval(PageBuilder.new, &block).build
       end
@@ -83,6 +88,10 @@ module RequestHandler
       def build_fieldsets(&block)
         Docile.dsl_eval(FieldsetsBuilder.new, &block).build
       end
+
+      def build_headers(&block)
+        Docile.dsl_eval(HeadersBuilder.new, &block).build
+      end
     end
   end
 end

data/lib/request_handler/fieldsets_parser.rb

@@ -46,7 +46,7 @@ module RequestHandler
       raise FieldsetsParamsError, [{ code: 'INVALID_QUERY_PARAMETER',
                                      status: '400',
                                      detail: "allowed fieldset does not include '#{option}'",
-                                     source: { param: "fields[#{type}]" } }]
+                                     source: { parameter: "fields[#{type}]" } }]
     end
 
     def check_required_fieldsets_types(fieldsets)
@@ -62,7 +62,7 @@ module RequestHandler
           code: 'INVALID_QUERY_PARAMETER',
           status: '400',
           detail: "fieldset for '#{type}' not allowed",
-          source: { param: "fields[#{type}]" }
+          source: { parameter: "fields[#{type}]" }
         }
       ]
     end
@@ -77,7 +77,7 @@ module RequestHandler
         {
           code: 'MISSING_QUERY_PARAMETER',
           status: '400',
-          source: { param: '' },
+          source: { parameter: '' },
           detail: "missing required parameter fields[#{type}]"
         }
       end

data/lib/request_handler/filter_parser.rb

@@ -37,7 +37,7 @@ module RequestHandler
       {
         status: '400',
         code: 'INVALID_QUERY_PARAMETER',
-        source: { param: source_param }
+        source: { parameter: source_param }
       }
     end
 

data/lib/request_handler/header_parser.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require 'request_handler/schema_parser'
 require 'request_handler/error'
+
 module RequestHandler
-  class HeaderParser
-    def initialize(env:)
+  class HeaderParser < SchemaParser
+    def initialize(env:, schema: nil, schema_options: {})
+      super(schema: schema, schema_options: schema_options) unless schema.nil?
+
       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
@@ -11,11 +15,34 @@ module RequestHandler
     end
 
     def run
-      headers
+      return headers if schema.nil?
+
+      validate_headers!
     end
 
     private
 
+    def validate_headers!
+      validate_schema(headers)
+    rescue SchemaValidationError => e
+      raise ExternalArgumentError, external_argument_error_params(e)
+    end
+
+    def external_argument_error_params(error)
+      error.errors.map do |schema_error|
+        header = schema_error[:source][:pointer]
+        {
+          status: '400',
+          code: "#{headers[header.to_sym] ? 'INVALID' : 'MISSING'}_HEADER",
+          detail: "#{format_header_name(header)} #{schema_error[:detail]}"
+        }
+      end
+    end
+
+    def format_header_name(name)
+      name.split('_').map(&:capitalize).join('-')
+    end
+
     attr_reader :headers
   end
 end

data/lib/request_handler/include_option_parser.rb

@@ -35,7 +35,7 @@ module RequestHandler
           status: '400',
           code:   code,
           detail: detail,
-          source: { param: 'include' }
+          source: { parameter: 'include' }
         }
       ]
     end

data/lib/request_handler/page_parser.rb

@@ -79,7 +79,7 @@ module RequestHandler
         code: 'INVALID_QUERY_PARAMETER',
         status: '400',
         detail: 'must be a positive integer',
-        source: { param: "page[#{param}]" }
+        source: { parameter: "page[#{param}]" }
       }]
     end
 

data/lib/request_handler/query_parser.rb

@@ -20,7 +20,7 @@ module RequestHandler
         { status: '400',
           code: "#{query[param] ? 'INVALID' : 'MISSING'}_QUERY_PARAMETER",
           detail: schema_error[:detail],
-          source: { param: param } }
+          source: { parameter: param } }
       end)
     end
 

data/lib/request_handler/sort_option_parser.rb

@@ -51,7 +51,7 @@ module RequestHandler
       {
         code: 'INVALID_QUERY_PARAMETER',
         status: '400',
-        source: { param: 'sort' },
+        source: { parameter: 'sort' },
         detail: detail
       }
     end

data/lib/request_handler/validation/definition_engine.rb

@@ -24,7 +24,7 @@ module RequestHandler
       end
 
       def self.error_message(validation_error)
-        validation_error.message
+        validation_error.translated_error
       end
 
       def self.error_pointer(validation_error)

data/lib/request_handler/version.rb

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

data/request_handler.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   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.4'
+  spec.required_ruby_version = '~> 2.6'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -44,5 +44,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rack'
 
-  spec.add_development_dependency 'definition', '~> 0.5'
+  spec.add_development_dependency 'definition', '~> 0.7'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Andreas Eger
 - Dominik Goltermann
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -241,14 +241,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
 description: shared base for request_handler using dry-* gems
 email:
 - andreas.eger@runtastic.com
@@ -281,6 +281,7 @@ files:
 - lib/request_handler/builder/fieldsets_builder.rb
 - lib/request_handler/builder/fieldsets_resource_builder.rb
 - lib/request_handler/builder/filter_builder.rb
+- lib/request_handler/builder/headers_builder.rb
 - lib/request_handler/builder/include_options_builder.rb
 - lib/request_handler/builder/multipart_builder.rb
 - lib/request_handler/builder/multipart_resource_builder.rb
@@ -318,7 +319,7 @@ homepage: https://github.com/runtastic/request_handler
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -326,15 +327,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: shared base for request_handler using dry-* gems
 test_files: []