openapi-ruby 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e392a1235f97dc71aaf0ec1790ee0bd64c4bcbae412063af363af91e95cb608d
-  data.tar.gz: 90f056e8bc51aa18d6de20a38ac706c079955567066e034d9408a8bd75b2f966
+  metadata.gz: 953f7f56ecdec3d8ee0f1f1261e49328e53d0aab5041b43f47a6e1138a2e880f
+  data.tar.gz: bec8a51340348604307f17791824d9327e7ceee7b58a8f35533ef7036c12156f
 SHA512:
-  metadata.gz: bde611e9f9b188969e3bbc8a6f1062efe7738ebc15e7eef40079406cccd0eab35051c767db9abfbcba0eea1e91ec39a265f7654468f8478efef8462e63b67f42
-  data.tar.gz: c02da938cd7edd9053fc89730916dbc31b87829fc945c36248269e6a77a569cf77ea07c14938550517a16909615ee926fc05b1b54bf848a3997ac7cfa1bf4c47
+  metadata.gz: c62b49da036fe1dbb27b3f7ce2937a044427ea89ded288bdab1c33dab6fc041e31c89ecb75fd2e2419731cd0f803428baed9ed5152cdf01d7cd77b42b004642e
+  data.tar.gz: 5e2bbbcf02c286120207fc06a9f86c66b2618c9766a78b4b94c215641d0c2a5173aa4c45705e4fd2e6ed909271c63000a65182d159f22f3d716a4742dcbc6bae

data/README.md

@@ -63,7 +63,6 @@ OpenapiRuby.configure do |config|
   config.camelize_keys = true
   config.schema_output_dir = "swagger"
   config.schema_output_format = :yaml
-  config.validate_responses_in_tests = true
 
   # Runtime middleware (disabled by default)
   config.request_validation = :disabled   # :enabled, :disabled, :warn_only

data/lib/generators/openapi_ruby/install/templates/initializer.rb.tt

@@ -20,9 +20,6 @@ OpenapiRuby.configure do |config|
   config.schema_output_dir = "swagger"
   config.schema_output_format = :yaml
 
-  # Validate response bodies in tests against defined schemas
-  config.validate_responses_in_tests = true
-
   # Runtime request/response validation middleware
   # Options: :disabled, :enabled, :warn_only
   config.request_validation = :disabled

data/lib/openapi_ruby/adapters/minitest.rb

@@ -87,7 +87,7 @@ module OpenapiRuby
           assert_equal expected_status, response.status,
             "Expected status #{expected_status}, got #{response.status}\nResponse body: #{response.body}"
 
-          if OpenapiRuby.configuration.validate_responses_in_tests && response_ctx.schema_definition
+          if response_ctx.schema_definition
             validator = Testing::ResponseValidator.new
             body_data = parse_response_body
             errors = validator.validate(

data/lib/openapi_ruby/adapters/rspec.rb

@@ -144,6 +144,12 @@ module OpenapiRuby
           accept = resolve_let(:Accept)
           headers["Accept"] = accept || "application/json"
 
+          # Always append query params to the URL so the middleware sees them
+          # (Rails sends params as request body for non-GET methods).
+          if params.any?
+            path = "#{path}?#{Rack::Utils.build_nested_query(params)}"
+          end
+
           if body
             content_type = operation&.request_body_definition&.dig("content")&.keys&.first || "application/json"
             request_args = if content_type.include?("form-data") || content_type.include?("x-www-form-urlencoded")
@@ -154,13 +160,8 @@ module OpenapiRuby
                 headers: headers.merge("Content-Type" => content_type)
               }
             end
-            # Append query params to path when body is present
-            if params.any?
-              query_string = params.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&")
-              path = "#{path}?#{query_string}"
-            end
           else
-            request_args = {params: params, headers: headers}
+            request_args = {headers: headers}
           end
 
           send(method.to_sym, path, **request_args)
@@ -177,6 +178,19 @@ module OpenapiRuby
               "Expected status #{expected_status}, got #{actual_status}\n" \
               "Response body: #{response.body}"
           end
+
+          if response_ctx.schema_definition
+            schema_name = find_in_metadata(metadata, :openapi_schema_name)
+            validator = Testing::ResponseValidator.new(OpenapiRuby::Adapters::RSpec.validation_document_for(schema_name))
+            errors = validator.validate(
+              response_body: parsed_response_body,
+              status_code: response.status,
+              response_context: response_ctx
+            )
+            unless errors.empty?
+              raise "Response body validation failed:\n#{errors.join("\n")}\nResponse body: #{response.body}"
+            end
+          end
         end
 
         private
@@ -269,6 +283,29 @@ module OpenapiRuby
         end
       end
 
+      # Build the OpenAPI document hash for a given schema name and cache it.
+      # Used by response body validation so $ref schemas can be resolved.
+      def self.validation_document_for(schema_name)
+        return nil unless schema_name
+
+        key = schema_name.to_sym
+        @validation_documents ||= {}
+        @validation_documents[key] ||= begin
+          config = OpenapiRuby.configuration
+          schema_config = config.schemas[key] || config.schemas[schema_name.to_s]
+          return nil unless schema_config
+
+          builder = OpenapiRuby::Core::DocumentBuilder.new(schema_config)
+          OpenapiRuby::DSL::MetadataStore.contexts_for(schema_name).each do |context|
+            builder.add_path(context.path_template, context.to_openapi)
+          end
+          scope = schema_config[:component_scope]
+          loader = OpenapiRuby::Components::Loader.new(scope: scope)
+          builder.merge_components(loader.to_openapi_hash)
+          builder.build.data
+        end
+      end
+
       def self.install!
         ::RSpec.configure do |config|
           config.extend ExampleGroupHelpers, type: :openapi

