openapi_first 2.0.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d712aa1e9c42b4d42bc048fa0cc5c793af9d8e5c4f3afd34deda3afe2136eb70
-  data.tar.gz: 8a220208d4eb6755a066db142f20271101c97e7c7c26e000d0519770300c0f39
+  metadata.gz: 600de21e1747c012275bf68c2d577296a8d82bb158cb4d73949b5b97167e655d
+  data.tar.gz: 86bcde27440b46fba91662fc7e6b86ac05d899da927fefc3e9d45a41a6d7fac9
 SHA512:
-  metadata.gz: d5424ea246ae643962375a22adddac25ec2de49222aed0a3e6cabc4d8efbbd49faf65e569c219a758b62261a085afd06ee9b6c75f453f0c30397610e9460a793
-  data.tar.gz: 9599b92d69766a231c7a24f708cabfcaff5f3724117b3f1948d1b9e76c1408f72bafceebaf17752a30e58d752375b807de57ab53dad38abf84720f192c5a3180
+  metadata.gz: ee729f6f6fedf5d6e9b82b82bdf86493a0a7ea6274e20b60e2cdd84eda2ce086cf366249f61a28016374355d11ab32654a970a418cf5af24a0b187d31b967618
+  data.tar.gz: 125cc38e91e489f30c922f38056c69f9a6d501f3748ee098f2977d8fc6dc7f5f43f77264991f98564cb60ff2af19912ae85537c57d25c92604f8f6ee8766a749

data/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 ## Unreleased
 
-## 2.0
+## 2.0.3
+
+- Request validation middleware now accepts `error_response: false` do disable rendering a response. This is useful if you just want to collect metrics (via hooks) during a migration phase.
+
+## 2.0.2
+
+- Fix setting custom error response (thanks @gobijan)
+
+## 2.0.1 (Janked)
+
+## 2.0.0
 
 ### New Features
 - Test Assertions! 📋 You can now use `assert_api_conform`  for contract testing in your rack-test / Rails integration tests. See Readme for details.

data/README.md

@@ -2,17 +2,20 @@
 
 OpenapiFirst helps to implement HTTP APIs based on an [OpenAPI](https://www.openapis.org/) API description. It supports OpenAPI 3.0 and 3.1. It offers request and response validation and it ensures that your implementation follows exactly the API description.
 
+[![Tests](https://github.com/ahx/openapi_first/actions/workflows/ruby.yml/badge.svg)](https://github.com/ahx/openapi_first/actions/workflows/ruby.yml)
+[![CodeQL](https://github.com/ahx/openapi_first/actions/workflows/codeql.yml/badge.svg)](https://github.com/ahx/openapi_first/blob/codeql/.github/workflows/codeql.yml)
+
 ## Contents
 
 <!-- TOC -->
 
+- [Manual use](#manual-use)
+  - [Validate request](#validate-request)
+  - [Validate response](#validate-response)
 - [Rack Middlewares](#rack-middlewares)
   - [Request validation](#request-validation)
   - [Response validation](#response-validation)
 - [Test assertions](#test-assertions)
-- [Manual use](#manual-use)
-  - [Validate request](#validate-request)
-  - [Validate response](#validate-response)
 - [Framework integration](#framework-integration)
 - [Configuration](#configuration)
 - [Hooks](#hooks)
@@ -23,6 +26,61 @@ OpenapiFirst helps to implement HTTP APIs based on an [OpenAPI](https://www.open
 
 <!-- /TOC -->
 
+## Manual use
+
+Load the API description:
+
+```ruby
+require 'openapi_first'
+
+definition = OpenapiFirst.load('openapi.yaml')
+```
+
+### Validate request
+
+```ruby
+validated_request = definition.validate_request(rack_request)
+
+# Inspect the request and access parsed parameters
+validated_request.valid?
+validated_request.invalid?
+validated_request.error # => Failure object or nil
+validated_request.parsed_body # => The parsed request body (Hash)
+validated_request.parsed_query # A Hash of query parameters that are defined in the API description, parsed exactly as described.
+validated_request.parsed_path_parameters
+validated_request.parsed_headers
+validated_request.parsed_cookies
+validated_request.parsed_params # Merged parsed path, query parameters and request body
+# Access the Openapi 3 Operation Object Hash
+validated_request.operation['x-foo']
+validated_request.operation['operationId'] => "getStuff"
+# or the whole request definition
+validated_request.request_definition.path # => "/pets/{petId}"
+validated_request.request_definition.operation_id # => "showPetById"
+
+# Or you can raise an exception if validation fails:
+definition.validate_request(rack_request, raise_error: true) # Raises OpenapiFirst::RequestInvalidError or OpenapiFirst::NotFoundError if request is invalid
+```
+
+### Validate response
+
+```ruby
+validated_response = definition.validate_response(rack_request, rack_response)
+
+# Inspect the response and access parsed parameters and
+validated_response.valid?
+validated_response.invalid?
+validated_response.error # => Failure object or nil
+validated_response.status # => 200
+validated_response.parsed_body
+validated_response.parsed_headers
+
+# Or you can raise an exception if validation fails:
+definition.validate_response(rack_request,rack_response, raise_error: true) # Raises OpenapiFirst::ResponseInvalidError or OpenapiFirst::ResponseNotFoundError
+```
+
+OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
+
 ## Rack Middlewares
 
 ### Request validation
@@ -39,7 +97,7 @@ use OpenapiFirst::Middlewares::RequestValidation, spec: 'openapi.yaml'
 | :---------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
 | `spec:`           |                                                                          | The path to the spec file or spec loaded via `OpenapiFirst.load`                                                                    |
 | `raise_error:`    | `false` (default), `true`                                                | If set to true the middleware raises `OpenapiFirst::RequestInvalidError` or `OpenapiFirst::NotFoundError` instead of returning 4xx. |
-| `error_response:` | `:default` (default), `:jsonapi`, Your implementation of `ErrorResponse` |
+| `error_response:` | `:default` (default), `:jsonapi`, Your implementation of `ErrorResponse` or `false` to disable responding  |
 
 #### Error responses
 
@@ -174,67 +232,6 @@ class TripsApiTest < ActionDispatch::IntegrationTest
 end
 ```
 
-## Manual use
-
-Load the API description:
-
-```ruby
-require 'openapi_first'
-
-definition = OpenapiFirst.load('openapi.yaml')
-```
-
-### Validate request
-
-```ruby
-# Find and validate request
-rack_request = Rack::Request.new(env)
-validated_request = definition.validate_request(rack_request)
-# Or raise an exception if validation fails:
-definition.validate_request(rack_request, raise_error: true) # Raises OpenapiFirst::RequestInvalidError or OpenapiFirst::NotFoundError if request is invalid
-
-# Inspect the request and access parsed parameters
-validated_request.known? # Is the request defined in the API description?
-validated_request.valid? # => true / false
-validated_request.invalid? # => true / false
-validated_request.error # => Failure object if request is invalid
-validated_request.parsed_params # Merged parsed path, query parameters and request body
-validated_request.parsed_body
-validated_request.parsed_path_parameters # => { "pet_id" => 42 }
-validated_request.parsed_headers
-validated_request.parsed_cookies
-validated_request.parsed_query
-
-# Access the Openapi 3 Operation Object Hash
-validated_request.operation['x-foo']
-validated_request.operation['operationId']
-# or the whole request definition
-validated_request.request_definition.path # => "/pets/{petId}"
-validated_request.request_definition.operation_id # => "showPetById"
-```
-
-### Validate response
-
-```ruby
-# Find and validate the response
-rack_response = Rack::Response[*app.call(env)]
-validated_response = definition.validate_response(rack_request, rack_response)
-
-# Raise an exception if validation fails:
-definition.validate_response(rack_request,rack_response, raise_error: true) # Raises OpenapiFirst::ResponseInvalidError or OpenapiFirst::ResponseNotFoundError
-
-# Inspect the response and access parsed parameters and
-response.known? # Is the response defined in the API description?
-response.valid? # => true / false
-response.invalid? # => true / false
-response.error # => Failure object if response is invalid
-response.status # => 200
-response.parsed_body
-response.parsed_headers
-```
-
-OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
-
 ## Configuration
 
 You can configure default options globally:

data/lib/openapi_first/configuration.rb

@@ -34,7 +34,7 @@ module OpenapiFirst
 
     def request_validation_error_response=(mod)
       @request_validation_error_response = if mod.is_a?(Symbol)
-                                             OpenapiFirst.find_plugin(:default)::ErrorResponse
+                                             OpenapiFirst.find_error_response(mod)
                                            else
                                              mod
                                            end

data/lib/openapi_first/middlewares/request_validation.rb

@@ -10,11 +10,13 @@ module OpenapiFirst
       #   :raise_error    A Boolean indicating whether to raise an error if validation fails.
       #                   default: false
       #   :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, options = {})
         @app = app
         @raise = options.fetch(:raise_error, OpenapiFirst.configuration.request_validation_raise_error)
-        @error_response_class = error_response(options[:error_response])
+        @error_response_class = error_response_option(options[:error_response])
 
         spec = options.fetch(:spec)
         raise "You have to pass spec: when initializing #{self.class}" unless spec
@@ -29,17 +31,18 @@ module OpenapiFirst
         validated = @definition.validate_request(Rack::Request.new(env), raise_error: @raise)
         env[REQUEST] = validated
         failure = validated.error
-        return @error_response_class.new(failure:).render if failure
+        return @error_response_class.new(failure:).render if failure && @error_response_class
 
         @app.call(env)
       end
 
       private
 
-      def error_response(mod)
-        return OpenapiFirst.find_error_response(mod) if mod.is_a?(Symbol)
+      def error_response_option(value)
+        return if value == false
+        return OpenapiFirst.find_error_response(value) if value.is_a?(Symbol)
 
-        mod || OpenapiFirst.configuration.request_validation_error_response
+        value || OpenapiFirst.configuration.request_validation_error_response
       end
     end
   end

data/lib/openapi_first/router/path_template.rb

@@ -5,8 +5,8 @@ module OpenapiFirst
     # @visibility private
     class PathTemplate
       # See also https://spec.openapis.org/oas/v3.1.0#path-templating
-      TEMPLATE_EXPRESSION = /(\{[^}]+\})/
-      TEMPLATE_EXPRESSION_NAME = /\{([^}]+)\}/
+      TEMPLATE_EXPRESSION = /(\{[^{}]+\})/
+      TEMPLATE_EXPRESSION_NAME = /\{([^{}]+)\}/
       ALLOWED_PARAMETER_CHARACTERS = %r{([^/?#]+)}
 
       def self.template?(string)

data/lib/openapi_first/test.rb

@@ -5,15 +5,24 @@ require_relative 'test/methods'
 module OpenapiFirst
   # Test integration
   module Test
+    class NotRegisteredError < StandardError; end
+
+    DEFINITIONS = {} # rubocop:disable Style/MutableConstant
+
+    def self.definitions = DEFINITIONS
+
     def self.register(path, as: :default)
-      @registry ||= {}
-      @registry[as] = OpenapiFirst.load(path)
+      definitions[as] = OpenapiFirst.load(path)
     end
 
     def self.[](api)
-      @registry[api] || raise(ArgumentError,
-                              "API description #{api} not found to be used via assert_api_conform. " \
-                              'Use OpenapiFirst::Test.register to load an API description first.')
+      definitions.fetch(api) do
+        option = api == :default ? '' : ", as: #{api.inspect}"
+        raise(NotRegisteredError,
+              "API description '#{api.inspect}' not found." \
+              "Please call OpenapiFirst::Test.register('myopenapi.yaml'#{option}) " \
+              'once before calling assert_api_conform.')
+      end
     end
   end
 end

data/lib/openapi_first/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.3
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana