rswag-specs 2.4.0 → 2.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ef5793bfd5d9e2b17fb14a67c41562597de0d3ceba4de65bff02708b52ced46
-  data.tar.gz: a2c38863e7ed7fe5e3f3d9d2fbdb8eff5d2052c9304ebe89795c6f087c44cce3
+  metadata.gz: 0337b822234111d51e0497b909b48a516359c377d60281fca510757737d4ec5b
+  data.tar.gz: efbab52e3fde30f2b29861c03b1ccc7aaeece2a6ed4136e87f0240fbcb257a30
 SHA512:
-  metadata.gz: 36dc472748a196a30eed6904064c05b3716089bbcea879976ee3ce14be95bcae41b2eab01f2cbd521c3ddbf1b959eaf898ae034c86d7a6b010bc8f7a33b3f66f
-  data.tar.gz: 610024b7e3ab5a860fb394b3c933a0cfab739c86f7e29f3b9927a566981aedb4e0ed38ddda617e625e49e1e8585d6c1ac14d770de22acaac2452efd14b38b5e5
+  metadata.gz: cd6b56b9d346ae29af299a02cbe48dc7bc308fc136b89fa973d56f89fbabab3e5f2910ff701097f3869be539c0b4592106a42b6e052351387694efeede956bae
+  data.tar.gz: e92f2795b54cdf75c5a70d547c11a60872456b0f88d929908a553014435950f2c6a1b0201eaac44b9b73e92ede8e75111d31e3822df8dbc44b086e36d6f1a4fd

data/lib/rswag/specs/request_factory.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require "active_support"
 require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/hash/conversions'
 require 'json'
@@ -194,12 +194,36 @@ module Rswag
 
       def build_json_payload(parameters, example)
         body_param = parameters.select { |p| p[:in] == :body }.first
-        body_param ? example.send(body_param[:name]).to_json : nil
+
+        return nil unless body_param
+
+        raise(MissingParameterError, body_param[:name]) unless example.respond_to?(body_param[:name])
+
+        example.send(body_param[:name]).to_json
       end
 
       def doc_version(doc)
         doc[:openapi] || doc[:swagger] || '3'
       end
     end
+
+    class MissingParameterError < StandardError
+      attr_reader :body_param
+
+      def initialize(body_param)
+        @body_param = body_param
+      end
+
+      def message
+        <<~MSG
+          Missing parameter '#{body_param}'
+
+          Please check your spec. It looks like you defined a body parameter,
+          but did not declare usage via let. Try adding:
+
+              let(:#{body_param}) {}
+        MSG
+      end
+    end
   end
 end

data/lib/rswag/specs/response_validator.rb

@@ -50,7 +50,11 @@ module Rswag
           .merge(schemas)
 
         errors = JSON::Validator.fully_validate(validation_schema, body)
-        raise UnexpectedResponse, "Expected response body to match schema: #{errors[0]}" if errors.any?
+        return unless errors.any?
+
+        raise UnexpectedResponse,
+              "Expected response body to match schema: #{errors[0]}\n" \
+              "Response body: #{JSON.pretty_generate(JSON.parse(body))}"
       end
 
       def definitions_or_component_schemas(swagger_doc, version)
@@ -62,7 +66,7 @@ module Rswag
             swagger_doc.slice(:definitions)
           else
             components = swagger_doc[:components] || {}
-            { components: { schemas: components[:schemas] } }
+            { components: components }
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0.rc1
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -21,7 +21,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +41,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,7 +51,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -109,11 +109,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: An OpenAPI-based (formerly called Swagger) DSL for rspec-rails & accompanying