request_handler 1.1.0 → 2.1.1

data/lib/request_handler.rb

@@ -2,26 +2,18 @@
 
 require 'request_handler/version'
 require 'request_handler/base'
-require 'confstruct'
-require 'dry-validation'
+require 'request_handler/validation/dry_engine'
 require 'multi_json'
 require 'logger'
+require 'gem_config'
 
 module RequestHandler
-  class << self
-    def configure(&block)
-      configuration.configure(&block)
-    end
+  include GemConfig::Base
 
-    def configuration
-      @configuration ||= ::Confstruct::Configuration.new do
-        logger Logger.new(STDOUT)
-        separator '__'
-      end
-    end
-
-    def separator
-      configuration.separator
-    end
+  with_configuration do
+    has :validation_engine
+    has :logger, default: Logger.new(STDOUT)
+    has :separator, classes: [String], default: '__'
+    has :raise_jsonapi_errors, default: false
   end
 end

data/lib/request_handler/base.rb

@@ -10,22 +10,22 @@ require 'request_handler/multipart_parser'
 require 'request_handler/fieldsets_parser'
 require 'request_handler/query_parser'
 require 'request_handler/helper'
-require 'confstruct'
+require 'request_handler/builder/options_builder'
+require 'request_handler/concerns/config_helper'
+require 'request_handler/config'
+
 module RequestHandler
   class Base
+    include RequestHandler::Concerns::ConfigHelper
+
     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
+        @config = Config.new(&block)
       end
 
       attr_accessor :config
     end
+
     def initialize(request:)
       raise MissingArgumentError, request: 'is missing' if request.nil?
       @request = request
@@ -38,7 +38,7 @@ module RequestHandler
     def page_params
       @page_params ||= PageParser.new(
         params:      params,
-        page_config: lookup!('page')
+        page_config: config.lookup!('page')
       ).run
     end
 
@@ -51,7 +51,7 @@ module RequestHandler
     end
 
     def headers
-      @headers ||= HeaderParser.new(env: request.env).run
+      @headers ||= parse_headers
     end
 
     def body_params
@@ -82,9 +82,9 @@ module RequestHandler
       defaults = fetch_defaults('filter.defaults', {})
       defaults.merge(FilterParser.new(
         params:                params,
-        schema:                lookup!('filter.schema'),
-        additional_url_filter: lookup('filter.additional_url_filter'),
-        schema_options:        execute_options(lookup('filter.options'))
+        schema:                config.lookup!('filter.schema'),
+        additional_url_filter: config.lookup('filter.additional_url_filter'),
+        schema_options:        execute_options(config.lookup('filter.options'))
       ).run)
     end
 
@@ -100,43 +100,58 @@ module RequestHandler
       defaults = fetch_defaults("#{type}.defaults", [])
       result = parser.new(
         params:               params,
-        allowed_options_type: lookup!("#{type}.allowed")
+        allowed_options_type: config.lookup!("#{type}.allowed")
       ).run
       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,
-        schema:           lookup!('body.schema'),
-        schema_options:   execute_options(lookup('body.options')),
-        type:             lookup('body.type')
+        schema:           config.lookup!('body.schema'),
+        schema_options:   execute_options(config.lookup('body.options')),
+        type:             config.lookup('body.type')
       ).run
     end
 
     def parse_multipart_params
       MultipartsParser.new(
         request:           request,
-        multipart_config: lookup!('multipart')
+        multipart_config: config.lookup!('multipart').to_h
       ).run
     end
 
     def parse_fieldsets_params
       FieldsetsParser.new(params:   params,
-                          allowed:  lookup!('fieldsets.allowed'),
-                          required: lookup('fieldsets.required') || []).run
+                          allowed:  config.lookup!('fieldsets.allowed'),
+                          required: config.lookup('fieldsets.required') || []).run
     end
 
     def parse_query_params
       QueryParser.new(
         params:         params,
-        schema:         lookup!('query.schema'),
-        schema_options: execute_options(lookup('query.options'))
+        schema:         config.lookup!('query.schema'),
+        schema_options: execute_options(config.lookup('query.options'))
       ).run
     end
 
     def fetch_defaults(key, default)
