committee 3.1.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 169dfa8f079626447ca5086429c0bd025d8180f3ef5b7a7194d1333bdeff8fab
-  data.tar.gz: 2c8eeece5b411266f482808b7caf08d2de285f64e78e705990a4b7b9606902d3
+  metadata.gz: 9bef22bebc103d1bee78ba294078cd56e34e37da3e92b5cb89aba683a2361c74
+  data.tar.gz: 76f012e3f28bd5275af941a372563f00b3bf68e1c0332d0e78affc18cbac9f2e
 SHA512:
-  metadata.gz: b891ea4d1498b2fc16f0d241520486736b0b707bf401e96bdab09795ff165c23d86344a2b29cfcf1dbca83d8a773b85a08e59dc09220c5acca2738e485c3994f
-  data.tar.gz: ca657dfb18edaf157cb01ca48b522882c165a8c06216c84deda9a88a7718fb61da4ea3a3b017e4ac8594e83f97f904d4f0f1ad1947ee9418b977ddf4884e8c52
+  metadata.gz: da601220eca1ea05bb829a61a65bf6928262be27c73647de756f44b07329752efe6818be1a79b95bb51ad2e00025d08ff5fbb5410acfdc670d43f6816c6614f1
+  data.tar.gz: c0fad32bef922020708c194065d0de90fccc9d33d00354b4c8a4f3208e18b4720030e01810e798107894e6f503e8145fef11fd12afa1ba1f0b5b017f3b58eeda

data/lib/committee/drivers.rb

@@ -21,14 +21,14 @@ module Committee
     # @param [String] schema_path
     # @return [Committee::Driver]
     def self.load_from_json(schema_path)
-      load_from_data(JSON.parse(File.read(schema_path)))
+      load_from_data(JSON.parse(File.read(schema_path)), schema_path)
     end
 
     # load and build drive from YAML file
     # @param [String] schema_path
     # @return [Committee::Driver]
     def self.load_from_yaml(schema_path)
-      load_from_data(YAML.load_file(schema_path))
+      load_from_data(YAML.load_file(schema_path), schema_path)
     end
 
     # load and build drive from file
@@ -48,10 +48,10 @@ module Committee
     # load and build drive from Hash object
     # @param [Hash] hash
     # @return [Committee::Driver]
-    def self.load_from_data(hash)
+    def self.load_from_data(hash, schema_path = nil)
       if hash['openapi']&.start_with?('3.0.')
-        parser = OpenAPIParser.parse(hash)
-        return Committee::Drivers::OpenAPI3::Driver.new.parse(parser)
+        openapi = OpenAPIParser.parse_with_filepath(hash, schema_path)
+        return Committee::Drivers::OpenAPI3::Driver.new.parse(openapi)
       end
 
       driver = if hash['swagger'] == '2.0'

data/lib/committee/middleware/base.rb

@@ -8,17 +8,19 @@ module Committee
 
         @error_class = options.fetch(:error_class, Committee::ValidationError)
         @error_handler = options[:error_handler]
+        @ignore_error = options.fetch(:ignore_error, false)
 
         @raise = options[:raise]
         @schema = self.class.get_schema(options)
 
         @router = @schema.build_router(options)
+        @accept_request_filter = options[:accept_request_filter] || -> (_) { true }
       end
 
       def call(env)
         request = Rack::Request.new(env)
 
-        if @router.includes_request?(request)
+        if @router.includes_request?(request) && @accept_request_filter.call(request)
           handle(request)
         else
           @app.call(request.env)

data/lib/committee/middleware/request_validation.rb

@@ -13,27 +13,25 @@ module Committee
       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
+        begin
+          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
+        rescue Committee::BadRequest, Committee::InvalidRequest
+          handle_exception($!, request.env)
+          raise if @raise
+          return @error_class.new(400, :bad_request, $!.message).render unless @ignore_error
+        rescue Committee::NotFound => e
+          raise if @raise
+          return @error_class.new(404, :not_found, e.message).render unless @ignore_error
+        rescue JSON::ParserError
+          handle_exception($!, request.env)
+          raise Committee::InvalidRequest if @raise
+          return @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render unless @ignore_error
+        end
 
         @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

data/lib/committee/middleware/response_validation.rb

@@ -11,22 +11,25 @@ module Committee
       end
 
       def handle(request)
