openapi_parser 0.11.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19a8fdbdbc8e1f8bf0ffe99c10a9db62b71efb1314b8fbd868a0320e99aa8198
-  data.tar.gz: 91c4bd31ed3fbde869967ba20bb6bb8bd4b279b1950ad1565e614b7ee6e45a10
+  metadata.gz: b1b06e3e4d6ad28828a02c2a4a79140439b9119ac53b73494318386195cc6275
+  data.tar.gz: 4360946a10aa364d8c0de18d773eee3df2ee683373de2178307f52530806e81a
 SHA512:
-  metadata.gz: 6e21bb707a5d0fd61dbb806690c984cc317823f4c18bc54a6bdc1a186addbb7845b1202a7c4e719c6027f6bf32b97b48958ec4a7335c9cc545bab77b167b5c37
-  data.tar.gz: a02864ccc5c5a64aba3ec84bb265c793f42ea7886356732d802f0934159da439659b44d1109c71b2335ec340970ba68c50760a5355e00e7e91f0465a0a850a07
+  metadata.gz: be2a98609d41e4207edff4aaa61687b34dc568cb36e38b37eef42c7edffc836ffb9110465dda772c41025bc0fce125115da370e36949414ceb8902051c81b7b8
+  data.tar.gz: 3047ab4d4ef9f465e9c9373567c11e323ecd135d994002d8578426bdc38d5cdbe5922050d66bdf701551fb10fcb3206029276b49a33e2bc1d755278cb105a9e3

data/.github/workflows/ci.yaml

@@ -0,0 +1,17 @@
+name: ci
+on: [push]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.4, 2.5, 2.6, 2.7, '3.0', head]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -7,6 +7,9 @@
 /spec/reports/
 /tmp/
 
+# RubyMine
+.idea
+
 # rspec failure tracking
 .rspec_status
-Gemfile.lock
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## Unreleased
 
+## 0.14.0 (2021-05-24)
+
+### Added
+* Add basic polymorphism handling #103
+* Support empty schema as any type #109
+* Add date format validation for string #102
+
+### Fixed
+* Fix anyOf coercion to float and integer when value is a non-string type #110
+
+## 0.13.0 (2021-05-01)
+* Fix a problem with remote reference to path items which have path parameters #95
+* Support enum for booleans. #104
+
+## 0.12.1 (2020-08-27)
+* Use CGI.unescape (warning fix) #92
+
+## 0.12.0 (2020-08-26)
+* Find path by extracted params than path length #84
+* Unescape ref URI before lookup in OpenAPIParser::Findable #85
+* Improved path parameter matching code to allow file extensions, multiple parameters inside one path element, etc #90
+
+## 0.11.2 (2020-05-23)
+* Allow date and time content in YAML #81
+
 ## 0.11.1 (2020-05-09)
 * fix too many warning
 

data/README.md

@@ -1,9 +1,7 @@
 # OpenAPI Parser
-[![Build Status](https://travis-ci.org/ota42y/openapi_parser.svg?branch=master)](https://travis-ci.org/ota42y/openapi_parser)
+[![ci](https://github.com/ota42y/openapi_parser/actions/workflows/ci.yaml/badge.svg)](https://github.com/ota42y/openapi_parser/actions/workflows/ci.yaml)
 [![Gem Version](https://badge.fury.io/rb/openapi_parser.svg)](https://badge.fury.io/rb/openapi_parser)
 [![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/openapi_parser)
-[![Maintainability](https://api.codeclimate.com/v1/badges/62bad4bcb3f691d46487/maintainability)](https://codeclimate.com/github/ota42y/openapi_parser/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/62bad4bcb3f691d46487/test_coverage)](https://codeclimate.com/github/ota42y/openapi_parser/test_coverage)
 [![Inch CI](https://inch-ci.org/github/ota42y/openapi_parser.svg?branch=master)](https://inch-ci.org/github/ota42y/openapi_parser)
 
 This is OpenAPI3 parser and validator. 

data/lib/openapi_parser.rb

@@ -78,7 +78,10 @@ module OpenAPIParser
       end
 
       def parse_yaml(content)
-        Psych.safe_load(content)
+        # FIXME: when drop ruby 2.5, we should use permitted_classes
+        (Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.6.0")) ? 
+          Psych.safe_load(content, [Date, Time]) : 
+          Psych.safe_load(content, permitted_classes: [Date, Time])
       end
 
       def parse_json(content)

data/lib/openapi_parser/concerns/findable.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 require 'uri'
 
 module OpenAPIParser::Findable
@@ -9,19 +10,21 @@ module OpenAPIParser::Findable
     return find_remote_object(reference) if remote_reference
     return nil unless reference.start_with?(object_reference)
 
+    unescaped_reference = CGI.unescape(reference)
+
     @find_object_cache = {} unless defined? @find_object_cache
-    if (obj = @find_object_cache[reference])
+    if (obj = @find_object_cache[unescaped_reference])
       return obj
     end
 
-    if (child = _openapi_all_child_objects[reference])
-      @find_object_cache[reference] = child
+    if (child = _openapi_all_child_objects[unescaped_reference])
+      @find_object_cache[unescaped_reference] = child
       return child
     end
 
     _openapi_all_child_objects.values.each do |c|
-      if (obj = c.find_object(reference))
-        @find_object_cache[reference] = obj
+      if (obj = c.find_object(unescaped_reference))
+        @find_object_cache[unescaped_reference] = obj
         return obj
       end
     end

data/lib/openapi_parser/errors.rb

@@ -13,7 +13,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} expected #{@type}, but received #{@data.class}: #{@data}"
+      "#{@reference} expected #{@type}, but received #{@data.class}: #{@data.inspect}"
     end
 
     class << self
@@ -73,7 +73,7 @@ module OpenAPIParser
     end
 
     def message
-      "discriminator propertyName #{@key} does not exist in value #{@value} in #{@reference}"
+      "discriminator propertyName #{@key} does not exist in value #{@value.inspect} in #{@reference}"
     end
   end
 
@@ -84,7 +84,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@value} isn't one of in #{@reference}"
+      "#{@value.inspect} isn't one of in #{@reference}"
     end
   end
 
@@ -95,7 +95,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@value} isn't any of in #{@reference}"
+      "#{@value.inspect} isn't any of in #{@reference}"
     end
   end
 
@@ -106,7 +106,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@value} isn't include enum in #{@reference}"
+      "#{@value.inspect} isn't part of the enum in #{@reference}"
     end
   end
 
@@ -117,7 +117,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} is less than minimum value"
+      "#{@reference} #{@value.inspect} is less than minimum value"
     end
   end
 
@@ -128,7 +128,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} cannot be less than or equal to exclusive minimum value"
+      "#{@reference} #{@value.inspect} cannot be less than or equal to exclusive minimum value"
     end
   end
 
@@ -139,7 +139,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} is more than maximum value"
+      "#{@reference} #{@value.inspect} is more than maximum value"
     end
   end
 
@@ -150,7 +150,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} cannot be more than or equal to exclusive maximum value"
+      "#{@reference} #{@value.inspect} cannot be more than or equal to exclusive maximum value"
     end
   end
 
@@ -163,7 +163,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} pattern #{@pattern} does not match value: #{@value}#{@example ? ", example: #{@example}" : ""}"
+      "#{@reference} pattern #{@pattern} does not match value: #{@value.inspect}#{@example ? ", example: #{@example}" : ""}"
     end
   end
 
@@ -174,7 +174,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} email address format does not match value: #{@value}"
+      "#{@reference} email address format does not match value: #{@value.inspect}"
     end
   end
 
@@ -185,7 +185,18 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} Value: #{@value} is not conformant with UUID format"
+      "#{@reference} Value: #{@value.inspect} is not conformant with UUID format"
+    end
+  end
+
+  class InvalidDateFormat < OpenAPIError
+    def initialize(value, reference)
+      super(reference)
+      @value = value
+    end
+
+    def message
+      "#{@reference} Value: #{@value.inspect} is not conformant with date format"
     end
   end
 
@@ -208,7 +219,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} is longer than max length"
+      "#{@reference} #{@value.inspect} is longer than max length"
     end
   end
 
