request_handler 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6f03be51da1bccf44ba08a55724d6cd68c8dd43817e5b1e74f427b9ae1164f7
-  data.tar.gz: 942131e22d64ee316f7e7c690c9c1a6af0d5c589459d2bc77786e86a940fe342
+  metadata.gz: 7fb382a3a9c578b69efee4f3f24371d3f1539cb9695057130ec60f04c7be858e
+  data.tar.gz: b5b4e80acb25c29c8e2cf1f139b9ec902750a0f46b0ac31311d9d144272f24f0
 SHA512:
-  metadata.gz: f50ec83b0dc218d07d9f9703f929696f761dfd812e2a1dd5230d2e901f20ac1c4141d8674a332d08ecf3297dd7e3a3af4514e7330e37d341db92efc1dc660714
-  data.tar.gz: 7e0b0d58b1f0fd697432c9e3f0fb4447b983510bc643acde7713db1c3bc8de23a4209bd45e80ce9f255458ba0c83c5dbd9f22eca672280c98363e85a6cd3c429
+  metadata.gz: 9ff65ee31333500b115f8b15e3f60561740e647f9c6171d51516aa7c8db0f369b85c7af44fe61b47ebab77888d74d7fec8e774c04cbd3833c2204e7565af28cb
+  data.tar.gz: b30401b3c56285040c493e5c4c8e80165ed6e1226d6d058906cf93b1ddf4a6226164325a6931ec73e81a42e8463d2a288689a41ee94e71f0af71b671154ec4ec

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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).
 
+## [2.1.0] - 2020-04-01
+### Added
+- Headers validation
+
 ## [2.0.0] - 2019-11-19
 ### Changed
 - BREAKING: Required configuration of validation engine

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/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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_handler
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andreas Eger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -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