openapi_parser 2.2.3 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcf4eb8daf0d179a7bda7dc584020f64ec8ee52ea0dcaddb4d532122f00b2f41
-  data.tar.gz: 9a5742b5f563e3d54d1739cd95e9b7da4f7da6a65ffe1180f9a4908ad93010e0
+  metadata.gz: 4016d11ce844002642120ada572812240bb8565b587af7126666ddc430504a7e
+  data.tar.gz: 4cafef840728490fe310f925220309ce955f81aae5561be19ddd3805e291d6fd
 SHA512:
-  metadata.gz: e7af1fc0b83d2b05b51d9005d45133194bffbdbbe56ec0029564d7e79332652dbbf729defaa7138f6d25df718b54467847b78315a7c747fc0bcfcda4ccba4bf2
-  data.tar.gz: 32384fce5b9e39674d1fd3fd9a565fa93d0ac5610a22159e6735cefec2ec02219c16305b4cf448ca7faeeace2f8fd82758c16c6b50ba998da6d203269d530c95
+  metadata.gz: 78a563d3b37e7b3c1be1930320d24bd12598205d2e4952e19b2af4dc349dd3c91ff887dfb83450cb4dcd9af9667adde554a82d90ee5af67467ec8de54d2a2db1
+  data.tar.gz: 92993b410aa4a2092fea00a8e37ed4724304f5742abb8c9fcf41eb5d094aaace7d0d7aac73766120bac14d502853f43dffc5e005a9470422f09037e4f996fe1b

data/.github/workflows/ci.yaml

@@ -14,6 +14,7 @@ jobs:
           - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
           - ruby-head
     runs-on: ${{ matrix.os }}
     steps:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 2.2.5 (2025-04-05)
+* add allow_empty_date_and_datetime option for more lenient format parsing #182
+
+## 2.2.4 (2025-02-27)
+* skip validation if format is set to `binary` #180
+
 ## 2.2.3 (2024-12-12)
 * fix parent_discriminator_schema nil from all_of_validator #179
 

data/lib/openapi_parser/config.rb

@@ -11,6 +11,10 @@ class OpenAPIParser::Config
     @config = config
   end
 
+  def allow_empty_date_and_datetime
+    @config.fetch(:allow_empty_date_and_datetime, false)
+  end
+
   def datetime_coerce_class
     @config[:datetime_coerce_class]
   end
@@ -39,7 +43,8 @@ class OpenAPIParser::Config
 
   # @return [OpenAPIParser::SchemaValidator::Options]
   def request_validator_options
-    @request_validator_options ||= OpenAPIParser::SchemaValidator::Options.new(coerce_value: coerce_value,
+    @request_validator_options ||= OpenAPIParser::SchemaValidator::Options.new(allow_empty_date_and_datetime: allow_empty_date_and_datetime,
+                                                                               coerce_value: coerce_value,
                                                                                datetime_coerce_class: datetime_coerce_class,
                                                                                validate_header: validate_header)
   end

data/lib/openapi_parser/schema_validator/options.rb

@@ -1,14 +1,17 @@
 class OpenAPIParser::SchemaValidator
   class Options
+    # @!attribute [r] allow_empty_date_and_datetime
+    #   @return [Boolean] allow empty date and datetime values option on/off
     # @!attribute [r] coerce_value
     #   @return [Boolean] coerce value option on/off
     # @!attribute [r] datetime_coerce_class
     #   @return [Object, nil] coerce datetime string by this Object class
     # @!attribute [r] validate_header
     #   @return [Boolean] validate header or not
-    attr_reader :coerce_value, :datetime_coerce_class, :validate_header
+    attr_reader :allow_empty_date_and_datetime, :coerce_value, :datetime_coerce_class, :validate_header
 
-    def initialize(coerce_value: nil, datetime_coerce_class: nil, validate_header: true)
+    def initialize(allow_empty_date_and_datetime: false, coerce_value: nil, datetime_coerce_class: nil, validate_header: true)
+      @allow_empty_date_and_datetime = allow_empty_date_and_datetime
       @coerce_value = coerce_value
       @datetime_coerce_class = datetime_coerce_class
       @validate_header = validate_header

data/lib/openapi_parser/schema_validator/string_validator.rb

@@ -2,13 +2,25 @@ class OpenAPIParser::SchemaValidator
   class StringValidator < Base
     include ::OpenAPIParser::SchemaValidator::Enumable
 
-    def initialize(validator, coerce_value, datetime_coerce_class)
+    def initialize(validator, allow_empty_date_and_datetime, coerce_value, datetime_coerce_class)
       super(validator, coerce_value)
+      @allow_empty_date_and_datetime = allow_empty_date_and_datetime
       @datetime_coerce_class = datetime_coerce_class
     end
 
     def coerce_and_validate(value, schema, **_keyword_args)
-      return OpenAPIParser::ValidateError.build_error_result(value, schema) unless value.kind_of?(String)
+      unless value.kind_of?(String)
+        # Skip validation if the format is `binary`, even if the value is not an actual string.
+        # ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-types
+        if schema.format == 'binary'
+          # TODO:
+          # It would be better to check whether the value is an instance of `Rack::Multipart::UploadFile`,
+          # `ActionDispatch::Http::UploadedFile`, or another similar class.
+          return [value, nil]
+        end
+
+        return OpenAPIParser::ValidateError.build_error_result(value, schema)
+      end
 
       value, err = check_enum_include(value, schema)
       return [nil, err] if err
@@ -69,6 +81,10 @@ class OpenAPIParser::SchemaValidator
       end
 
       def validate_date_format(value, schema)
+        if @allow_empty_date_and_datetime && value.to_s.empty?
+          return [value, nil] if schema.format == 'date'
+        end
+
         return [value, nil] unless schema.format == 'date'
 
         return [nil, OpenAPIParser::InvalidDateFormat.new(value, schema.object_reference)] unless value =~ /^\d{4}-\d{2}-\d{2}$/
@@ -87,6 +103,10 @@ class OpenAPIParser::SchemaValidator
       end
 
       def validate_datetime_format(value, schema)
+        if @allow_empty_date_and_datetime && value.to_s.empty?
+          return [value, nil] if schema.format == 'date-time'
+        end
+
         return [value, nil] unless schema.format == 'date-time'
 
         begin

data/lib/openapi_parser/schema_validator.rb

@@ -53,6 +53,7 @@ class OpenAPIParser::SchemaValidator
   def initialize(value, schema, options)
     @value = value
     @schema = schema
+    @allow_empty_date_and_datetime = options.allow_empty_date_and_datetime
     @coerce_value = options.coerce_value
     @datetime_coerce_class = options.datetime_coerce_class
   end
@@ -120,7 +121,7 @@ class OpenAPIParser::SchemaValidator
     end
 
     def string_validator
-      @string_validator ||= OpenAPIParser::SchemaValidator::StringValidator.new(self, @coerce_value, @datetime_coerce_class)
+      @string_validator ||= OpenAPIParser::SchemaValidator::StringValidator.new(self, @allow_empty_date_and_datetime, @coerce_value, @datetime_coerce_class)
     end
 
     def integer_validator

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '2.2.3'.freeze
+  VERSION = '2.2.5'.freeze
 end

data/sig/openapi_parser/config.rbs

@@ -8,10 +8,12 @@ module OpenAPIParser
     alias path_params_options request_validator_options
 
     def initialize: (untyped config) -> untyped
+    def allow_empty_date_and_datetime: -> bool
     def datetime_coerce_class: -> (singleton(Object) | nil)
     def coerce_value: -> bool
     def expand_reference: -> bool
     def strict_response_validation: -> bool
+    def strict_reference_validation: -> bool
     def validate_header: -> bool
     def request_validator_options: -> OpenAPIParser::SchemaValidator::Options
     def response_validate_options: -> OpenAPIParser::SchemaValidator::ResponseValidateOptions

data/sig/openapi_parser/schema_validators/options.rbs

@@ -2,10 +2,11 @@
 module OpenAPIParser
   class SchemaValidator
     class Options
+      attr_reader allow_empty_date_and_datetime: bool | nil
       attr_reader coerce_value: bool | nil
       attr_reader datetime_coerce_class: singleton(Object) | nil
       attr_reader validate_header: bool
-      def initialize: (?coerce_value: bool | nil, ?datetime_coerce_class: singleton(Object) | nil, ?validate_header: bool) -> untyped
+      def initialize: (?allow_empty_date_and_datetime: bool | nil, ?coerce_value: bool | nil, ?datetime_coerce_class: singleton(Object) | nil, ?validate_header: bool) -> untyped
     end
 
     class ResponseValidateOptions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.5
 platform: ruby
 authors:
 - ota42y
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler