openapi_first 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5505b1339baa8f9dcfdcbedb2270eb67436f0661ebd04115bc6d3346da9d09c6
-  data.tar.gz: 4bea9a7977b95fbb05499d2c1a01eaef54dbabcdccab85c0ab327059e4450db4
+  metadata.gz: 631b8fea22128020990af7edb3605d0e842d04b0f876affb4277b3f81b571921
+  data.tar.gz: 3fc61f1ca41bb0d380c188681bad5477c36c6cbeeeec5fabf1700d468987aae5
 SHA512:
-  metadata.gz: 78597035bfd86554fe437f8c26d285572bdc7eb5c19a8e7fa70cb55942e3df3f57bb7851666787b111fbf29e59ac03eb1a1db2bbf8d81b1f92d50298c3559e74
-  data.tar.gz: ff9b1d5871a855187aef2de7c6eec5324b8ba32c95560d1478f5b61566f7d53d7138d5a52dc4a13a78c5a518f6de83fec6f56ef2354509297cfcd15202cc3eda
+  metadata.gz: e2b1210a029a62742928ebf2e285a58d9d48d2a809373cce1652a13f8b538675b37be361c99625d6e0bb6cf70ea58ebbaba7486f8ac73896cf5989b74257cd06
+  data.tar.gz: 0e5d4798b159fd71af8da50703644f71a16cc276bfdafcaff3cf64777042d6ed9b78ac62ba1dfe07cbd1026cf8d359b77124a5abe39d239030c5d5f5b967b12c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.5
+
+- Added support for `/some/{kebab-cased}` path parameters ([#245](https://github.com/ahx/openapi_first/issues/245))
+
 ## 1.3.4
 
 - Fixed handling "binary" format in optional multipart file uploads

data/lib/openapi_first/definition/path_item.rb

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
+require 'forwardable'
 require_relative 'operation'
+require_relative 'path_template'
 
 module OpenapiFirst
   class Definition
     # A pathItem as defined in the OpenAPI document.
     class PathItem
+      extend Forwardable
+
       def initialize(path, path_item_object, openapi_version:)
         @path = path
         @path_item_object = path_item_object
         @openapi_version = openapi_version
+        @path_template = PathTemplate.new(path)
       end
 
       attr_reader :path
 
+      def_delegator :@path_template, :match
+
       def operation(request_method)
         return unless @path_item_object[request_method]
 

data/lib/openapi_first/definition/path_template.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  class Definition
+    # @visibility private
+    class PathTemplate
+      # See also https://spec.openapis.org/oas/v3.1.0#path-templating
+      TEMPLATE_EXPRESSION = /(\{[^}]+\})/
+      TEMPLATE_EXPRESSION_NAME = /\{([^}]+)\}/
+      ALLOWED_PARAMETER_CHARACTERS = %r{([^/?#]+)}
+
+      def initialize(template)
+        @template = template
+        @names = template.scan(TEMPLATE_EXPRESSION_NAME).flatten
+        @pattern = build_pattern(template)
+      end
+
+      def match(path)
+        return {} if path == @template
+        return if @names.empty?
+
+        matches = path.match(@pattern)
+        return unless matches
+
+        values = matches.captures
+        @names.zip(values).to_h
+      end
+
+      private
+
+      def build_pattern(template)
+        parts = template.split(TEMPLATE_EXPRESSION).map! do |part|
+          part.start_with?('{') ? ALLOWED_PARAMETER_CHARACTERS : Regexp.escape(part)
+        end
+
+        %r{^#{parts.join}/?$}
+      end
+    end
+  end
+end

data/lib/openapi_first/definition.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'mustermann'
 require_relative 'definition/path_item'
 require_relative 'runtime_request'
 require_relative 'request_validation/validator'
@@ -99,14 +98,12 @@ module OpenapiFirst
     end
 
     def search_for_path_item(request_path)
-      paths.find do |path, path_item_object|
-        template = Mustermann.new(path)
-        path_params = template.params(request_path)
+      path_items.find do |path_item|
+        path_params = path_item.match(request_path)
         next unless path_params
-        next unless path_params.size == template.names.size
 
         return [
-          PathItem.new(path, path_item_object, openapi_version:),
+          path_item,
           path_params
         ]
       end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '1.3.4'
+  VERSION = '1.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: mustermann
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: openapi_parameters
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +108,7 @@ files:
 - lib/openapi_first/definition.rb
 - lib/openapi_first/definition/operation.rb
 - lib/openapi_first/definition/path_item.rb
+- lib/openapi_first/definition/path_template.rb
 - lib/openapi_first/definition/request_body.rb
 - lib/openapi_first/definition/response.rb
 - lib/openapi_first/definition/responses.rb