@@ -219,7 +230,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} is shorter than min length"
+      "#{@reference} #{@value.inspect} is shorter than min length"
     end
   end
 
@@ -230,7 +241,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} contains more than max items"
+      "#{@reference} #{@value.inspect} contains more than max items"
     end
   end
 
@@ -241,7 +252,7 @@ module OpenAPIParser
     end
 
     def message
-      "#{@reference} #{@value} contains fewer than min items"
+      "#{@reference} #{@value.inspect} contains fewer than min items"
     end
   end
 end

data/lib/openapi_parser/path_item_finder.rb

@@ -38,7 +38,41 @@ class OpenAPIParser::PathItemFinder
     end
   end
 
+  def parse_path_parameters(schema_path, request_path)
+    parameters = path_parameters(schema_path)
+    return nil if parameters.empty?
+
+    # If there are regex special characters in the path, the regex will
+    # be too permissive, so escape the non-parameter parts.
+    components = []
+    unprocessed = schema_path.dup
+    parameters.each do |parameter|
+      parts = unprocessed.partition(parameter)
+      components << Regexp.escape(parts[0]) unless parts[0] == ''
+      components << "(?<#{param_name(parameter)}>.+)"
+      unprocessed = parts[2]
+    end
+    components << Regexp.escape(unprocessed) unless unprocessed == ''
+
+    regex = components.join('')
+    matches = request_path.match(regex)
+    return nil unless matches
+
+    # Match up the captured names with the captured values as a hash
+    matches.names.zip(matches.captures).to_h
+  end
+
   private
+    def path_parameters(schema_path)
+      # OAS3 follows a RFC6570 subset for URL templates
+      # https://swagger.io/docs/specification/serialization/#uri-templates
+      # A URL template param can be preceded optionally by a "." or ";", and can be succeeded optionally by a "*";
+      # this regex returns a match of the full parameter name with all of these modifiers. Ex: {;id*}
+      parameters = schema_path.scan(/(\{[\.;]*[^\{\*\}]+\**\})/)
+      # The `String#scan` method returns an array of arrays; we want an array of strings
+      parameters.collect { |param| param[0] }
+    end
+
     # check if there is a identical path in the schema (without any param)
     def matches_directly?(request_path, http_method)
       @paths.path[request_path]&.operation(http_method)
@@ -70,8 +104,9 @@ class OpenAPIParser::PathItemFinder
       splitted_request_path.zip(splitted_schema_path).reduce({}) do |result, zip_item|
         request_path_item, schema_path_item = zip_item
 
-        if path_template?(schema_path_item)
-          result[param_name(schema_path_item)] = request_path_item
+        params = parse_path_parameters(schema_path_item, request_path_item)
+        if params
+          result.merge!(params)
         else
           return if schema_path_item != request_path_item
         end
@@ -80,7 +115,7 @@ class OpenAPIParser::PathItemFinder
       end
     end
 
-    # find all matching patchs with parameters extracted
+    # find all matching paths with parameters extracted
     # EXAMPLE:
     # [
     #    ['/user/{id}/edit', { 'id' => 1 }],
@@ -94,23 +129,23 @@ class OpenAPIParser::PathItemFinder
         splitted_schema_path = path.split('/')
 
         next result if different_depth_or_method?(splitted_schema_path, splitted_request_path, path_item, http_method)
-        
+
         extracted_params = extract_params(splitted_request_path, splitted_schema_path)
         result << [path, extracted_params] if extracted_params
         result
       end
     end
 
-    # find mathing path and extract params
+    # find matching path and extract params
     # EXAMPLE: find_path_and_params('get', '/user/1') => ['/user/{id}', { 'id' => 1 }]
     def find_path_and_params(http_method, request_path)
       return [request_path, {}] if matches_directly?(request_path, http_method)
-      
+
       matching = matching_paths_with_params(request_path, http_method)
 
       # if there are many matching paths, return the one with the smallest number of params
       # (prefer /user/{id}/action over /user/{param_1}/{param_2} )
-      matching.min_by { |match| match[0].size } 
+      matching.min_by { |match| match[1].size }
     end
 
     def parse_request_path(http_method, request_path)

data/lib/openapi_parser/schema_validator.rb

@@ -12,6 +12,7 @@ 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'
 
 class OpenAPIParser::SchemaValidator
   # validate value by schema
@@ -113,7 +114,7 @@ class OpenAPIParser::SchemaValidator
       when 'array'
         array_validator
       else
-        nil
+        unspecified_type_validator
       end
     end
 
@@ -156,4 +157,8 @@ class OpenAPIParser::SchemaValidator
     def nil_validator
       @nil_validator ||= OpenAPIParser::SchemaValidator::NilValidator.new(self, @coerce_value)
     end
+
+    def unspecified_type_validator
+      @unspecified_type_validator ||= OpenAPIParser::SchemaValidator::UnspecifiedTypeValidator.new(self, @coerce_value)
+    end
 end

data/lib/openapi_parser/schema_validators/all_of_validator.rb

@@ -4,13 +4,18 @@ class OpenAPIParser::SchemaValidator
     # coerce and validate value
     # @param [Object] value
     # @param [OpenAPIParser::Schemas::Schema] schema
-    def coerce_and_validate(value, schema, **_keyword_args)
+    def coerce_and_validate(value, schema, **keyword_args)
       # if any schema return error, it's not valida all of value
       remaining_keys               = value.kind_of?(Hash) ? value.keys : []
       nested_additional_properties = false
       schema.all_of.each do |s|
         # We need to store the reference to all of, so we can perform strict check on allowed properties
-        _coerced, err = validatable.validate_schema(value, s, :parent_all_of => true)
+        _coerced, err = validatable.validate_schema(
+          value,
+          s,
+          :parent_all_of => true,
+          parent_discriminator_schemas: keyword_args[:parent_discriminator_schemas]
+        )
 
         if s.type == "object"
           remaining_keys               -= (s.properties || {}).keys

data/lib/openapi_parser/schema_validators/base.rb

@@ -18,7 +18,7 @@ class OpenAPIParser::SchemaValidator
       raise 'need implement'
     end
 
-    def validate_discriminator_schema(discriminator, value)
+    def validate_discriminator_schema(discriminator, value, parent_discriminator_schemas: [])
       unless value.key?(discriminator.property_name)
         return [nil, OpenAPIParser::NotExistDiscriminatorPropertyName.new(discriminator.property_name, value, discriminator.object_reference)]
       end
@@ -34,7 +34,11 @@ class OpenAPIParser::SchemaValidator
       unless resolved_schema
         return [nil, OpenAPIParser::NotExistDiscriminatorMappedSchema.new(mapping_target, discriminator.object_reference)]
       end
-      validatable.validate_schema(value, resolved_schema, **{discriminator_property_name: discriminator.property_name})
+      validatable.validate_schema(
+        value,
+        resolved_schema,
+        **{discriminator_property_name: discriminator.property_name, parent_discriminator_schemas: parent_discriminator_schemas}
+      )
     end
   end
 end

data/lib/openapi_parser/schema_validators/boolean_validator.rb

@@ -1,5 +1,7 @@
 class OpenAPIParser::SchemaValidator
   class BooleanValidator < Base
+    include ::OpenAPIParser::SchemaValidator::Enumable
+
     TRUE_VALUES = ['true', '1'].freeze
     FALSE_VALUES = ['false', '0'].freeze
 
@@ -8,6 +10,9 @@ class OpenAPIParser::SchemaValidator
 
       return OpenAPIParser::ValidateError.build_error_result(value, schema) unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
 
+      value, err = check_enum_include(value, schema)
+      return [nil, err] if err
+
       [value, nil]
     end
 

data/lib/openapi_parser/schema_validators/float_validator.rb

@@ -21,14 +21,14 @@ class OpenAPIParser::SchemaValidator
 
         value, err = check_enum_include(value, schema)
         return [nil, err] if err
-        
+
         check_minimum_maximum(value, schema)
       end
 
       def coerce(value)
         Float(value)
-      rescue ArgumentError => e
-        raise e unless e.message =~ /invalid value for Float/
+      rescue ArgumentError, TypeError
+        value
       end
   end
 end

data/lib/openapi_parser/schema_validators/integer_validator.rb

@@ -23,12 +23,10 @@ class OpenAPIParser::SchemaValidator
         return value if value.kind_of?(Integer)
 
         begin
-          return Integer(value)
-        rescue ArgumentError => e
-          raise e unless e.message =~ /invalid value for Integer/
+          Integer(value)
+        rescue ArgumentError, TypeError
+          value
         end
-
-        value
       end
   end
 end

data/lib/openapi_parser/schema_validators/object_validator.rb

@@ -4,7 +4,7 @@ class OpenAPIParser::SchemaValidator
     # @param [OpenAPIParser::Schemas::Schema] schema
     # @param [Boolean] parent_all_of true if component is nested under allOf
     # @param [String, nil] discriminator_property_name discriminator.property_name to ignore checking additional_properties
-    def coerce_and_validate(value, schema, parent_all_of: false, discriminator_property_name: nil)
+    def coerce_and_validate(value, schema, parent_all_of: false, parent_discriminator_schemas: [], discriminator_property_name: nil)
       return OpenAPIParser::ValidateError.build_error_result(value, schema) unless value.kind_of?(Hash)
 
       properties = schema.properties || {}
@@ -12,6 +12,16 @@ class OpenAPIParser::SchemaValidator
       required_set = schema.required ? schema.required.to_set : Set.new
       remaining_keys = value.keys
 
+      if schema.discriminator && !parent_discriminator_schemas.include?(schema)
+        return validate_discriminator_schema(
+          schema.discriminator,
+          value,
+          parent_discriminator_schemas: parent_discriminator_schemas + [schema]
+        )
+      else
+        remaining_keys.delete('discriminator')
+      end
+
       coerced_values = value.map do |name, v|
         s = properties[name]
         coerced, err = if s

data/lib/openapi_parser/schema_validators/string_validator.rb

@@ -30,6 +30,9 @@ class OpenAPIParser::SchemaValidator
       value, err = validate_uuid_format(value, schema)
       return [nil, err] if err
 
+      value, err = validate_date_format(value, schema)
+      return [nil, err] if err
+
       [value, nil]
     end
 
@@ -86,5 +89,17 @@ class OpenAPIParser::SchemaValidator
 
         return [nil, OpenAPIParser::InvalidUUIDFormat.new(value, schema.object_reference)]
       end
+
+      def validate_date_format(value, schema)
+        return [value, nil] unless schema.format == 'date'
+
+        begin
+          Date.strptime(value, "%Y-%m-%d")
+        rescue ArgumentError
+          return [nil, OpenAPIParser::InvalidDateFormat.new(value, schema.object_reference)]
+        end
+
+        return [value, nil]
+      end
   end
 end

data/lib/openapi_parser/schema_validators/unspecified_type_validator.rb

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

data/lib/openapi_parser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.14.0
 platform: ruby
 authors:
 - ota42y
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2021-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,11 +129,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_ignore.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -184,6 +184,7 @@ files:
 - 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/schemas.rb
 - lib/openapi_parser/schemas/base.rb
 - lib/openapi_parser/schemas/classes.rb
@@ -207,7 +208,7 @@ homepage: https://github.com/ota42y/openapi_parser
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: OpenAPI3 parser
 test_files: []

data/.travis.yml

@@ -1,37 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=b49a1717b8ff0aef9eced41d0f87d350a88b46d55083ba2e3df8b6f441ae3fb7
-
-language: ruby
-
-rvm:
-  - 2.3.8
-  - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-  - ruby-head
-
-cache: bundler
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script: bundle exec rspec
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-notifications:
-  email: false
-
-sudo: false
-
-git:
-  depth: 10
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head