committee 4.4.0 → 5.0.0

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -32,12 +32,15 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
     ]
 
     it 'correct data' do
-      operation_object.validate_request_params(SCHEMA_PROPERTIES_PAIR.to_h, HEADER, @validator_option)
+      operation_object.validate_request_params({}, {}, SCHEMA_PROPERTIES_PAIR.to_h, HEADER, @validator_option)
       assert true
     end
 
     it 'correct object data' do
-      operation_object.validate_request_params({
+      operation_object.validate_request_params(
+                                  {},
+                                  {},
+                                  {
                                      "object_1" =>
                                          {
                                              "string_1" => nil,
@@ -54,7 +57,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
 
     it 'invalid params' do
       e = assert_raises(Committee::InvalidRequest) {
-        operation_object.validate_request_params({"string" => 1}, HEADER, @validator_option)
+        operation_object.validate_request_params({}, {}, {"string" => 1}, HEADER, @validator_option)
       }
 
       assert_match(/expected string, but received Integer: 1/i, e.message)
@@ -63,10 +66,10 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
 
     it 'support put method' do
       @method = "put"
-      operation_object.validate_request_params({"string" => "str"}, HEADER, @validator_option)
+      operation_object.validate_request_params({}, {}, {"string" => "str"}, HEADER, @validator_option)
 
       e = assert_raises(Committee::InvalidRequest) {
-        operation_object.validate_request_params({"string" => 1}, HEADER, @validator_option)
+        operation_object.validate_request_params({}, {}, {"string" => 1}, HEADER, @validator_option)
       }
 
       assert_match(/expected string, but received Integer: 1/i, e.message)
@@ -75,10 +78,10 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
 
     it 'support patch method' do
       @method = "patch"
-      operation_object.validate_request_params({"integer" => 1}, HEADER, @validator_option)
+      operation_object.validate_request_params({}, {}, {"integer" => 1}, HEADER, @validator_option)
 
       e = assert_raises(Committee::InvalidRequest) {
-        operation_object.validate_request_params({"integer" => "str"}, HEADER, @validator_option)
+        operation_object.validate_request_params({}, {}, {"integer" => "str"}, HEADER, @validator_option)
       }
 
       assert_match(/expected integer, but received String: "str"/i, e.message)
@@ -86,7 +89,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
     end
 
     it 'unknown param' do
-      operation_object.validate_request_params({"unknown" => 1}, HEADER, @validator_option)
+      operation_object.validate_request_params({}, {}, {"unknown" => 1}, HEADER, @validator_option)
     end
 
     describe 'support get method' do
@@ -96,13 +99,17 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
 
       it 'correct' do
         operation_object.validate_request_params(
+            {},
             {"query_string" => "query", "query_integer_list" => [1, 2]},
+            {},
             HEADER,
             @validator_option
         )
 
         operation_object.validate_request_params(
+            {},
             {"query_string" => "query", "query_integer_list" => [1, 2], "optional_integer" => 1},
+            {},
             HEADER,
             @validator_option
         )
@@ -112,7 +119,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
 
       it 'not exist required' do
         e = assert_raises(Committee::InvalidRequest) {
-          operation_object.validate_request_params({"query_integer_list" => [1, 2]}, HEADER, @validator_option)
+          operation_object.validate_request_params({}, {"query_integer_list" => [1, 2]}, {}, HEADER, @validator_option)
         }
 
         assert_match(/missing required parameters: query_string/i, e.message)
@@ -122,7 +129,9 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
       it 'invalid type' do
         e = assert_raises(Committee::InvalidRequest) {
           operation_object.validate_request_params(
+              {},
               {"query_string" => 1, "query_integer_list" => [1, 2], "optional_integer" => 1},
+              {},
               HEADER,
               @validator_option
           )
@@ -140,14 +149,14 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
       end
 
       it 'correct' do
-        operation_object.validate_request_params({"limit" => "1"}, HEADER, @validator_option)
+        operation_object.validate_request_params({}, {"limit" => "1"}, {}, HEADER, @validator_option)
 
         assert true
       end
 
       it 'invalid type' do
         e = assert_raises(Committee::InvalidRequest) {
-          operation_object.validate_request_params({"limit" => "a"}, HEADER, @validator_option)
+          operation_object.validate_request_params({}, {"limit" => "a"}, {}, HEADER, @validator_option)
         }
 
         assert_match(/expected integer, but received String: "a"/i, e.message)
@@ -155,6 +164,41 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
       end
     end
 
+    describe 'support head method' do
+      before do
+        @path = '/characters'
+        @method = 'head'
+      end
+
+      it 'correct' do
+        operation_object.validate_request_params({}, {"limit" => "1"}, {}, HEADER, @validator_option)
+
+        assert true
+      end
+
+      it 'invalid type' do
+        e = assert_raises(Committee::InvalidRequest) {
+          operation_object.validate_request_params({}, {"limit" => "a"}, {}, HEADER, @validator_option)
+        }
+
+        assert_match(/expected integer, but received String: "a"/i, e.message)
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+      end
+    end
+
+    it 'support options method' do
+      @method = "options"
+      operation_object.validate_request_params({}, {}, {"integer" => 1}, HEADER, @validator_option)
+
+      e = assert_raises(Committee::InvalidRequest) {
+        operation_object.validate_request_params({}, {}, {"integer" => "str"}, HEADER, @validator_option)
+      }
+
+      assert_match(/expected integer, but received String: "str"/i, e.message)
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+    end
+
+
     describe '#content_types' do
       it 'returns supported content types' do
         @path = '/validate_content_types'

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -71,10 +71,34 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       assert_equal 200, last_response.status
     end
 
+    it "skips content_type check with an empty body" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      header "Content-Type", "application/x-www-form-urlencoded"
+      patch "/validate_empty_optional_body"
+      assert_equal 200, last_response.status
+    end
+    
+    it "does not mix up parameters and requestBody" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      params = {
+          "last_name" => "Skywalker"
+      }
+      header "Content-Type", "application/json"
+      post "/additional_properties?first_name=Luke", JSON.generate(params)
+      assert_equal 200, last_response.status
+    end
+
+    it "error because content_type check with body" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      header "Content-Type", "application/x-www-form-urlencoded"
+      patch "/validate_empty_optional_body", "{}"
+      assert_equal 400, last_response.status
+    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

@@ -42,6 +42,15 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
   end
 
+  it "raises InvalidResponse when a invalid status code with strict option" do
+    @status = 201
+    e = assert_raises(Committee::InvalidResponse) {
+      call_response_validator(true)
+    }
+
+    assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+  end
+
   it "passes through a valid response with no Content-Type" do
     @headers = {}
     call_response_validator
@@ -67,6 +76,11 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
+  it "passes through a 304 Not Modified response" do
+    @status, @headers, @data = 304, {}, nil
+    call_response_validator
+  end
+
   private
 
   def call_response_validator(strict = false)

data/test/test/methods_new_version_test.rb

@@ -72,7 +72,7 @@ describe Committee::Test::Methods do
       @committee_options.merge!(validate_success_only: true)
       @app = new_rack_app(JSON.generate([ValidApp]), 400, {})
       get "/apps"
-      assert_schema_conform
+      assert_schema_conform(400)
     end
 
     it "detects an invalid response Content-Type and check all status code" do

data/test/test/methods_test.rb

@@ -57,16 +57,6 @@ describe Committee::Test::Methods do
         end
         assert_match(/response header must be set to/i, e.message)
       end
-
-      it "outputs deprecation warning" do
-        @app = new_rack_app(JSON.generate([ValidApp]))
-        get "/apps"
-        _, err = capture_io do
-          assert_schema_conform
-        end
-        assert_match(/\[DEPRECATION\] Now assert_schema_conform check response schema only/i, err)
-        assert_match(/\[DEPRECATION\] Pass expected response status code/i, err)
-      end
     end
 
     describe "assert_request_schema_confirm" do
@@ -99,14 +89,14 @@ describe Committee::Test::Methods do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate([ValidApp]))
         get "/apps"
-        assert_response_schema_confirm
+        assert_response_schema_confirm(200)
       end
 
       it "detects an invalid response Content-Type" do
         @app = new_rack_app(JSON.generate([ValidApp]), {})
         get "/apps"
         e = assert_raises(Committee::InvalidResponse) do
-          assert_response_schema_confirm
+          assert_response_schema_confirm(200)
         end
         assert_match(/response header must be set to/i, e.message)
       end
@@ -133,14 +123,14 @@ describe Committee::Test::Methods do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate(@correct_response))
         get "/characters"
-        assert_schema_conform
+        assert_schema_conform(200)
       end
 
       it "detects an invalid response Content-Type" do
         @app = new_rack_app(JSON.generate([@correct_response]), {})
         get "/characters"
         e = assert_raises(Committee::InvalidResponse) do
-          assert_schema_conform
+          assert_schema_conform(200)
         end
         assert_match(/response definition does not exist/i, e.message)
       end
@@ -151,20 +141,10 @@ describe Committee::Test::Methods do
         get "/characters"
 
         e = assert_raises(Committee::InvalidResponse) do
-          assert_schema_conform
+          assert_schema_conform(419)
         end
         assert_match(/status code definition does not exist/i, e.message)
       end
-
-      it "outputs deprecation warning" do
-        @app = new_rack_app(JSON.generate(@correct_response))
-        get "/characters"
-        _, err = capture_io do
-          assert_schema_conform
-        end
-        assert_match(/\[DEPRECATION\] Now assert_schema_conform check response schema only/i, err)
-        assert_match(/\[DEPRECATION\] Pass expected response status code/i, err)
-      end
     end
 
     describe "assert_request_schema_confirm" do
@@ -198,14 +178,14 @@ describe Committee::Test::Methods do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate(@correct_response))
         get "/characters"
-        assert_response_schema_confirm
+        assert_response_schema_confirm(200)
       end
 
       it "detects an invalid response Content-Type" do
         @app = new_rack_app(JSON.generate([@correct_response]), {})
         get "/characters"
         e = assert_raises(Committee::InvalidResponse) do
-          assert_response_schema_confirm
+          assert_response_schema_confirm(200)
         end
         assert_match(/response definition does not exist/i, e.message)
       end
@@ -216,7 +196,7 @@ describe Committee::Test::Methods do
         get "/characters"
 
         e = assert_raises(Committee::InvalidResponse) do
-          assert_response_schema_confirm
+          assert_response_schema_confirm(419)
         end
         assert_match(/status code definition does not exist/i, e.message)
       end
@@ -249,7 +229,7 @@ describe Committee::Test::Methods do
         end
         it 'records openapi coverage' do
           get "/posts"
-          assert_response_schema_confirm
+          assert_response_schema_confirm(200)
           assert_equal({
             '/threads/{id}' => {
               'get' => {
@@ -290,7 +270,7 @@ describe Committee::Test::Methods do
         it 'can record openapi coverage correctly when prefix is set' do
           @committee_options.merge!(prefix: '/api')
           post "/api/likes"
-          assert_response_schema_confirm
+          assert_response_schema_confirm(200)
           assert_equal({
             '/threads/{id}' => {
               'get' => {
@@ -330,7 +310,7 @@ describe Committee::Test::Methods do
 
         it 'records openapi coverage correctly with path param' do
           get "/threads/asd"
-          assert_response_schema_confirm
+          assert_response_schema_confirm(200)
           assert_equal({
             '/threads/{id}' => {
               'get' => {

data/test/test_helper.rb

@@ -11,8 +11,10 @@ SimpleCov.start do
   add_filter "/test/"
 
   # This library has a pretty modest number of lines, so let's try to stick
-  # to a 100% coverage target for a while and see what happens.
-  minimum_coverage 100
+  # to a 99% coverage target for a while and see what happens.
+  # We can't use 100% because old rack version doesn't support media_type and it's not testable :(
+  # https://github.com/interagent/committee/pull/360/files#diff-ce1125b6594690a88a70dbe2869f7fcfa2962c2bca80751f3720888920e2dfabR54
+  minimum_coverage 99
 end
 
 require "minitest"
@@ -60,11 +62,11 @@ def open_api_2_form_schema
 end
 
 def open_api_3_schema
-  @open_api_3_schema ||= Committee::Drivers.load_from_file(open_api_3_schema_path)
+  @open_api_3_schema ||= Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true})
 end
 
 def open_api_3_coverage_schema
-  @open_api_3_coverage_schema ||= Committee::Drivers.load_from_file(open_api_3_coverage_schema_path)
+  @open_api_3_coverage_schema ||= Committee::Drivers.load_from_file(open_api_3_coverage_schema_path, parser_options:{strict_reference_validation: true})
 end
 
 # Don't cache this because we'll often manipulate the created hash in tests.
@@ -82,7 +84,11 @@ def open_api_2_form_data
 end
 
 def open_api_3_data
-  YAML.load_file(open_api_3_schema_path)
+  if YAML.respond_to?(:unsafe_load_file)
+    YAML.unsafe_load_file(open_api_3_schema_path)
+  else
+    YAML.load_file(open_api_3_schema_path)
+  end
 end
 
 def hyper_schema_schema_path
@@ -108,3 +114,7 @@ end
 def open_api_3_0_1_schema_path
   "./test/data/openapi3/3_0_1.yaml"
 end
+
+def open_api_3_invalid_reference_path
+  "./test/data/openapi3/invalid_reference.yaml"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -50,20 +50,14 @@ dependencies:
   name: openapi_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -86,14 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +269,7 @@ files:
 - lib/committee/test/schema_coverage.rb
 - lib/committee/utils.rb
 - lib/committee/validation_error.rb
+- lib/committee/version.rb
 - test/bin/committee_stub_test.rb
 - test/bin_test.rb
 - test/committee_test.rb
@@ -319,14 +314,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.