openapi_parser 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7480b22f5a7f1e12c9c1d2b21dbcc50b711bb06fba8f31e7cdff9f340f7f6fe8
-  data.tar.gz: d9fecd50469f7e3f8bf88cf5076c8b78df24a5d825920748f518bcbd38ca0677
+  metadata.gz: e6fdbfb2bf6d7101bc016fc611e144cba0c53ee1456f433f62200f6b216d15ef
+  data.tar.gz: 27f093ed770beca6b908f9079306afc4f74d81de136c9da8e295ab3ccf833cc6
 SHA512:
-  metadata.gz: 18af5156bd11cd2388608f2c835cfc44a049f55e5729c25997d44a7e434f00f9278ea1b39ef5490044aa950252148585e101f021659d34fa023046af03f96401
-  data.tar.gz: e706defe789e26b503018653b8be22671a0155a2bbc39ac62c29603e7bd9a58f1cb923c9f7b51a858dde34ae06397860c1c68345828fff5be386866a2f6ca236
+  metadata.gz: c179283bac82745556d85ee1c02dcf0a2135caa60ff16c6f6b1fa44ff83de531631cc4b39da00c12b0a9e3e11eb2e606d9dc2b53f7b53cee47aa4e4e7a12e709
+  data.tar.gz: 1638236c9fd1b22b7922ce8e2f81c942748101ef71e919fa7333b8a7e854a43c5e9ba738e47a61ffd823f682997f33c15634b18f515a88d5ddb7670bda205965

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 0.7.0 (2020-01-15)
+* Avoid potential `.send(:exit)` #58
+* Improve PathItemFinder #44
+
 ## 0.6.1 (2019-10-12)
 * Bugfix: validate non-nullable response header #54
 * Improve grammar in error messages #55

data/lib/openapi_parser/path_item_finder.rb

@@ -1,10 +1,7 @@
 class OpenAPIParser::PathItemFinder
   # @param [OpenAPIParser::Schemas::Paths] paths
   def initialize(paths)
-    @root = PathNode.new('/')
     @paths = paths
-
-    @paths.path.each { |path, _path_item_object| @root.register_path_node(path.split('/'), path) }
   end
 
   # find operation object and if not exist return nil
@@ -41,71 +38,83 @@ class OpenAPIParser::PathItemFinder
     end
   end
 
-  # path tree node
-  class PathNode
-    attr_accessor :full_path, :name
-
-    def initialize(name)
-      @name = name
-      @children = Hash.new { |h, k| h[k] = PathNode.new(k) }
-      @path_template_node = nil # we can't initialize because recursive initialize...
-      @full_path = nil
+  private
+    # 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)
     end
 
-    # @param [Array<string>] splited_path
-    # @param [String] full_path
-    def register_path_node(splited_path, full_path)
-      if splited_path.empty?
-        @full_path = full_path
-        return
-      end
-
-      path_name = splited_path.shift
-
-      child = path_template?(path_name) ? path_template_node(path_name) : children[path_name]
-      child.register_path_node(splited_path, full_path)
+    # used to filter paths with different depth or without given http method
+    def different_depth_or_method?(splitted_schema_path, splitted_request_path, path_item, http_method)
+      splitted_schema_path.size != splitted_request_path.size || !path_item.operation(http_method)
     end
 
-    # @return [String, nil] and Hash
-    def find_full_path(splited_path)
-      return [@full_path, {}] if splited_path.empty?
-
-      path_name = splited_path.shift
+    # check if the path item is a template
+    # EXAMPLE: path_template?('{id}') => true
+    def path_template?(schema_path_item)
+      schema_path_item.start_with?('{') && schema_path_item.end_with?('}')
+    end
 
-      # when ambiguous matching like this
-      # /{entity}/me
-      # /books/{id}
-      # OpenAPI3 depend on the tooling so we use concrete one (using /books/)
+    # get the parameter name from the schema path item
+    # EXAMPLE: param_name('{id}') => 'id'
+    def param_name(schema_path_item)
+      schema_path_item[1..(schema_path_item.length - 2)]
+    end
 
-      path_params = {}
-      if children.has_key?(path_name)
-        child = children[path_name]
-      else
-        child = path_template_node(path_name)
-        path_params = { child.name.to_s => path_name }
+    # extract params by comparing the request path and the path from schema
+    # EXAMPLE:
+    # extract_params(['org', '1', 'user', '2', 'edit'], ['org', '{org_id}', 'user', '{user_id}'])
+    # => { 'org_id' => 1, 'user_id' => 2 }
+    # return nil if the schema does not match
+    def extract_params(splitted_request_path, splitted_schema_path)
+      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
+        else
+          return if schema_path_item != request_path_item
+        end
+
+        result
       end
-
-      ret, other_path_params = child.find_full_path(splited_path)
-      [ret, path_params.merge(other_path_params)]
     end
 
-    private
-
-      attr_reader :children
-
-      def path_template_node(path_name)
-        @path_template_node ||= PathNode.new(path_name[1..(path_name.length - 2)]) # delete {} from {name}
+    # find all matching patchs with parameters extracted
+    # EXAMPLE:
+    # [
+    #    ['/user/{id}/edit', { 'id' => 1 }],
+    #    ['/user/{id}/{action}', { 'id' => 1, 'action' => 'edit' }],
+    #  ]
+    def matching_paths_with_params(request_path, http_method)
+      splitted_request_path = request_path.split('/')
+
+      @paths.path.reduce([]) do |result, item|
+        path, path_item = item
+        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
 
-      def path_template?(path_name)
-        path_name.start_with?('{') && path_name.end_with?('}')
-      end
-  end
+    # find mathing 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)
 
-  private
+      # 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 } 
+    end
 
     def parse_request_path(http_method, request_path)
-      original_path, path_params = @root.find_full_path(request_path.split('/'))
+      original_path, path_params = find_path_and_params(http_method, request_path)
       return nil unless original_path # # can't find
 
       path_item_object = @paths.path[original_path]

data/lib/openapi_parser/schemas/path_item.rb

@@ -12,7 +12,9 @@ module OpenAPIParser::Schemas
 
     # @return [Operation]
     def operation(method)
-      send(method)
+      public_send(method)
+    rescue NoMethodError
+      nil
     end
   end
 end

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - ota42y
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2020-01-15 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.0.6
 signing_key: 
 specification_version: 4
 summary: OpenAPI3 parser