committee 5.5.2 → 5.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c6653c3224887d3adf7300b4c4e2f047a839ab31ba1890b87b8daad828e939d
-  data.tar.gz: 7c00b24dff0a892dfe82b28304547e8ac47729f1ac87fcdf81f47575a7757bad
+  metadata.gz: 4d63a9269323d485600c6f853e59ea9ac678faa6090838560cea1e54cec88f40
+  data.tar.gz: d8168ded9e92aabbf7144e6f98c8b52a90f1b5b956c3c4d9ae1bbba61504fbf2
 SHA512:
-  metadata.gz: 876a44d4c13020892a3e6b10ee1008fc0b5ee0d7e294acbca8922c5ec4cf7c78fe6bee6374388bc9468a4511b11eb68cf6e3c49bf360e77f158942953e113bcb
-  data.tar.gz: 17f3777d9d610fe64f86670c7b849a8dae18346ae5d59639b3bdd5cff2958649b1a6da78c5abe4d60e01dfd5a506fc2420f1c024de40d5f982bd2f353bf34d01
+  metadata.gz: 3b951a8e7d81870e3d5947145dfdafb777e980367d41f83f4bc66c4ed902face9b29e6e92f7bb2db55e5a3ed56ff0c95544b35305373061501dcba76cb71ee5e
+  data.tar.gz: ac977e7c4f909abd4707aa0b540cf5efcd885b03212bec6eca6cf69f4199e2bed0ed2711768d7852f93921192d12ea957e7f4f07868cc3259b96374097c89a12

data/lib/committee/request_unpacker.rb

@@ -21,11 +21,12 @@ module Committee
     end
 
     def initialize(options = {})
-      @allow_form_params          = options[:allow_form_params]
-      @allow_get_body             = options[:allow_get_body]
-      @allow_query_params         = options[:allow_query_params]
-      @allow_non_get_query_params = options[:allow_non_get_query_params]
-      @optimistic_json            = options[:optimistic_json]
+      @allow_empty_date_and_datetime = options[:allow_empty_date_and_datetime]
+      @allow_form_params             = options[:allow_form_params]
+      @allow_get_body                = options[:allow_get_body]
+      @allow_query_params            = options[:allow_query_params]
+      @allow_non_get_query_params    = options[:allow_non_get_query_params]
+      @optimistic_json               = options[:optimistic_json]
     end
 
     # return params and is_form_params

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

@@ -31,10 +31,12 @@ module Committee
         end
 
         # @param [Boolean] strict when not content_type or status code definition, raise error
-        def validate_response_params(status_code, headers, response_data, strict, check_header)
+        def validate_response_params(status_code, headers, response_data, strict, check_header, validator_options: {})
           response_body = OpenAPIParser::RequestOperation::ValidatableResponseBody.new(status_code, response_data, headers)
 
-          return request_operation.validate_response_body(response_body, response_validate_options(strict, check_header))
+          return request_operation.validate_response_body(
+            response_body,
+            response_validate_options(strict, check_header, validator_options: validator_options))
         rescue OpenAPIParser::OpenAPIError => e
           raise Committee::InvalidResponse.new(e.message, original_error: e)
         end
@@ -89,11 +91,15 @@ module Committee
 
         # @return [OpenAPIParser::SchemaValidator::Options]
         def build_openapi_parser_option(validator_option, coerce_value)
-          datetime_coerce_class = validator_option.coerce_date_times ? DateTime : nil
-          validate_header = validator_option.check_header
-          OpenAPIParser::SchemaValidator::Options.new(coerce_value: coerce_value,
-                                                      datetime_coerce_class: datetime_coerce_class,
-                                                      validate_header: validate_header)
+          parser_options = {
+            coerce_value: coerce_value,
+            datetime_coerce_class: validator_option.coerce_date_times ? DateTime : nil,
+            validate_header: validator_option.check_header,
+          }
+          if OpenAPIParser::SchemaValidator::Options.method_defined?(:allow_empty_date_and_datetime)
+            parser_options[:allow_empty_date_and_datetime] = validator_option.allow_empty_date_and_datetime
+          end
+          OpenAPIParser::SchemaValidator::Options.new(**parser_options)
         end
 
         def validate_get_request_params(path_params, query_params, headers, validator_option)
@@ -130,8 +136,14 @@ module Committee
           end
         end
 
-        def response_validate_options(strict, check_header)
-          ::OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(strict: strict, validate_header: check_header)
+        def response_validate_options(strict, check_header, validator_options: {})
+          options = { strict: strict, validate_header: check_header }
+
+          if OpenAPIParser::SchemaValidator::ResponseValidateOptions.method_defined?(:validator_options)
+            ::OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(**options, **validator_options)
+          else
+            ::OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(**options)
+          end
         end
       end
     end

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

@@ -12,12 +12,15 @@ module Committee
           @operation_wrapper = operation_wrapper
           @validate_success_only = validator_option.validate_success_only
           @check_header = validator_option.check_header
+          @allow_empty_date_and_datetime = validator_option.allow_empty_date_and_datetime
         end
 
         def call(status, headers, response_data, strict)
           return unless Committee::Middleware::ResponseValidation.validate?(status, validate_success_only)
 
-          operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header)
+          validator_options = { allow_empty_date_and_datetime: @allow_empty_date_and_datetime }
+
+          operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header, validator_options: validator_options)
         end
 
         private

data/lib/committee/schema_validator/open_api_3.rb

@@ -84,6 +84,7 @@ module Committee
 
       def request_unpack(request)
         unpacker = Committee::RequestUnpacker.new(
+          allow_empty_date_and_datetime: validator_option.allow_empty_date_and_datetime,
           allow_form_params:  validator_option.allow_form_params,
           allow_get_body:     validator_option.allow_get_body,
           allow_query_params: validator_option.allow_query_params,

data/lib/committee/schema_validator/option.rb

@@ -5,6 +5,7 @@ module Committee
     class Option
       # Boolean Options
       attr_reader :allow_blank_structures,
+                  :allow_empty_date_and_datetime,
                   :allow_form_params,
                   :allow_get_body,
                   :allow_query_params,
@@ -36,6 +37,7 @@ module Committee
 
         # Boolean options and have a common value by default
         @allow_blank_structures           = options.fetch(:allow_blank_structures, false)
+        @allow_empty_date_and_datetime    = options.fetch(:allow_empty_date_and_datetime, false)
         @allow_form_params                = options.fetch(:allow_form_params, true)
         @allow_query_params               = options.fetch(:allow_query_params, true)
         @allow_non_get_query_params       = options.fetch(:allow_non_get_query_params, false)

data/lib/committee/version.rb

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

data/test/middleware/request_validation_open_api_3_test.rb

@@ -146,7 +146,7 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
-  it "passes given an invalid datetime string with coerce_date_times enabled" do
+  it "errors given an invalid datetime string with coerce_date_times enabled" do
     @app = new_rack_app(schema: open_api_3_schema, coerce_date_times: true)
     params = { "datetime_string" => "invalid_datetime_format" }
     get "/string_params_coercer", params
@@ -244,6 +244,50 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  it "errors given an empty datetime string with allow_empty_date_and_datetime disabled" do
+    @app = new_rack_app(schema: open_api_3_schema)
+    params = { "datetime_string" => "" }
+    get "/string_params_coercer", params
+
+    assert_equal 400, last_response.status
+    assert_match(/\\"\\" is not conformant with date-time format/i, last_response.body)
+  end
+
+  it "passes given an empty datetime string with allow_empty_date_and_datetime enabled" do
+    @app = new_rack_app(schema: open_api_3_schema, allow_empty_date_and_datetime: true)
+    params = { "datetime_string" => "" }
+    get "/string_params_coercer", params
+
+    if OpenAPIParser::VERSION >= "2.2.5"
+      assert_equal 200, last_response.status
+    else
+      assert_equal 400, last_response.status
+      assert_match(/\\"\\" is not conformant with date-time format/i, last_response.body)
+    end
+  end
+
+  it "errors given an empty date string with allow_empty_date_and_datetime disabled" do
+    @app = new_rack_app(schema: open_api_3_schema)
+    params = { "date_string" => "" }
+    get "/string_params_coercer", params
+
+    assert_equal 400, last_response.status
+    assert_match(/\\"\\" is not conformant with date format/i, last_response.body)
+  end
+
+  it "passes given an empty date string with allow_empty_date_and_datetime enabled" do
+    @app = new_rack_app(schema: open_api_3_schema, allow_empty_date_and_datetime: true)
+    params = { "date_string" => "" }
+    get "/string_params_coercer", params
+
+    if OpenAPIParser::VERSION >= "2.2.5"
+      assert_equal 200, last_response.status
+    else
+      assert_equal 400, last_response.status
+      assert_match(/\\"\\" is not conformant with date format/i, last_response.body)
+    end
+  end
+
   it "OpenAPI3 detects an invalid request" do
     @app = new_rack_app(schema: open_api_3_schema, strict: true)
     header "Content-Type", "application/json"

data/test/schema_validator/open_api_3/response_validator_test.rb

@@ -75,6 +75,76 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
+  describe 'allow_empty_date_and_datetime' do
+    it "errors given an empty date string with allow_empty_date_and_datetime disabled" do
+      @path = '/date_time'
+      @method = 'get'
+      @data = { 'date' => '' }
+
+      e = assert_raises(Committee::InvalidResponse) {
+        call_response_validator
+      }
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+      assert_match(/\"\" is not conformant with date format/i, e.message)
+    end
+
+    it "errors given an empty date-time string with allow_empty_date_and_datetime disabled" do
+      @path = '/date_time'
+      @method = 'get'
+      @data = { 'date-time' => '' }
+
+      e = assert_raises(Committee::InvalidResponse) {
+        call_response_validator
+      }
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+      assert_match(/\"\" is not conformant with date-time format/i, e.message)
+    end
+
+    it "passes given an empty date string with allow_empty_date_and_datetime enabled" do
+      @validator_option = Committee::SchemaValidator::Option.new(
+        { allow_empty_date_and_datetime: true },
+        open_api_3_schema,
+        :open_api_3)
+
+      @path = '/date_time'
+      @method = 'get'
+      @data = { 'date' => '' }
+
+      if OpenAPIParser::VERSION >= "2.2.6"
+        response = call_response_validator
+        assert_equal({ 'date' => '' }, response)
+      else
+        e = assert_raises(Committee::InvalidResponse) {
+          call_response_validator
+        }
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+        assert_match(/\"\" is not conformant with date format/i, e.message)
+      end
+    end
+
+    it "passes given an empty date-time string with allow_empty_date_and_datetime enabled" do
+      @validator_option = Committee::SchemaValidator::Option.new(
+        { allow_empty_date_and_datetime: true },
+        open_api_3_schema,
+        :open_api_3)
+
+      @path = '/date_time'
+      @method = 'get'
+      @data = { 'date-time' => '' }
+
+      if OpenAPIParser::VERSION >= "2.2.6"
+        response = call_response_validator
+        assert_equal({ 'date-time' => '' }, response)
+      else
+        e = assert_raises(Committee::InvalidResponse) {
+          call_response_validator
+        }
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
+        assert_match(/\"\" is not conformant with date-time format/i, e.message)
+      end
+    end
+  end
+
   private
 
   def call_response_validator(strict = false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 5.5.2
+  version: 5.5.3
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema