openapi_parser 0.14.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b06e3e4d6ad28828a02c2a4a79140439b9119ac53b73494318386195cc6275
-  data.tar.gz: 4360946a10aa364d8c0de18d773eee3df2ee683373de2178307f52530806e81a
+  metadata.gz: 3019c8458c35d159f7c8eccc8f8203d39826438804460cccd1383f9e29b95299
+  data.tar.gz: 3471fed71a9d1f81688d87a0c907a0ab4c0529ca3e4a9d40159403b88238d1a6
 SHA512:
-  metadata.gz: be2a98609d41e4207edff4aaa61687b34dc568cb36e38b37eef42c7edffc836ffb9110465dda772c41025bc0fce125115da370e36949414ceb8902051c81b7b8
-  data.tar.gz: 3047ab4d4ef9f465e9c9373567c11e323ecd135d994002d8578426bdc38d5cdbe5922050d66bdf701551fb10fcb3206029276b49a33e2bc1d755278cb105a9e3
+  metadata.gz: d9f7ba65682079456e26ff03d4be816ad6f61b9bb9224c4cf37157a0bb4d4455d17c3e36fbadd0f557700d9926f69a50ae8ebdc9041412304b12b05feb91df4e
+  data.tar.gz: fd611630b787af1e69a003de92c01f8c83d9e9d6e8be68fe66fdba6a93ce2a8ca412c89a00fa35bcf4d7441fe10c309ec9eb9f3e91659957429b0375629a3671

data/.github/workflows/ci.yaml

@@ -6,7 +6,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.4, 2.5, 2.6, 2.7, '3.0', head]
+        ruby: [2.6, 2.7, '3.0', '3.1']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## Unreleased
 
+## 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
+
+## 0.15.0 (2021-09-27)
+### Added
+* support: relative file path escape. #117
+
+## 0.14.1 (2021-07-9)
+### Fixed
+* Fix bug for using path parameter and coerce option #115
+
 ## 0.14.0 (2021-05-24)
 
 ### Added

data/README.md

@@ -62,6 +62,33 @@ We support additional type validation.
 |---|---|---|
 |string|uuid|validate uuid string. But we don't check uuid layout|
 
+### Reference Validation on Schema Load
+Invalid references (missing definitions, typos, etc.) can cause validation to fail in runtime,
+and these errors can be difficult to debug (see: https://github.com/ota42y/openapi_parser/issues/29).
+
+Pass the `strict_reference_validation: true` option to detect invalid references.
+An `OpenAPIError::MissingReferenceError` exception will be raised when a reference cannot be resolved.
+
+If the `expand_reference` configuration is explicitly `false` (default is `true`), then
+this configuration has no effect.
+
+DEPRECATION NOTICE: To maintain compatibility with the previous behavior, this version sets `false` as a default.
+This behavior will be changed to `true` in a later version, so you should explicitly pass `strict_reference_validation: false`
+if you wish to keep the old behavior (and please let the maintainers know your use-case for this configuration!).
+
+```ruby
+yaml_file = YAML.load_file('open_api_3/schema_with_broken_references.yml')
+options = {
+  coerce_value: true,
+  datetime_coerce_class: DateTime,
+  # This defaults to false (for now) - passing `true` provides load-time validation of refs
+  strict_reference_validation: true
+}
+
+# Will raise with OpenAPIParser::MissingReferenceError
+OpenAPIParser.parse(yaml_file, options)
+```
+
 ## ToDo
 - correct schema checker
 - more detailed validator

data/Rakefile

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

data/Steepfile

@@ -0,0 +1,11 @@
+target :lib do
+  signature "sig"
+  #check "lib"
+
+  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"
+
+  library 'uri'
+end

data/lib/openapi_parser/concerns/expandable.rb

@@ -2,28 +2,28 @@ module OpenAPIParser::Expandable
   # expand refs
   # @param [OpenAPIParser::Schemas::Base] root
   # @return nil
-  def expand_reference(root)
-    expand_list_objects(root, self.class._openapi_attr_list_objects.keys)
-    expand_objects(root, self.class._openapi_attr_objects.keys)
-    expand_hash_objects(root, self.class._openapi_attr_hash_objects.keys)
-    expand_hash_objects(root, self.class._openapi_attr_hash_body_objects.keys)
+  def expand_reference(root, validate_references)
+    expand_list_objects(root, self.class._openapi_attr_list_objects.keys, validate_references)
+    expand_objects(root, self.class._openapi_attr_objects.keys, validate_references)
+    expand_hash_objects(root, self.class._openapi_attr_hash_objects.keys, validate_references)
+    expand_hash_objects(root, self.class._openapi_attr_hash_body_objects.keys, validate_references)
     nil
   end
 
   private
 
-    def expand_hash_objects(root, attribute_names)
+    def expand_hash_objects(root, attribute_names, validate_references)
       return unless attribute_names
 
-      attribute_names.each { |name| expand_hash_attribute(root, name) }
+      attribute_names.each { |name| expand_hash_attribute(root, name, validate_references) }
     end
 
-    def expand_hash_attribute(root, name)
+    def expand_hash_attribute(root, name, validate_references)
       h = send(name)
       return if h.nil?
 
       update_values = h.map do |k, v|
-        new_object = expand_object(root, v)
+        new_object = expand_object(root, v, validate_references)
         new_object.nil? ? nil : [k, new_object]
       end
 
@@ -33,14 +33,14 @@ module OpenAPIParser::Expandable
       end
     end
 
-    def expand_objects(root, attribute_names)
+    def expand_objects(root, attribute_names, validate_references)
       return unless attribute_names
 
       attribute_names.each do |name|
         v = send(name)
         next if v.nil?
 
-        new_object = expand_object(root, v)
+        new_object = expand_object(root, v, validate_references)
         next if new_object.nil?
 
         _update_child_object(v, new_object)
@@ -48,7 +48,7 @@ module OpenAPIParser::Expandable
       end
     end
 
-    def expand_list_objects(root, attribute_names)
+    def expand_list_objects(root, attribute_names, validate_references)
       return unless attribute_names
 
       attribute_names.each do |name|
@@ -56,7 +56,7 @@ module OpenAPIParser::Expandable
         next if l.nil?
 
         l.each_with_index do |v, idx|
-          new_object = expand_object(root, v)
+          new_object = expand_object(root, v, validate_references)
           next if new_object.nil?
 
           _update_child_object(v, new_object)
@@ -65,12 +65,15 @@ module OpenAPIParser::Expandable
       end
     end
 
-    def expand_object(root, object)
+    def expand_object(root, object, validate_references)
       if object.kind_of?(OpenAPIParser::Schemas::Reference)
-        return referenced_object(root, object)
+        ref_object = referenced_object(root, object)
+        raise OpenAPIParser::MissingReferenceError.new(object.ref) if ref_object.nil? && validate_references
+
+        return ref_object
       end
 
-      object.expand_reference(root) if object.kind_of?(OpenAPIParser::Expandable)
+      object.expand_reference(root, validate_references) if object.kind_of?(OpenAPIParser::Expandable)
       nil
     end
 

data/lib/openapi_parser/concerns/findable.rb

@@ -46,8 +46,8 @@ module OpenAPIParser::Findable
   private
 
     def find_remote_object(reference)
-      reference_uri = URI(reference)
-      fragment = reference_uri.fragment
+      uri, fragment = reference.split("#", 2)
+      reference_uri = URI(uri)
       reference_uri.fragment = nil
       root.load_another_schema(reference_uri)&.find_object("##{fragment}")
     end

data/lib/openapi_parser/concerns/parameter_validatable.rb

@@ -13,6 +13,12 @@ module OpenAPIParser::ParameterValidatable
     validate_query_parameter(params, object_reference, options)
   end
 
+  # @param [PathItem] path_item parent
+  def set_parent_path_item(path_item)
+    @merged_parameter = (parameters || []) + (path_item.parameters || [])
+    nil
+  end
+
   private
 
     # @param [Hash] params query parameter hash
@@ -44,7 +50,7 @@ module OpenAPIParser::ParameterValidatable
     # @return [Hash{String => Hash{String => Parameter}}] hash[in][name] => Parameter
     def divided_parameter_hash
       @divided_parameter_hash ||=
-        (parameters || []).
+        (@merged_parameter || []).
           group_by(&:in).
           map { |in_type, params| # rubocop:disable Style/BlockDelimiters
           [

data/lib/openapi_parser/config.rb

@@ -1,5 +1,13 @@
 class OpenAPIParser::Config
   def initialize(config)
+    # TODO: This deprecation warning can be removed after we set the default to `true`
+    # in a later (major?) version update.
+    unless config.key?(:strict_reference_validation)
+      msg = "[DEPRECATION] strict_reference_validation config is not set. It defaults to `false` now, " +
+          "but will be `true` in a future version. Please explicitly set to `false` " +
+          "if you want to skip reference validation on schema load."
+      warn(msg)
+    end
     @config = config
   end
 
@@ -16,9 +24,15 @@ class OpenAPIParser::Config
   end
 
   def strict_response_validation
+    # TODO: in a major version update, change this to default to `true`.
+    # https://github.com/ota42y/openapi_parser/pull/123/files#r767142217
     @config.fetch(:strict_response_validation, false)
   end
 
+  def strict_reference_validation
+    @config.fetch(:strict_reference_validation, false)
+  end
+
   def validate_header
     @config.fetch(:validate_header, true)
   end

data/lib/openapi_parser/errors.rb

@@ -5,6 +5,12 @@ module OpenAPIParser
     end
   end
 
+  class MissingReferenceError < OpenAPIError
+    def message
+      "'#{@reference}' was referenced but could not be found"
+    end
+  end
+
   class ValidateError < OpenAPIError
     def initialize(data, type, reference)
       super(reference)
@@ -200,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"

data/lib/openapi_parser/reference_expander.rb

@@ -1,8 +1,8 @@
 class OpenAPIParser::ReferenceExpander
   class << self
     # @param [OpenAPIParser::Schemas::OpenAPI] openapi
-    def expand(openapi)
-      openapi.expand_reference(openapi)
+    def expand(openapi, validate_references)
+      openapi.expand_reference(openapi, validate_references)
       openapi.purge_object_cache
     end
   end

data/lib/openapi_parser/request_operation.rb

@@ -65,7 +65,6 @@ class OpenAPIParser::RequestOperation
   # @param [OpenAPIParser::SchemaValidator::Options] options request validator options
   def validate_request_parameter(params, headers, options = nil)
     options ||= config.request_validator_options
-    path_item&.validate_request_parameter(params, headers, options)
     operation_object&.validate_request_parameter(params, headers, options)
   end
 

data/lib/openapi_parser/schema_validators/base.rb

@@ -1,6 +1,5 @@
 class OpenAPIParser::SchemaValidator
   class Base
-    # @param [OpenAPIParser::SchemaValidator::Validatable] validatable
     def initialize(validatable, coerce_value)
       @validatable = validatable
       @coerce_value = coerce_value
@@ -8,21 +7,17 @@ class OpenAPIParser::SchemaValidator
 
     attr_reader :validatable
 
-    # @!attribute [r] validatable
-    #   @return [OpenAPIParser::SchemaValidator::Validatable]
-
     # need override
-    # @param [Array] _value
-    # @param [OpenAPIParser::Schemas::Schema] _schema
     def coerce_and_validate(_value, _schema, **_keyword_args)
       raise 'need implement'
     end
 
     def validate_discriminator_schema(discriminator, value, parent_discriminator_schemas: [])
-      unless value.key?(discriminator.property_name)
+      property_name = discriminator.property_name
+      unless (property_name && value.key?(property_name))
         return [nil, OpenAPIParser::NotExistDiscriminatorPropertyName.new(discriminator.property_name, value, discriminator.object_reference)]
       end
-      mapping_key = value[discriminator.property_name]
+      mapping_key = value[property_name]
 
       # it's allowed to have discriminator without mapping, then we need to lookup discriminator.property_name
       # but the format is not the full path, just model name in the components

data/lib/openapi_parser/schema_validators/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/schemas/path_item.rb

@@ -3,8 +3,6 @@
 
 module OpenAPIParser::Schemas
   class PathItem < Base
-    include OpenAPIParser::ParameterValidatable
-
     openapi_attr_values :summary, :description
 
     openapi_attr_objects :get, :put, :post, :delete, :options, :head, :patch, :trace, Operation
@@ -16,5 +14,9 @@ module OpenAPIParser::Schemas
     rescue NoMethodError
       nil
     end
+
+    def set_path_item_to_operation
+      [:get, :put, :post, :delete, :options, :head, :patch, :trace].each{ |method| operation(method)&.set_parent_path_item(self)}
+    end
   end
 end

data/lib/openapi_parser/version.rb

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

data/lib/openapi_parser.rb

@@ -44,9 +44,9 @@ module OpenAPIParser
       # 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.
       content = if uri.scheme == 'file'
-        open(uri.path, &:read)
-      else
-        uri.open(&:read)
+        open(uri.path)&.read
+      elsif uri.is_a?(OpenURI::OpenRead)
+        uri.open()&.read
       end
 
       extension = Pathname.new(uri.path).extname
@@ -61,8 +61,8 @@ module OpenAPIParser
         URI.join("file:///",  path.to_s)
       end
 
-      def parse_file(content, extension)
-        case extension.downcase
+      def parse_file(content, ext)
+        case ext.downcase
         when '.yaml', '.yml'
           parse_yaml(content)
         when '.json'
@@ -91,7 +91,12 @@ module OpenAPIParser
       def load_hash(hash, config:, uri:, schema_registry:)
         root = Schemas::OpenAPI.new(hash, config, uri: uri, schema_registry: schema_registry)
 
-        OpenAPIParser::ReferenceExpander.expand(root) if config.expand_reference
+        OpenAPIParser::ReferenceExpander.expand(root, config.strict_reference_validation) if config.expand_reference
+
+        # TODO: use callbacks
+        root.paths&.path&.values&.each do | path_item |
+          path_item.set_path_item_to_operation
+        end
 
         root
       end

data/openapi_parser.gemspec

@@ -12,6 +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"
 
   # 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.
@@ -24,10 +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

@@ -0,0 +1,17 @@
+# Classes
+module OpenAPIParser
+  class Config
+    @config: untyped
+    alias request_body_options request_validator_options
+    alias path_params_options request_validator_options
+
+    def initialize: (untyped config) -> untyped
+    def datetime_coerce_class: -> (singleton(Object) | nil)
+    def coerce_value: -> bool
+    def expand_reference: -> bool
+    def strict_response_validation: -> bool
+    def validate_header: -> bool
+    def request_validator_options: -> OpenAPIParser::SchemaValidator::Options
+    def response_validate_options: -> OpenAPIParser::SchemaValidator::ResponseValidateOptions
+  end
+end

data/sig/openapi_parser/schema_validator.rbs

@@ -0,0 +1,46 @@
+# Classes
+module OpenAPIParser
+  class SchemaValidator
+    include Validatable
+    @value: Hash[bot, bot]
+    @schema: OpenAPIParser::Schemas::Schema
+    @coerce_value: bool | nil
+    @datetime_coerce_class: singleton(Object) | nil
+    @string_validator: OpenAPIParser::SchemaValidator::StringValidator | nil
+    @integer_validator: OpenAPIParser::SchemaValidator::IntegerValidator | nil
+    @float_validator: OpenAPIParser::SchemaValidator::FloatValidator | nil
+    @boolean_validator: OpenAPIParser::SchemaValidator::BooleanValidator | nil
+    @object_validator: OpenAPIParser::SchemaValidator::ObjectValidator | nil
+    @array_validator: OpenAPIParser::SchemaValidator::ArrayValidator | nil
+    @any_of_validator: OpenAPIParser::SchemaValidator::AnyOfValidator | nil
+    @all_of_validator: OpenAPIParser::SchemaValidator::AllOfValidator | nil
+    @one_of_validator: OpenAPIParser::SchemaValidator::OneOfValidator | nil
+    @nil_validator: OpenAPIParser::SchemaValidator::NilValidator | nil
+    @unspecified_type_validator: OpenAPIParser::SchemaValidator::UnspecifiedTypeValidator | nil
+
+    def self.validate: (Hash[bot, bot] value, OpenAPIParser::Schemas::Schema schema, OpenAPIParser::SchemaValidator::Options options) -> Object
+    def initialize: (Hash[bot, bot] value, OpenAPIParser::Schemas::Schema schema, OpenAPIParser::SchemaValidator::Options options) -> untyped
+    def validate_data: -> Object
+    def validate_schema: (Object value, OpenAPIParser::Schemas::Schema schema, **bot) -> [Object, OpenAPIParser::validate_error]
+    def validate_integer: (Object value, OpenAPIParser::Schemas::Schema schema) -> [Object, OpenAPIParser::validate_error]
+
+    private
+    def validator: (Object value, OpenAPIParser::Schemas::Schema schema) -> [OpenAPIParser::SchemaValidator::Base, OpenAPIParser::validate_error]
+    def string_validator: -> OpenAPIParser::SchemaValidator::StringValidator
+    def integer_validator: -> OpenAPIParser::SchemaValidator::IntegerValidator
+    def float_validator: -> OpenAPIParser::SchemaValidator::FloatValidator
+    def boolean_validator: -> OpenAPIParser::SchemaValidator::BooleanValidator
+    def object_validator: -> OpenAPIParser::SchemaValidator::ObjectValidator
+    def array_validator: -> OpenAPIParser::SchemaValidator::ArrayValidator
+    def any_of_validator: -> OpenAPIParser::SchemaValidator::AnyOfValidator
+    def all_of_validator: -> OpenAPIParser::SchemaValidator::AllOfValidator
+    def one_of_validator: -> OpenAPIParser::SchemaValidator::OneOfValidator
+    def nil_validator: -> OpenAPIParser::SchemaValidator::NilValidator
+    def unspecified_type_validator: -> OpenAPIParser::SchemaValidator::UnspecifiedTypeValidator
+
+    module Validatable
+      def validate_schema: (Object value, OpenAPIParser::Schemas::Schema schema, **untyped) -> [Object, OpenAPIParser::validate_error]
+      def validate_integer: (Object _value, OpenAPIParser::Schemas::Schema _schema) -> [Object, OpenAPIParser::validate_error]
+    end
+  end
+end

data/sig/openapi_parser/schema_validators/base.rbs

@@ -0,0 +1,17 @@
+# Classes
+module OpenAPIParser
+  class SchemaValidator
+    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 validate_discriminator_schema: (
+        OpenAPIParser::Schemas::Discriminator discriminator, 
+        Hash[String, bot] value,
+        ?parent_discriminator_schemas: Array[OpenAPIParser::Schemas::Schema]
+      ) -> [Object | nil, OpenAPIParser::validate_error]
+    end
+  end
+end

data/sig/openapi_parser/schema_validators/options.rbs

@@ -0,0 +1,17 @@
+# Classes
+module OpenAPIParser
+  class SchemaValidator
+    class Options
+      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
+    end
+
+    class ResponseValidateOptions
+      attr_reader strict: bool
+      attr_reader validate_header: bool
+      def initialize: (?strict: bool, ?validate_header: bool) -> untyped
+    end
+  end
+end

data/sig/openapi_parser/schemas/base.rbs

@@ -0,0 +1,17 @@
+# Classes
+module OpenAPIParser
+  module Schemas
+    class Base
+      include OpenAPIParser::Expandable
+      include OpenAPIParser::Findable
+    
+      attr_reader parent: OpenAPIParser::Schemas::Base | nil
+      attr_reader raw_schema: Hash[String, bot]
+      attr_reader object_reference: String
+      attr_reader root: OpenAPIParser::Schemas::OpenAPI
+      def initialize: (String object_reference, OpenAPIParser::Schemas::Base | nil parent, OpenAPIParser::Schemas::OpenAPI root, Hash[String, bot] raw_schema) -> nil
+      def after_init: -> nil
+      def inspect: -> String
+    end
+  end
+end

data/sig/openapi_parser/version.rbs

@@ -0,0 +1,3 @@
+module OpenAPIParser
+  VERSION: String
+end

data/sig/openapi_parser.rbs

@@ -0,0 +1,19 @@
+module OpenAPIParser
+  def self.parse: (Hash[bot, bot] schema, ?Hash[bot, bot] config) -> OpenAPIParser::Schemas::OpenAPI
+  def self.parse_with_filepath: (Hash[bot, bot] schema, String filepath, ?Hash[bot, bot] config) -> OpenAPIParser::Schemas::OpenAPI
+  def self.load: (String filepath, ?Hash[bot, bot] config) -> OpenAPIParser::Schemas::OpenAPI
+  def self.load_uri: (OpenAPIParser::readable_uri uri, config: untyped, schema_registry: Hash[bot, bot]) -> OpenAPIParser::Schemas::OpenAPI
+  def self.file_uri: (String filepath) -> URI::Generic
+  def self.parse_file: (String? content, String ext) -> Hash[bot, bot]
+  def self.parse_yaml: (String? content) -> Hash[bot, bot]
+  def self.parse_json: (String? content) -> Hash[bot, bot]
+  def self.load_hash: (Hash[bot, bot] hash, config: untyped, uri: OpenAPIParser::readable_uri?, schema_registry: Hash[bot, bot]) -> OpenAPIParser::Schemas::OpenAPI
+end
+
+module OpenAPIParser
+  module Schemas
+    class OpenAPI
+      def initialize: (Hash[bot, bot] hash, untyped config, uri: OpenAPIParser::readable_uri?, schema_registry: Hash[bot, bot]) -> OpenAPIParser::Schemas::OpenAPI
+    end
+  end
+end

data/sig/types.rbs

@@ -0,0 +1,8 @@
+module OpenURI
+  module OpenRead
+    def open: () -> (IO | nil)
+    def path: () -> String
+    def scheme: () -> String
+  end
+end
+

data/sig/wip_types.rbs

@@ -0,0 +1,67 @@
+module OpenAPIParser
+  type readable_uri = URI::Generic | OpenURI::OpenRead
+  type validate_error = nil
+end
+                 
+module OpenAPIParser
+  module Schemas
+    class Schema
+    end
+  end
+end
+
+class OpenAPIParser::SchemaValidator::Base
+end
+
+class OpenAPIParser::SchemaValidator::StringValidator
+end
+
+class OpenAPIParser::SchemaValidator::IntegerValidator
+end
+
+class OpenAPIParser::SchemaValidator::FloatValidator
+end
+
+class OpenAPIParser::SchemaValidator::BooleanValidator
+end
+
+class OpenAPIParser::SchemaValidator::ObjectValidator
+end
+
+class OpenAPIParser::SchemaValidator::ArrayValidator
+end
+
+class OpenAPIParser::SchemaValidator::AnyOfValidator
+end
+
+class OpenAPIParser::SchemaValidator::AllOfValidator
+end
+
+class OpenAPIParser::SchemaValidator::OneOfValidator
+end
+
+class OpenAPIParser::SchemaValidator::NilValidator
+end
+
+class OpenAPIParser::SchemaValidator::UnspecifiedTypeValidator
+end
+
+class OpenAPIParser::Schemas::OpenAPI < OpenAPIParser::Schemas::Base 
+  attr_reader paths: untyped
+end
+
+module OpenAPIParser::Expandable
+  def expand_reference: (OpenAPIParser::Schemas::OpenAPI root) -> nil
+end
+
+module OpenAPIParser::Findable
+  def find_object: (String reference) -> ::OpenAPIParser::Schemas::Schema
+end
+
+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: 0.14.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ota42y
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  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: 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
@@ -134,12 +162,14 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_ignore.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - lib/openapi_parser.rb
@@ -204,6 +234,15 @@ files:
 - lib/openapi_parser/schemas/schema.rb
 - lib/openapi_parser/version.rb
 - openapi_parser.gemspec
+- sig/openapi_parser.rbs
+- sig/openapi_parser/config.rbs
+- sig/openapi_parser/schema_validator.rbs
+- sig/openapi_parser/schema_validators/base.rbs
+- sig/openapi_parser/schema_validators/options.rbs
+- sig/openapi_parser/schemas/base.rbs
+- sig/openapi_parser/version.rbs
+- sig/types.rbs
+- sig/wip_types.rbs
 homepage: https://github.com/ota42y/openapi_parser
 licenses:
 - MIT
@@ -216,14 +255,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: OpenAPI3 parser