data/lib/openapi_ruby/configuration.rb

@@ -9,46 +9,51 @@ module OpenapiRuby
     # Components
     attr_accessor :component_paths
     attr_accessor :component_scope_paths
-    attr_accessor :camelize_keys, :key_transform, :response_validation, :strict_query_params,
-      :coerce_params, :error_handler, :schema_output_format, :validate_responses_in_tests, :ui_path, :ui_config, :coverage_report_path
-    attr_accessor :strict_reference_validation
+
+    # Output / formatting
+    attr_accessor :camelize_keys, :schema_output_format, :schema_output_dir
     attr_accessor :auto_validation_error_response
     attr_accessor :validation_error_schema
 
     # Middleware (runtime validation)
-    attr_accessor :request_validation
+    attr_accessor :request_validation, :response_validation, :coerce_params
 
-    # Test / Generation
-    attr_accessor :schema_output_dir
+    # OpenAPI meta-schema validation of generated specs and middleware-loaded
+    # documents. One of :disabled, :enabled (raise on errors), :warn_only
+    # (default, log warnings). Boolean values are accepted for backwards
+    # compatibility: `true` → :warn_only, `false` → :disabled.
+    attr_reader :strict_reference_validation
 
-    # UI (optional)
-    attr_accessor :ui_enabled
+    def strict_reference_validation=(value)
+      @strict_reference_validation = case value
+      when true, :warn_only then :warn_only
+      when false, :disabled then :disabled
+      when :enabled then :enabled
+      else
+        raise ConfigurationError,
+          "strict_reference_validation must be :disabled, :enabled, :warn_only, or a boolean"
+      end
+    end
 
-    # Coverage
-    attr_accessor :coverage_enabled
+    # UI (optional)
+    attr_accessor :ui_enabled, :ui_path, :ui_config
 
     def initialize
       @schemas = {}
       @component_paths = ["app/api_components"]
       @component_scope_paths = {}
       @camelize_keys = true
-      @key_transform = nil
       @request_validation = :disabled
       @response_validation = :disabled
-      @strict_query_params = false
       @coerce_params = true
-      @error_handler = nil
       @schema_output_dir = "swagger"
       @schema_output_format = :yaml
-      @validate_responses_in_tests = true
       @ui_enabled = false
       @ui_path = "/api-docs"
       @ui_config = {}
-      @strict_reference_validation = true
+      @strict_reference_validation = :warn_only
       @auto_validation_error_response = true
       @validation_error_schema = nil
-      @coverage_enabled = false
-      @coverage_report_path = "tmp/openapi_coverage.json"
     end
 
     def validate!

data/lib/openapi_ruby/generator/schema_writer.rb

@@ -23,7 +23,7 @@ module OpenapiRuby
 
       def write!
         document = build_document
-        validate_document!(document) if OpenapiRuby.configuration.strict_reference_validation
+        validate_document!(document) unless OpenapiRuby.configuration.strict_reference_validation == :disabled
         output_path = File.join(output_dir, filename)
         FileUtils.mkdir_p(output_dir)
         File.write(output_path, format_output(document))
@@ -63,7 +63,12 @@ module OpenapiRuby
         return if errors.empty?
 
         error_messages = errors.first(10).map { |e| e["error"] || e.to_s }
-        warn "[openapi_ruby] Generated schema '#{@schema_name}' has validation errors:\n#{error_messages.join("\n")}"
+        message = "[openapi_ruby] Generated schema '#{@schema_name}' has validation errors:\n#{error_messages.join("\n")}"
+        if OpenapiRuby.configuration.strict_reference_validation == :enabled
+          raise OpenapiRuby::ConfigurationError, message
+        else
+          warn message
+        end
       end
 
       def format_output(document)

data/lib/openapi_ruby/middleware/schema_resolver.rb

@@ -3,7 +3,7 @@
 module OpenapiRuby
   module Middleware
     class SchemaResolver
-      def initialize(spec_path: nil, document: nil, strict_reference_validation: true)
+      def initialize(spec_path: nil, document: nil, strict_reference_validation: :warn_only)
         @spec_path = spec_path
         @document = document
         @strict_reference_validation = strict_reference_validation
@@ -41,15 +41,19 @@ module OpenapiRuby
       private
 
       def validate_document!(doc)
-        return unless @strict_reference_validation
+        return if @strict_reference_validation == :disabled
 
         schemer = JSONSchemer.openapi(doc)
         errors = schemer.validate.to_a
         return if errors.empty?
 
         error_messages = errors.first(5).map { |e| e["error"] || e.to_s }
-        raise OpenapiRuby::ConfigurationError,
-          "OpenAPI document validation failed:\n#{error_messages.join("\n")}"
+        message = "OpenAPI document validation failed:\n#{error_messages.join("\n")}"
+        if @strict_reference_validation == :enabled
+          raise OpenapiRuby::ConfigurationError, message
+        else
+          warn message
+        end
       end
 
       def load_document

data/lib/openapi_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiRuby
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Morten Hartvig