openapi_parser 2.2.6 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cab3ae5e12891d0181e466a9fd7536aab281437f0cab8ef6b70e1dbfb291d8f
-  data.tar.gz: 4e246ee4c71e532ed38dbabb8f788d9ad7c85b5362b708482648b972a3ff9b8a
+  metadata.gz: b3129b448382c0b36273808c25a197c9264ec23d4729c93f8c5594375cf16cc5
+  data.tar.gz: 57aa683478c58dd684995e326687ef8e187a08fe4818e707812b1484a3e6e13b
 SHA512:
-  metadata.gz: 68298030cbd034b42f46e6dc9781b905f8b1c993d56db02e33c750d91934560301b2664d3287c4c462d33483020dccc3d3de8906a2e9f7b905f2b5bea5324e68
-  data.tar.gz: 68a9d252f6eb2ee4a5ce231b435c9022fc73b592e4eafc0e64b9aed4f711ebcfa66d079fb9f29dcd366b73d47a9426b594d3c30d032becbce035b67276da044a
+  metadata.gz: 1e99aa6ea5ae7234c886c17c6d48bdeb75480db7698057aa77825301c0151caa986b59f6cc0b5a5a421c135fb47fb513e6440b6a3a18db4dae2f25620001f05a
+  data.tar.gz: b5886770b412d8d73fe30a07039fcf76773880874e4762bd704e6ab3c4b545ade6ed722ebd010717af42c9e09e4e3ccd4fc0f53954c9d98bd24e64583ed99e48

data/.github/workflows/ci.yaml

@@ -1,5 +1,7 @@
 name: ci
-on: [push]
+on:
+  - pull_request
+  - push
 jobs:
   test:
     strategy:
@@ -18,7 +20,7 @@ jobs:
           - ruby-head
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 2.3.1 (2025-11-14)
+* add optional date coercion with behavior matching existing datetime coercion
+
+## 2.3.0 (2025-10-01)
+* bump base64 dep
+* bump actions checkout dep
+* improvements for additionalProperties validation #187
+
 ## 2.2.6 (2025-04-07)
 * support validator options and allow_empty_date_and_datetime for response validate options #183
 

data/README.md

@@ -27,7 +27,7 @@ request_operation.path_params
 # => {"template_name"=>"1"}
 
 # coerce parameter
-root = OpenAPIParser.parse(YAML.load_file('open_api_3/schema.yml'), {coerce_value: true, datetime_coerce_class: DateTime})
+root = OpenAPIParser.parse(YAML.load_file('open_api_3/schema.yml'), {coerce_value: true, datetime_coerce_class: DateTime, date_coerce_class: Date})
 request_operation = root.request_operation(:get, '/string_params_coercer')
 request_operation.validate_request_parameter({'integer_1' => '1', 'datetime_string' => '2016-04-01T16:00:00+09:00'})
 # => {"integer_1"=>1, "datetime_string"=>#<DateTime: 2016-04-01T16:00:00+09:00 ((2457480j,25200s,0n),+32400s,2299161j)>

data/lib/openapi_parser/config.rb

@@ -19,6 +19,10 @@ class OpenAPIParser::Config
     @config[:datetime_coerce_class]
   end
 
+  def date_coerce_class
+    @config[:date_coerce_class]
+  end
+
   def coerce_value
     @config[:coerce_value]
   end
@@ -46,6 +50,7 @@ class OpenAPIParser::Config
     @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,
+                                                                               date_coerce_class: date_coerce_class,
                                                                                validate_header: validate_header)
   end
 

data/lib/openapi_parser/schema_validator/all_of_validator.rb

@@ -9,7 +9,7 @@ class OpenAPIParser::SchemaValidator
         return [value, nil]
       end
 
-      # if any schema return error, it's not valida all of value
+      # if any schema return error, it's not a valid all_of
       remaining_keys               = value.kind_of?(Hash) ? value.keys : []
       nested_additional_properties = false
       schema.all_of.each do |s|
@@ -32,7 +32,7 @@ class OpenAPIParser::SchemaValidator
         return [nil, err] if err
       end
 
-      # If there are nested additionalProperites, we allow not defined extra properties and lean on the specific
+      # If there are nested additionalProperties, we allow not defined extra properties and lean on the specific
       # additionalProperties validation
       if !nested_additional_properties && !remaining_keys.empty?
         return [nil, OpenAPIParser::NotExistPropertyDefinition.new(remaining_keys, schema.object_reference)]

data/lib/openapi_parser/schema_validator/object_validator.rb

@@ -10,6 +10,7 @@ class OpenAPIParser::SchemaValidator
       return OpenAPIParser::ValidateError.build_error_result(value, schema) unless value.kind_of?(Hash)
 
       properties = schema.properties || {}
+      additional_properties = schema.additional_properties
 
       required_set = schema.required ? schema.required.to_set : Set.new
       remaining_keys = value.keys
@@ -29,9 +30,11 @@ class OpenAPIParser::SchemaValidator
         coerced, err = if s
                          remaining_keys.delete(name)
                          validatable.validate_schema(v, s)
+                       # TODO: better handling for parent_all_of with additional_properties
+                       elsif !parent_all_of && additional_properties.is_a?(OpenAPIParser::Schemas::Schema)
+                         remaining_keys.delete(name)
+                         validatable.validate_schema(v, additional_properties)
                        else
-                         # TODO: we need to perform a validation based on schema.additional_properties here, if
-                         # additionalProperties are defined
                          [v, nil]
                        end
 
@@ -43,7 +46,7 @@ class OpenAPIParser::SchemaValidator
 
       remaining_keys.delete(discriminator_property_name) if discriminator_property_name
 
-      if !remaining_keys.empty? && !parent_all_of && !schema.additional_properties
+      if !remaining_keys.empty? && !parent_all_of && !additional_properties
         # If object is nested in all of, the validation is already done in allOf validator. Or if
         # additionalProperties are defined, we will validate using that
         return [nil, OpenAPIParser::NotExistPropertyDefinition.new(remaining_keys, schema.object_reference)]

data/lib/openapi_parser/schema_validator/options.rb

@@ -6,14 +6,17 @@ class OpenAPIParser::SchemaValidator
     #   @return [Boolean] coerce value option on/off
     # @!attribute [r] datetime_coerce_class
     #   @return [Object, nil] coerce datetime string by this Object class
+    # @!attribute [r] date_coerce_class
+    #   @return [Object, nil] coerce date string by this Object class
     # @!attribute [r] validate_header
     #   @return [Boolean] validate header or not
-    attr_reader :allow_empty_date_and_datetime, :coerce_value, :datetime_coerce_class, :validate_header
+    attr_reader :allow_empty_date_and_datetime, :coerce_value, :datetime_coerce_class, :validate_header, :date_coerce_class
 
-    def initialize(allow_empty_date_and_datetime: false, 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, date_coerce_class: nil)
       @allow_empty_date_and_datetime = allow_empty_date_and_datetime
       @coerce_value = coerce_value
       @datetime_coerce_class = datetime_coerce_class
+      @date_coerce_class = date_coerce_class
       @validate_header = validate_header
     end
   end

data/lib/openapi_parser/schema_validator/string_validator.rb

@@ -2,10 +2,11 @@ class OpenAPIParser::SchemaValidator
   class StringValidator < Base
     include ::OpenAPIParser::SchemaValidator::Enumable
 
-    def initialize(validator, allow_empty_date_and_datetime, coerce_value, datetime_coerce_class)
+    def initialize(validator, allow_empty_date_and_datetime, coerce_value, datetime_coerce_class, date_coerce_class)
       super(validator, coerce_value)
       @allow_empty_date_and_datetime = allow_empty_date_and_datetime
       @datetime_coerce_class = datetime_coerce_class
+      @date_coerce_class = date_coerce_class
     end
 
     def coerce_and_validate(value, schema, **_keyword_args)
@@ -90,16 +91,18 @@ class OpenAPIParser::SchemaValidator
         return [nil, OpenAPIParser::InvalidDateFormat.new(value, schema.object_reference)] unless value =~ /^\d{4}-\d{2}-\d{2}$/
 
         begin
-          parsed_date = Date.iso8601(value)
+          if @date_coerce_class.nil?
+            # validate only
+            Date.iso8601(value)
+            [value, nil]
+          else
+            # validate and coerce
+            [@date_coerce_class.iso8601(value), nil]
+          end
         rescue ArgumentError
-          return [nil, OpenAPIParser::InvalidDateFormat.new(value, schema.object_reference)]
-        end
-
-        unless parsed_date.strftime('%Y-%m-%d') == value
-          return [nil, OpenAPIParser::InvalidDateFormat.new(value, schema.object_reference)]
+          # when rfc3339(value) failed
+          [nil, OpenAPIParser::InvalidDateFormat.new(value, schema.object_reference)]
         end
-
-        return [value, nil]
       end
 
       def validate_datetime_format(value, schema)

data/lib/openapi_parser/schema_validator.rb

@@ -56,6 +56,7 @@ class OpenAPIParser::SchemaValidator
     @allow_empty_date_and_datetime = options.allow_empty_date_and_datetime
     @coerce_value = options.coerce_value
     @datetime_coerce_class = options.datetime_coerce_class
+    @date_coerce_class = options.date_coerce_class
   end
 
   # execute validate data
@@ -121,7 +122,7 @@ class OpenAPIParser::SchemaValidator
     end
 
     def string_validator
-      @string_validator ||= OpenAPIParser::SchemaValidator::StringValidator.new(self, @allow_empty_date_and_datetime, @coerce_value, @datetime_coerce_class)
+      @string_validator ||= OpenAPIParser::SchemaValidator::StringValidator.new(self, @allow_empty_date_and_datetime, @coerce_value, @datetime_coerce_class, @date_coerce_class)
     end
 
     def integer_validator

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '2.2.6'.freeze
+  VERSION = '2.3.1'.freeze
 end

data/openapi_parser.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency "steep"
   # for steep + ruby-head
-  spec.add_development_dependency 'base64', '~> 0.2.0'
+  spec.add_development_dependency 'base64', '~> 0.3.0'
 end

data/sig/openapi_parser/config.rbs

@@ -9,6 +9,7 @@ module OpenAPIParser
 
     def initialize: (untyped config) -> untyped
     def allow_empty_date_and_datetime: -> bool
+    def date_coerce_class: -> (singleton(Object) | nil)
     def datetime_coerce_class: -> (singleton(Object) | nil)
     def coerce_value: -> bool
     def expand_reference: -> bool

data/sig/openapi_parser/schema_validator.rbs

@@ -6,6 +6,7 @@ module OpenAPIParser
     @schema: OpenAPIParser::Schemas::Schema
     @coerce_value: bool | nil
     @datetime_coerce_class: singleton(Object) | nil
+    @date_coerce_class: singleton(Object) | nil
     @string_validator: OpenAPIParser::SchemaValidator::StringValidator | nil
     @integer_validator: OpenAPIParser::SchemaValidator::IntegerValidator | nil
     @float_validator: OpenAPIParser::SchemaValidator::FloatValidator | nil

data/sig/openapi_parser/schema_validators/options.rbs

@@ -6,7 +6,7 @@ module OpenAPIParser
       attr_reader coerce_value: bool | nil
       attr_reader datetime_coerce_class: singleton(Object) | nil
       attr_reader validate_header: bool
-      def initialize: (?allow_empty_date_and_datetime: bool | nil, ?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, ?date_coerce_class: singleton(Object) | nil, ?validate_header: bool) -> untyped
     end
 
     class ResponseValidateOptions

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.3.1
 platform: ruby
 authors:
 - ota42y
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 description: parser for OpenAPI 3.0 or later
 email:
 - ota42y@gmail.com
@@ -225,7 +224,6 @@ homepage: https://github.com/ota42y/openapi_parser
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,8 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: OpenAPI3 parser
 test_files: []