committee 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c313e8694c8ad00b4f0ed75ac173f177cb62c3cc18494a946df9b9066abbaa
-  data.tar.gz: 7080a9ec40c56d2d47fde358217068ac3dcc907528ac359e2a94089f9b9f068e
+  metadata.gz: 8ec0b5b55c4e5f1be93511f36d4ae210f7318232ab1aa421bbac14f3f172f2ef
+  data.tar.gz: 96ecf2cdc5e4053c1eec56c0ea5d27ec5c4353230b508385fd84f39f486a4baf
 SHA512:
-  metadata.gz: 4530289393371c110c67564e277dbfdaab9f6a83aff9cc3e8c625ee83a6fabb3fb4c1c0abd3e93d83577a8204143672ccab998e50aabccbc866cb619c43f698c
-  data.tar.gz: 91feff9fb8ee526fe0715ce12e570fe53782750ad823a44a31f549d738c0ce9d65421a1323568992e43dd16a4e202130fbd3f020ac836eab5a19a0626a59d5d0
+  metadata.gz: a5d0d3daa686424b1dbab55e684ca483aff5a060c423c1bdc6796fcf1bbf4de918595d94f8df579918067778c8ab311fb7ba0c4ed34c5d4246ef21600c35d2af
+  data.tar.gz: 90a8511576aae0756b4e817b3dc61e4b55b5e2fdb744b1125f5892e09b544a7b7e01c746b5b510d986031d6ecf072ed5f246e125745790e0eb0384d4fdee7f16

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

@@ -4,11 +4,12 @@ module Committee
   module SchemaValidator
     class HyperSchema
       class ResponseValidator
-        attr_reader :validate_success_only
+        attr_reader :allow_blank_structures, :validate_success_only
 
         def initialize(link, options = {})
           @link = link
           @validate_success_only = options[:validate_success_only]
+          @allow_blank_structures = options[:allow_blank_structures]
 
           @validator = JsonSchema::Validator.new(target_schema(link))
         end
@@ -39,9 +40,18 @@ module Committee
             return if data == nil
           end
 
-          if Committee::Middleware::ResponseValidation.validate?(status, validate_success_only) && !@validator.validate(data)
-            errors = JsonSchema::SchemaError.aggregate(@validator.errors).join("\n")
-            raise InvalidResponse, "Invalid response.\n\n#{errors}"
+          if allow_blank_structures && @link.is_a?(Committee::Drivers::OpenAPI2::Link) && !@link.target_schema
+            return if data.nil?
+          end
+
+          begin
+            if Committee::Middleware::ResponseValidation.validate?(status, validate_success_only) && !@validator.validate(data)
+              errors = JsonSchema::SchemaError.aggregate(@validator.errors).join("\n")
+              raise InvalidResponse, "Invalid response.\n\n#{errors}"
+            end
+          rescue => e
+            raise InvalidResponse, "Invalid response.\n\nschema is undefined" if /undefined method .all_of. for nil/ =~ e.message
+            raise e
           end
         end
 

data/lib/committee/schema_validator/hyper_schema.rb

@@ -33,7 +33,7 @@ module Committee
           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)
+        Committee::SchemaValidator::HyperSchema::ResponseValidator.new(link, validate_success_only: validator_option.validate_success_only, allow_blank_structures: validator_option.allow_blank_structures).call(status, headers, data)
       end
 
       def link_exist?

data/lib/committee/schema_validator/open_api_3.rb

@@ -97,7 +97,7 @@ module Committee
       end
 
       def copy_coerced_data_to_params(request)
-        order = if validator_option.parameter_overwite_by_rails_rule
+        order = if validator_option.parameter_overwrite_by_rails_rule
           # (high priority) path_hash_key -> query_param -> request_body_hash          
           [validator_option.request_body_hash_key, validator_option.query_hash_key, validator_option.path_hash_key]
         else

data/lib/committee/schema_validator/option.rb

@@ -4,7 +4,8 @@ module Committee
   module SchemaValidator
     class Option
       # Boolean Options
-      attr_reader :allow_form_params,
+      attr_reader :allow_blank_structures,
+                  :allow_form_params,
                   :allow_get_body,
                   :allow_query_params,
                   :check_content_type,
@@ -17,7 +18,7 @@ module Committee
                   :optimistic_json,
                   :validate_success_only,
                   :parse_response_by_content_type,
-                  :parameter_overwite_by_rails_rule
+                  :parameter_overwrite_by_rails_rule
 
       # Non-boolean options:
       attr_reader :headers_key,
@@ -38,6 +39,7 @@ module Committee
         @prefix                = options[:prefix]
 
         # Boolean options and have a common value by default
+        @allow_blank_structures           = options.fetch(:allow_blank_structures, false)
         @allow_form_params                = options.fetch(:allow_form_params, true)
         @allow_query_params               = options.fetch(:allow_query_params, true)
         @check_content_type               = options.fetch(:check_content_type, true)
@@ -45,7 +47,14 @@ module Committee
         @coerce_recursive                 = options.fetch(:coerce_recursive, true)
         @optimistic_json                  = options.fetch(:optimistic_json, false)
         @parse_response_by_content_type   = options.fetch(:parse_response_by_content_type, true)
-        @parameter_overwite_by_rails_rule = options.fetch(:parameter_overwite_by_rails_rule, true)
+
+        @parameter_overwrite_by_rails_rule =
+          if options.key?(:parameter_overwite_by_rails_rule)
+            Committee.warn_deprecated_until_6(true, "The option `parameter_overwite_by_rails_rule` is deprecated. Use `parameter_overwrite_by_rails_rule` instead.")
+            options[:parameter_overwite_by_rails_rule]
+          else
+            options.fetch(:parameter_overwrite_by_rails_rule, true)
+          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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Committee
-    VERSION = '5.2.0'.freeze
+    VERSION = '5.3.0'.freeze
 end

data/test/middleware/request_validation_open_api_3_test.rb

@@ -419,7 +419,7 @@ describe Committee::Middleware::RequestValidation do
         assert_equal env['committee.query_hash']['integer'], 42
         #assert_equal env['rack.request.query_hash'][:integer], 42 # this isn't hash indifferent hash because we use rack.request.query_hash
         [204, {}, []]
-      end, schema: open_api_3_schema, parameter_overwite_by_rails_rule: false)
+      end, schema: open_api_3_schema, parameter_overwrite_by_rails_rule: false)
 
       header "Content-Type", "application/json"
       post '/overwrite_same_parameter?integer=42'
@@ -434,7 +434,7 @@ describe Committee::Middleware::RequestValidation do
         assert_equal env['committee.request_body_hash'][:integer], 21
         assert_equal env['committee.query_hash']['integer'], 42
         [204, {}, []]
-      end, schema: open_api_3_schema, parameter_overwite_by_rails_rule: false)
+      end, schema: open_api_3_schema, parameter_overwrite_by_rails_rule: false)
 
       params = {integer: 21}
 
@@ -454,7 +454,7 @@ describe Committee::Middleware::RequestValidation do
         assert_equal env['committee.query_hash']['integer'], 84 # we can't use query_parameter :(
         #assert_equal env['rack.request.query_hash'][:integer], 21 # this isn't hash indifferent hash because we use rack.request.query_hash
         [204, {}, []]
-      end, schema: open_api_3_schema, parameter_overwite_by_rails_rule: false)
+      end, schema: open_api_3_schema, parameter_overwrite_by_rails_rule: false)
 
       params = {integer: 21}
 

data/test/middleware/response_validation_test.rb

@@ -136,6 +136,29 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 200, last_response.status
   end
 
+  it "passes through a valid response for OpenAPI when data=nil, target_schema=empty, allow_blank_structures=true" do
+    @app = new_rack_app("null", {},
+                        allow_blank_structures: true, schema: open_api_2_schema)
+    get "/api/pets/cat"
+    assert_equal 200, last_response.status
+  end
+
+  it "invalid responses for OpenAPI when data=nil, target_schema=empty, allow_blank_structures=false" do
+    @app = new_rack_app("null", {},
+                        allow_blank_structures: false, schema: open_api_2_schema)
+    get "/api/pets/cat"
+    assert_equal 500, last_response.status
+    assert_match(/Invalid response/i, last_response.body)
+  end
+
+  it "passes through a valid response for OpenAPI when data=nil, target_schema=present, allow_blank_structures=true" do
+    @app = new_rack_app("null", {},
+                        allow_blank_structures: true, schema: open_api_2_schema)
+    get "/api/pets/dog"
+    assert_equal 500, last_response.status
+    assert_match(/nil is not an array/i, last_response.body)
+  end
+
   it "detects an invalid response for OpenAPI" do
     @app = new_rack_app("{_}", {}, schema: open_api_2_schema)
     get "/api/pets"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-04 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -263,7 +263,11 @@ files:
 homepage: https://github.com/interagent/committee
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/interagent/committee/issues
+  changelog_uri: https://github.com/interagent/committee/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/interagent/committee
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -279,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.