-        status, headers, response = @app.call(request.env)
+        begin
+          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)
+          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)
+        rescue Committee::InvalidResponse
+          handle_exception($!, request.env)
+
+          raise if @raise
+          return @error_class.new(500, :invalid_response, $!.message).render unless @ignore_error
+        rescue JSON::ParserError
+          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
+          return @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render unless @ignore_error
+        end
 
-        raise Committee::InvalidResponse if @raise
-        @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render
+        [status, headers, response]
       end
 
       class << self

data/lib/committee/schema_validator/hyper_schema.rb

@@ -35,7 +35,14 @@ module Committee
         response.each do |chunk|
           full_body << chunk
         end
-        data = full_body.empty? ? {} : JSON.parse(full_body)
+
+        data = {}
+        unless full_body.empty?
+          parse_to_json = !validator_option.parse_response_by_content_type ||
+                          headers.fetch('Content-Type', nil)&.start_with?('application/json')
+          data = JSON.parse(full_body) if parse_to_json
+        end
+
         Committee::SchemaValidator::HyperSchema::ResponseValidator.new(link, validate_success_only: validator_option.validate_success_only).call(status, headers, data)
       end
 

data/lib/committee/schema_validator/open_api_3.rb

@@ -30,7 +30,14 @@ module Committee
         response.each do |chunk|
           full_body << chunk
         end
-        data = full_body.empty? ? {} : JSON.parse(full_body)
+
+        parse_to_json = !validator_option.parse_response_by_content_type || 
+                        headers.fetch('Content-Type', nil)&.start_with?('application/json')
+        data = if parse_to_json
+          full_body.empty? ? {} : JSON.parse(full_body)
+        else
+          full_body
+        end
 
         strict = test_method
         Committee::SchemaValidator::OpenAPI3::ResponseValidator.

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

@@ -64,6 +64,10 @@ module Committee
           end
         end
 
+        def request_content_types
+          request_operation.operation_object&.request_body&.content&.keys || []
+        end
+
         private
 
         attr_reader :request_operation
@@ -112,7 +116,9 @@ module Committee
           content_type = headers['Content-Type'].to_s.split(";").first.to_s
 
           # bad performance because when we coerce value, same check
-          return request_operation.validate_request_body(content_type, params, build_openapi_parser_post_option(validator_option))
+          schema_validator_options = build_openapi_parser_post_option(validator_option)
+          request_operation.validate_request_parameter(params, headers, schema_validator_options)
+          request_operation.validate_request_body(content_type, params, schema_validator_options)
         rescue => e
           raise Committee::InvalidRequest.new(e.message)
         end

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

@@ -25,7 +25,17 @@ module Committee
           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}".}
