committee 4.3.0 → 4.99.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c70ee2e436755ddf7b0b59b213ab7c00b60e67ce52520b956b889121b24e4c
-  data.tar.gz: 06066adc6056231938d36d93a98c5d7318d9c1ff367784265d66c0eb271fb7b6
+  metadata.gz: d369a9be7988a151dbd3b7d9f0065cc821ffcdc8e2543b95355b22fb1f93f6b8
+  data.tar.gz: 356fa03d1f3405544d7251302f012f48c0587c31c09b60f2509bdf7776e0c95c
 SHA512:
-  metadata.gz: bfbcc7aa85c676291125ed16b20badadda3eb8d895b6834cdc884602345c6ed3a052ecbdd381615b8bbca49815d884407cf8cc2f8cbbe05702593b5cc171f568
-  data.tar.gz: cc454350c3d04969ad3f24c1922b887a6e319cea4f0a869b647ef439dbc9f5f83f3922bde82abdeb0994a540e53d5e68345e76d7291b408e42cd2f5a4df9eec1
+  metadata.gz: 6c821b9f35b1eb20ebea532e8cbc901295596136ccdd680c34ee6eed48da8858c2a22a754a52812cc66de43598f90515ec8642753cb4d3e46390dfd3f840b6a4
+  data.tar.gz: 6b720c3e1e2c25e7f8682ba4b8db3879d552a943ec7739d6686baa62b5c4985f609643ed43db67b135025d76e7bde7ff767629ae57b5da27b82107dc6a325629

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

@@ -12,8 +12,8 @@ module Committee
 
         attr_reader :validator_option
 
-        def build_router(options)
-          @validator_option = Committee::SchemaValidator::Option.new(options, self, :hyper_schema)
+        def build_router(options, is_request)
+          @validator_option = Committee::SchemaValidator::Option.new(options, self, :hyper_schema, is_request)
           Committee::SchemaValidator::HyperSchema::Router.new(self, @validator_option)
         end
       end

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

@@ -156,7 +156,6 @@ module Committee
 
             methods.each do |method, link_data|
               method = method.upcase
-
               link = Link.new
               link.enc_type = schema.consumes
               link.href = href

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

@@ -16,8 +16,8 @@ module Committee
         attr_accessor :routes
         attr_reader :validator_option
 
-        def build_router(options)
-          @validator_option = Committee::SchemaValidator::Option.new(options, self, :hyper_schema)
+        def build_router(options, is_request)
+          @validator_option = Committee::SchemaValidator::Option.new(options, self, :hyper_schema, is_request)
           Committee::SchemaValidator::HyperSchema::Router.new(self, @validator_option)
         end
       end

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

@@ -23,8 +23,8 @@ module Committee
           @driver
         end
 
-        def build_router(options)
-          @validator_option = Committee::SchemaValidator::Option.new(options, self, :open_api_3)
+        def build_router(options, is_request)
+          @validator_option = Committee::SchemaValidator::Option.new(options, self, :open_api_3, is_request)
           Committee::SchemaValidator::OpenAPI3::Router.new(self, @validator_option)
         end
 

data/lib/committee/drivers/schema.rb

@@ -10,7 +10,7 @@ module Committee
         raise "needs implementation"
       end
 
-      def build_router(options)
+      def build_router(options, is_request)
         raise "needs implementation"
       end
 

data/lib/committee/middleware/base.rb

@@ -13,7 +13,7 @@ module Committee
         @raise = options[:raise]
         @schema = self.class.get_schema(options)
 
-        @router = @schema.build_router(options)
+        @router = @schema.build_router(options, is_request: Committee::Middleware::RequestValidation == self.class)
         @accept_request_filter = options[:accept_request_filter] || -> (_) { true }
       end
 

data/lib/committee/middleware/request_validation.rb

@@ -7,9 +7,6 @@ module Committee
         super
 
         @strict  = options[:strict]
-
-        # deprecated
-        @allow_extra = options[:allow_extra]
       end
 
       def handle(request)

data/lib/committee/middleware/response_validation.rb

@@ -7,6 +7,10 @@ module Committee
 
       def initialize(app, options = {})
         super
+
+        unless options[:strict].nil?
+          Committee.warn_deprecated("Committee: Committee::Middleware::ResponseValidation doesn't support strict option now but we'll support this option. This change break backward compatibility so please remove strict option from ResponseValidation")
+        end
         @validate_success_only = @schema.validator_option.validate_success_only
       end
 

data/lib/committee/request_unpacker.rb

@@ -2,84 +2,82 @@
 
 module Committee
   class RequestUnpacker
-    def initialize(request, options={})
-      @request = request
+    class << self
+      # Enable string or symbol key access to the nested params hash.
+      #
+      # (Copied from Sinatra)
+      def indifferent_params(object)
+        case object
+        when Hash
+          new_hash = Committee::Utils.indifferent_hash
+          object.each { |key, value| new_hash[key] = indifferent_params(value) }
+          new_hash
+        when Array
+          object.map { |item| indifferent_params(item) }
+        else
+          object
+        end
+      end
+    end
 
+    def initialize(options={})
       @allow_form_params  = options[:allow_form_params]
       @allow_get_body     = options[:allow_get_body]
       @allow_query_params = options[:allow_query_params]
-      @coerce_form_params = options[:coerce_form_params]
       @optimistic_json    = options[:optimistic_json]
-      @schema_validator   = options[:schema_validator]
     end
 
-    def call
+    # reutrn params and is_form_params
+    def unpack_request_params(request)
       # if Content-Type is empty or JSON, and there was a request body, try to
       # interpret it as JSON
-      params = if !@request.media_type || @request.media_type =~ %r{application/(?:.*\+)?json}
-        parse_json
+      params = if !request.media_type || request.media_type =~ %r{application/(?:.*\+)?json}
+        parse_json(request)
       elsif @optimistic_json
         begin
-          parse_json
+          parse_json(request)
         rescue JSON::ParserError
           nil
         end
       end
 
-      params = if params
-        params
-      elsif @allow_form_params && %w[application/x-www-form-urlencoded multipart/form-data].include?(@request.media_type)
+      return [params, false] if params
+
+      if @allow_form_params && %w[application/x-www-form-urlencoded multipart/form-data].include?(request.media_type)
         # Actually, POST means anything in the request body, could be from
         # PUT or PATCH too. Silly Rack.
-        p = @request.POST
-
-        @schema_validator.coerce_form_params(p) if @coerce_form_params
-
-        p
-      else
-        {}
+        return [request.POST, true] if request.POST
       end
 
-      if @allow_query_params
-        [indifferent_params(@request.GET).merge(params), headers]
-      else
-        [params, headers]
-      end
+      [{}, false]
     end
 
-    private
-
-    # Creates a Hash with indifferent access.
-    #
-    # (Copied from Sinatra)
-    def indifferent_hash
-      Hash.new { |hash,key| hash[key.to_s] if Symbol === key }
+    def unpack_query_params(request)
+      @allow_query_params ? self.class.indifferent_params(request.GET) : {}
     end
 
-    # Enable string or symbol key access to the nested params hash.
-    #
-    # (Copied from Sinatra)
-    def indifferent_params(object)
-      case object
-      when Hash
-        new_hash = indifferent_hash
-        object.each { |key, value| new_hash[key] = indifferent_params(value) }
-        new_hash
-      when Array
-        object.map { |item| indifferent_params(item) }
-      else
-        object
+    def unpack_headers(request)
+      env = request.env
+      base = env.keys.grep(/HTTP_/).inject({}) do |headers, key|
+        headerized_key = key.gsub(/^HTTP_/, '').gsub(/_/, '-')
+        headers[headerized_key] = env[key]
+        headers
       end
+
+      base['Content-Type'] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']
+      base
     end
 
-    def parse_json
-      return nil if @request.request_method == "GET" && !@allow_get_body
+    private
+
+    def parse_json(request)
+      return nil if request.request_method == "GET" && !@allow_get_body
 
-      body = @request.body.read
+      body = request.body.read
       # if request body is empty, we just have empty params
       return nil if body.length == 0
 
-      @request.body.rewind
+      request.body.rewind
       hash = JSON.parse(body)
       # We want a hash specifically. '42', 42, and [42] will all be
       # decoded properly, but we can't use them here.
@@ -87,19 +85,7 @@ module Committee
         raise BadRequest,
               "Invalid JSON input. Require object with parameters as keys."
       end
-      indifferent_params(hash)
-    end
-
-    def headers
-      env = @request.env
-      base = env.keys.grep(/HTTP_/).inject({}) do |headers, key|
-        headerized_key = key.gsub(/^HTTP_/, '').gsub(/_/, '-')
-        headers[headerized_key] = env[key]
-        headers
-      end
-
-      base['Content-Type'] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']
-      base
+      self.class.indifferent_params(hash)
     end
   end
 end

data/lib/committee/schema_validator/hyper_schema.rb

@@ -11,18 +11,8 @@ module Committee
       end
 
       def request_validate(request)
-        # Attempts to coerce parameters that appear in a link's URL to Ruby
-        # types that can be validated with a schema.
-        param_matches_hash = validator_option.coerce_path_params ? coerce_path_params : {}
-
-        # Attempts to coerce parameters that appear in a query string to Ruby
-        # types that can be validated with a schema.
-        coerce_query_params(request) if validator_option.coerce_query_params
-
         request_unpack(request)
 
-        request.env[validator_option.params_key].merge!(param_matches_hash) if param_matches_hash
-
         request_schema_validation(request)
         parameter_coerce!(request, link, validator_option.params_key)
         parameter_coerce!(request, link, "rack.request.query_hash") if link_exist? && !request.GET.nil? && !link.schema.nil?
@@ -50,16 +40,10 @@ module Committee
         !link.nil?
       end
 
-      def coerce_form_params(parameter)
-        return unless link_exist?
-        return unless link.schema
-        Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(parameter, link.schema).call!
-      end
-
       private
 
         def coerce_path_params
-          return unless link_exist?
+          return {} unless link_exist?
 
           Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(param_matches, link.schema, coerce_recursive: validator_option.coerce_recursive).call!
           param_matches
@@ -73,15 +57,38 @@ module Committee
         end
 
         def request_unpack(request)
-          request.env[validator_option.params_key], request.env[validator_option.headers_key] = Committee::RequestUnpacker.new(
-              request,
-              allow_form_params:  validator_option.allow_form_params,
-              allow_get_body:     validator_option.allow_get_body,
-              allow_query_params: validator_option.allow_query_params,
-              coerce_form_params: validator_option.coerce_form_params,
-              optimistic_json:    validator_option.optimistic_json,
-              schema_validator:   self
-          ).call
+          unpacker = Committee::RequestUnpacker.new(
+            allow_form_params:  validator_option.allow_form_params,
+            allow_get_body:     validator_option.allow_get_body,
+            allow_query_params: validator_option.allow_query_params,
+            optimistic_json:    validator_option.optimistic_json,
+          )
+
+          request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
+
+          # Attempts to coerce parameters that appear in a link's URL to Ruby
+          # types that can be validated with a schema.
+          param_matches_hash = validator_option.coerce_path_params ? coerce_path_params : {}
+
+          # Attempts to coerce parameters that appear in a query string to Ruby
+          # types that can be validated with a schema.
+          coerce_query_params(request) if validator_option.coerce_query_params
+
+          query_param = unpacker.unpack_query_params(request)
+          request_param, is_form_params = unpacker.unpack_request_params(request)
+          coerce_form_params(request_param) if validator_option.coerce_form_params && is_form_params
+          request.env[validator_option.request_body_hash_key] = request_param
+
+          request.env[validator_option.params_key] = Committee::Utils.indifferent_hash
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(query_param))
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(request_param))
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(param_matches_hash))
+        end
+
+        def coerce_form_params(parameter)
+          return unless link_exist?
+          return unless link.schema
+          Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(parameter, link.schema).call!
         end
 
         def request_schema_validation(request)

data/lib/committee/schema_validator/open_api_3.rb

@@ -14,12 +14,7 @@ module Committee
       def request_validate(request)
         return unless link_exist?
 
-        path_params = validator_option.coerce_path_params ? coerce_path_params : {}
-
         request_unpack(request)
-
-        request.env[validator_option.params_key]&.merge!(path_params) unless path_params.empty?
-
         request_schema_validation(request)
 
         copy_coerced_data_to_query_hash(request)
@@ -49,16 +44,13 @@ module Committee
         !@operation_object.nil?
       end
 
-      def coerce_form_params(_parameter)
-        # Empty because request_schema_validation checks and coerces
-      end
-
       private
 
       attr_reader :validator_option
 
       def coerce_path_params
-        @operation_object.coerce_path_parameter(@validator_option)
+        return Committee::Utils.indifferent_hash unless validator_option.coerce_path_params
+        Committee::RequestUnpacker.indifferent_params(@operation_object.coerce_path_parameter(@validator_option))
       end
 
       def request_schema_validation(request)
@@ -73,22 +65,44 @@ module Committee
       end
 
       def request_unpack(request)
-        request.env[validator_option.params_key], request.env[validator_option.headers_key] = Committee::RequestUnpacker.new(
-            request,
-            allow_form_params:  validator_option.allow_form_params,
-            allow_get_body:     validator_option.allow_get_body,
-            allow_query_params: validator_option.allow_query_params,
-            coerce_form_params: validator_option.coerce_form_params,
-            optimistic_json:    validator_option.optimistic_json,
-            schema_validator:   self
-        ).call
+        unpacker = Committee::RequestUnpacker.new(
+          allow_form_params:  validator_option.allow_form_params,
+          allow_get_body:     validator_option.allow_get_body,
+          allow_query_params: validator_option.allow_query_params,
+          optimistic_json:    validator_option.optimistic_json,
+        )
+
+        request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
+
+        request_param, is_form_params = unpacker.unpack_request_params(request)
+        request.env[validator_option.request_body_hash_key] = request_param
+        request.env[validator_option.path_hash_key] = coerce_path_params
+
+        query_param = unpacker.unpack_query_params(request)
+
+        order = if validator_option.parameter_overwite_by_rails_rule
+          # (high priority) path_hash_key -> query_param -> request_body_hash          
+          [request.env[validator_option.request_body_hash_key], query_param, request.env[validator_option.path_hash_key]]
+        else
+          # (high priority) path_hash_key -> request_body_hash -> query_param
+          [query_param, request.env[validator_option.request_body_hash_key], request.env[validator_option.path_hash_key]]
+        end
+
+        request.env[validator_option.params_key] = Committee::Utils.indifferent_hash
+        order.each do |param|
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(param))
+        end
       end
 
       def copy_coerced_data_to_query_hash(request)
         return if request.env["rack.request.query_hash"].nil? || request.env["rack.request.query_hash"].empty?
 
+        query_hash_key = @validator_option.query_hash_key
+        return unless query_hash_key
+
+        request.env[query_hash_key] = {} unless request.env[query_hash_key]
         request.env["rack.request.query_hash"].keys.each do |k|
-          request.env["rack.request.query_hash"][k] = request.env[validator_option.params_key][k]
+          request.env[query_hash_key][k] = request.env[validator_option.params_key][k]
         end
       end
     end

data/lib/committee/schema_validator/option.rb

@@ -16,17 +16,30 @@ module Committee
                   :coerce_recursive,
                   :optimistic_json,
                   :validate_success_only,
-                  :parse_response_by_content_type
+                  :parse_response_by_content_type,
+                  :parameter_overwite_by_rails_rule
 
       # Non-boolean options:
       attr_reader :headers_key,
                   :params_key,
+                  :query_hash_key,
+                  :request_body_hash_key,
+                  :path_hash_key,
                   :prefix
 
-      def initialize(options, schema, schema_type)
+      def initialize(options, schema, schema_type, is_request)
         # Non-boolean options
-        @headers_key         = options[:headers_key] || "committee.headers"
-        @params_key          = options[:params_key] || "committee.params"
+        @headers_key         = options[:headers_key]    || "committee.headers"
+        @params_key          = options[:params_key]     || "committee.params"
+        @query_hash_key      = if options[:query_hash_key].nil?
+          Committee.warn_deprecated('Committee: please set query_hash_key = "rack.request.query_hash" because we\'ll change default value to "committee.query_hash" in next major version.') 
+          'rack.request.query_hash'
+        else
+          options.fetch(:query_hash_key)
+        end
+        @path_hash_key      = options[:path_hash_key] || "committee.path_hash"
+        @request_body_hash_key = options[:request_body_hash_key] || "committee.request_body_hash"
+
         @prefix              = options[:prefix]
 
         # Boolean options and have a common value by default
@@ -37,11 +50,19 @@ module Committee
         @coerce_recursive    = options.fetch(:coerce_recursive, true)
         @optimistic_json     = options.fetch(:optimistic_json, false)
         @parse_response_by_content_type = if options[:parse_response_by_content_type].nil?
-          Committee.warn_deprecated('Committee: please set parse_response_by_content_type = false because we\'ll change default value in next major version.') 
+          if !is_request
+            Committee.warn_deprecated('Committee: please set parse_response_by_content_type = false because we\'ll change default value in next major version.') 
+          end
           false
         else
           options.fetch(:parse_response_by_content_type)
         end
+        @parameter_overwite_by_rails_rule      = if options[:parameter_overwite_by_rails_rule].nil?
+          Committee.warn_deprecated('Committee: please set parameter_overwite_by_rails_rule = false because we\'ll change default value to "true" in next major version.') 
+          false
+        else
+          options.fetch(:parameter_overwite_by_rails_rule)
+        end
 
         # Boolean options and have a different value by default
         @allow_get_body      = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)

data/lib/committee/test/methods.rb

@@ -3,9 +3,9 @@
 module Committee
   module Test
     module Methods
-      def assert_schema_conform
+      def assert_schema_conform(expected_status = nil)
         assert_request_schema_confirm unless old_behavior
-        assert_response_schema_confirm
+        assert_response_schema_confirm(expected_status)
       end
 
       def assert_request_schema_confirm
@@ -17,7 +17,7 @@ module Committee
         schema_validator.request_validate(request_object)
       end
 
-      def assert_response_schema_confirm
+      def assert_response_schema_confirm(expected_status = nil)
         unless schema_validator.link_exist?
           response = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema (prefix: #{committee_options[:prefix].inspect})."
           raise Committee::InvalidResponse.new(response)
@@ -25,6 +25,13 @@ module Committee
 
         status, headers, body = response_data
 
+        if expected_status.nil?
+          Committee.warn_deprecated('Pass expected response status code to check it against the corresponding schema explicitly.')
+        elsif expected_status != status
+          response = "Expected `#{expected_status}` status code, but it was `#{status}`."
+          raise Committee::InvalidResponse.new(response)
+        end
+
         if schema_coverage
           operation_object = router.operation_object(request_object)
           schema_coverage&.update_response_coverage!(operation_object.original_path, operation_object.http_method, status)
@@ -54,7 +61,7 @@ module Committee
       end
 
       def router
-        @router ||= schema.build_router(committee_options)
+        @router ||= schema.build_router(committee_options, true)
       end
 
       def schema_validator

data/lib/committee/utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Committee
+    module Utils
+        # Creates a Hash with indifferent access.
+        #
+        # (Copied from Sinatra)
+        def self.indifferent_hash
+            Hash.new { |hash,key| hash[key.to_s] if Symbol === key }
+        end
+
+        def self.deep_copy(from)
+            if from.is_a?(Hash)
+                h = Committee::Utils.indifferent_hash
+                from.each_pair do |k, v|
+                h[k] = deep_copy(v)
+                end
+                return h
+            end
+
+            if from.is_a?(Array)
+                return from.map{ |v| deep_copy(v) }
+            end
+
+            return from
+        end
+    end
+end

data/lib/committee.rb

@@ -20,6 +20,7 @@ module Committee
   end
 end
 
+require_relative "committee/utils"
 require_relative "committee/drivers"
 require_relative "committee/errors"
 require_relative "committee/middleware"

data/test/drivers_test.rb

@@ -125,7 +125,7 @@ end
 describe Committee::Drivers::Schema do
   SCHEMA_METHODS = {
     driver: [],
-    build_router: [validator_option: nil, prefix: nil]
+    build_router: [[validator_option: nil, prefix: nil], true]
   }
 
   it "has a set of abstract methods" do