openapi_parser 1.0.0.beta1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e383e6ff9f0d2a6ac67fda1ac8663b82c249449a7c1cff616a72fb608344a816
-  data.tar.gz: 53c6a442a5f170f5190197aa17a805a707fd586d7b4d0fc4c259ed8af46dc2bd
+  metadata.gz: 00f123cd8511ebd3cbe2f48ec901285d591a93ac1a56d2693f2ba896aebdf076
+  data.tar.gz: 263634fb1891c2fae9756c64e3fb0d0b3832484aced219b6091a7af9db3e6793
 SHA512:
-  metadata.gz: 3cd78f54ac0bb0bca68e9538f3f33968b7815b76d88c39908735da2f18936118ecc66ec57a97ac491f2b0fdc7fd4985e312b8b32a4051d22a2242ed8ea55608f
-  data.tar.gz: 22fcb549a4c134350274be73bc59114309d612f096b70dfd5633fe049b9b2111c176809575b2ce89fc30a2db3a8cda633c5ce18b82a58a418cd95d76ce23791a
+  metadata.gz: 3f58453f7daa0e73156cd221e1027cd7da7ecb8e63ce13fdee538c544380a763fa6c1b1de52e6a3a191e0f54c4fbde2ba1fd747d88ec5418a25075adcb1f246f
+  data.tar.gz: 9ebff3ee048466e02918cc6993de56147b640903418a1fbff9a6669a277c72954541c441bc2f7acdfff555ee4765c4392e7c3e7367235caff7774db01048f1ea

data/.github/workflows/ci.yaml

@@ -5,8 +5,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        ruby: [2.6, 2.7, '3.0', head]
+        os:
+          - ubuntu-latest
+          - macos-latest
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - ruby-head
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.1.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Unreleased
 
+## 1.1.0 (2023-10-15)
+### Added
+* Support for uniqueItems in array #154
+* Fix nullable field does not work with allOf, anyOf and oneOf keyword #128
+* drop ruby 2.6 #158
+
+## 1.0.0 (2021-02-03)
+### Added
+* Add date-time format validation #126
+
 ## 1.0.0.beta1 (2021-12-15)
 ### Added
 * Add strict_reference_validation config and implementation to address/implement #29 #123

data/Rakefile

@@ -4,7 +4,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task :steep do
-sh 'steep check'
+    sh 'steep check'
 end
 
 task :default => [:steep, :spec]

data/Steepfile

@@ -4,8 +4,8 @@ target :lib do
 
   check "lib/openapi_parser.rb"
   check "lib/openapi_parser/config.rb"
-  check "lib/openapi_parser/schema_validators/options.rb"
-  check "lib/openapi_parser/schema_validators/base.rb"
+  check "lib/openapi_parser/schema_validator/options.rb"
+  check "lib/openapi_parser/schema_validator/base.rb"
 
-  library 'uri'
+  library 'uri', 'json', 'pathname'
 end

data/lib/openapi_parser/errors.rb

@@ -206,6 +206,17 @@ module OpenAPIParser
     end
   end
 
+  class InvalidDateTimeFormat < OpenAPIError
+    def initialize(value, reference)
+      super(reference)
+      @value = value
+    end
+
+    def message
+      "#{@reference} Value: #{@value.inspect} is not conformant with date-time format"
+    end
+  end
+
   class NotExistStatusCodeDefinition < OpenAPIError
     def message
       "#{@reference} status code definition does not exist"
@@ -261,4 +272,15 @@ module OpenAPIParser
       "#{@reference} #{@value.inspect} contains fewer than min items"
     end
   end
+
+  class NotUniqueItems < OpenAPIError
+    def initialize(value, reference)
+      super(reference)
+      @value = value
+    end
+
+    def message
+      "#{@reference} #{@value.inspect} contains duplicate items"
+    end
+  end
 end

data/lib/openapi_parser/{schema_validators → schema_validator}/all_of_validator.rb

@@ -5,6 +5,10 @@ class OpenAPIParser::SchemaValidator
     # @param [Object] value
     # @param [OpenAPIParser::Schemas::Schema] schema
     def coerce_and_validate(value, schema, **keyword_args)
+      if value.nil? && schema.nullable
+        return [value, nil]
+      end
+
       # if any schema return error, it's not valida all of value
       remaining_keys               = value.kind_of?(Hash) ? value.keys : []
       nested_additional_properties = false

data/lib/openapi_parser/{schema_validators → schema_validator}/any_of_validator.rb

@@ -3,6 +3,9 @@ class OpenAPIParser::SchemaValidator
     # @param [Object] value
     # @param [OpenAPIParser::Schemas::Schema] schema
     def coerce_and_validate(value, schema, **_keyword_args)
+      if value.nil? && schema.nullable
+        return [value, nil]
+      end
       if schema.discriminator
         return validate_discriminator_schema(schema.discriminator, value)
       end

data/lib/openapi_parser/{schema_validators → schema_validator}/array_validator.rb

@@ -8,6 +8,9 @@ class OpenAPIParser::SchemaValidator
       value, err = validate_max_min_items(value, schema)
       return [nil, err] if err
 
+      value, err = validate_unique_items(value, schema)
+      return [nil, err] if err
+
       # array type have an schema in items property
       items_schema = schema.items
       coerced_values = value.map do |v|
@@ -28,5 +31,11 @@ class OpenAPIParser::SchemaValidator
 
       [value, nil]
     end
+
+    def validate_unique_items(value, schema)
+      return [nil, OpenAPIParser::NotUniqueItems.new(value, schema.object_reference)] if schema.uniqueItems && value.length != value.uniq.length
+
+      [value, nil]
+    end
   end
 end

data/lib/openapi_parser/{schema_validators → schema_validator}/base.rb

@@ -14,7 +14,7 @@ class OpenAPIParser::SchemaValidator
 
     def validate_discriminator_schema(discriminator, value, parent_discriminator_schemas: [])
       property_name = discriminator.property_name
-      unless (property_name && value.key?(property_name))
+      if property_name.nil? || !value.key?(property_name)
         return [nil, OpenAPIParser::NotExistDiscriminatorPropertyName.new(discriminator.property_name, value, discriminator.object_reference)]
       end
       mapping_key = value[property_name]

data/lib/openapi_parser/{schema_validators → schema_validator}/one_of_validator.rb

@@ -3,6 +3,9 @@ class OpenAPIParser::SchemaValidator
     # @param [Object] value
     # @param [OpenAPIParser::Schemas::Schema] schema
     def coerce_and_validate(value, schema, **_keyword_args)
+      if value.nil? && schema.nullable
+        return [value, nil]
+      end
       if schema.discriminator
         return validate_discriminator_schema(schema.discriminator, value)
       end

data/lib/openapi_parser/{schema_validators → schema_validator}/string_validator.rb

@@ -16,11 +16,6 @@ class OpenAPIParser::SchemaValidator
       value, err = pattern_validate(value, schema)
       return [nil, err] if err
 
-      unless @datetime_coerce_class.nil?
-        value, err = coerce_date_time(value, schema)
-        return [nil, err] if err
-      end
-
       value, err = validate_max_min_length(value, schema)
       return [nil, err] if err
 
@@ -33,28 +28,14 @@ class OpenAPIParser::SchemaValidator
       value, err = validate_date_format(value, schema)
       return [nil, err] if err
 
+      value, err = validate_datetime_format(value, schema)
+      return [nil, err] if err
+
       [value, nil]
     end
 
     private
 
-      # @param [OpenAPIParser::Schemas::Schema] schema
-      def coerce_date_time(value, schema)
-        return parse_date_time(value, schema) if schema.format == 'date-time'
-
-        [value, nil]
-      end
-
-      def parse_date_time(value, schema)
-        begin
-          return @datetime_coerce_class.parse(value), nil
-        rescue ArgumentError => e
-          raise e unless e.message =~ /invalid date/
-        end
-
-        OpenAPIParser::ValidateError.build_error_result(value, schema)
-      end
-
       # @param [OpenAPIParser::Schemas::Schema] schema
       def pattern_validate(value, schema)
         # pattern support string only so put this
@@ -101,5 +82,27 @@ class OpenAPIParser::SchemaValidator
 
         return [value, nil]
       end
+
+      def validate_datetime_format(value, schema)
+        return [value, nil] unless schema.format == 'date-time'
+
+        begin
+          if @datetime_coerce_class.nil?
+            # validate only
+            DateTime.rfc3339(value)
+            [value, nil]
+          else
+            # validate and coerce
+            if @datetime_coerce_class == Time
+              [DateTime.rfc3339(value).to_time, nil]
+            else
+              [@datetime_coerce_class.rfc3339(value), nil]
+            end
+          end
+        rescue ArgumentError
+          # when rfc3339(value) failed
+          [nil, OpenAPIParser::InvalidDateTimeFormat.new(value, schema.object_reference)]
+        end
+      end
   end
 end

data/lib/openapi_parser/{schema_validators → schema_validator}/unspecified_type_validator.rb

@@ -2,7 +2,7 @@ class OpenAPIParser::SchemaValidator
   class UnspecifiedTypeValidator < Base
     # @param [Object] value
     def coerce_and_validate(value, _schema, **_keyword_args)
-      value
+      [value, nil]
     end
   end
 end

data/lib/openapi_parser/schema_validator.rb

@@ -1,18 +1,18 @@
-require_relative 'schema_validators/options'
-require_relative 'schema_validators/enumable'
-require_relative 'schema_validators/minimum_maximum'
-require_relative 'schema_validators/base'
-require_relative 'schema_validators/string_validator'
-require_relative 'schema_validators/integer_validator'
-require_relative 'schema_validators/float_validator'
-require_relative 'schema_validators/boolean_validator'
-require_relative 'schema_validators/object_validator'
-require_relative 'schema_validators/array_validator'
-require_relative 'schema_validators/any_of_validator'
-require_relative 'schema_validators/all_of_validator'
-require_relative 'schema_validators/one_of_validator'
-require_relative 'schema_validators/nil_validator'
-require_relative 'schema_validators/unspecified_type_validator'
+require_relative 'schema_validator/options'
+require_relative 'schema_validator/enumable'
+require_relative 'schema_validator/minimum_maximum'
+require_relative 'schema_validator/base'
+require_relative 'schema_validator/string_validator'
+require_relative 'schema_validator/integer_validator'
+require_relative 'schema_validator/float_validator'
+require_relative 'schema_validator/boolean_validator'
+require_relative 'schema_validator/object_validator'
+require_relative 'schema_validator/array_validator'
+require_relative 'schema_validator/any_of_validator'
+require_relative 'schema_validator/all_of_validator'
+require_relative 'schema_validator/one_of_validator'
+require_relative 'schema_validator/nil_validator'
+require_relative 'schema_validator/unspecified_type_validator'
 
 class OpenAPIParser::SchemaValidator
   # validate value by schema

data/lib/openapi_parser/schemas/classes.rb

@@ -16,4 +16,5 @@ module OpenAPIParser::Schemas
   class Schema < Base; end
   class Components < Base; end
   class Header < Base; end
+  class Info < Base; end
 end

data/lib/openapi_parser/schemas/info.rb

@@ -0,0 +1,6 @@
+module OpenAPIParser::Schemas
+  class Info < Base
+
+    openapi_attr_values :title, :version
+  end
+end

data/lib/openapi_parser/schemas/openapi.rb

@@ -29,6 +29,10 @@ module OpenAPIParser::Schemas
     #   @return [Components, nil]
     openapi_attr_object :components, Components, reference: false
 
+    # @!attribute [r] info
+    #   @return [Info, nil]
+    openapi_attr_object :info, Info, reference: false
+
     # @return [OpenAPIParser::RequestOperation, nil]
     def request_operation(http_method, request_path)
       OpenAPIParser::RequestOperation.create(http_method, request_path, @path_item_finder, @config)

data/lib/openapi_parser/schemas.rb

@@ -15,3 +15,4 @@ require_relative 'schemas/components'
 require_relative 'schemas/media_type'
 require_relative 'schemas/schema'
 require_relative 'schemas/header'
+require_relative 'schemas/info'

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '1.0.0.beta1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/openapi_parser.rb

@@ -43,13 +43,16 @@ module OpenAPIParser
     def load_uri(uri, config:, schema_registry:)
       # Open-uri doesn't open file scheme uri, so we try to open file path directly
       # File scheme uri which points to a remote file is not supported.
+      uri_path = uri.path
+      raise "file not found" if uri_path.nil?
+
       content = if uri.scheme == 'file'
-        open(uri.path)&.read
+        open(uri_path)&.read
       elsif uri.is_a?(OpenURI::OpenRead)
         uri.open()&.read
       end
 
-      extension = Pathname.new(uri.path).extname
+      extension = Pathname.new(uri_path).extname
       load_hash(parse_file(content, extension), config: config, uri: uri, schema_registry: schema_registry)
     end
 
@@ -85,6 +88,7 @@ module OpenAPIParser
       end
 
       def parse_json(content)
+        raise "json content is nil" unless content 
         JSON.parse(content)
       end
 

data/openapi_parser.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'parser for OpenAPI 3.0 or later'
   spec.homepage      = 'https://github.com/ota42y/openapi_parser'
   spec.license       = 'MIT'
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,11 +25,17 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'fincop'
-  spec.add_development_dependency 'pry', '~> 0.12.0'
-  spec.add_development_dependency 'pry-byebug'
+
+  if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("3.2.0")
+    spec.add_development_dependency 'pry', '~> 0.12.0'
+    spec.add_development_dependency 'pry-byebug'
+  end
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-parameterized'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency "steep"
+  # for steep 
+  # https://github.com/soutaro/steep/issues/466
+  spec.add_development_dependency "activesupport", '~> 6.0'
 end

data/sig/openapi_parser/config.rbs

@@ -2,6 +2,8 @@
 module OpenAPIParser
   class Config
     @config: untyped
+    @request_validator_options: OpenAPIParser::SchemaValidator::Options
+    @response_validate_options: OpenAPIParser::SchemaValidator::ResponseValidateOptions
     alias request_body_options request_validator_options
     alias path_params_options request_validator_options
 

data/sig/openapi_parser/errors.rbs

@@ -0,0 +1,22 @@
+module OpenAPIParser
+  class OpenAPIError < StandardError
+    def initialize: (untyped reference) -> untyped
+  end
+
+  class ValidateError < OpenAPIError
+    def initialize: (untyped data, (String | nil) type, untyped reference) -> untyped
+    def message: -> String
+               
+    def self.build_error_result: (Object value, OpenAPIParser::Schemas::Schema schema) -> [nil, OpenAPIParser::ValidateError]
+  end
+
+  class NotExistDiscriminatorMappedSchema < OpenAPIError
+    def initialize: (untyped mapped_schema_reference, untyped reference) -> untyped
+    def message: -> String
+  end
+
+  class NotExistDiscriminatorPropertyName < OpenAPIError
+    def initialize: (untyped mapped_schema_reference, untyped value, untyped reference) -> untyped
+    def message: -> String
+  end
+end

data/sig/openapi_parser/reference_expander.rbs

@@ -0,0 +1,3 @@
+class OpenAPIParser::ReferenceExpander
+  def self.expand: (OpenAPIParser::Schemas::OpenAPI openapi, untyped validate_references) -> nil
+end

data/sig/openapi_parser/schema_validators/base.rbs

@@ -4,14 +4,15 @@ module OpenAPIParser
     class Base
       @coerce_value: bool | nil
 
-      def initialize: (OpenAPIParser::SchemaValidator::Validatable validatable, (bool | nil) coerce_value) -> untyped
       attr_reader validatable: OpenAPIParser::SchemaValidator::Validatable
-      def coerce_and_validate: (Object _value, OpenAPIParser::Schemas::Schema _schema, **untyped) -> bot
+
+      def initialize: (OpenAPIParser::SchemaValidator::Validatable validatable, (bool | nil) coerce_value) -> untyped
+      def coerce_and_validate: (Object _value, OpenAPIParser::Schemas::Schema _schema, **untyped) -> [untyped, (ValidateError | NotExistDiscriminatorMappedSchema | nil)]
       def validate_discriminator_schema: (
         OpenAPIParser::Schemas::Discriminator discriminator, 
         Hash[String, bot] value,
         ?parent_discriminator_schemas: Array[OpenAPIParser::Schemas::Schema]
-      ) -> [Object | nil, OpenAPIParser::validate_error]
+      ) -> [Object | nil, OpenAPIParser::OpenAPIError]
     end
   end
 end

data/sig/types.rbs

@@ -6,3 +6,8 @@ module OpenURI
   end
 end
 
+
+module Psych
+  def self.safe_load: (untyped content, untyped parmitted_classes) -> Hash[bot, bot]
+end
+

data/sig/wip_types.rbs

@@ -62,6 +62,3 @@ class OpenAPIParser::Schemas::Discriminator < OpenAPIParser::Schemas::Base
   attr_reader property_name: (String | nil)
   attr_reader mapping: Hash[String, String] 
 end
-
-class OpenAPIParser::OpenAPIError
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 2.0.0
 platform: ruby
 authors:
 - ota42y
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: parser for OpenAPI 3.0 or later
 email:
 - ota42y@gmail.com
@@ -186,27 +172,28 @@ files:
 - lib/openapi_parser/reference_expander.rb
 - lib/openapi_parser/request_operation.rb
 - lib/openapi_parser/schema_validator.rb
-- lib/openapi_parser/schema_validators/all_of_validator.rb
-- lib/openapi_parser/schema_validators/any_of_validator.rb
-- lib/openapi_parser/schema_validators/array_validator.rb
-- lib/openapi_parser/schema_validators/base.rb
-- lib/openapi_parser/schema_validators/boolean_validator.rb
-- lib/openapi_parser/schema_validators/enumable.rb
-- lib/openapi_parser/schema_validators/float_validator.rb
-- lib/openapi_parser/schema_validators/integer_validator.rb
-- lib/openapi_parser/schema_validators/minimum_maximum.rb
-- lib/openapi_parser/schema_validators/nil_validator.rb
-- lib/openapi_parser/schema_validators/object_validator.rb
-- lib/openapi_parser/schema_validators/one_of_validator.rb
-- lib/openapi_parser/schema_validators/options.rb
-- lib/openapi_parser/schema_validators/string_validator.rb
-- lib/openapi_parser/schema_validators/unspecified_type_validator.rb
+- lib/openapi_parser/schema_validator/all_of_validator.rb
+- lib/openapi_parser/schema_validator/any_of_validator.rb
+- lib/openapi_parser/schema_validator/array_validator.rb
+- lib/openapi_parser/schema_validator/base.rb
+- lib/openapi_parser/schema_validator/boolean_validator.rb
+- lib/openapi_parser/schema_validator/enumable.rb
+- lib/openapi_parser/schema_validator/float_validator.rb
+- lib/openapi_parser/schema_validator/integer_validator.rb
+- lib/openapi_parser/schema_validator/minimum_maximum.rb
+- lib/openapi_parser/schema_validator/nil_validator.rb
+- lib/openapi_parser/schema_validator/object_validator.rb
+- lib/openapi_parser/schema_validator/one_of_validator.rb
+- lib/openapi_parser/schema_validator/options.rb
+- lib/openapi_parser/schema_validator/string_validator.rb
+- lib/openapi_parser/schema_validator/unspecified_type_validator.rb
 - lib/openapi_parser/schemas.rb
 - lib/openapi_parser/schemas/base.rb
 - lib/openapi_parser/schemas/classes.rb
 - lib/openapi_parser/schemas/components.rb
 - lib/openapi_parser/schemas/discriminator.rb
 - lib/openapi_parser/schemas/header.rb
+- lib/openapi_parser/schemas/info.rb
 - lib/openapi_parser/schemas/media_type.rb
 - lib/openapi_parser/schemas/openapi.rb
 - lib/openapi_parser/schemas/operation.rb
@@ -222,6 +209,8 @@ files:
 - openapi_parser.gemspec
 - sig/openapi_parser.rbs
 - sig/openapi_parser/config.rbs
+- sig/openapi_parser/errors.rbs
+- sig/openapi_parser/reference_expander.rbs
 - sig/openapi_parser/schema_validator.rbs
 - sig/openapi_parser/schema_validators/base.rbs
 - sig/openapi_parser/schema_validators/options.rbs
@@ -233,7 +222,7 @@ homepage: https://github.com/ota42y/openapi_parser
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -241,15 +230,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.4.20
+signing_key: 
 specification_version: 4
 summary: OpenAPI3 parser
 test_files: []