openapi_first 1.3.6 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 221362a78a788c449a8c11af9c40fc91bf307c82ee79d0931c94f39bb22901bc
-  data.tar.gz: d9b806ed56371199552b4081d2b6b220279b925b9fdbdaa90ce47623c86e4bff
+  metadata.gz: 5e143a15321c0af7dfde5539a31ab7909255e9efdf50fcb7d59bde406d3aabb2
+  data.tar.gz: 84304a9fd090b4fa25c56e515d5502e8b40195da17a0f26a0ecde972ae2107e1
 SHA512:
-  metadata.gz: 5c5ceac8c85f7d074983e5d237febe8ecf9ec3414a5ecb1a5bd8af43259eb2c83621ac867ca9b1d5420a3dda7518e131ed2ac1f08b86d71fa6fdfccbf76e1885
-  data.tar.gz: 92c44316bf96d31841a959898efcd20e08bc223f233e26af253cc3575dbf29680b13e27ab628eb9bb9544371c08c0d7aea42b5aaf8bef75d369299067e6eb0ca
+  metadata.gz: a17ab4fa7b30355f0396f96601c3da19ec863b4a2f895d47e0841dcb776442eeb22da979fbce006354f27ca2bf09658d64883c8b4293f53402eb2b330231b0c4
+  data.tar.gz: ad332622204451191ba668c237812c3e1b62328130ad76b7caf0229c000dd935497c5ea7b9df8762f8dbd4a3456a5583cfde2078daf713b4fcacca21e697c0a3

data/CHANGELOG.md

@@ -2,9 +2,24 @@
 
 ## Unreleased
 
+## 1.4.1
+
+- Fixed: Don't call deprecated methods in middlewares
+
+## 1.4.0
+
+### Changed
+
+Some redundant methods to validate or inspect requests/responses will be removed in 2.0. So this release deprecates these methods.
+
+- Deprecate `OpenapiFirst::RuntimeRequest#validate`, `#validate!`, `#validate_response`, `#response`.
+  Use `OpenapiFirst.load('openapi.yaml').validate_request(rack_request, raise_error: true/false)` instead
+- Deprecate `OpenapiFirst::RuntimeResponse#validate`.
+  Use `OpenapiFirst.load('openapi.yaml').validate_response(rack_request, rack_response, raise_error: true/false)` instead.
+
 ## 1.3.6
 
-- Fix Rack 2 / Rails 6 compatibility ([#246](https://github.com/ahx/openapi_first/issues/246)
+- FIx Rack 2 / Rails 6 compatibility ([#246](https://github.com/ahx/openapi_first/issues/246)
 
 ## 1.3.5
 

data/lib/openapi_first/definition.rb

@@ -24,9 +24,12 @@ module OpenapiFirst
     # @param raise_error [Boolean] Whether to raise an error if validation fails.
     # @return [RuntimeRequest] The validated request object.
     def validate_request(rack_request, raise_error: false)
-      validated = request(rack_request).tap(&:validate)
-      validated.error&.raise! if raise_error
-      validated
+      runtime_request = request(rack_request)
+      validator = RequestValidation::Validator.new(runtime_request.operation)
+      validation_error = validator.validate(runtime_request)
+      validation_error.raise! if validation_error && raise_error
+      runtime_request.error = validation_error
+      runtime_request
     end
 
     # Validates the response against the API description.
@@ -35,7 +38,12 @@ module OpenapiFirst
     # @param raise_error [Boolean] Whether to raise an error if validation fails.
     # @return [RuntimeResponse] The validated response object.
     def validate_response(rack_request, rack_response, raise_error: false)
-      request(rack_request).validate_response(rack_response, raise_error:)
+      runtime_response = response(rack_request, rack_response)
+      validator = ResponseValidation::Validator.new(runtime_response.operation)
+      validation_error = validator.validate(runtime_response)
+      validation_error.raise! if validation_error && raise_error
+      runtime_response.error = validation_error
+      runtime_response
     end
 
     # Builds a RuntimeRequest object based on the Rack request.
@@ -57,7 +65,8 @@ module OpenapiFirst
     # @param rack_response [Rack::Response] The Rack response object.
     # @return [RuntimeResponse] The RuntimeResponse object.
     def response(rack_request, rack_response)
-      request(rack_request).response(rack_response)
+      runtime_request = request(rack_request)
+      RuntimeResponse.new(runtime_request.operation, rack_response)
     end
 
     # Gets all the operations defined in the API description.

data/lib/openapi_first/middlewares/request_validation.rb

@@ -26,11 +26,9 @@ module OpenapiFirst
       attr_reader :app
 
       def call(env)
-        request = find_request(env)
-        return @app.call(env) unless request
-
-        failure = request.validate
-        failure.raise! if failure && @raise
+        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
 
         @app.call(env)
@@ -38,10 +36,6 @@ module OpenapiFirst
 
       private
 
-      def find_request(env)
-        env[REQUEST] ||= @definition.request(Rack::Request.new(env))
-      end
-
       def error_response(mod)
         return OpenapiFirst.find_plugin(mod)::ErrorResponse if mod.is_a?(Symbol)
 

data/lib/openapi_first/middlewares/response_validation.rb

@@ -22,10 +22,10 @@ module OpenapiFirst
       attr_reader :app
 
       def call(env)
-        request = find_request(env)
         status, headers, body = @app.call(env)
         body = read_body(body)
-        request.validate_response(Rack::Response[status, headers, body], raise_error: true)
+        @definition.validate_response(Rack::Request.new(env), Rack::Response[status, headers, body], raise_error: true)
+        env[REQUEST] ||= @definition.request(Rack::Request.new(env))
         [status, headers, body]
       end
 
@@ -34,13 +34,7 @@ module OpenapiFirst
       def read_body(body)
         return body.to_ary if body.respond_to?(:to_ary)
 
-        result = []
-        body.each { |part| result << part }
-        result
-      end
-
-      def find_request(env)
-        env[REQUEST] ||= @definition.request(Rack::Request.new(env))
+        body.map { |part| part }
       end
     end
   end

data/lib/openapi_first/runtime_request.rb

@@ -16,7 +16,6 @@ module OpenapiFirst
       @path_item = path_item
       @operation = operation
       @original_path_params = path_params
-      @error = nil
       @validated = false
     end
 
@@ -34,12 +33,12 @@ module OpenapiFirst
 
     # Returns the error object if validation failed.
     # @return [Failure, nil]
-    attr_reader :error
+    attr_accessor :error
 
     # Checks if the request is valid.
     # @return [Boolean] true if the request is valid, false otherwise.
     def valid?
-      validate unless @validated
+      validate unless validated?
       error.nil?
     end
 
@@ -120,13 +119,17 @@ module OpenapiFirst
 
     # Validates the request.
     # @return [Failure, nil] The Failure object if validation failed.
+    # @deprecated Please use {Definition#validate_request} instead
     def validate
-      @validated = true
+      warn '[DEPRECATION] `validate` is deprecated. Please use ' \
+           "`OpenapiFirst.load('openapi.yaml').validate_request(rack_request)` instead."
       @error = RequestValidation::Validator.new(operation).validate(self)
     end
 
     # Validates the request and raises an error if validation fails.
     def validate!
+      warn '[DEPRECATION] `validate!` is deprecated. Please use ' \
+           "`OpenapiFirst.load('openapi.yaml').validate_request(rack_request, raise_error: true)` instead."
       error = validate
       error&.raise!
     end
@@ -136,6 +139,8 @@ module OpenapiFirst
     # @param raise_error [Boolean] Whether to raise an error if validation fails.
     # @return [RuntimeResponse] The validated response object.
     def validate_response(rack_response, raise_error: false)
+      warn '[DEPRECATION] `validate_response!` is deprecated. Please use ' \
+           "`OpenapiFirst.load('openapi.yaml').validate_response(request, response, raise_error: false)` instead."
       validated = response(rack_response).tap(&:validate)
       validated.error&.raise! if raise_error
       validated
@@ -145,11 +150,17 @@ module OpenapiFirst
     # @param rack_response [Rack::Response] The rack response object.
     # @return [RuntimeResponse] The RuntimeResponse object.
     def response(rack_response)
+      warn '[DEPRECATION] `response` is deprecated. Please use ' \
+           "`OpenapiFirst.load('openapi.yaml').validate_response(request, response, raise_error: false)` instead."
       RuntimeResponse.new(operation, rack_response)
     end
 
     private
 
+    def validated?
+      defined?(@error)
+    end
+
     attr_reader :request
   end
 end

data/lib/openapi_first/runtime_response.rb

@@ -12,11 +12,13 @@ module OpenapiFirst
     def initialize(operation, rack_response)
       @operation = operation
       @rack_response = rack_response
-      @error = nil
     end
 
     # @return [Failure, nil] Error object if validation failed.
-    attr_reader :error
+    attr_accessor :error
+
+    # @visibility private
+    attr_accessor :operation
 
     # @attr_reader [Integer] status The HTTP status code of this response.
     # @attr_reader [String] content_type The content_type of the Rack::Response.
@@ -30,7 +32,7 @@ module OpenapiFirst
     # Checks if the response is valid. Runs the validation unless it has been run before.
     # @return [Boolean]
     def valid?
-      validate unless @validated
+      validate unless validated?
       @error.nil?
     end
 
@@ -67,8 +69,10 @@ module OpenapiFirst
 
     # Validates the response.
     # @return [Failure, nil] Returns the validation error, or nil if the response is valid.
+    # @deprecated Please use {Definition#validate_response} instead
     def validate
-      @validated = true
+      warn '[DEPRECATION] `validate` is deprecated. ' \
+           "Please use `OpenapiFirst.load('openapi.yaml').validate_response(rack_request, rack_response)` instead."
       @error = ResponseValidation::Validator.new(@operation).validate(self)
     end
 
@@ -87,6 +91,10 @@ module OpenapiFirst
 
     private
 
+    def validated?
+      defined?(@error)
+    end
+
     # Usually the body responds to #each, but when using manual response validation without the middleware
     # in Rails request specs the body is a String. So this code handles both cases.
     def original_body

data/lib/openapi_first/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.4.1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana