rswag-specs 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfedb2177ee21788aa710db72fbc573230a51c84877bd90edff99b8a1fc9967c
-  data.tar.gz: 842d0dba7c2dcd4aa59ec015928c825da6ef1cf892859e492589d540b003c181
+  metadata.gz: 6d30046aab2de448f6194ded5849b09684c36be6e1b5e703858647bca6bb3301
+  data.tar.gz: 24bd271875ee9011313a2866930c7b045175638564d35e5816e5b3ad75fb59d7
 SHA512:
-  metadata.gz: 5640b7930547aa45a3b2662f8fad08508063d1c9726c2f72d6e2f15f6eab32408472e7645230b30a5eec74ae223cfae5e87e9d26311cc609aa543c90d8234aef
-  data.tar.gz: 98e797ce8b1babf942ba387cffbe6eec52994047543c669b9293631bc08bfc1695b9d3c1ca572f3ec9357e7649bf601f0df81bf28590ee605b501f7546aae8f1
+  metadata.gz: b61f3ac5b3d790eadc1d424ec2bebc967fbd97cafb22de3a4d7186c421d83bd4283b6bf0c63c450f749f969b8a5244490a74e5355179b62f615847e26759a53a
+  data.tar.gz: 03af0fb0ed593daa9e6e9d9102aa74445bffbe65fa20a473b157c90b7a82120660d23cee13b84c9986d3ecc601525a3c5c6e68969a4b37e109433a5e1d1be651

data/.rubocop_rspec_alias_config.yml

@@ -0,0 +1,17 @@
+RSpec:
+  Language:
+    ExampleGroups:
+      Regular:
+        - path
+        - response
+        - get
+        - post
+        - patch
+        - put
+        - delete
+        - head
+        - options
+        - trace
+    Examples:
+      Regular:
+        - run_test!

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

@@ -13,9 +13,9 @@ module Rswag
       end
 
       [:get, :post, :patch, :put, :delete, :head, :options, :trace].each do |verb|
-        define_method(verb) do |summary, &block|
-          api_metadata = { operation: { verb: verb, summary: summary } }
-          describe(verb, api_metadata, &block)
+        define_method(verb) do |summary, **metadata, &block|
+          api_metadata = { operation: { verb: verb, summary: summary } }.deep_merge(metadata)
+          describe(verb, **api_metadata, &block)
         end
       end
 
@@ -55,17 +55,16 @@ module Rswag
         end
       end
 
-
-      def request_body_example(value:, summary: nil, name: nil) 
-        if metadata.key?(:operation) 
+      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 
+          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 
+        end
+      end
 
       def response(code, description, metadata = {}, &block)
         metadata[:response] = { code: code, description: description }
@@ -115,14 +114,27 @@ module Rswag
         )
       end
 
-      def run_test!(&block)
+      #
+      # Perform request and assert response matches swagger definitions
+      #
+      # @param description [String] description of the test
+      # @param args [Array] arguments to pass to the `it` method
+      # @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!(description = nil, *args, **options, &block)
+        # rswag metadata value defaults to true
+        options[:rswag] = true unless options.key?(:rswag)
+
+        description ||= "returns a #{metadata[:response][:code]} response"
+
         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 description, *args, **options do
             assert_response_matches_metadata(metadata)
             block.call(response) if block_given?
           end
@@ -131,7 +143,7 @@ module Rswag
             submit_request(example.metadata)
           end
 
-          it "returns a #{metadata[:response][:code]} response", rswag: true do |example|
+          it description, *args, **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,22 +126,23 @@ 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
 
       def build_query_string_part(param, value, swagger_doc)
         name = param[:name]
+        escaped_name = CGI.escape(name.to_s)
 
         # OAS 3: https://swagger.io/docs/specification/serialization/
         if swagger_doc && doc_version(swagger_doc).start_with?('3') && param[:schema]
@@ -157,20 +158,20 @@ module Rswag
               if explode
                 return value.to_query
               else
-                return "#{CGI.escape(name.to_s)}=" + value.to_a.flatten.map{|v| CGI.escape(v.to_s) }.join(',')
+                return "#{escaped_name}=" + value.to_a.flatten.map{|v| CGI.escape(v.to_s) }.join(',')
               end
             end
           when :array
             case explode
             when true
-              return value.to_a.flatten.map{|v| "#{CGI.escape(name.to_s)}=#{CGI.escape(v.to_s)}"}.join('&')
+              return value.to_a.flatten.map{|v| "#{escaped_name}=#{CGI.escape(v.to_s)}"}.join('&')
             else
               separator = case style
                           when :form then ','
                           when :spaceDelimited then '%20'
                           when :pipeDelimited then '|'
                           end
-              return "#{CGI.escape(name.to_s)}=" + value.to_a.flatten.map{|v| CGI.escape(v.to_s) }.join(separator)
+              return "#{escaped_name}=" + value.to_a.flatten.map{|v| CGI.escape(v.to_s) }.join(separator)
             end
           else
             return "#{name}=#{value}"
@@ -178,7 +179,7 @@ module Rswag
         end
 
         type = param[:type] || param.dig(:schema, :type)
-        return "#{name}=#{value}" unless type&.to_sym == :array
+        return "#{escaped_name}=#{CGI.escape(value.to_s)}" unless type&.to_sym == :array
 
         case param[:collectionFormat]
         when :ssv
@@ -197,7 +198,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]
@@ -255,7 +256,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
 
@@ -272,6 +273,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

@@ -62,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,
@@ -70,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,6 +58,7 @@ 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]
@@ -147,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
@@ -207,10 +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]
-        value.delete(:request_examples) if is_hash && value[:request_examples]
+        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.8.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,6 +109,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop_rspec_alias_config.yml"
 - MIT-LICENSE
 - Rakefile
 - lib/generators/rspec/USAGE