openapi_first 1.3.6 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 221362a78a788c449a8c11af9c40fc91bf307c82ee79d0931c94f39bb22901bc
-  data.tar.gz: d9b806ed56371199552b4081d2b6b220279b925b9fdbdaa90ce47623c86e4bff
+  metadata.gz: 1a462473bc1c585914983760dc3023fda2a375276f2703712ec1f8e7d8ef4950
+  data.tar.gz: 46c6cb68fc175a55525595ed90a4cf599af36d117a80dff8078fecf24aca79d7
 SHA512:
-  metadata.gz: 5c5ceac8c85f7d074983e5d237febe8ecf9ec3414a5ecb1a5bd8af43259eb2c83621ac867ca9b1d5420a3dda7518e131ed2ac1f08b86d71fa6fdfccbf76e1885
-  data.tar.gz: 92c44316bf96d31841a959898efcd20e08bc223f233e26af253cc3575dbf29680b13e27ab628eb9bb9544371c08c0d7aea42b5aaf8bef75d369299067e6eb0ca
+  metadata.gz: c51b30bf959533eeee109cea59fdce2c1f0057e1c40eec6a961b0360000665e940ff1366125db655b1d2026f7bf8767ba62cd8358b6a31b9ac7128f4f129c497
+  data.tar.gz: d639e00db05a01a1e2f8bdb57c1e95c72ee71c5bcc317d53b1130a915124075d0b8e922cb0c3340ba02b709a1c7e06142024f64d1de264abaa631caf7522b563

data/CHANGELOG.md

@@ -2,9 +2,20 @@
 
 ## Unreleased
 
+## 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/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
 
@@ -38,10 +38,6 @@ module OpenapiFirst
         body.each { |part| result << part }
         result
       end
-
-      def find_request(env)
-        env[REQUEST] ||= @definition.request(Rack::Request.new(env))
-      end
     end
   end
 end

data/lib/openapi_first/runtime_request.rb

@@ -120,13 +120,18 @@ module OpenapiFirst
 
     # Validates the request.
     # @return [Failure, nil] The Failure object if validation failed.
+    # @deprecated Please use {Definition#validate_request} instead
     def validate
+      warn '[DEPRECATION] `validate` is deprecated. Please use ' \
+           "`OpenapiFirst.load('openapi.yaml').validate_request(rack_request)` instead."
       @validated = true
       @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 +141,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,6 +152,8 @@ 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
 

data/lib/openapi_first/runtime_response.rb

@@ -67,7 +67,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
+      warn '[DEPRECATION] `validate` is deprecated. ' \
+           "Please use `OpenapiFirst.load('openapi.yaml').validate_response(rack_request, rack_response)` instead."
       @validated = true
       @error = ResponseValidation::Validator.new(@operation).validate(self)
     end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '1.3.6'
+  VERSION = '1.4.0'
 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.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana