openapi_first 1.3.2 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d004ac9e317cce0a7d9df95e49b3abbe435e9dab2f23d91880b29cb670ece06f
-  data.tar.gz: c8a1b0ee8238adbf6869aa4a81f642fa0bae0091eabab63417ee142df50ded47
+  metadata.gz: 631b8fea22128020990af7edb3605d0e842d04b0f876affb4277b3f81b571921
+  data.tar.gz: 3fc61f1ca41bb0d380c188681bad5477c36c6cbeeeec5fabf1700d468987aae5
 SHA512:
-  metadata.gz: 2e937d066ee559653a60c28b910da5f02def4b73cbb653673c89b2402f96f2dbe79aad482e4c92c23270d0cf9b9e8b35b2423770abc89590056bcd9b5d16332d
-  data.tar.gz: edab0f813f6e98f2db2e245d6d306b0218e678a5ff0e8b22330d6bb69354011d4c254a9e38b2bf15869294b7f9e5d2b19eb7511079665f414b15f2f3da8b2357
+  metadata.gz: e2b1210a029a62742928ebf2e285a58d9d48d2a809373cce1652a13f8b538675b37be361c99625d6e0bb6cf70ea58ebbaba7486f8ac73896cf5989b74257cd06
+  data.tar.gz: 0e5d4798b159fd71af8da50703644f71a16cc276bfdafcaff3cf64777042d6ed9b78ac62ba1dfe07cbd1026cf8d359b77124a5abe39d239030c5d5f5b967b12c

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## 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
+- Cache the resolved OAD. This especially makes things run faster in tests.
+
+## 1.3.3 (yanked)
+
 ## 1.3.2
 
 ### Changed

data/lib/openapi_first/definition/operation.rb

@@ -95,7 +95,7 @@ module OpenapiFirst
       # Returns a unique name for this operation. Used for generating error messages.
       # @visibility private
       def name
-        @name ||= "#{method.upcase} #{path} (#{operation_id})"
+        @name ||= "#{method.upcase} #{path}"
       end
 
       # Returns the path parameters of the operation.

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/failure.rb

@@ -71,8 +71,8 @@ module OpenapiFirst
     private
 
     def generate_message
-      messages = errors&.take(4)&.map(&:error)
-      messages << "... (#{errors.size} errors total)" if errors && errors.size > 4
+      messages = errors&.take(3)&.map(&:error)
+      messages << "... (#{errors.size} errors total)" if errors && errors.size > 3
       messages&.join('. ')
     end
   end

data/lib/openapi_first/json_refs.rb

@@ -32,112 +32,122 @@ require 'hana'
 require 'json'
 require 'yaml'
 
-module JsonRefs
-  class << self
-    def dereference(doc)
-      file_cache = {}
-      Dereferencer.new(Dir.pwd, doc, file_cache).call
-    end
+module OpenapiFirst
+  class FileNotFoundError < StandardError; end
+
+  module JsonRefs
+    class << self
+      def dereference(doc)
+        file_cache = {}
+        Dereferencer.new(Dir.pwd, doc, file_cache).call
+      end
 
-    def load(filename)
-      doc_dir = File.dirname(filename)
-      doc = Loader.handle(filename)
-      file_cache = {}
-      Dereferencer.new(doc_dir, doc, file_cache).call
+      def load(filename)
+        doc_dir = File.dirname(filename)
+        doc = Loader.handle(filename)
+        file_cache = {}
+        Dereferencer.new(filename, doc_dir, doc, file_cache).call
+      end
     end
-  end
 
-  module LocalRef
-    module_function
+    module LocalRef
+      module_function
 
-    def call(path:, doc:)
-      Hana::Pointer.new(path[1..]).eval(doc)
+      def call(path:, doc:)
+        Hana::Pointer.new(path[1..]).eval(doc)
+      end
     end
-  end
 
-  module Loader
-    module_function
+    module Loader
+      module_function
 
-    def handle(filename)
-      body = File.read(filename)
-      return JSON.parse(body) if File.extname(filename) == '.json'
+      def handle(filename)
+        body = File.read(filename)
+        return JSON.parse(body) if File.extname(filename) == '.json'
 
-      YAML.unsafe_load(body)
+        YAML.unsafe_load(body)
+      end
     end
-  end
 
-  class Dereferencer
-    def initialize(doc_dir, doc, file_cache)
-      @doc = doc
-      @doc_dir = doc_dir
-      @file_cache = file_cache
-    end
+    class Dereferencer
+      def initialize(filename, doc_dir, doc, file_cache)
+        @filename = filename
+        @doc = doc
+        @doc_dir = doc_dir
+        @file_cache = file_cache
+      end
 
-    def call(doc = @doc, keys = [])
-      if doc.is_a?(Array)
-        doc.each_with_index do |value, idx|
-          call(value, keys + [idx])
-        end
-      elsif doc.is_a?(Hash)
-        if doc.key?('$ref')
-          dereference(keys, doc['$ref'])
-        else
-          doc.each do |key, value|
-            call(value, keys + [key])
+      def call(doc = @doc, keys = [])
+        if doc.is_a?(Array)
+          doc.each_with_index do |value, idx|
+            call(value, keys + [idx])
+          end
+        elsif doc.is_a?(Hash)
+          if doc.key?('$ref')
+            dereference(keys, doc['$ref'])
+          else
+            doc.each do |key, value|
+              call(value, keys + [key])
+            end
           end
         end
+        doc
       end
-      doc
-    end
 
-    private
+      private
 
-    attr_reader :doc_dir
+      attr_reader :doc_dir
 
-    def dereference(paths, referenced_path)
-      key = paths.pop
-      target = paths.inject(@doc) do |obj, k|
-        obj[k]
+      def dereference(paths, referenced_path)
+        key = paths.pop
+        target = paths.inject(@doc) do |obj, k|
+          obj[k]
+        end
+        value = follow_referenced_value(referenced_path)
+        target[key] = value
       end
-      value = follow_referenced_value(referenced_path)
-      target[key] = value
-    end
 
-    def follow_referenced_value(referenced_path)
-      value = referenced_value(referenced_path)
-      return referenced_value(value['$ref']) if value.is_a?(Hash) && value.key?('$ref')
+      def follow_referenced_value(referenced_path)
+        value = referenced_value(referenced_path)
+        return referenced_value(value['$ref']) if value.is_a?(Hash) && value.key?('$ref')
 
-      value
-    end
+        value
+      end
 
-    def referenced_value(referenced_path)
-      filepath, pointer = referenced_path.split('#')
-      pointer&.prepend('#')
-      return dereference_local(pointer) if filepath.empty?
+      def referenced_value(referenced_path)
+        filepath, pointer = referenced_path.split('#')
+        pointer&.prepend('#')
+        return dereference_local(pointer) if filepath.empty?
 
-      dereferenced_file = dereference_file(filepath)
-      return dereferenced_file if pointer.nil?
+        dereferenced_file = dereference_file(filepath)
+        return dereferenced_file if pointer.nil?
 
-      LocalRef.call(
-        path: pointer,
-        doc: dereferenced_file
-      )
-    end
+        LocalRef.call(
+          path: pointer,
+          doc: dereferenced_file
+        )
+      end
 
-    def dereference_local(referenced_path)
-      LocalRef.call(path: referenced_path, doc: @doc)
-    end
+      def dereference_local(referenced_path)
+        LocalRef.call(path: referenced_path, doc: @doc)
+      end
 
-    def dereference_file(referenced_path)
-      referenced_path = File.expand_path(referenced_path, doc_dir) unless File.absolute_path?(referenced_path)
-      @file_cache[referenced_path] ||= load_referenced_file(referenced_path)
-    end
+      def dereference_file(referenced_path)
+        referenced_path = File.expand_path(referenced_path, doc_dir) unless File.absolute_path?(referenced_path)
+        @file_cache[referenced_path] ||= load_referenced_file(referenced_path)
+      end
 
-    def load_referenced_file(absolute_path)
-      directory = File.dirname(absolute_path)
+      def load_referenced_file(absolute_path)
+        directory = File.dirname(absolute_path)
 
-      referenced_doc = Loader.handle(absolute_path)
-      Dereferencer.new(directory, referenced_doc, @file_cache).call
+        unless File.exist?(absolute_path)
+          raise FileNotFoundError,
+                "Problem while loading file referenced in #{@filename}: File not found #{absolute_path}"
+        end
+
+        referenced_doc = Loader.handle(absolute_path)
+        Dereferencer.new(@filename, directory, referenced_doc, @file_cache).call
+      end
     end
   end
 end

data/lib/openapi_first/runtime_response.rb

@@ -22,8 +22,10 @@ module OpenapiFirst
     # @attr_reader [String] content_type The content_type of the Rack::Response.
     def_delegators :@rack_response, :status, :content_type
 
-    # @attr_reader [String] name The name of the operation. Used for generating error messages.
-    def_delegators :@operation, :name # @visibility private
+    # @return [String] name The name of the operation. Used for generating error messages.
+    def name
+      "#{@operation.name} response status: #{status}"
+    end
 
     # Checks if the response is valid. Runs the validation unless it has been run before.
     # @return [Boolean]

data/lib/openapi_first/schema.rb

@@ -42,7 +42,7 @@ module OpenapiFirst
     def binary_format(data, property, property_schema, _parent)
       return unless property_schema.is_a?(Hash) && property_schema['format'] == 'binary'
 
-      data[property] = data[property][:tempfile].read
+      data[property] = data.dig(property, :tempfile)&.read if data[property]
     end
   end
 end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -49,7 +49,8 @@ module OpenapiFirst
   # @!visibility private
   module Bundle
     def self.resolve(spec_path)
-      JsonRefs.load(spec_path)
+      @file_cache ||= {}
+      @file_cache[File.expand_path(spec_path).to_sym] ||= JsonRefs.load(spec_path)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.5
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-04 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