-      value = lookup(key)
+      value = config.lookup(key)
       return default if value.nil?
       return value unless value.respond_to?(:call)
       value.call(request)
@@ -148,26 +163,20 @@ module RequestHandler
       options.call(self, request)
     end
 
-    def lookup!(key)
-      config.lookup!(key).tap do |data|
-        raise NoConfigAvailableError, key.to_sym => 'is not configured' if data.nil?
-      end
-    end
-
-    def lookup(key)
-      config.lookup!(key)
-    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)
+      raise ExternalArgumentError, [] unless request.params.is_a?(Hash)
       @params ||= Helper.deep_transform_keys_in_object(request.params) do |k|
-        k.to_s.gsub('.', ::RequestHandler.separator)
+        k.to_s.gsub('.', separator)
       end
     end
 
     def config
       self.class.instance_variable_get('@config')
     end
+
+    def separator
+      ::RequestHandler.configuration.separator
+    end
   end
 end

data/lib/request_handler/base_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'request_handler/concerns/config_helper'
+
+module RequestHandler
+  class BaseParser
+    include RequestHandler::Concerns::ConfigHelper
+  end
+end

data/lib/request_handler/builder/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module RequestHandler
+  module Builder
+    class Base
+      attr_accessor :result
+
+      def initialize
+        create_klass_struct
+      end
+
+      def create_klass_struct
+        raise NotImplementedError
+      end
+
+      def build
+        result
+      end
+    end
+  end
+end

data/lib/request_handler/builder/body_builder.rb

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

data/lib/request_handler/builder/fieldsets_builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'request_handler/builder/base'
+require 'request_handler/builder/fieldsets_resource_builder'
+
+module RequestHandler
+  module Builder
+    class FieldsetsBuilder < Base
+      Fieldsets = Struct.new(:allowed, :required)
+
+      def create_klass_struct
+        @result = Fieldsets.new
+      end
+
+      def allowed(&block)
+        @result.allowed = build_fieldsets_resource(&block)
+      end
+
+      def required(value)
+        @result.required = value
+      end
+
+      def build_fieldsets_resource(&block)
+        Docile.dsl_eval(FieldsetsResourceBuilder.new, &block).build
+      end
+    end
+  end
+end

data/lib/request_handler/builder/fieldsets_resource_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "request_handler/builder/base"
+
+module RequestHandler
+  module Builder
+    class FieldsetsResourceBuilder < Base
+      def create_klass_struct
+        @result = OpenStruct.new
+      end
+
+      def resource(name, value)
+        @result[name.to_sym] = value
+      end
+    end
+  end
+end

data/lib/request_handler/builder/filter_builder.rb

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

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

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

data/lib/request_handler/builder/multipart_builder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'request_handler/builder/base'
+require 'request_handler/builder/multipart_resource_builder'
+
+module RequestHandler
+  module Builder
+    class MultipartBuilder < Base
+      def create_klass_struct
+        @result = OpenStruct.new
+      end
+
+      def resource(name, &block)
+        @result[name.to_sym] = build_multipart_resource(&block)
+      end
+
+      def build_multipart_resource(&block)
+        Docile.dsl_eval(MultipartResourceBuilder.new, &block).build
+      end
+    end
+  end
+end

data/lib/request_handler/builder/multipart_resource_builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'request_handler/builder/base'
+
+module RequestHandler
+  module Builder
+    class MultipartResourceBuilder < Base
+      MultipartResource = Struct.new(:required, :schema, :type, :options)
+
+      def create_klass_struct
+        @result = MultipartResource.new
+      end
+
+      def type(value)
+        @result.type = value
+      end
+
+      def required(value)
+        @result.required = value
+      end
+
+      def resource(name, &block)
+        @result[name.to_sym] = build_multipart_resource(&block)
+      end
+
+      def schema(value)
+        @result.schema = value
+      end
+
+      def options(value)
+        @result.options = value
+      end
+    end
+  end
+end