openapi_parser 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c94d0bbb5e44314e9cde71c23587355496214b1fdf6ca2e3bf43f404087b6220
-  data.tar.gz: be8205b97559da91e85613df31c2ac0e060116046532e4285eb01127c0303eae
+  metadata.gz: 9afe7e0164ddcad6c8a8fbb6d57e0514e32df10d014bc642b88fa3473f1f8d74
+  data.tar.gz: cefb18a632f4a16dd948fe2e82fadfc0236a159af2406fdcb52db50ef6dc980e
 SHA512:
-  metadata.gz: a844336ca5d80573478d7e35d6978881c8d0581e2757584e227781c5b523e1f181f5403c4efb4047df3a9c519043ab0513bbaf5df83acff12d54f0d2c19874a2
-  data.tar.gz: 406ad0fc2ad51af48b56ba1bf2ace1cac8b920adb85615e160e901aacbacf58c94a02cf4c737cf0601a6bab120bc2c51b3d7cd3f9da0295138edbc63bf7cf8ae
+  metadata.gz: fb0397b9251edac7e3bfb15e30041d5945a466c21b6671183eaec8491a372730e2f76101af71efbc7c07c66345353c260983acfb69d80f2b066c35c71207a076
+  data.tar.gz: 5a58f4b47946ca9c376dcce3c5be34de998a2bc3d59ee4321e2e7f0425c7cdf6b809ff9eb3a103fe099a849210def6c362431628610fdde137b3b79157a32849

data/.gitignore

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

data/.travis.yml

@@ -7,9 +7,10 @@ language: ruby
 rvm:
   - 2.3.8
   - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
   - ruby-head
 
 cache: bundler

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## Unreleased
 
+## 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
+
 ## 0.11.0 (2020-05-09)
 * Add committee friendly interface to use remote references. #74
 * Prevent SystemStackError on recursive schema reference #76

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
@@ -30,6 +33,8 @@ module OpenAPIParser::Findable
   end
 
   def purge_object_cache
+    @purged = false unless defined? @purged
+
     return if @purged
 
     @find_object_cache = {}

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,7 @@ 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
 
@@ -208,7 +208,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 +219,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 +230,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 +241,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_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/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.13.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - ota42y
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -207,7 +207,7 @@ homepage: https://github.com/ota42y/openapi_parser
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +222,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: []