+          message = if valid_content_types.size > 1
+                      types = valid_content_types.map {|x| %{"#{x}"} }.join(', ')
+                      %{"Content-Type" request header must be set to any of the following: [#{types}].}
+                    else
+                      %{"Content-Type" request header must be set to "#{valid_content_types.first}".}
+                    end
+          raise Committee::InvalidRequest, message
+        end
+
+        def valid_content_types
+          @operation_object&.request_content_types
         end
       end
     end

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

@@ -17,7 +17,6 @@ module Committee
         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
 

data/lib/committee/schema_validator/option.rb

@@ -15,7 +15,8 @@ module Committee
                   :coerce_query_params,
                   :coerce_recursive,
                   :optimistic_json,
-                  :validate_success_only
+                  :validate_success_only,
+                  :parse_response_by_content_type
 
       # Non-boolean options:
       attr_reader :headers_key,
@@ -35,6 +36,12 @@ module Committee
         @check_header        = options.fetch(:check_header, true)
         @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.') 
+          false
+        else
+          options.fetch(:parse_response_by_content_type)
+        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/test/bin/committee_stub_test.rb

@@ -43,7 +43,11 @@ describe Committee::Bin::CommitteeStub, "app" do
   end
 
   def app
-    @bin.get_app(hyper_schema, {})
+    options = {}
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = false
+
+    @bin.get_app(hyper_schema, options)
   end
 
   it "defaults to a 404" do

data/test/middleware/base_test.rb

@@ -103,17 +103,20 @@ describe Committee::Middleware::Base do
 
   describe 'initialize option' do
     it "schema_path option with hyper-schema" do
-      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::HyperSchema::Schema, b.instance_variable_get(:@schema)
     end
 
     it "schema_path option with OpenAPI2" do
-      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, b.instance_variable_get(:@schema)
     end
 
     it "schema_path option with OpenAPI3" do
-      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, b.instance_variable_get(:@schema)
     end
   end
@@ -121,6 +124,9 @@ describe Committee::Middleware::Base do
   private
 
   def new_rack_app(options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run lambda { |_|

data/test/middleware/request_validation_open_api_3_test.rb

@@ -249,8 +249,7 @@ describe Committee::Middleware::RequestValidation do
     }
     post "/characters", JSON.generate(params)
     assert_equal 400, last_response.status
-    # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-    assert_match(/1 class is #{1.class}/i, last_response.body)
+    assert_match(/expected string, but received Integer:/i, last_response.body)
   end
 
   it "rescues JSON errors" do
@@ -279,7 +278,7 @@ describe Committee::Middleware::RequestValidation do
     header "Content-Type", "application/json"
     post "/v1/characters", JSON.generate(params)
     assert_equal 400, last_response.status
-    assert_match(/1 class is/i, last_response.body)
+    assert_match(/expected string, but received Integer: /i, last_response.body)
   end
 
   it "ignores paths outside the prefix" do
@@ -321,7 +320,7 @@ describe Committee::Middleware::RequestValidation do
       get "/validate", nil
     end
 
-    assert_match(/required parameters query_string not exist in/i, e.message)
+    assert_match(/missing required parameters: query_string/i, e.message)
   end
 
   it "raises error when required path parameter is invalid" do
@@ -332,7 +331,7 @@ describe Committee::Middleware::RequestValidation do
       get "/coerce_path_params/#{not_an_integer}", nil
     end
 
-    assert_match(/is String but it's not valid integer in/i, e.message)
+    assert_match(/expected integer, but received String: abc/i, e.message)
   end
 
   it "optionally raises an error" do
@@ -356,7 +355,7 @@ describe Committee::Middleware::RequestValidation do
     get "/string_params_coercer", {"integer_1" => "1"}
 
     assert_equal 400, last_response.status
-    assert_match(/1 class/i, last_response.body)
+    assert_match(/expected integer, but received String:/i, last_response.body)
   end
 
   it "passes through a valid request for OpenAPI3" do
@@ -375,7 +374,14 @@ describe Committee::Middleware::RequestValidation do
     get "/characters?limit=foo"
 
     assert_equal 400, last_response.status
-    assert_match(/foo class/i, last_response.body)
+    assert_match(/expected integer, but received String: foo/i, last_response.body)
+  end
+
+  it "ignores errors when ignore_error: true" do
+    @app = new_rack_app(schema: open_api_3_schema, ignore_error: true)
+    get "/characters?limit=foo"
+
+    assert_equal 200, last_response.status
   end
 
   it "coerce string to integer" do
@@ -399,21 +405,55 @@ describe Committee::Middleware::RequestValidation do
   end
 
   describe 'check header' do
-    it 'no required header' do
-      @app = new_rack_app(schema: open_api_3_schema, check_header: true)
-
-      get "/header"
-
-      assert_equal 400, last_response.status
-      assert_match(/required parameters integer not exist/i, last_response.body)
+    [
+      { check_header: true, description: 'valid value', value: 1, expected: { status: 200 } },
+      { check_header: true, description: 'missing value', value: nil, expected: { status: 400, error: 'missing required parameters: integer' } },
+      { check_header: true, description: 'invalid value', value: 'x', expected: { status: 400, error: 'expected integer, but received String: x' } },
+
+      { check_header: false, description: 'valid value', value: 1, expected: { status: 200 } },
+      { check_header: false, description: 'missing value', value: nil, expected: { status: 200 } },
+      { check_header: false, description: 'invalid value', value: 'x', expected: { status: 200 } },
+    ].each do |h|
+      check_header = h[:check_header]
+      description = h[:description]
+      value = h[:value]
+      expected = h[:expected]
+      describe "when #{check_header}" do
+        %w(get post put patch delete).each do |method|
+          describe method do
+            describe description do
+              it (expected[:error].nil? ? 'should pass' : 'should fail') do
+                @app = new_rack_app(schema: open_api_3_schema, check_header: check_header)
+
+                header 'integer', value
+                send(method, "/header")
+
+                assert_equal expected[:status], last_response.status
+                assert_match(expected[:error], last_response.body) if expected[:error]
+              end
+            end
+          end
+        end
+      end
     end
+  end
 
-    it 'no required header but not check' do
-      @app = new_rack_app(schema: open_api_3_schema, check_header: false)
-
-      get "/header"
-
-      assert_equal 200, last_response.status
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 400 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/c') }, expected: { status: 400 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
+      it description do
+        @app = new_rack_app(prefix: '/v1', schema: open_api_3_schema, accept_request_filter: accept_request_filter)
+
+        post 'v1/characters', JSON.generate(string_post_1: 1)
+
+        assert_equal expected[:status], last_response.status
+      end
     end
   end
 
@@ -426,6 +466,9 @@ describe Committee::Middleware::RequestValidation do
   end
 
   def new_rack_app_with_lambda(check_lambda, options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run check_lambda

data/test/middleware/request_validation_test.rb

@@ -296,6 +296,16 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/invalid request/i, last_response.body)
   end
 
+  it "ignores errors when ignore_error: true" do
+    @app = new_rack_app(schema: hyper_schema, ignore_error: true)
+    header "Content-Type", "application/json"
+    params = {
+      "name" => 1
+    }
+    post "/apps", JSON.generate(params)
+    assert_equal 200, last_response.status
+  end
+
   it "calls error_handler (has a arg) when request is invalid" do
     called_err = nil
     pr = ->(e) { called_err = e }
@@ -480,6 +490,25 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 400 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/a') }, expected: { status: 400 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
+      it description do
+        @app = new_rack_app(prefix: '/v1', schema: hyper_schema, accept_request_filter: accept_request_filter)
+
+        post '/v1/apps', '{x:y}'
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_rack_app(options = {})
@@ -490,6 +519,9 @@ describe Committee::Middleware::RequestValidation do
 
 
   def new_rack_app_with_lambda(check_lambda, options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run check_lambda

data/test/middleware/response_validation_open_api_3_test.rb

@@ -26,6 +26,22 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal "{\"id\":\"invalid_response\",\"message\":\"Response wasn't valid JSON.\"}", last_response.body
   end
 
+  it "passes through a invalid json with ignore_error option" do
+    @app = new_response_rack("not_json", {}, schema: open_api_3_schema, ignore_error: true)
+
+    get "/characters"
+
+    assert_equal 200, last_response.status
+  end
+
+  it "passes through a invalid json with parse_response_by_content_type option" do
+    @app = new_response_rack("csv response", { "Content-Type" => "test/csv"}, schema: open_api_3_schema, parse_response_by_content_type: true)
+
+    get "/csv"
+
+    assert_equal 200, last_response.status
+  end
+
   it "passes through not definition" do
     @app = new_response_rack(JSON.generate(CHARACTERS_RESPONSE), {}, schema: open_api_3_schema)
     get "/no_data"
@@ -39,7 +55,7 @@ describe Committee::Middleware::ResponseValidation do
       get "/characters"
     }
 
-    assert_match(/class is Array but it's not valid object/i, e.message)
+    assert_match(/expected object, but received Array: /i, e.message)
   end
 
   it "passes through a 204 (no content) response" do
@@ -91,29 +107,59 @@ describe Committee::Middleware::ResponseValidation do
     assert_match(/valid JSON/i, last_response.body)
   end
 
-  describe 'check header' do
-    it 'valid type header' do
-      @app = new_response_rack({}.to_json, {'x-limit' => 1}, schema: open_api_3_schema, raise: true)
-
-      get "/header"
-
+  describe "remote schema $ref" do
+    it "passes through a valid response" do
+      @app = new_response_rack(JSON.generate({ "sample" => "value" }), {}, schema: open_api_3_schema)
+      get "/ref-sample"
       assert_equal 200, last_response.status
     end
 
-    it 'invalid type header' do
-      @app = new_response_rack({}.to_json, {'x-limit' => '1'}, schema: open_api_3_schema, raise: true)
-
-      assert_raises(Committee::InvalidResponse) do
-        get "/header"
-      end
+    it "detects a invalid response" do
+      @app = new_response_rack("{}", {}, schema: open_api_3_schema)
+      get "/ref-sample"
+      assert_equal 500, last_response.status
     end
+  end
 
-    it 'invalid type but not check' do
-      @app = new_response_rack({}.to_json, {'x-limit' => '1'}, schema: open_api_3_schema, raise: true, check_header: false)
-
-      get "/header"
-
-      assert_equal 200, last_response.status
+  describe 'check header' do
+    [
+      { check_header: true, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
+      { check_header: true, description: 'missing value', header: { 'integer' => nil }, expected: { error: 'headers/integer/schema does not allow null values' } },
+      { check_header: true, description: 'invalid value', header: { 'integer' => 'x' }, expected: { error: 'headers/integer/schema expected integer, but received String: x' } },
+
+      { check_header: false, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
+      { check_header: false, description: 'missing value', header: { 'integer' => nil }, expected: { status: 200 } },
+      { check_header: false, description: 'invalid value', header: { 'integer' => 'x' }, expected: { status: 200 } },
+    ].each do |h|
+      check_header = h[:check_header]
+      description = h[:description]
+      header = h[:header]
+      expected = h[:expected]
+      describe "when #{check_header}" do
+        %w(get post put patch delete).each do |method|
+          describe method do
+            describe description do
+              if expected[:error].nil?
+                it 'should pass' do
+                  @app = new_response_rack({}.to_json, header, schema: open_api_3_schema, raise: true, check_header: check_header)
+
+                  send(method, "/header")
+                  assert_equal expected[:status], last_response.status
+                end
+              else
+                it 'should fail' do
+                  @app = new_response_rack({}.to_json, header, schema: open_api_3_schema, raise: true, check_header: check_header)
+
+                  error = assert_raises(Committee::InvalidResponse) do
+                    get "/header"
+                  end
+                  assert_match(expected[:error], error.message)
+                end
+              end
+            end
+          end
+        end
+      end
     end
   end
 
@@ -130,7 +176,8 @@ describe Committee::Middleware::ResponseValidation do
       e = assert_raises(Committee::InvalidResponse) do
         get "/characters"
       end
-      assert_match(/1 class is String/i, e.message)
+
+      assert_match(/but received String: 1/i, e.message)
     end
 
     it "detects an invalid response status code with validate_success_only=true" do
@@ -148,9 +195,32 @@ describe Committee::Middleware::ResponseValidation do
     end
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 500 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/c') }, expected: { status: 500 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
+
+      it description do
+        @app = new_response_rack('not_json', {}, schema: open_api_3_schema, prefix: '/v1', accept_request_filter: accept_request_filter)
+
+        get 'v1/characters'
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_response_rack(response, headers = {}, options = {}, rack_options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     status = rack_options[:status] || 200
     headers = {
       "Content-Type" => "application/json"

data/test/middleware/response_validation_test.rb

@@ -38,6 +38,12 @@ describe Committee::Middleware::ResponseValidation do
     assert_match(/{} is not an array/i, last_response.body)
   end
 
+  it "detects a response invalid due to schema with ignore_error option" do
+    @app = new_rack_app("{}", {}, schema: hyper_schema, ignore_error: true)
+    get "/apps"
+    assert_equal 200, last_response.status
+  end
+
   it "detects a response invalid due to not being JSON" do
     @app = new_rack_app("{_}", {}, schema: hyper_schema)
     get "/apps"
@@ -156,9 +162,31 @@ describe Committee::Middleware::ResponseValidation do
     assert_match(/valid JSON/i, last_response.body)
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 500 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/a') }, expected: { status: 500 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
+      it description do
+        @app = new_rack_app('not_json', {}, schema: hyper_schema, prefix: '/v1', accept_request_filter: accept_request_filter)
+
+        get '/v1/apps'
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_rack_app(response, headers = {}, options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     headers = {
       "Content-Type" => "application/json"
     }.merge(headers)

data/test/middleware/stub_test.rb

@@ -112,6 +112,10 @@ describe Committee::Middleware::Stub do
   def new_rack_app(options = {})
     response = options.delete(:response)
     suppress = options.delete(:suppress)
+
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::Stub, options
       run lambda { |env|

data/test/request_unpacker_test.rb

@@ -100,7 +100,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = hyper_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = hyper_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       schema = JsonSchema::Schema.new
@@ -133,7 +136,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = open_api_3_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = open_api_3_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       params, _ = Committee::RequestUnpacker.new(
@@ -158,7 +164,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = open_api_3_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = open_api_3_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       params, _ = Committee::RequestUnpacker.new(

data/test/schema_validator/hyper_schema/router_test.rb

@@ -69,6 +69,8 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def hyper_schema_router(options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
     schema = Committee::Drivers::HyperSchema::Driver.new.parse(hyper_schema_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 
@@ -76,6 +78,8 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def open_api_2_router(options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
     schema = Committee::Drivers::OpenAPI2::Driver.new.parse(open_api_2_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -9,7 +9,12 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
     before do
       @path = '/validate'
       @method = 'post'
-      @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+
+      # TODO: delete when 5.0.0 released because default value changed
+      options = {}
+      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
+      @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
     end
 
     def operation_object
@@ -52,8 +57,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         operation_object.validate_request_params({"string" => 1}, HEADER, @validator_option)
       }
 
-      # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-      assert e.message.start_with?("1 class is #{1.class} but it's not valid")
+      assert_match(/expected string, but received Integer: 1/i, e.message)
     end
 
     it 'support put method' do
@@ -64,8 +68,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         operation_object.validate_request_params({"string" => 1}, HEADER, @validator_option)
       }
 
-      # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-      assert e.message.start_with?("1 class is #{1.class} but it's not valid")
+      assert_match(/expected string, but received Integer: 1/i, e.message)
     end
 
     it 'support patch method' do
@@ -76,7 +79,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         operation_object.validate_request_params({"integer" => "str"}, HEADER, @validator_option)
       }
 
-      assert e.message.start_with?("str class is String but it's not valid")
+      assert_match(/expected integer, but received String: str/i, e.message)
     end
 
     it 'unknown param' do
@@ -109,7 +112,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
           operation_object.validate_request_params({"query_integer_list" => [1, 2]}, HEADER, @validator_option)
         }
 
-        assert e.message.start_with?("required parameters query_string not exist in")
+        assert_match(/missing required parameters: query_string/i, e.message)
       end
 
       it 'invalid type' do
@@ -121,8 +124,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
           )
         }
 
-        # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-        assert e.message.start_with?("1 class is #{1.class} but")
+        assert_match(/expected string, but received Integer: 1/i, e.message)
       end
     end
 
@@ -143,7 +145,23 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
           operation_object.validate_request_params({"limit" => "a"}, HEADER, @validator_option)
         }
 
-        assert e.message.start_with?("a class is String but")
+        assert_match(/expected integer, but received String: a/i, e.message)
+      end
+    end
+
+    describe '#content_types' do
+      it 'returns supported content types' do
+        @path = '/validate_content_types'
+        @method = 'post'
+
+        assert_equal ["application/json", "application/binary"], operation_object.request_content_types
+      end
+
+      it 'returns an empty array when the content of requestBody does not exist' do
+        @path = '/characters'
+        @method = 'get'
+
+        assert_equal [], operation_object.request_content_types
       end
     end
   end

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -10,7 +10,7 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       @app
     end
 
-    it "skip validaiton when link does not exist" do
+    it "skip validation when link does not exist" do
       @app = new_rack_app(schema: open_api_3_schema)
       params = {}
       header "Content-Type", "application/json"
@@ -21,11 +21,34 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
     it "optionally content_type check" do
       @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
       params = {
-          "string_post_1" => "cloudnasium"
+        "string_post_1" => "cloudnasium"
       }
       header "Content-Type", "text/html"
       post "/characters", JSON.generate(params)
       assert_equal 400, last_response.status
+
+      body = JSON.parse(last_response.body)
+      message =
+          %{"Content-Type" request header must be set to "application/json".}
+
+      assert_equal "bad_request", body['id']
+      assert_equal message, body['message']
+    end
+
+    it "validates content_type" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      params = {
+        "string_post_1" => "cloudnasium"
+      }
+      header "Content-Type", "text/html"
+      post "/validate_content_types", JSON.generate(params)
+      assert_equal 400, last_response.status
+
+      body = JSON.parse(last_response.body)
+      message =
+        %{"Content-Type" request header must be set to any of the following: ["application/json", "application/binary"].}
+
+      assert_equal message, body['message']
     end
 
     it "optionally skip content_type check" do
@@ -38,7 +61,7 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       assert_equal 200, last_response.status
     end
 
-    it "if not exist requsetBody definition, skip content_type check" do
+    it "if not exist requestBody definition, skip content_type check" do
       @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
       params = {
           "string_post_1" => "cloudnasium"
@@ -49,6 +72,9 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
     end
 
     def new_rack_app(options = {})
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+    
       Rack::Builder.new {
         use Committee::Middleware::RequestValidation, options
         run lambda { |_|

data/test/schema_validator/open_api_3/response_validator_test.rb

@@ -12,7 +12,12 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
 
     @path = '/validate'
     @method = 'post'
-    @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+
+    # TODO: delete when 5.0.0 released because default value changed
+    options = {}
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+    
+    @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
   end
 
   it "passes through a valid response" do
@@ -29,7 +34,7 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
-  it "passes through a valid response with no registered Content-Type with strict = true" do
+  it "raises InvalidResponse when a valid response with no registered body with strict option" do
     @headers = { "Content-Type" => "application/xml" }
     assert_raises(Committee::InvalidResponse) {
       call_response_validator(true)
@@ -41,7 +46,7 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
-  it "passes through a valid response with no Content-Type with strict option" do
+  it "raises InvalidResponse when a valid response with no Content-Type headers with strict option" do
     @headers = {}
     assert_raises(Committee::InvalidResponse) {
       call_response_validator(true)

data/test/test/methods_new_version_test.rb

@@ -30,6 +30,9 @@ describe Committee::Test::Methods do
     @committee_schema = nil
 
     @committee_options = {schema: hyper_schema}
+
+    # TODO: delete when 5.0.0 released because default value changed
+    @committee_options[:parse_response_by_content_type] = false
   end
 
   describe "#assert_schema_conform" do

data/test/test/methods_test.rb

@@ -28,7 +28,10 @@ describe Committee::Test::Methods do
     # our purposes here in testing the module.
     @committee_router = nil
     @committee_schema = nil
-    @committee_options = nil
+    @committee_options = {}
+
+    # TODO: delete when 5.0.0 released because default value changed
+    @committee_options[:parse_response_by_content_type] = true
   end
 
   describe "Hyper-Schema" do
@@ -36,7 +39,7 @@ describe Committee::Test::Methods do
       sc = JsonSchema.parse!(hyper_schema_data)
       sc.expand_references!
       s = Committee::Drivers::HyperSchema::Driver.new.parse(sc)
-      @committee_options = {schema: s}
+      @committee_options.merge!({schema: s})
     end
 
     describe "#assert_schema_conform" do
@@ -120,7 +123,7 @@ describe Committee::Test::Methods do
 
   describe "OpenAPI3" do
     before do
-      @committee_options = {schema: open_api_3_schema}
+      @committee_options.merge!({schema: open_api_3_schema})
 
       @correct_response = { string_1: :honoka }
     end
@@ -138,7 +141,7 @@ describe Committee::Test::Methods do
         e = assert_raises(Committee::InvalidResponse) do
           assert_schema_conform
         end
-        assert_match(/don't exist response definition/i, e.message)
+        assert_match(/response definition does not exist/i, e.message)
       end
 
       it "detects an invalid response status code" do
@@ -149,7 +152,7 @@ describe Committee::Test::Methods do
         e = assert_raises(Committee::InvalidResponse) do
           assert_schema_conform
         end
-        assert_match(/don't exist status code definition/i, e.message)
+        assert_match(/status code definition does not exist/i, e.message)
       end
 
       it "outputs deprecation warning" do
@@ -175,7 +178,8 @@ describe Committee::Test::Methods do
         e = assert_raises(Committee::InvalidRequest) do
           assert_request_schema_confirm
         end
-        assert_match(/required parameters query_string not exist in #\/paths/i, e.message)
+
+        assert_match(/missing required parameters: query_string/i, e.message)
       end
 
       it "path undefined in schema" do
@@ -201,7 +205,7 @@ describe Committee::Test::Methods do
         e = assert_raises(Committee::InvalidResponse) do
           assert_response_schema_confirm
         end
-        assert_match(/don't exist response definition/i, e.message)
+        assert_match(/response definition does not exist/i, e.message)
       end
 
       it "detects an invalid response status code" do
@@ -212,7 +216,7 @@ describe Committee::Test::Methods do
         e = assert_raises(Committee::InvalidResponse) do
           assert_response_schema_confirm
         end
-        assert_match(/don't exist status code definition/i, e.message)
+        assert_match(/status code definition does not exist/i, e.message)
       end
 
       it "path undefined in schema" do

data/test/test_helper.rb

@@ -56,7 +56,7 @@ def open_api_2_schema
 end
 
 def open_api_3_schema
-  @open_api_3_schema ||= Committee::Drivers.load_from_data(open_api_3_data)
+  @open_api_3_schema ||= Committee::Drivers.load_from_file(open_api_3_schema_path)
 end
 
 # Don't cache this because we'll often manipulate the created hash in tests.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -52,14 +52,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +282,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.