openapi_parser 0.10.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98afa3c7fb754859a594373659d18ebb81483581c948621d0ea050c360da38ec
-  data.tar.gz: 9cf7b695875b6ca55a89a3d5e1a288381d39e203c5fbb469beeb7465232ff0a5
+  metadata.gz: e25413096d326cffe71e82846cc5c95c10c9d453ef7ec2026840cebc9d90ff67
+  data.tar.gz: e2c3efef0cab1f63e0c4c682802e4a377b711b769ffce3203b47a2313c5da235
 SHA512:
-  metadata.gz: ddc32d47e0072b78f4790a6b6fa031eab103bb4665d5c0cfe4e7ac2ac9b2e04a048a82f4ddefd40fd112221e389cd86568ac67c3ca9db6f46ae4b9f8ece23c8a
-  data.tar.gz: bdd2fdeaec224eaecdde6088abc7eb69513a4ab9e2afffbf23a6a21f9e13a640bddaf6bd7fbbaab16dff588c021bc12296aefd01b1efcb28908f33f8b263f9ad
+  metadata.gz: 1ddcd885be5ccfdd2cc74f60731517e9a18617d001abb3c95767905c6629e5fe6925e39cfb2668c81a94696974aab22a6a20f7eb96f403d189f9d3f6957f3fd2
+  data.tar.gz: b588c5ebfcecb63112c8cbf97bfdacc26bcdfdcea24d38315f20210eeb4b93848ed58dd3c415d8b866363b579f026a5449993932e919005509e6254ea3d3671b

data/.gitignore

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

data/.travis.yml

@@ -6,9 +6,10 @@ language: ruby
 
 rvm:
   - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
   - ruby-head
 
 cache: bundler

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## Unreleased
 
+## 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
+* support newest ruby versions #78
+
 ## 0.10.0 (2020-04-01)
 * Support $ref to objects in other OpenAPI yaml files #66
 * Allow $ref for path item objects #71

data/lib/openapi_parser.rb

@@ -18,18 +18,24 @@ require 'openapi_parser/reference_expander'
 
 module OpenAPIParser
   class << self
-    # Load schema yaml object. Uri is not set for returned schema.
+    # Load schema hash object. Uri is not set for returned schema.
     # @return [OpenAPIParser::Schemas::OpenAPI]
     def parse(schema, config = {})
       load_hash(schema, config: Config.new(config), uri: nil, schema_registry: {})
     end
 
+    # @param filepath [String] Path of the file containing the passed schema.
+    #   Used for resolving remote $ref if provided.
+    #   If file path is relative, it is resolved using working directory.
+    # @return [OpenAPIParser::Schemas::OpenAPI]
+    def parse_with_filepath(schema, filepath, config = {})
+      load_hash(schema, config: Config.new(config), uri: filepath && file_uri(filepath), schema_registry: {})
+    end
+
     # Load schema in specified filepath. If file path is relative, it is resolved using working directory.
     # @return [OpenAPIParser::Schemas::OpenAPI]
     def load(filepath, config = {})
-      path = Pathname.new(filepath)
-      path = Pathname.getwd + path if path.relative?
-      load_uri(URI.join("file:///",  path.to_s), config: Config.new(config), schema_registry: {})
+      load_uri(file_uri(filepath), config: Config.new(config), schema_registry: {})
     end
 
     # Load schema located by the passed uri. Uri must be absolute.
@@ -49,6 +55,12 @@ module OpenAPIParser
 
     private
 
+      def file_uri(filepath)
+        path = Pathname.new(filepath)
+        path = Pathname.getwd + path if path.relative?
+        URI.join("file:///",  path.to_s)
+      end
+
       def parse_file(content, extension)
         case extension.downcase
         when '.yaml', '.yml'
@@ -66,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,9 +1,11 @@
+require 'cgi'
 require 'uri'
 
 module OpenAPIParser::Findable
   # @param [String] reference
   # @return [OpenAPIParser::Findable]
   def find_object(reference)
+    reference = CGI.unescape(reference)
     return self if object_reference == reference
     remote_reference = !reference.start_with?('#')
     return find_remote_object(reference) if remote_reference
@@ -30,7 +32,12 @@ module OpenAPIParser::Findable
   end
 
   def purge_object_cache
+    @purged = false unless defined? @purged
+
+    return if @purged
+
     @find_object_cache = {}
+    @purged = true
 
     _openapi_all_child_objects.values.each(&:purge_object_cache)
   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,7 +129,7 @@ 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
@@ -105,12 +140,12 @@ class OpenAPIParser::PathItemFinder
     # 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/base.rb

@@ -34,7 +34,7 @@ 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})
     end
   end
 end

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.12.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.1
 platform: ruby
 authors:
 - ota42y
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: OpenAPI3 parser