openapi_first 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a5311b4ca774b9a0cb80e85f29243f46e1c5c762241b015090834971373a7b
-  data.tar.gz: 640be1c8c02b8a86b5c9d562b7ac837b73881473c54cf9ea731779352e0cee2d
+  metadata.gz: c4ae98a82d67480a49874eaec264d200b53685f1fd7d28e09e4e3faf2fc86075
+  data.tar.gz: e8d1166f2876dc7f5e909fe9290a03f0f8c530bc6469822a3c88583fa0a29047
 SHA512:
-  metadata.gz: 42ab4483c694d921c68fcb30099ecd779e789c5bfc9163f97a70327f5ef1aacdc7b7abae66c70341e2edd4ff5821d4fe6e9ab3e0d65b081963685272d094e5e2
-  data.tar.gz: 7bbc02b4e061a012663b115758b1f43a6fd4642687d07711d90e7032a800fedb453e3b32a762658bd5185d9cea0f8859b2436d28f4bea12f0bebd4bb613aeeff
+  metadata.gz: dd927a3a8a9167e69b1fd2f795b333b232581cc1fb2ee805105f89d82125d58eddd951660fb06d300ac41555ef7ce6cfc2b680feda2d809c8fe64eebc8537b1b
+  data.tar.gz: 456f6f1ccffc43d20b3ab51cdd4d392ac4dacf00e403bb92f8829f88e97c63fd48ac1ba316d5dc89662e1d32509f2ee6a92c60b7f327b261d428125bf8e2ec99

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## 2.9.0
+
+- OpenapiFirst::Test now raises an error for unknown requests. You can deactivate with:
+
+```ruby
+OpenapiFirst::Test.setup do |test|
+  # ...
+  test.ignore_unknown_request = true
+end
+```
+
+- NotFoundError#message now includes the requested path
+
 ## 2.8.0
 
 ### OpenapiFirst::Test is now stricter and more configurable

data/README.md

@@ -77,6 +77,14 @@ Here is how to set it up:
 
 (✷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.
 
+OpenapiFirst' request validation raises an error when a request is not defined. You can deactivate this during testing:
+
+```ruby
+OpenapiFirst::Test.setup do |test|
+  test.ignore_unknown_requests = true
+end
+```
+
 ## Rack Middlewares
 
 ### Request validation

data/lib/openapi_first/failure.rb

@@ -5,7 +5,7 @@ module OpenapiFirst
   # This returned in ValidatedRequest#error and ValidatedResponse#error.
   class Failure
     TYPES = {
-      not_found: [NotFoundError, 'Request path is not defined.'],
+      not_found: [NotFoundError, 'Not found.'],
       method_not_allowed: [RequestInvalidError, 'Request method is not defined.'],
       unsupported_media_type: [RequestInvalidError, 'Request content type is not defined.'],
       invalid_body: [RequestInvalidError, 'Request body invalid:'],

data/lib/openapi_first/router.rb

@@ -54,7 +54,10 @@ module OpenapiFirst
     # Return all request objects that match the given path and request method
     def match(request_method, path, content_type: nil)
       path_item, params = find_path_item(path)
-      return NOT_FOUND unless path_item
+      unless path_item
+        message = "Request path #{path} is not defined in API description."
+        return NOT_FOUND.with(error: Failure.new(:not_found, message:))
+      end
 
       contents = path_item.dig(request_method, :requests)
       return NOT_FOUND.with(error: Failure.new(:method_not_allowed)) unless contents

data/lib/openapi_first/test/configuration.rb

@@ -12,6 +12,7 @@ module OpenapiFirst
         @response_raise_error = true
         @ignored_unknown_status = [404]
         @report_coverage = true
+        @ignore_unknown_requests = false
         @registry = {}
         @apps = {}
       end
@@ -28,7 +29,8 @@ module OpenapiFirst
         @apps[api] = app
       end
 
-      attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error, :minimum_coverage
+      attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error, :minimum_coverage,
+                    :ignore_unknown_requests
       attr_reader :registry, :apps, :report_coverage, :ignored_unknown_status
 
       # Configure report coverage

data/lib/openapi_first/test.rb

@@ -100,6 +100,10 @@ module OpenapiFirst
 
       OpenapiFirst.configure do |config|
         @after_request_validation = config.after_request_validation do |validated_request, oad|
+          raise validated_request.error.exception if raise_request_error?(validated_request)
+
+          configuration.ignore_unknown_requests && validated_request.known?
+
           Coverage.track_request(validated_request, oad)
         end
 
@@ -114,6 +118,13 @@ module OpenapiFirst
       @installed = true
     end
 
+    def self.raise_request_error?(validated_request)
+      return false if validated_request.valid?
+      return true if validated_request.known?
+
+      !configuration.ignore_unknown_requests
+    end
+
     def self.raise_response_error?(validated_response)
       configuration.response_raise_error && !configuration.ignored_unknown_status.include?(validated_response.status)
     end

data/lib/openapi_first/version.rb

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

metadata

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