committee 3.1.0 → 3.1.1

data/lib/committee/drivers/open_api_3.rb

@@ -1,79 +1,11 @@
-module Committee::Drivers
-  class OpenAPI3 < Committee::Drivers::Driver
-    def default_coerce_date_times
-      true
-    end
-
-    # Whether parameters that were form-encoded will be coerced by default.
-    def default_coerce_form_params
-      true
-    end
-
-    def default_allow_get_body
-      false
-    end
-
-    # Whether parameters in a request's path will be considered and coerced by
-    # default.
-    def default_path_params
-      true
-    end
-
-    # Whether parameters in a request's query string will be considered and
-    # coerced by default.
-    def default_query_params
-      true
-    end
-
-    def default_validate_success_only
-      false
-    end
-
-    def name
-      :open_api_3
-    end
+# frozen_string_literal: true
 
-    # @return [Committee::Drivers::OpenAPI3::Schema]
-    def parse(open_api)
-      schema_class.new(self, open_api)
-    end
-
-    def schema_class
-      Committee::Drivers::OpenAPI3::Schema
-    end
-
-    class Schema < Committee::Drivers::Schema
-      attr_reader :open_api
-      attr_reader :validator_option
-
-      # @!attribute [r] open_api
-      #   @return [OpenAPIParser::Schemas::OpenAPI]
-
-      def initialize(driver, open_api)
-        @open_api = open_api
-        @driver = driver
-      end
-
-      def supports_stub?
-        false
-      end
-
-      def driver # we don't use attr_reader because this method override super class
-        @driver
-      end
-
-      def build_router(options)
-        @validator_option = Committee::SchemaValidator::Option.new(options, self, :open_api_3)
-        Committee::SchemaValidator::OpenAPI3::Router.new(self, @validator_option)
-      end
-
-      # OpenAPI3 only
-      def operation_object(path, method)
-        request_operation = open_api.request_operation(method, path)
-        return nil unless request_operation
-
-        Committee::SchemaValidator::OpenAPI3::OperationWrapper.new(request_operation)
-      end
+module Committee
+  module Drivers
+    module OpenAPI3
     end
   end
 end
+
+require_relative 'open_api_3/driver'
+require_relative 'open_api_3/schema'

data/lib/committee/drivers/open_api_3/driver.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Committee
+  module Drivers
+    module OpenAPI3
+      class Driver < ::Committee::Drivers::Driver
+        def default_coerce_date_times
+          true
+        end
+
+        # Whether parameters that were form-encoded will be coerced by default.
+        def default_coerce_form_params
+          true
+        end
+
+        def default_allow_get_body
+          false
+        end
+
+        # Whether parameters in a request's path will be considered and coerced by
+        # default.
+        def default_path_params
+          true
+        end
+
+        # Whether parameters in a request's query string will be considered and
+        # coerced by default.
+        def default_query_params
+          true
+        end
+
+        def default_validate_success_only
+          false
+        end
+
+        def name
+          :open_api_3
+        end
+
+        # @return [Committee::Drivers::OpenAPI3::Schema]
+        def parse(open_api)
+          schema_class.new(self, open_api)
+        end
+
+        def schema_class
+          Committee::Drivers::OpenAPI3::Schema
+        end
+      end
+    end
+  end
+end

data/lib/committee/drivers/open_api_3/schema.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Committee
+  module Drivers
+    module OpenAPI3
+      class Schema < ::Committee::Drivers::Schema
+        attr_reader :open_api
+        attr_reader :validator_option
+
+        # @!attribute [r] open_api
+        #   @return [OpenAPIParser::Schemas::OpenAPI]
+
+        def initialize(driver, open_api)
+          @open_api = open_api
+          @driver = driver
+        end
+
+        def supports_stub?
+          false
+        end
+
+        def driver # we don't use attr_reader because this method override super class
+          @driver
+        end
+
+        def build_router(options)
+          @validator_option = Committee::SchemaValidator::Option.new(options, self, :open_api_3)
+          Committee::SchemaValidator::OpenAPI3::Router.new(self, @validator_option)
+        end
+
+        # OpenAPI3 only
+        def operation_object(path, method)
+          request_operation = open_api.request_operation(method, path)
+          return nil unless request_operation
+
+          Committee::SchemaValidator::OpenAPI3::OperationWrapper.new(request_operation)
+        end
+      end
+    end
+  end
+end

data/lib/committee/drivers/schema.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Committee
+  module Drivers
+    # Schema is a base class for driver schema implementations.
+    class Schema
+      # A link back to the derivative instance of Committee::Drivers::Driver
+      # that create this schema.
+      def driver
+        raise "needs implementation"
+      end
+
+      def build_router(options)
+        raise "needs implementation"
+      end
+
+      # Stubs are supported in JSON Hyper-Schema and OpenAPI 2, but not yet in OpenAPI 3
+      def supports_stub?
+        true
+      end
+    end
+  end
+end

data/lib/committee/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Committee
   class Error < StandardError
   end

data/lib/committee/middleware.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Committee
+  module Middleware
+  end
+end
+
+require_relative "middleware/base"
+require_relative "middleware/request_validation"
+require_relative "middleware/response_validation"
+require_relative "middleware/stub"

data/lib/committee/middleware/base.rb

@@ -1,50 +1,54 @@
-module Committee::Middleware
-  class Base
-    def initialize(app, options={})
-      @app = app
+# frozen_string_literal: true
 
-      @error_class = options.fetch(:error_class, Committee::ValidationError)
-      @error_handler = options[:error_handler]
+module Committee
+  module Middleware
+    class Base
+      def initialize(app, options={})
+        @app = app
 
-      @raise = options[:raise]
-      @schema = self.class.get_schema(options)
+        @error_class = options.fetch(:error_class, Committee::ValidationError)
+        @error_handler = options[:error_handler]
 
-      @router = @schema.build_router(options)
-    end
-
-    def call(env)
-      request = Rack::Request.new(env)
+        @raise = options[:raise]
+        @schema = self.class.get_schema(options)
 
-      if @router.includes_request?(request)
-        handle(request)
-      else
-        @app.call(request.env)
+        @router = @schema.build_router(options)
       end
-    end
 
-    class << self
-      def get_schema(options)
-        schema = options[:schema]
-        unless schema
-          schema = Committee::Drivers::load_from_file(options[:schema_path]) if options[:schema_path]
+      def call(env)
+        request = Rack::Request.new(env)
 
-          raise(ArgumentError, "Committee: need option `schema` or `schema_path`") unless schema
+        if @router.includes_request?(request)
+          handle(request)
+        else
+          @app.call(request.env)
         end
+      end
 
-        # Expect the type we want by now. If we don't have it, the user passed
-        # something else non-standard in.
-        if !schema.is_a?(Committee::Drivers::Schema)
-          raise ArgumentError, "Committee: schema expected to be an instance of Committee::Drivers::Schema."
-        end
+      class << self
+        def get_schema(options)
+          schema = options[:schema]
+          unless schema
+            schema = Committee::Drivers::load_from_file(options[:schema_path]) if options[:schema_path]
 
-        return schema
+            raise(ArgumentError, "Committee: need option `schema` or `schema_path`") unless schema
+          end
+
+          # Expect the type we want by now. If we don't have it, the user passed
+          # something else non-standard in.
+          if !schema.is_a?(Committee::Drivers::Schema)
+            raise ArgumentError, "Committee: schema expected to be an instance of Committee::Drivers::Schema."
+          end
+
+          return schema
+        end
       end
-    end
 
-    private
+      private
 
-    def build_schema_validator(request)
-      @router.build_schema_validator(request)
+      def build_schema_validator(request)
+        @router.build_schema_validator(request)
+      end
     end
   end
 end

data/lib/committee/middleware/request_validation.rb

@@ -1,36 +1,57 @@
-module Committee::Middleware
-  class RequestValidation < Base
-    def initialize(app, options={})
-      super
+# frozen_string_literal: true
 
-      @strict  = options[:strict]
+module Committee
+  module Middleware
+    class RequestValidation < Base
+      def initialize(app, options={})
+        super
 
