committee 3.1.0 → 3.1.1

data/lib/committee/schema_validator/open_api_3/request_validator.rb

@@ -1,27 +1,33 @@
+# frozen_string_literal: true
+
 module Committee
-  class SchemaValidator::OpenAPI3::RequestValidator
-    # @param [SchemaValidator::OpenAPI3::OperationWrapper] operation_object
-    # @param [Committee::SchemaValidator::Option] validator_option
-    def initialize(operation_object, validator_option:)
-      @operation_object = operation_object
-      @validator_option = validator_option
-    end
+  module SchemaValidator
+    class OpenAPI3
+      class RequestValidator
+        # @param [SchemaValidator::OpenAPI3::OperationWrapper] operation_object
+        # @param [Committee::SchemaValidator::Option] validator_option
+        def initialize(operation_object, validator_option:)
+          @operation_object = operation_object
+          @validator_option = validator_option
+        end
 
-    def call(request, params, headers)
-      content_type = ::Committee::SchemaValidator.request_media_type(request)
-      check_content_type(request, content_type) if @validator_option.check_content_type
+        def call(request, params, headers)
+          content_type = ::Committee::SchemaValidator.request_media_type(request)
+          check_content_type(request, content_type) if @validator_option.check_content_type
 
-      @operation_object.validate_request_params(params, headers, @validator_option)
-    end
+          @operation_object.validate_request_params(params, headers, @validator_option)
+        end
 
-    private
+        private
 
-    def check_content_type(request, content_type)
-      # support post, put, patch only
-      return true unless request.post? || request.put? || request.patch?
-      return true if @operation_object.valid_request_content_type?(content_type)
+        def check_content_type(request, content_type)
+          # support post, put, patch only
+          return true unless request.post? || request.put? || request.patch?
+          return true if @operation_object.valid_request_content_type?(content_type)
 
-      raise Committee::InvalidRequest, %{"Content-Type" request header must be set to "#{@operation_object}".}
+          raise Committee::InvalidRequest, %{"Content-Type" request header must be set to "#{@operation_object}".}
+        end
+      end
     end
   end
 end

data/lib/committee/schema_validator/open_api_3/response_validator.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 module Committee
-  class SchemaValidator::OpenAPI3::ResponseValidator
-    attr_reader :validate_success_only
+  module SchemaValidator
+    class OpenAPI3
+      class ResponseValidator
+        attr_reader :validate_success_only
 
-    # @param [Committee::SchemaValidator::Options] validator_option
-    # @param [Committee::SchemaValidator::OpenAPI3::OperationWrapper] operation_wrapper
-    def initialize(operation_wrapper, validator_option)
-      @operation_wrapper = operation_wrapper
-      @validate_success_only = validator_option.validate_success_only
-      @check_header = validator_option.check_header
-    end
+        # @param [Committee::SchemaValidator::Options] validator_option
+        # @param [Committee::SchemaValidator::OpenAPI3::OperationWrapper] operation_wrapper
+        def initialize(operation_wrapper, validator_option)
+          @operation_wrapper = operation_wrapper
+          @validate_success_only = validator_option.validate_success_only
+          @check_header = validator_option.check_header
+        end
 
-    def call(status, headers, response_data, strict)
-      return unless Committee::Middleware::ResponseValidation.validate?(status, validate_success_only)
+        def call(status, headers, response_data, strict)
+          return unless Committee::Middleware::ResponseValidation.validate?(status, validate_success_only)
 
-      #content_type = headers['Content-Type'].to_s.split(";").first.to_s
-      operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header)
-    end
+          #content_type = headers['Content-Type'].to_s.split(";").first.to_s
+          operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header)
+        end
 
-    private
+        private
 
-    attr_reader :operation_wrapper, :check_header
+        attr_reader :operation_wrapper, :check_header
+      end
+    end
   end
 end

data/lib/committee/schema_validator/open_api_3/router.rb

@@ -1,37 +1,43 @@
+# frozen_string_literal: true
+
 module Committee
-  class SchemaValidator::OpenAPI3::Router
-    # @param [Committee::SchemaValidator::Option] validator_option
-    def initialize(schema, validator_option)
-      @schema = schema
-      @prefix_regexp = ::Committee::SchemaValidator.build_prefix_regexp(validator_option.prefix)
-      @validator_option = validator_option
-    end
+  module SchemaValidator
+    class OpenAPI3
+      class Router
+        # @param [Committee::SchemaValidator::Option] validator_option
+        def initialize(schema, validator_option)
+          @schema = schema
+          @prefix_regexp = ::Committee::SchemaValidator.build_prefix_regexp(validator_option.prefix)
+          @validator_option = validator_option
+        end
 
-    def includes_request?(request)
-      return true unless @prefix_regexp
+        def includes_request?(request)
+          return true unless @prefix_regexp
 
-      prefix_request?(request)
-    end
+          prefix_request?(request)
+        end
 
-    def build_schema_validator(request)
-      Committee::SchemaValidator::OpenAPI3.new(self, request, @validator_option)
-    end
+        def build_schema_validator(request)
+          Committee::SchemaValidator::OpenAPI3.new(self, request, @validator_option)
+        end
 
-    def operation_object(request)
-      path = request.path
-      path = path.gsub(@prefix_regexp, '') if prefix_request?(request)
+        def operation_object(request)
+          path = request.path
+          path = path.gsub(@prefix_regexp, '') if prefix_request?(request)
 
-      request_method = request.request_method.downcase
+          request_method = request.request_method.downcase
 
-      @schema.operation_object(path, request_method)
-    end
+          @schema.operation_object(path, request_method)
+        end
 
-    private
+        private
 
-    def prefix_request?(request)
-      return false unless @prefix_regexp
+        def prefix_request?(request)
+          return false unless @prefix_regexp
 
-      request.path =~ @prefix_regexp
+          request.path =~ @prefix_regexp
+        end
+      end
     end
   end
 end

data/lib/committee/schema_validator/option.rb

@@ -1,45 +1,49 @@
-class Committee::SchemaValidator
-  class Option
-    # Boolean Options
-    attr_reader :allow_form_params,
-                :allow_get_body,
-                :allow_query_params,
-                :check_content_type,
-                :check_header,
-                :coerce_date_times,
-                :coerce_form_params,
-                :coerce_path_params,
-                :coerce_query_params,
-                :coerce_recursive,
-                :optimistic_json,
-                :validate_success_only
+# frozen_string_literal: true
 
-    # Non-boolean options:
-    attr_reader :headers_key,
-                :params_key,
-                :prefix
+module Committee
+  module SchemaValidator
+    class Option
+      # Boolean Options
+      attr_reader :allow_form_params,
+                  :allow_get_body,
+                  :allow_query_params,
+                  :check_content_type,
+                  :check_header,
+                  :coerce_date_times,
+                  :coerce_form_params,
+                  :coerce_path_params,
+                  :coerce_query_params,
+                  :coerce_recursive,
+                  :optimistic_json,
+                  :validate_success_only
 
-    def initialize(options, schema, schema_type)
-      # Non-boolean options
-      @headers_key         = options[:headers_key] || "committee.headers"
-      @params_key          = options[:params_key] || "committee.params"
-      @prefix              = options[:prefix]
+      # Non-boolean options:
+      attr_reader :headers_key,
+                  :params_key,
+                  :prefix
 
-      # Boolean options and have a common value by default
-      @allow_form_params   = options.fetch(:allow_form_params, true)
-      @allow_query_params  = options.fetch(:allow_query_params, true)
-      @check_content_type  = options.fetch(:check_content_type, true)
-      @check_header        = options.fetch(:check_header, true)
-      @coerce_recursive    = options.fetch(:coerce_recursive, true)
-      @optimistic_json     = options.fetch(:optimistic_json, false)
+      def initialize(options, schema, schema_type)
+        # Non-boolean options
+        @headers_key         = options[:headers_key] || "committee.headers"
+        @params_key          = options[:params_key] || "committee.params"
+        @prefix              = options[:prefix]
 
-      # Boolean options and have a different value by default
-      @allow_get_body      = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)
-      @coerce_date_times   = options.fetch(:coerce_date_times, schema.driver.default_coerce_date_times)
-      @coerce_form_params  = options.fetch(:coerce_form_params, schema.driver.default_coerce_form_params)
-      @coerce_path_params  = options.fetch(:coerce_path_params, schema.driver.default_path_params)
-      @coerce_query_params = options.fetch(:coerce_query_params, schema.driver.default_query_params)
-      @validate_success_only = options.fetch(:validate_success_only, schema.driver.default_validate_success_only)
+        # Boolean options and have a common value by default
+        @allow_form_params   = options.fetch(:allow_form_params, true)
+        @allow_query_params  = options.fetch(:allow_query_params, true)
+        @check_content_type  = options.fetch(:check_content_type, true)
+        @check_header        = options.fetch(:check_header, true)
+        @coerce_recursive    = options.fetch(:coerce_recursive, true)
+        @optimistic_json     = options.fetch(:optimistic_json, false)
+
+        # Boolean options and have a different value by default
+        @allow_get_body      = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)
+        @coerce_date_times   = options.fetch(:coerce_date_times, schema.driver.default_coerce_date_times)
+        @coerce_form_params  = options.fetch(:coerce_form_params, schema.driver.default_coerce_form_params)
+        @coerce_path_params  = options.fetch(:coerce_path_params, schema.driver.default_path_params)
+        @coerce_query_params = options.fetch(:coerce_query_params, schema.driver.default_query_params)
+        @validate_success_only = options.fetch(:validate_success_only, schema.driver.default_validate_success_only)
+      end
     end
   end
 end

data/lib/committee/test/methods.rb

@@ -1,69 +1,73 @@
-module Committee::Test
-  module Methods
-    def assert_schema_conform
-      assert_request_schema_confirm unless old_behavior
-      assert_response_schema_confirm
-    end
+# frozen_string_literal: true
 
-    def assert_request_schema_confirm
-      unless schema_validator.link_exist?
-        request = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
-        raise Committee::InvalidRequest.new(request)
+module Committee
+  module Test
+    module Methods
+      def assert_schema_conform
+        assert_request_schema_confirm unless old_behavior
+        assert_response_schema_confirm
       end
 
-      schema_validator.request_validate(request_object)
-    end
+      def assert_request_schema_confirm
+        unless schema_validator.link_exist?
+          request = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
+          raise Committee::InvalidRequest.new(request)
+        end
 
-    def assert_response_schema_confirm
-      unless schema_validator.link_exist?
-        response = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
-        raise Committee::InvalidResponse.new(response)
+        schema_validator.request_validate(request_object)
       end
 
-      status, headers, body = response_data
-      schema_validator.response_validate(status, headers, [body], true) if validate_response?(status)
-    end
+      def assert_response_schema_confirm
+        unless schema_validator.link_exist?
+          response = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
+          raise Committee::InvalidResponse.new(response)
+        end
 
-    def committee_options
-      raise "please set options"
-    end
+        status, headers, body = response_data
+        schema_validator.response_validate(status, headers, [body], true) if validate_response?(status)
+      end
 
-    def request_object
-      raise "please set object like 'last_request'"
-    end
+      def committee_options
+        raise "please set options"
+      end
 
-    def response_data
-      raise "please set response data like 'last_response.status, last_response.headers, last_response.body'"
-    end
+      def request_object
+        raise "please set object like 'last_request'"
+      end
 
-    def validate_response?(status)
-      Committee::Middleware::ResponseValidation.validate?(status, committee_options.fetch(:validate_success_only, false))
-    end
+      def response_data
+        raise "please set response data like 'last_response.status, last_response.headers, last_response.body'"
+      end
 
-    def schema
-      @schema ||= Committee::Middleware::Base.get_schema(committee_options)
-    end
+      def validate_response?(status)
+        Committee::Middleware::ResponseValidation.validate?(status, committee_options.fetch(:validate_success_only, false))
+      end
 
-    def router
-      @router ||= schema.build_router(committee_options)
-    end
+      def schema
+        @schema ||= Committee::Middleware::Base.get_schema(committee_options)
+      end
 
-    def schema_validator
-      @schema_validator ||= router.build_schema_validator(request_object)
-    end
+      def router
+        @router ||= schema.build_router(committee_options)
+      end
+
+      def schema_validator
+        @schema_validator ||= router.build_schema_validator(request_object)
+      end
 
-    def old_behavior
-      old_assert_behavior = committee_options.fetch(:old_assert_behavior, nil)
-      if old_assert_behavior.nil?
-        warn <<-MSG
-        [DEPRECATION] now assert_schema_confirm check response schema only.
-          but we will change check request and response in future major version.
-          so if you want to conform response only, please use assert_response_schema_confirm,
-          or you can suppress this message and keep old behavior by setting old_assert_behavior=true.
-        MSG
-        old_assert_behavior = true
+      def old_behavior
+        old_assert_behavior = committee_options.fetch(:old_assert_behavior, nil)
+        if old_assert_behavior.nil?
+          warn <<-MSG
+          [DEPRECATION] now assert_schema_conform check response schema only.
+            but we will change check request and response in future major version.
+            so if you want to conform response only, please use assert_response_schema_confirm,
+            or you can suppress this message and keep old behavior by setting old_assert_behavior=true.
+          MSG
+          old_assert_behavior = true
+        end
+        old_assert_behavior
       end
-      old_assert_behavior
     end
   end
 end

data/lib/committee/validation_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Committee
   class ValidationError
     attr_reader :id, :message, :status

data/test/bin/committee_stub_test.rb

@@ -1,4 +1,6 @@
-require_relative "../test_helper"
+# frozen_string_literal: true
+
+require "test_helper"
 
 describe Committee::Bin::CommitteeStub do
   before do

data/test/bin_test.rb

@@ -1,4 +1,6 @@
-require_relative "test_helper"
+# frozen_string_literal: true
+
+require "test_helper"
 
 #
 # The purpose of this sets of tests is just to include our Ruby executables

data/test/committee_test.rb

@@ -1,4 +1,6 @@
-require_relative "test_helper"
+# frozen_string_literal: true
+
+require "test_helper"
 
 describe Committee do
   it "debugs based off env" do

data/test/drivers/hyper_schema/driver_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Drivers::HyperSchema::Driver do
+  before do
+    @driver = Committee::Drivers::HyperSchema::Driver.new
+  end
+
+  it "has a name" do
+    assert_equal :hyper_schema, @driver.name
+  end
+
+  it "has a schema class" do
+    assert_equal Committee::Drivers::HyperSchema::Schema, @driver.schema_class
+  end
+
+  it "parses a hyper-schema and builds routes" do
+    schema = @driver.parse(hyper_schema_data)
+    assert_kind_of Committee::Drivers::HyperSchema::Schema, schema
+    assert_equal @driver, schema.driver
+
+    assert_kind_of Hash, schema.routes
+    refute schema.routes.empty?
+    assert(schema.routes.keys.all? { |m|
+      ["DELETE", "GET", "PATCH", "POST", "PUT"].include?(m)
+    })
+
+    schema.routes.each do |(_, method_routes)|
+      method_routes.each do |regex, link|
+        assert_kind_of Regexp, regex
+        assert_kind_of Committee::Drivers::HyperSchema::Link, link
+      end
+    end
+  end
+
+  it "defaults to not coercing form parameters" do
+    assert_equal false, @driver.default_coerce_form_params
+  end
+
+  it "defaults to no path parameters" do
+    assert_equal false, @driver.default_path_params
+  end
+
+  it "defaults to no query parameters" do
+    assert_equal false, @driver.default_query_params
+  end
+end
+