rswag-specs 2.7.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 989468cbcebd005e6bf95724400366cfa1b80e7d395bb6d1255bc12c283a98b2
-  data.tar.gz: 949a822da86b5d6f3ead28cdd1262a093bcd8399875b1962f101c41634cc4c51
+  metadata.gz: fa8f8005ed229944c19cb2e33e09eaebb95b8e32b9bef505a5e6b64b237bcbdc
+  data.tar.gz: 7eebf43807f0252c3168e08283b716c3dd9356f5d79fde1fcfc275377b5bc522
 SHA512:
-  metadata.gz: b4cb982b39359a8f69dd5ebf18287a2b4941349a202751d10f936b81014fce8ec99a24886e5de63c4fb1d4aba653893cf4ebff9f425f547be99b1ac3910e53ad
-  data.tar.gz: 1064a439e5b8652c40a77eddd6d0837ea908780750187879bb8bdb11af67656ea6882a8a251bb8627001c7857ebad94c378d68432c1101e2e19647b5c7c29ae5
+  metadata.gz: e99187485ac197dad84d0f28b9bdec67c0e11b10efb5f2561a939e48852a6fc28505d2c92feb49a2969dd6a5a7919279986a05d9c3d09db2dc15581b085908ed
+  data.tar.gz: 1da746e08c42864094b13f36b72587f1d05b55922106ac1888accf16ac1bfae84c5fafb28dfa5952c47b477742b592bfff915743842523104f28e416859c1889

data/lib/generators/rspec/swagger_generator.rb

@@ -6,13 +6,14 @@ require 'rails/generators'
 module Rspec
   class SwaggerGenerator < ::Rails::Generators::NamedBase
     source_root File.expand_path('templates', __dir__)
+    class_option :spec_path, type: :string, default: 'requests'
 
     def setup
       @routes = Rswag::RouteParser.new(controller_path).routes
     end
 
     def create_spec_file
-      template 'spec.rb', File.join('spec', 'requests', "#{controller_path}_spec.rb")
+      template 'spec.rb', File.join('spec', options['spec_path'], "#{controller_path}_spec.rb")
     end
 
     private

data/lib/rswag/specs/configuration.rb

@@ -55,6 +55,10 @@ module Rswag
         doc = get_swagger_doc(name)
         doc[:openapi] || doc[:swagger]
       end
+
+      def swagger_strict_schema_validation
+        @swagger_strict_schema_validation ||= (@rspec_config.swagger_strict_schema_validation || false)
+      end
     end
 
     class ConfigurationError < StandardError; end

data/lib/rswag/specs/example_group_helpers.rb

@@ -55,6 +55,18 @@ module Rswag
         end
       end
 
+
+      def request_body_example(value:, summary: nil, name: nil)
+        if metadata.key?(:operation)
+          metadata[:operation][:request_examples] ||= []
+          example = { value: value }
+          example[:summary] = summary if summary
+          # We need the examples to have a unique name for a set of examples, so just make the name the length if one isn't provided.
+          example[:name] = name || metadata[:operation][:request_examples].length()
+          metadata[:operation][:request_examples] << example
+        end
+      end
+
       def response(code, description, metadata = {}, &block)
         metadata[:response] = { code: code, description: description }
         context(description, metadata, &block)
@@ -103,14 +115,22 @@ module Rswag
         )
       end
 
-      def run_test!(&block)
+      #
+      # Perform request and assert response matches swagger definitions
+      #
+      # @param options [Hash] options to pass to the `it` method
+      # @param &block [Proc] you can make additional assertions within that block
+      # @return [void]
+      def run_test!(**options, &block)
+        options[:rswag] = true unless options.key?(:rswag)
+
         if RSPEC_VERSION < 3
           ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0')
           before do
             submit_request(example.metadata)
           end
 
-          it "returns a #{metadata[:response][:code]} response", rswag: true do
+          it "returns a #{metadata[:response][:code]} response", **options do
             assert_response_matches_metadata(metadata)
             block.call(response) if block_given?
           end
@@ -119,7 +139,7 @@ module Rswag
             submit_request(example.metadata)
           end
 
-          it "returns a #{metadata[:response][:code]} response", rswag: true do |example|
+          it "returns a #{metadata[:response][:code]} response", **options do |example|
             assert_response_matches_metadata(example.metadata, &block)
             example.instance_exec(response, &block) if block_given?
           end

data/lib/rswag/specs/request_factory.rb

@@ -34,7 +34,7 @@ module Rswag
         (operation_params + path_item_params + security_params)
           .map { |p| p['$ref'] ? resolve_parameter(p['$ref'], swagger_doc) : p }
           .uniq { |p| p[:name] }
-          .reject { |p| p[:required] == false && !example.respond_to?(p[:name]) }
+          .reject { |p| p[:required] == false && !example.respond_to?(extract_getter(p)) }
       end
 
       def derive_security_params(metadata, swagger_doc)
@@ -106,7 +106,7 @@ module Rswag
         server = swagger_doc[:servers].first
         variables = {}
         server.fetch(:variables, {}).each_pair { |k,v| variables[k] = v[use_server] }
-        base_path = server[:url].gsub(/\{(.*?)\}/) { |name| variables[name.to_sym] }
+        base_path = server[:url].gsub(/\{(.*?)\}/) { variables[$1.to_sym] }
         URI(base_path).path
       end
 
@@ -126,16 +126,16 @@ module Rswag
 
         request[:path] = template.tap do |path_template|
           parameters.select { |p| p[:in] == :path }.each do |p|
-            unless example.respond_to?(p[:name])
+            unless example.respond_to?(extract_getter(p))
               raise ArgumentError.new("`#{p[:name].to_s}` parameter key present, but not defined within example group"\
                 "(i. e `it` or `let` block)")
             end
-            path_template.gsub!("{#{p[:name]}}", example.send(p[:name]).to_s)
+            path_template.gsub!("{#{p[:name]}}", example.send(extract_getter(p)).to_s)
           end
 
           parameters.select { |p| p[:in] == :query }.each_with_index do |p, i|
             path_template.concat(i.zero? ? '?' : '&')
-            path_template.concat(build_query_string_part(p, example.send(p[:name]), swagger_doc))
+            path_template.concat(build_query_string_part(p, example.send(extract_getter(p)), swagger_doc))
           end
         end
       end
@@ -148,7 +148,7 @@ module Rswag
           style = param[:style]&.to_sym || :form
           explode = param[:explode].nil? ? true : param[:explode]
 
-          case param[:schema][:type].to_sym
+          case param[:schema][:type]&.to_sym
           when :object
             case style
             when :deepObject
@@ -197,7 +197,7 @@ module Rswag
       def add_headers(request, metadata, swagger_doc, parameters, example)
         tuples = parameters
           .select { |p| p[:in] == :header }
-          .map { |p| [p[:name], example.send(p[:name]).to_s] }
+          .map { |p| [p[:name], example.send(extract_getter(p)).to_s] }
 
         # Accept header
         produces = metadata[:operation][:produces] || swagger_doc[:produces]
@@ -213,14 +213,22 @@ module Rswag
           tuples << ['Content-Type', content_type]
         end
 
+        # Host header
+        host = metadata[:operation][:host] || swagger_doc[:host]
+        if host.present?
+          host = example.respond_to?(:'Host') ? example.send(:'Host') : host
+          tuples << ['Host', host]
+        end
+
         # Rails test infrastructure requires rack-formatted headers
         rack_formatted_tuples = tuples.map do |pair|
           [
             case pair[0]
-            when 'Accept' then 'HTTP_ACCEPT'
-            when 'Content-Type' then 'CONTENT_TYPE'
-            when 'Authorization' then 'HTTP_AUTHORIZATION'
-            else pair[0]
+              when 'Accept' then 'HTTP_ACCEPT'
+              when 'Content-Type' then 'CONTENT_TYPE'
+              when 'Authorization' then 'HTTP_AUTHORIZATION'
+              when 'Host' then 'HTTP_HOST'
+              else pair[0]
             end,
             pair[1]
           ]
@@ -247,7 +255,7 @@ module Rswag
         # PROS: simple to implement, CONS: serialization/deserialization is bypassed in test
         tuples = parameters
           .select { |p| p[:in] == :formData }
-          .map { |p| [p[:name], example.send(p[:name])] }
+          .map { |p| [p[:name], example.send(extract_getter(p))] }
         Hash[tuples]
       end
 
@@ -264,6 +272,10 @@ module Rswag
       def doc_version(doc)
         doc[:openapi] || doc[:swagger] || '3'
       end
+
+      def extract_getter(parameter)
+         parameter[:getter] || parameter[:name]
+      end
     end
 
     class MissingParameterError < StandardError

data/lib/rswag/specs/response_validator.rb

@@ -32,9 +32,22 @@ module Rswag
       end
 
       def validate_headers!(metadata, headers)
-        expected = (metadata[:response][:headers] || {}).keys
+        header_schemas = (metadata[:response][:headers] || {})
+        expected = header_schemas.keys
         expected.each do |name|