-      # deprecated
-      @allow_extra = options[:allow_extra]
-    end
+        @strict  = options[:strict]
+
+        # deprecated
+        @allow_extra = options[:allow_extra]
+      end
+
+      def handle(request)
+        schema_validator = build_schema_validator(request)
+        schema_validator.request_validate(request)
+
+        raise Committee::NotFound, "That request method and path combination isn't defined." if !schema_validator.link_exist? && @strict
+
+        @app.call(request.env)
+      rescue Committee::BadRequest, Committee::InvalidRequest
+        handle_exception($!, request.env)
+        raise if @raise
+        @error_class.new(400, :bad_request, $!.message).render
+      rescue Committee::NotFound => e
+        raise if @raise
+        @error_class.new(
+          404,
+          :not_found,
+          e.message
+        ).render
+      rescue JSON::ParserError
+        handle_exception($!, request.env)
+        raise Committee::InvalidRequest if @raise
+        @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render
+      end
+
+      private
+
+      def handle_exception(e, env)
+        return unless @error_handler
+
+        if @error_handler.arity > 1
+          @error_handler.call(e, env)
+        else
+          warn <<-MESSAGE
+          [DEPRECATION] Using `error_handler.call(exception)` is deprecated and will be change to
+            `error_handler.call(exception, request.env)` in next major version.
+          MESSAGE
 
-    def handle(request)
-      schema_validator = build_schema_validator(request)
-      schema_validator.request_validate(request)
-
-      raise Committee::NotFound, "That request method and path combination isn't defined." if !schema_validator.link_exist? && @strict
-
-      @app.call(request.env)
-    rescue Committee::BadRequest, Committee::InvalidRequest
-      @error_handler.call($!) if @error_handler
-      raise if @raise
-      @error_class.new(400, :bad_request, $!.message).render
-    rescue Committee::NotFound => e
-      raise if @raise
-      @error_class.new(
-        404,
-        :not_found,
-        e.message
-      ).render
-    rescue JSON::ParserError
-      @error_handler.call($!) if @error_handler
-      raise Committee::InvalidRequest if @raise
-      @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render
+          @error_handler.call(e)
+        end
+      end
     end
   end
 end

data/lib/committee/middleware/response_validation.rb

@@ -1,32 +1,55 @@
-module Committee::Middleware
-  class ResponseValidation < Base
-    attr_reader :validate_success_only
+# frozen_string_literal: true
 
-    def initialize(app, options = {})
-      super
-      @validate_success_only = @schema.validator_option.validate_success_only
-    end
+module Committee
+  module Middleware
+    class ResponseValidation < Base
+      attr_reader :validate_success_only
 
-    def handle(request)
-      status, headers, response = @app.call(request.env)
-
-      v = build_schema_validator(request)
-      v.response_validate(status, headers, response) if v.link_exist? && self.class.validate?(status, validate_success_only)
-
-      [status, headers, response]
-    rescue Committee::InvalidResponse
-      @error_handler.call($!) if @error_handler
-      raise if @raise
-      @error_class.new(500, :invalid_response, $!.message).render
-    rescue JSON::ParserError
-      @error_handler.call($!) if @error_handler
-      raise Committee::InvalidResponse if @raise
-      @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render
-    end
+      def initialize(app, options = {})
+        super
+        @validate_success_only = @schema.validator_option.validate_success_only
+      end
+
+      def handle(request)
+        status, headers, response = @app.call(request.env)
+
+        v = build_schema_validator(request)
+        v.response_validate(status, headers, response) if v.link_exist? && self.class.validate?(status, validate_success_only)
+
+        [status, headers, response]
+      rescue Committee::InvalidResponse
+        handle_exception($!, request.env)
+
+        raise if @raise
+        @error_class.new(500, :invalid_response, $!.message).render
+      rescue JSON::ParserError
+        handle_exception($!, request.env)
+
+        raise Committee::InvalidResponse if @raise
+        @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render
+      end
+
+      class << self
+        def validate?(status, validate_success_only)
+          status != 204 && (!validate_success_only || (200...300).include?(status))
+        end
+      end
+
+      private
+
+      def handle_exception(e, env)
+        return unless @error_handler
+
+        if @error_handler.arity > 1
+          @error_handler.call(e, env)
+        else
+          warn <<-MESSAGE
+          [DEPRECATION] Using `error_handler.call(exception)` is deprecated and will be change to
+            `error_handler.call(exception, request.env)` in next major version.
+          MESSAGE
 
-    class << self
-      def validate?(status, validate_success_only)
-        status != 204 && (!validate_success_only || (200...300).include?(status))
+          @error_handler.call(e)
+        end
       end
     end
   end