openapi_first 2.11.0 → 2.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7687c4d4ac32654b4a2fd8880eeaeb0ca98ab6fac19b8d9a336fe5d5bb94785a
-  data.tar.gz: 6fb04355d69916cfc3d1dce1e21d0f163082878cf1348421a9b1006b070621f3
+  metadata.gz: 0c84ae6fc48433fbbe1845ff66ed2315b58a47ff3ba17ea6756bb6c276db5ed3
+  data.tar.gz: 3b584da97ce9b7ea712dc66ac55e39a16c1631254dd719551d27a4df9bc13e4c
 SHA512:
-  metadata.gz: '0988025dd93f55354b646c8aeb3fe7d0febfd54925d368fd3aa5959067c1a0a948b193158130b5fa7fb91cf51ffe774f9f8f281e76ac3feb318e67ea1b079020'
-  data.tar.gz: f70094cd6b531e42e06f931ed31155385bf9dd97588cad6bc977e961e7fdd497e057a971112fe10a0457d145b8f916cabdad3995c90bc29d78d31e59184211ac
+  metadata.gz: 863d5ea4124958e81d62e7a72efef17e6fe5326fe4db6d34bc6fe97e8ec863c09dd8d138eaf9b249ce94ce490dad937297cd9d15b98dc73a6c01f30c6f6da2f7
+  data.tar.gz: 7c5c264ce6f969788986bbaf71cb6060b998ae5819cf5551ddf4f82ab2069c87afda22e97fa9c8aa03ea91bb6133cbf579d63b35a12c0eb30a7e17a774508ec7

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 2.11.1
+
+- OpenapiFirst can now route requests correctly for paths like `/stuffs` and `/stuffs{format}` (https://github.com/ahx/openapi_first/issues/386)
+
 ## 2.11.0
 
 - OpenapiFirst::Test.observe now works with `Rack::URLMap` (returned by `Rack::Builder.app`) and probably all objects that respond to `.call`

data/README.md

@@ -168,7 +168,7 @@ Here is how to set it up:
     end
     ```
 2. Observe your application. You can do this in multiple ways:
-    - Add an `app` method to your tests, which wraps your application with silent request / response validation. (✷1)
+    - Add an `app` method to your tests (which is called by rack-test) that wraps your application with silent request / response validation.
       ```ruby
       module RequestSpecHelpers
         def app
@@ -188,18 +188,26 @@ Here is how to set it up:
         config.include OpenapiFirst::Test::Methods[MyApp], type: :request
       end
       ```
-4. Run your tests. The Coverage feature will tell you about missing or invalid requests/responses.
+4. Run your tests. The Coverage feature will tell you about missing or invalid requests/responses:
+      ```
+      ✓ GET /stations
+        ✓ 200(application/json)
+        ❌ 200(application/xml) – No responses tracked!
+        ❌ 400(application/problem+json) – No responses tracked!
+      ```
 
-(✷1): It does not matter what method of openapi_first you use to validate requests/responses. Instead of using `OpenapiFirstTest.app` to wrap your application, you could also use the [middlewares](#rack-middlewares) or [test assertion method](#test-assertions), but you would have to do that for all requests/responses defined in your API description to make coverage work.
+      Now add tests for all those "❌" to make them "✓" and you're green!
+
+> [!NOTE]
+> Check out [faraday-openapi](https://codeberg.org/ahx/faraday-openapi) to have your API _client_ validate request/responses against an OAD, which is useful to validate HTTP mocks during testing.
 
 ### Configure test coverage
 
-OpenapiFirst::Test raises an error when a request is not defined. You can deactivate this with:
+OpenapiFirst::Test raises an error when a response status is not defined. You can deactivate this with:
 
 ```ruby
 OpenapiFirst::Test.setup do |test|
-  # …
-  test.ignore_unknown_requests = true
+  [403, 401].each { test.ignored_unknown_status << it }
 end
 ```
 
@@ -225,6 +233,15 @@ OpenapiFirst::Test.setup do |test|
 end
 ```
 
+OpenapiFirst::Test raises an error when a request is not defined. You can deactivate this with:
+
+```ruby
+OpenapiFirst::Test.setup do |test|
+  # …
+  test.ignore_unknown_requests = true
+end
+```
+
 ### Test assertions
 
 openapi_first ships with a simple but powerful Test method to run request and response validation in your tests without using the middlewares. This is designed to be used with rack-test or Ruby on Rails integration tests or request specs.

data/lib/openapi_first/configuration.rb

@@ -14,7 +14,7 @@ module OpenapiFirst
       @request_validation_error_response = OpenapiFirst.find_error_response(:default)
       @request_validation_raise_error = false
       @response_validation_raise_error = true
-      @hooks = (HOOKS.map { [_1, Set.new] }).to_h
+      @hooks = HOOKS.to_h { [_1, Set.new] }
       @path = nil
     end
 

data/lib/openapi_first/router/find_response.rb

@@ -11,7 +11,7 @@ module OpenapiFirst
       def self.call(responses, status, content_type, request_method:, path:)
         contents = find_status(responses, status)
         if contents.nil?
-          message = "Status #{status} is not defined for #{request_method} #{path}. " \
+          message = "Status #{status} is not defined for #{request_method.upcase} #{path}. " \
                     "Defined statuses are: #{responses.keys.join(', ')}."
           return Match.new(error: Failure.new(:response_not_found, message:), response: nil)
         end

data/lib/openapi_first/router.rb

@@ -97,10 +97,15 @@ module OpenapiFirst
       found = @static[request_path]
       return [found, {}] if found
 
-      @dynamic.find do |_path, path_item|
+      matches = @dynamic.filter_map do |_path, path_item|
         params = path_item[:template].match(request_path)
-        return [path_item, params] if params
+        next unless params
+
+        [path_item, params]
       end
+      return matches.first if matches.length == 1
+
+      matches&.min_by { |match| match[1].values.sum(&:length) }
     end
   end
 end

data/lib/openapi_first/version.rb

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

metadata

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