committee 5.6.1 → 5.6.2

data/test/schema_validator_test.rb

@@ -20,4 +20,12 @@ describe Committee::SchemaValidator do
     media_type = Committee::SchemaValidator.request_media_type(request)
     assert_equal 'multipart/form-data', media_type
   end
+
+  it "builds prefix regexp with a path segment boundary" do
+    regexp = Committee::SchemaValidator.build_prefix_regexp("/v1")
+
+    assert regexp.match?("/v1")
+    assert regexp.match?("/v1/characters")
+    refute regexp.match?("/v11/characters")
+  end
 end

data/test/test/methods_test.rb

@@ -169,6 +169,225 @@ describe Committee::Test::Methods do
         end
         assert_match(/`GET \/undefined` undefined in schema/i, e.message)
       end
+
+      describe "with except option" do
+        it "passes validation when required query parameter is excepted" do
+          @app = new_rack_app
+          # Missing required 'data' parameter, but except it
+          get "/get_endpoint_with_required_parameter"
+          assert_request_schema_confirm(except: { query: ['data'] })
+        end
+
+        it "still validates other parameters when some are excepted" do
+          @app = new_rack_app
+          # Missing required 'data' parameter, but except it
+          # This test verifies that the except option works
+          get "/get_endpoint_with_required_parameter"
+          assert_request_schema_confirm(except: { query: ['data'] })
+        end
+
+        it "works without except option (backward compatibility)" do
+          @app = new_rack_app
+          get "/characters"
+          assert_request_schema_confirm
+        end
+
+        it "supports multiple parameter types" do
+          @app = new_rack_app
+          # Can except headers, query, and body parameters
+          get "/get_endpoint_with_required_parameter"
+          assert_request_schema_confirm(except: { headers: ['authorization'], query: ['data'] })
+        end
+
+        it "supports multiple parameters in each type" do
+          @app = new_rack_app
+          # Can except multiple parameters in each type simultaneously
+          get "/get_endpoint_with_required_parameter"
+          assert_request_schema_confirm(except: { headers: ['content-type', 'authorization', 'accept'], query: ['data', 'page', 'limit'] })
+        end
+
+        it "raises error when non-excepted required parameter is missing" do
+          @app = new_rack_app
+          # Except only 'required_param_a', but 'required_param_b' is also required and missing
+          # This should raise an error for 'required_param_b'
+          get "/test_except_validation"
+
+          e = assert_raises(Committee::InvalidRequest) do
+            assert_request_schema_confirm(except: { query: ['required_param_a'] })
+          end
+          # Verify error is about the non-excepted missing parameter
+          assert_match(/required_param_b/i, e.message)
+        end
+
+        describe "with body params" do
+          it "passes validation when required string body param is excepted" do
+            @app = new_rack_app
+            post "/test_except_body_params", JSON.generate({ "required_integer" => 1 }), { "CONTENT_TYPE" => "application/json" }
+            assert_request_schema_confirm(except: { body: ['required_string'] })
+          end
+
+          it "passes validation when required integer body param is excepted" do
+            @app = new_rack_app
+            post "/test_except_body_params", JSON.generate({ "required_string" => "foo" }), { "CONTENT_TYPE" => "application/json" }
+            assert_request_schema_confirm(except: { body: ['required_integer'] })
+          end
+
+          it "passes validation when all required body params are excepted" do
+            @app = new_rack_app
+            post "/test_except_body_params", nil, { "CONTENT_TYPE" => "application/json" }
+            assert_request_schema_confirm(except: { body: ['required_string', 'required_integer'] })
+          end
+
+          it "raises error when non-excepted required body param is missing" do
+            @app = new_rack_app
+            post "/test_except_body_params", nil, { "CONTENT_TYPE" => "application/json" }
+            e = assert_raises(Committee::InvalidRequest) do
+              assert_request_schema_confirm(except: { body: ['required_string'] })
+            end
+            assert_match(/required_integer/i, e.message)
+          end
+
+          describe "non-string types and format constraints" do
+            it "passes validation when required integer query param is excepted" do
+              @app = new_rack_app
+              get "/get_endpoint_with_required_integer_query"
+              assert_request_schema_confirm(except: { query: ['count'] })
+            end
+
+            it "passes validation when required integer header is excepted" do
+              @app = new_rack_app
+              get "/header"
+              assert_request_schema_confirm(except: { headers: ['integer'] })
+            end
+
+            it "passes validation when required enum body param is excepted" do
+              @app = new_rack_app
+              post "/test_except_body_with_constraints", JSON.generate({ "created_at" => "2024-01-01T00:00:00Z" }), { "CONTENT_TYPE" => "application/json" }
+              assert_request_schema_confirm(except: { body: ['status'] })
+            end
+
+            it "passes validation when required date-time format body param is excepted" do
+              @app = new_rack_app
+              post "/test_except_body_with_constraints", JSON.generate({ "status" => "active" }), { "CONTENT_TYPE" => "application/json" }
+              assert_request_schema_confirm(except: { body: ['created_at'] })
+            end
+          end
+
+          describe "with form-encoded body params" do
+            it "passes validation when required string form param is excepted" do
+              @app = new_rack_app
+              post "/test_except_form_params", "required_integer=1", { "CONTENT_TYPE" => "application/x-www-form-urlencoded" }
+              assert_request_schema_confirm(except: { body: ['required_string'] })
+            end
+
+            it "passes validation when required integer form param is excepted" do
+              @app = new_rack_app
+              post "/test_except_form_params", "required_string=foo", { "CONTENT_TYPE" => "application/x-www-form-urlencoded" }
+              assert_request_schema_confirm(except: { body: ['required_integer'] })
+            end
+
+            it "passes validation when all required form params are excepted" do
+              @app = new_rack_app
+              post "/test_except_form_params", "", { "CONTENT_TYPE" => "application/x-www-form-urlencoded" }
+              assert_request_schema_confirm(except: { body: ['required_string', 'required_integer'] })
+            end
+
+            it "raises error when non-excepted required form param is missing" do
+              @app = new_rack_app
+              post "/test_except_form_params", "", { "CONTENT_TYPE" => "application/x-www-form-urlencoded" }
+              e = assert_raises(Committee::InvalidRequest) do
+                assert_request_schema_confirm(except: { body: ['required_string'] })
+              end
+              assert_match(/required_integer/i, e.message)
+            end
+          end
+
+          describe "with special rack headers" do
+            it "passes validation when required Content-Type header is excepted" do
+              @app = new_rack_app
+              post "/test_except_content_type_header", nil
+              assert_request_schema_confirm(except: { headers: ['Content-Type'] })
+            end
+          end
+
+          describe "does not overwrite existing values" do
+            it "leaves an existing query param value unchanged when it is excepted" do
+              @app = new_rack_app
+              get "/get_endpoint_with_required_parameter", "data" => "existing_value"
+              before_value = last_request.GET["data"]
+              assert_request_schema_confirm(except: { query: ['data'] })
+              assert_equal before_value, last_request.GET["data"]
+            end
+          end
+
+          describe "with vnd.api+json content type" do
+            it "treats application/vnd.api+json body as JSON and injects dummy values" do
+              @app = new_rack_app
+              post "/test_except_vnd_json_body", JSON.generate({}), { "CONTENT_TYPE" => "application/vnd.api+json" }
+              assert_request_schema_confirm(except: { body: ['required_string'] })
+            end
+          end
+
+          describe "with schema_path option" do
+            before do
+              @committee_options = { schema_path: open_api_3_schema_path }
+            end
+
+            it "passes validation when required integer query param is excepted" do
+              @app = new_rack_app
+              get "/get_endpoint_with_required_integer_query"
+              assert_request_schema_confirm(except: { query: ['count'] })
+            end
+          end
+
+          describe "with path item-level parameters" do
+            it "passes validation when required integer query param declared at path level is excepted" do
+              @app = new_rack_app
+              get "/test_path_level_required_integer"
+              assert_request_schema_confirm(except: { query: ['count'] })
+            end
+          end
+
+          describe "with multiple content-type body" do
+            it "uses the correct schema for form-urlencoded when excepting a body param" do
+              @app = new_rack_app
+              post "/test_multi_content_type_body", "", "CONTENT_TYPE" => "application/x-www-form-urlencoded"
+              assert_request_schema_confirm(except: { body: ['status'] })
+            end
+          end
+
+          describe "with non-hash JSON body" do
+            it "raises BadRequest when JSON body is an array" do
+              @app = new_rack_app
+              post "/test_except_body_params", "[1,2,3]", "CONTENT_TYPE" => "application/json"
+              assert_raises(Committee::BadRequest) do
+                assert_request_schema_confirm(except: { body: ['required_string'] })
+              end
+            end
+          end
+
+          describe "error recovery" do
+            it "restores partially-applied params when JSON body parsing raises mid-apply" do
+              # Scenario: HeaderHandler injects a dummy header, then BodyHandler fails
+              # to parse an invalid JSON body (JSON::ParserError). With apply() outside
+              # the ensure block the injected header would not be restored. This test
+              # verifies that all side-effects from apply() are rolled back even when
+              # apply() itself raises.
+              @app = new_rack_app
+              post "/test_except_body_params", 'invalid-json', { "CONTENT_TYPE" => "application/json" }
+
+              assert_nil last_request.env['HTTP_AUTHORIZATION']
+
+              assert_raises(JSON::ParserError) do
+                assert_request_schema_confirm(except: { headers: ['authorization'], body: ['required_string'] })
+              end
+
+              assert_nil last_request.env['HTTP_AUTHORIZATION']
+            end
+          end
+
+        end
+      end
     end
 
     describe "#assert_response_schema_confirm" do
@@ -227,122 +446,20 @@ describe Committee::Test::Methods do
         it 'records openapi coverage' do
           get "/posts"
           assert_response_schema_confirm(200)
-          assert_equal({
-            '/threads/{id}' => {
-              'get' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-            '/posts' => {
-              'get' => {
-                'responses' => {
-                  '200' => true,
-                  '404' => false,
-                  'default' => false,
-                },
-              },
-              'post' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-            '/likes' => {
-              'post' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-              'delete' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-          }, @schema_coverage.report)
+          assert_equal({ '/threads/{id}' => { 'get' => { 'responses' => { '200' => false, }, }, }, '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => false, 'default' => false, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => false, }, }, 'delete' => { 'responses' => { '200' => false, }, }, }, }, @schema_coverage.report)
         end
 
         it 'can record openapi coverage correctly when prefix is set' do
           @committee_options.merge!(prefix: '/api')
           post "/api/likes"
           assert_response_schema_confirm(200)
-          assert_equal({
-            '/threads/{id}' => {
-              'get' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-            '/posts' => {
-              'get' => {
-                'responses' => {
-                  '200' => false,
-                  '404' => false,
-                  'default' => false,
-                },
-              },
-              'post' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-            '/likes' => {
-              'post' => {
-                'responses' => {
-                  '200' => true,
-                },
-              },
-              'delete' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-          }, @schema_coverage.report)
+          assert_equal({ '/threads/{id}' => { 'get' => { 'responses' => { '200' => false, }, }, }, '/posts' => { 'get' => { 'responses' => { '200' => false, '404' => false, 'default' => false, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => true, }, }, 'delete' => { 'responses' => { '200' => false, }, }, }, }, @schema_coverage.report)
         end
 
         it 'records openapi coverage correctly with path param' do
           get "/threads/asd"
           assert_response_schema_confirm(200)
-          assert_equal({
-            '/threads/{id}' => {
-              'get' => {
-                'responses' => {
-                  '200' => true,
-                },
-              },
-            },
-            '/posts' => {
-              'get' => {
-                'responses' => {
-                  '200' => false,
-                  '404' => false,
-                  'default' => false,
-                },
-              },
-              'post' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-            '/likes' => {
-              'post' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-              'delete' => {
-                'responses' => {
-                  '200' => false,
-                },
-              },
-            },
-          }, @schema_coverage.report)
+          assert_equal({ '/threads/{id}' => { 'get' => { 'responses' => { '200' => true, }, }, }, '/posts' => { 'get' => { 'responses' => { '200' => false, '404' => false, 'default' => false, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => false, }, }, 'delete' => { 'responses' => { '200' => false, }, }, }, }, @schema_coverage.report)
         end
       end
     end

data/test/test/schema_coverage_test.rb

@@ -22,182 +22,35 @@ describe Committee::Test::SchemaCoverage do
     it 'can record and report coverage properly' do
       @schema_coverage.update_response_coverage!('/posts', 'get', '200')
       assert_equal(['/posts get 200',], covered_responses)
-      assert_equal([
-        '/threads/{id} get 200',
-        '/posts get 404',
-        '/posts get default',
-        '/posts post 200',
-        '/likes post 200',
-        '/likes delete 200',
-      ], uncovered_responses)
+      assert_equal(['/threads/{id} get 200', '/posts get 404', '/posts get default', '/posts post 200', '/likes post 200', '/likes delete 200',], uncovered_responses)
 
       @schema_coverage.update_response_coverage!('/likes', 'post', '200')
       assert_equal(['/posts get 200', '/likes post 200',], covered_responses)
-      assert_equal([
-        '/threads/{id} get 200',
-        '/posts get 404',
-        '/posts get default',
-        '/posts post 200',
-        '/likes delete 200',
-      ], uncovered_responses)
+      assert_equal(['/threads/{id} get 200', '/posts get 404', '/posts get default', '/posts post 200', '/likes delete 200',], uncovered_responses)
 
       @schema_coverage.update_response_coverage!('/likes', 'delete', '200')
       assert_equal(['/posts get 200', '/likes post 200', '/likes delete 200',], covered_responses)
-      assert_equal([
-        '/threads/{id} get 200',
-        '/posts get 404',
-        '/posts get default',
-        '/posts post 200',
-      ], uncovered_responses)
+      assert_equal(['/threads/{id} get 200', '/posts get 404', '/posts get default', '/posts post 200',], uncovered_responses)
 
       @schema_coverage.update_response_coverage!('/posts', 'get', '422')
-      assert_equal([
-        '/posts get 200',
-        '/posts get default',
-        '/likes post 200',
-        '/likes delete 200',
-      ], covered_responses)
+      assert_equal(['/posts get 200', '/posts get default', '/likes post 200', '/likes delete 200',], covered_responses)
       assert_equal(['/threads/{id} get 200', '/posts get 404', '/posts post 200',], uncovered_responses)
 
-      assert_equal({
-        '/threads/{id}' => {
-          'get' => {
-            'responses' => {
-              '200' => false,
-            },
-          },
-        },
-        '/posts' => {
-          'get' => {
-            'responses' => {
-              '200' => true,
-              '404' => false,
-              'default' => true,
-            },
-          },
-          'post' => {
-            'responses' => {
-              '200' => false,
-            },
-          },
-        },
-        '/likes' => {
-          'post' => {
-            'responses' => {
-              '200' => true,
-            },
-          },
-          'delete' => {
-            'responses' => {
-              '200' => true,
-            },
-          },
-        },
-      }, @schema_coverage.report)
+      assert_equal({ '/threads/{id}' => { 'get' => { 'responses' => { '200' => false, }, }, }, '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => false, 'default' => true, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => true, }, }, 'delete' => { 'responses' => { '200' => true, }, }, }, }, @schema_coverage.report)
 
       @schema_coverage.update_response_coverage!('/posts', 'post', '200')
       @schema_coverage.update_response_coverage!('/posts', 'get', '404')
       @schema_coverage.update_response_coverage!('/threads/{id}', 'get', '200')
-      assert_equal([
-        '/threads/{id} get 200',
-        '/posts get 200',
-        '/posts get 404',
-        '/posts get default',
-        '/posts post 200',
-        '/likes post 200',
-        '/likes delete 200',
-      ], covered_responses)
+      assert_equal(['/threads/{id} get 200', '/posts get 200', '/posts get 404', '/posts get default', '/posts post 200', '/likes post 200', '/likes delete 200',], covered_responses)
       assert_equal([], uncovered_responses)
     end
   end
 
   describe '.merge_report' do
     it 'can merge 2 coverage reports together' do
-      report = Committee::Test::SchemaCoverage.merge_report(
-        {
-          '/posts' => {
-            'get' => {
-              'responses' => {
-                '200' => true,
-                '404' => false,
-              },
-            },
-            'post' => {
-              'responses' => {
-                '200' => false,
-              },
-            },
-          },
-          '/likes' => {
-            'post' => {
-              'responses' => {
-                '200' => true,
-              },
-            },
-          },
-        },
-        {
-          '/posts' => {
-            'get' => {
-              'responses' => {
-                '200' => true,
-                '404' => true,
-              },
-            },
-            'post' => {
-              'responses' => {
-                '200' => false,
-              },
-            },
-          },
-          '/likes' => {
-            'post' => {
-              'responses' => {
-                '200' => false,
-                '400' => false,
-              },
-            },
-          },
-          '/users' => {
-            'get' => {
-              'responses' => {
-                '200' => true,
-              },
-            },
-          },
-        },
-      )
+      report = Committee::Test::SchemaCoverage.merge_report({ '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => false, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => true, }, }, }, }, { '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => true, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => false, '400' => false, }, }, }, '/users' => { 'get' => { 'responses' => { '200' => true, }, }, }, },)
 
-      assert_equal({
-        '/posts' => {
-          'get' => {
-            'responses' => {
-              '200' => true,
-              '404' => true,
-            },
-          },
-          'post' => {
-            'responses' => {
-              '200' => false,
-            },
-          },
-        },
-        '/likes' => {
-          'post' => {
-            'responses' => {
-              '200' => true,
-              '400' => false,
-            },
-          },
-        },
-        '/users' => {
-          'get' => {
-            'responses' => {
-              '200' => true,
-            },
-          },
-        },
-      }, report)
+      assert_equal({ '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => true, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => true, '400' => false, }, }, }, '/users' => { 'get' => { 'responses' => { '200' => true, }, }, }, }, report)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 5.6.1
+  version: 5.6.2
 platform: ruby
 authors:
 - Brandur
@@ -189,6 +189,10 @@ files:
 - lib/committee/errors.rb
 - lib/committee/middleware.rb
 - lib/committee/middleware/base.rb
+- lib/committee/middleware/options.rb
+- lib/committee/middleware/options/base.rb
+- lib/committee/middleware/options/request_validation.rb
+- lib/committee/middleware/options/response_validation.rb
 - lib/committee/middleware/request_validation.rb
 - lib/committee/middleware/response_validation.rb
 - lib/committee/middleware/stub.rb
@@ -203,10 +207,12 @@ files:
 - lib/committee/schema_validator/hyper_schema/string_params_coercer.rb
 - lib/committee/schema_validator/open_api_3.rb
 - lib/committee/schema_validator/open_api_3/operation_wrapper.rb
+- lib/committee/schema_validator/open_api_3/parameter_deserializer.rb
 - lib/committee/schema_validator/open_api_3/request_validator.rb
 - lib/committee/schema_validator/open_api_3/response_validator.rb
 - lib/committee/schema_validator/open_api_3/router.rb
 - lib/committee/schema_validator/option.rb
+- lib/committee/test/except_parameter.rb
 - lib/committee/test/methods.rb
 - lib/committee/test/schema_coverage.rb
 - lib/committee/utils.rb
@@ -224,6 +230,9 @@ files:
 - test/drivers/open_api_3/driver_test.rb
 - test/drivers_test.rb
 - test/middleware/base_test.rb
+- test/middleware/options/base_test.rb
+- test/middleware/options/request_validation_test.rb
+- test/middleware/options/response_validation_test.rb
 - test/middleware/request_validation_open_api_3_test.rb
 - test/middleware/request_validation_test.rb
 - test/middleware/response_validation_open_api_3_test.rb
@@ -237,6 +246,7 @@ files:
 - test/schema_validator/hyper_schema/router_test.rb
 - test/schema_validator/hyper_schema/string_params_coercer_test.rb
 - test/schema_validator/open_api_3/operation_wrapper_test.rb
+- test/schema_validator/open_api_3/parameter_deserializer_test.rb
 - test/schema_validator/open_api_3/request_validator_test.rb
 - test/schema_validator/open_api_3/response_validator_test.rb
 - test/schema_validator_test.rb
@@ -267,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.
 test_files: []