openapi_first 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db682408d3927edb6c83c2778f16edecfa428c3e85bdc33ec96664259ddd3f0b
-  data.tar.gz: 4519ccef3e6c27da6372f52fea09a1e36aa09b5648534edce6caf4d7bdbca8b3
+  metadata.gz: ef15e925e193150f3425c32bd94986f3c069f12af86a88ad043886de13c1ca8a
+  data.tar.gz: d4f11e849a469be720cbd5973ffb04e039664101ed44484d4b4f4b2c5ef542f8
 SHA512:
-  metadata.gz: d37cc2c5d0d99331907a5d565eba3a404e492c7cef71c154e5badd52fe05fb2c7761d17cbe2f94dfec14cda1df59e354f5848bcdc44b515069d325a1316d14aa
-  data.tar.gz: 20d09dc7debef84d08504202bd6b2acabc33d172486d79d82685bce22362dbf15f920bda84287619bc7517f42da5701c454bf1e23c74a7eeb0c870ab8ae7025c
+  metadata.gz: 8aa700d2587944d67f5e2372fe7793c1cd71a76e6c772bf56938564e4f4c4221cb29e54e0ec37bec66c1da370415aabbebb7f722f4cd4fbeba478919308df6cb
+  data.tar.gz: 6ef3870f3b011ac35065775da7265d6bc6dff0b121ec0ee42a7e5b47a9fd69d17dbc25ea85723615206d9704afcaee4f65ff3f04e6c85f430ea4781316260ff8

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 4.4.0
+
+- Changed: Percent-encoded path parameters are now decoded. For example `/files/my%20file` yields `my file` for `/files/{name}`. A `+` stays a `+`. Values with a malformed encoding or that do not decode to valid UTF-8 are kept as they are. If your application decodes path parameters itself, remove that, or values get decoded twice. Known limitation: An encoded delimiter inside an array or object path parameter is decoded before the value is split, so `/files/a%2Cb,c` yields `["a", "b", "c"]`.
+- Added: You can pass a block to `OpenapiFirst::Middlewares::RequestValidation` to configure hooks and other options specifically for that middleware. With a registered name or a Definition it creates a copy of that OAD, so the registered OAD stays unchanged.
+- Fix: `OpenapiFirst.load` now accepts and applies a configuration block.
+
 ## 4.3.0
 
 - Fix: Passing a block to `config.register` not works when called inside `OpenapiFirst.configure` block. Before the block was ignored.

data/README.md

@@ -84,6 +84,19 @@ The request validation middleware returns a 4xx if the request is invalid or not
 use OpenapiFirst::Middlewares::RequestValidation
 ```
 
+You can pass a block to configure [hooks](#hooks) and other options for this middleware only:
+
+```ruby
+use OpenapiFirst::Middlewares::RequestValidation, :v1 do |config|
+  config.request_validation_error_response = :jsonapi
+  config.after_request_validation do |validated_request|
+    warn validated_request.error.message if validated_request.invalid?
+  end
+end
+```
+
+If you pass a registered name or a Definition together with a block, the middleware uses a copy of that OAD that keeps its configuration and adds yours. The registered OAD stays unchanged.
+
 #### Error responses
 
 openapi_first produces a useful machine readable error response that can be customized.

data/lib/openapi_first/child_configuration.rb

@@ -6,16 +6,20 @@ module OpenapiFirst
     def initialize(parent:)
       super()
       @parent = parent
-      @request_validation_error_response = parent.request_validation_error_response
+      @request_validation_error_response = nil
       @path = parent.path
       @regexp_resolver = parent.regexp_resolver
     end
 
     private attr_reader :parent
 
+    def request_validation_error_response
+      @request_validation_error_response || parent.request_validation_error_response
+    end
+
     HOOKS.each do |hook|
       define_method(hook) do |&block|
-        return hooks[hook].chain(parent.hooks[hook]) if block.nil?
+        return hooks[hook].chain(parent.public_send(hook)) if block.nil?
 
         hooks[hook] << block
         block

data/lib/openapi_first/definition.rb

@@ -24,10 +24,11 @@ module OpenapiFirst
     # @param contents [Hash] The OpenAPI document.
     # @param filepath [String] The file path of the OpenAPI document.
     # @param path_prefix [String,nil] An optional path prefix, that is not documented, that all requests begin with.
-    def initialize(contents, filepath = nil, path_prefix = nil)
+    # @param config [Configuration] The configuration to use. Gets yielded and frozen.
+    def initialize(contents, filepath = nil, path_prefix = nil, config: OpenapiFirst.configuration.child)
       @filepath = filepath
       @path_prefix = path_prefix
-      @config = OpenapiFirst.configuration.child
+      @config = config
       yield @config if block_given?
       @config.freeze
       @router = Builder.build_router(contents, filepath:, config:)
@@ -35,6 +36,14 @@ module OpenapiFirst
       @paths = @router.routes.map(&:path).to_a.uniq # TODO: Refactor
     end
 
+    # Returns a new Definition of the same document whose configuration is a child of this one's.
+    # @visibility private
+    # @yield [Configuration]
+    # @return [Definition]
+    def configure(&)
+      Definition.new(@resolved, filepath, path_prefix, config: @config.child, &)
+    end
+
     # Gives access to the raw resolved Hash. Like `mydefinition['components'].dig('schemas', 'Stations')`
     # @!method [](key)
     # @return [Hash]

data/lib/openapi_first/middlewares/request_validation.rb

@@ -29,20 +29,19 @@ module OpenapiFirst
       #   :error_response The Class to use for error responses.
       #                   This can be a Symbol-name of an registered error response (:default, :jsonapi)
       #                   or it can be set to false to disable returning a response.
-      #                   default: OpenapiFirst::Plugins::Default::ErrorResponse (Config.default_options.error_response)
-      def initialize(app, spec = nil, options = {})
+      #                   default: the configured request_validation_error_response
+      # @yield [Configuration] Optional block to configure hooks and other options for this middleware.
+      #   If spec is a registered name or a Definition, this uses a new Definition that inherits its configuration,
+      #   so the registered Definition is not changed.
+      def initialize(app, spec = nil, options = {}, &)
         @app = app
         if spec.is_a?(Hash)
           options = spec
           spec = options[:spec]
         end
         @raise = options.fetch(:raise_error, false)
+        @definition = OpenapiFirst.load(spec || :default, &)
         @error_response_class = error_response_option(options[:error_response])
-
-        spec ||= :default
-        spec = OpenapiFirst[spec] if spec.is_a?(Symbol)
-
-        @definition = spec.is_a?(Definition) ? spec : OpenapiFirst.load(spec)
       end
 
       # @attr_reader [Proc] app The upstream Rack application
@@ -70,7 +69,7 @@ module OpenapiFirst
         return if value == false
         return OpenapiFirst.find_error_response(value) if value.is_a?(Symbol)
 
-        value || OpenapiFirst.configuration.request_validation_error_response
+        value || @definition.config.request_validation_error_response
       end
     end
   end

data/lib/openapi_first/router/path_trie.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'rack/utils'
 require_relative '../path_template'
 require_relative 'segment_pattern'
 
@@ -23,7 +24,10 @@ module OpenapiFirst
       def match(path)
         values = []
         value, names = find(path.split('/', -1), 0, values)
-        [value, names.zip(values).to_h] if value
+        return unless value
+
+        values.map! { decode(_1) } if path.include?('%')
+        [value, names.zip(values).to_h]
       end
 
       def find(segments, index, values)
@@ -47,6 +51,11 @@ module OpenapiFirst
 
       private
 
+      def decode(value)
+        decoded = Rack::Utils.unescape_path(value).force_encoding(Encoding::UTF_8)
+        decoded.valid_encoding? ? decoded : value
+      end
+
       def find_partial(segments, index, values)
         @partial.each_value do |pattern, node|
           captures = pattern.match(segments[index])

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -62,15 +62,20 @@ module OpenapiFirst
     configuration.plugin(name, **)
   end
 
-  # Load and dereference an OpenAPI spec file or return the Definition if it's already loaded
-  # @param filepath_or_definition [String, Definition] The path to the file or a Definition object
+  # Load and dereference an OpenAPI spec file or return the Definition if it's already loaded.
+  # If a block is given together with a Definition or Symbol,
+  # this returns a new Definition with the configuration block applied.
+  # @param filepath_or_definition [String, Symbol, Definition] The path to the file, a registered name or a Definition
   # @param only [Proc, nil] An optional proc to filter paths. It is called with the path string and should return
   # true/false
   # @param path_prefix [String, nil] An optional path prefix, that is not documented, that all requests begin with.
+  # @yieldparam config [Configuration] Configuration of the returned Definition.
   # @return [Definition]
   def self.load(filepath_or_definition, only: nil, path_prefix: nil, &)
-    return filepath_or_definition if filepath_or_definition.is_a?(Definition)
-    return self[filepath_or_definition] if filepath_or_definition.is_a?(Symbol)
+    if filepath_or_definition.is_a?(Definition) || filepath_or_definition.is_a?(Symbol)
+      definition = self[filepath_or_definition]
+      return block_given? ? definition.configure(&) : definition
+    end
 
     filepath = filepath_or_definition
     raise FileNotFoundError, "File not found: #{filepath}" unless File.exist?(filepath)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Andreas Haller