-          raise UnexpectedResponse, "Expected response header #{name} to be present" if headers[name.to_s].nil?
+          nullable_attribute = header_schemas.dig(name.to_s, :schema, :nullable)
+          required_attribute = header_schemas.dig(name.to_s, :required)
+
+          is_nullable = nullable_attribute.nil? ? false : nullable_attribute
+          is_required = required_attribute.nil? ? true : required_attribute
+
+          if headers.exclude?(name.to_s) && is_required
+            raise UnexpectedResponse, "Expected response header #{name} to be present"
+          end
+
+          if headers.include?(name.to_s) && headers[name.to_s].nil? && !is_nullable
+            raise UnexpectedResponse, "Expected response header #{name} to not be null"
+          end
         end
       end
 
@@ -49,7 +62,9 @@ module Rswag
           .merge('$schema' => 'http://tempuri.org/rswag/specs/extended_schema')
           .merge(schemas)
 
-        errors = JSON::Validator.fully_validate(validation_schema, body)
+        validation_options = validation_options_from(metadata)
+
+        errors = JSON::Validator.fully_validate(validation_schema, body, validation_options)
         return unless errors.any?
 
         raise UnexpectedResponse,
@@ -57,6 +72,15 @@ module Rswag
               "Response body: #{JSON.pretty_generate(JSON.parse(body))}"
       end
 
+      def validation_options_from(metadata)
+        is_strict = !!metadata.fetch(
+          :swagger_strict_schema_validation,
+          @config.swagger_strict_schema_validation
+        )
+
+        { strict: is_strict }
+      end
+
       def definitions_or_component_schemas(swagger_doc, version)
         if version.start_with?('2')
           swagger_doc.slice(:definitions)

data/lib/rswag/specs/swagger_formatter.rb

@@ -58,12 +58,23 @@ module Rswag
                 if is_hash && value[:parameters]
                   schema_param = value[:parameters]&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
                   mime_list = value[:consumes] || doc[:consumes]
+
                   if value && schema_param && mime_list
                     value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
                     value[:requestBody][:required] = true if schema_param[:required]
                     value[:requestBody][:description] = schema_param[:description] if schema_param[:description]
+                    examples = value.dig(:request_examples)
                     mime_list.each do |mime|
                       value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
+                      if examples
+                        value[:requestBody][:content][mime][:examples] ||= {}
+                        examples.map do |example|
+                          value[:requestBody][:content][mime][:examples][example[:name]] = {
+                            summary: example[:summary] || value[:summary],
+                            value: example[:value]
+                          }
+                        end
+                      end
                     end
                   end
 
@@ -137,7 +148,7 @@ module Rswag
 
         target_node[:content] ||= {}
         mime_list.each do |mime_type|
-          # TODO upgrade to have content-type specific schema
+          # TODO: upgrade to have content-type specific schema
           (target_node[:content][mime_type] ||= {}).merge!(schema: schema)
         end
       end
@@ -197,9 +208,12 @@ module Rswag
       end
 
       def remove_invalid_operation_keys!(value)
-        is_hash = value.is_a?(Hash)
-        value.delete(:consumes) if is_hash && value[:consumes]
-        value.delete(:produces) if is_hash && value[:produces]
+        return unless value.is_a?(Hash)
+
+        value.delete(:consumes) if value[:consumes]
+        value.delete(:produces) if value[:produces]
+        value.delete(:request_examples) if value[:request_examples]
+        value[:parameters].each { |p| p.delete(:getter) } if value[:parameters]
       end
     end
   end

data/lib/rswag/specs.rb

@@ -14,6 +14,7 @@ module Rswag
       c.add_setting :swagger_docs
       c.add_setting :swagger_dry_run
       c.add_setting :swagger_format
+      c.add_setting :swagger_strict_schema_validation
       c.extend ExampleGroupHelpers, type: :request
       c.include ExampleHelpers, type: :request
     end

data/lib/tasks/rswag-specs_tasks.rake

@@ -16,11 +16,13 @@ namespace :rswag do
         ''
       )
 
+      t.rspec_opts = [additional_rspec_opts]
+
       if Rswag::Specs::RSPEC_VERSION > 2 && Rswag::Specs.config.swagger_dry_run
-        t.rspec_opts = ['--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined'] << additional_rspec_opts
+        t.rspec_opts += ['--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined']
       else
         ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0')
-        t.rspec_opts = ['--format Rswag::Specs::SwaggerFormatter', '--order defined']
+        t.rspec_opts += ['--format Rswag::Specs::SwaggerFormatter', '--order defined']
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport