rswag-specs 2.5.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df4a6de7cd0c39993e11e3cee2e4f21a1bf7175d53d467530a2d5d2fb0de62ad
-  data.tar.gz: 5845e6e3cc9368ff18a777155bb039aae5f8ad526444b9bf00ef5c3635ad732a
+  metadata.gz: 989468cbcebd005e6bf95724400366cfa1b80e7d395bb6d1255bc12c283a98b2
+  data.tar.gz: 949a822da86b5d6f3ead28cdd1262a093bcd8399875b1962f101c41634cc4c51
 SHA512:
-  metadata.gz: '088948aa3b15b493d95d678e6d30d211bc3d942d27db9f6c340acdee76b43783352b830045d118b1d91f65be068248c4a829d5f0a06fe58cd4478b903b069a25'
-  data.tar.gz: 60175ad736c79c12cfc14e1a9e810b57e0676a52ddc5b35fdb084fc6b0b8f0b1097080d6a367535287b982a71241b6675f6484252fce4a2b351972dead2664d5
+  metadata.gz: b4cb982b39359a8f69dd5ebf18287a2b4941349a202751d10f936b81014fce8ec99a24886e5de63c4fb1d4aba653893cf4ebff9f425f547be99b1ac3910e53ad
+  data.tar.gz: 1064a439e5b8652c40a77eddd6d0837ea908780750187879bb8bdb11af67656ea6882a8a251bb8627001c7857ebad94c378d68432c1101e2e19647b5c7c29ae5

data/lib/rswag/specs/example_group_helpers.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require 'active_support'
+
 module Rswag
   module Specs
     module ExampleGroupHelpers
+      ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for Ruby 2.6 will be dropped in v3.0') if RUBY_VERSION.start_with? '2.6'
+
       def path(template, metadata = {}, &block)
         metadata[:path_item] = { template: template }
         describe(template, metadata, &block)
@@ -69,23 +73,44 @@ module Rswag
       # NOTE: Similar to 'description', 'examples' need to handle the case when
       # being invoked with no params to avoid overriding 'examples' method of
       # rspec-core ExampleGroup
-      def examples(example = nil)
-        return super() if example.nil?
+      def examples(examples = nil)
+        return super() if examples.nil?
+        # should we add a deprecation warning?
+        examples.each_with_index do |(mime, example_object), index|
+          example(mime, "example_#{index}", example_object)
+        end
+      end
 
-        metadata[:response][:content] =
-          example.each_with_object({}) do |(mime, example_object), memo|
-            memo[mime] = { example: example_object }
-          end
+      def example(mime, name, value, summary=nil, description=nil)
+        # Todo - move initialization of metadata somewhere else.
+        if metadata[:response][:content].blank?
+          metadata[:response][:content] = {}
+        end
+
+        if metadata[:response][:content][mime].blank?
+          metadata[:response][:content][mime] = {}
+          metadata[:response][:content][mime][:examples] = {}
+        end
+
+        example_object = {
+          value: value,
+          summary: summary,
+          description: description
+        }.select { |_, v| v.present? }
+        # TODO, issue a warning if example is being overridden with the same key
+        metadata[:response][:content][mime][:examples].merge!(
+          { name.to_sym => example_object }
+        )
       end
 
       def run_test!(&block)
-        # NOTE: rspec 2.x support
         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" do
+          it "returns a #{metadata[:response][:code]} response", rswag: true do
             assert_response_matches_metadata(metadata)
             block.call(response) if block_given?
           end
@@ -94,7 +119,7 @@ module Rswag
             submit_request(example.metadata)
           end
 
-          it "returns a #{metadata[:response][:code]} response" do |example|
+          it "returns a #{metadata[:response][:code]} response", rswag: true do |example|
             assert_response_matches_metadata(example.metadata, &block)
             example.instance_exec(response, &block) if block_given?
           end

data/lib/rswag/specs/extended_schema.rb

@@ -7,14 +7,11 @@ module Rswag
     class ExtendedSchema < JSON::Schema::Draft4
       def initialize
         super
-        @attributes['type'] = ExtendedTypeAttribute
         @uri = URI.parse('http://tempuri.org/rswag/specs/extended_schema')
         @names = ['http://tempuri.org/rswag/specs/extended_schema']
       end
-    end
 
-    class ExtendedTypeAttribute < JSON::Schema::TypeV4Attribute
-      def self.validate(current_schema, data, fragments, processor, validator, options = {})
+      def validate(current_schema, data, *)
         return if data.nil? && (current_schema.schema['nullable'] == true || current_schema.schema['x-nullable'] == true)
 
         super

data/lib/rswag/specs/request_factory.rb

@@ -101,23 +101,82 @@ module Rswag
         request[:verb] = metadata[:operation][:verb]
       end
 
+      def base_path_from_servers(swagger_doc, use_server = :default)
+        return '' if swagger_doc[:servers].nil? || swagger_doc[:servers].empty?
+        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] }
+        URI(base_path).path
+      end
+
       def add_path(request, metadata, swagger_doc, parameters, example)
-        template = (swagger_doc[:basePath] || '') + metadata[:path_item][:template]
+        open_api_3_doc = doc_version(swagger_doc).start_with?('3')
+        uses_base_path = swagger_doc[:basePath].present?
+
+        if open_api_3_doc && uses_base_path
+          ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: basePath is replaced in OpenAPI3! Update your swagger_helper.rb')
+        end
+
+        if uses_base_path
+          template = (swagger_doc[:basePath] || '') + metadata[:path_item][:template]
+        else # OpenAPI 3
+          template = base_path_from_servers(swagger_doc) + metadata[:path_item][:template]
+        end
 
         request[:path] = template.tap do |path_template|
           parameters.select { |p| p[:in] == :path }.each do |p|
+            unless example.respond_to?(p[:name])
+              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)
           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])))
+            path_template.concat(build_query_string_part(p, example.send(p[:name]), swagger_doc))
           end
         end
       end
 
-      def build_query_string_part(param, value)
+      def build_query_string_part(param, value, swagger_doc)
         name = param[:name]
+
+        # OAS 3: https://swagger.io/docs/specification/serialization/
+        if swagger_doc && doc_version(swagger_doc).start_with?('3') && param[:schema]
+          style = param[:style]&.to_sym || :form
+          explode = param[:explode].nil? ? true : param[:explode]
+
+          case param[:schema][:type].to_sym
+          when :object
+            case style
+            when :deepObject
+              return { name => value }.to_query
+            when :form
+              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(',')
+              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('&')
+            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)
+            end
+          else
+            return "#{name}=#{value}"
+          end
+        end
+
         type = param[:type] || param.dig(:schema, :type)
         return "#{name}=#{value}" unless type&.to_sym == :array
 
@@ -154,8 +213,8 @@ module Rswag
           tuples << ['Content-Type', content_type]
         end
 
-        # Rails test infrastructure requires rackified headers
-        rackified_tuples = tuples.map do |pair|
+        # Rails test infrastructure requires rack-formatted headers
+        rack_formatted_tuples = tuples.map do |pair|
           [
             case pair[0]
             when 'Accept' then 'HTTP_ACCEPT'
@@ -167,7 +226,7 @@ module Rswag
           ]
         end
 
-        request[:headers] = Hash[rackified_tuples]
+        request[:headers] = Hash[rack_formatted_tuples]
       end
 
       def add_payload(request, parameters, example)

data/lib/rswag/specs/response_validator.rb

@@ -53,7 +53,7 @@ module Rswag
         return unless errors.any?
 
         raise UnexpectedResponse,
-              "Expected response body to match schema: #{errors[0]}\n" \
+              "Expected response body to match schema: #{errors.join("\n")}\n" \
               "Response body: #{JSON.pretty_generate(JSON.parse(body))}"
       end
 

data/lib/rswag/specs/swagger_formatter.rb

@@ -7,10 +7,12 @@ require 'swagger_helper'
 module Rswag
   module Specs
     class SwaggerFormatter < ::RSpec::Core::Formatters::BaseTextFormatter
+      ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for Ruby 2.6 will be dropped in v3.0') if RUBY_VERSION.start_with? '2.6'
 
-      # NOTE: rspec 2.x support
       if RSPEC_VERSION > 2
         ::RSpec::Core::Formatters.register self, :example_group_finished, :stop
+      else
+        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0')
       end
 
       def initialize(output, config = Rswag::Specs.config)
@@ -21,7 +23,6 @@ module Rswag
       end
 
       def example_group_finished(notification)
-        # NOTE: rspec 2.x support
         metadata = if RSPEC_VERSION > 2
           notification.group.metadata
         else
@@ -54,12 +55,13 @@ module Rswag
             doc[:paths]&.each_pair do |_k, v|
               v.each_pair do |_verb, value|
                 is_hash = value.is_a?(Hash)
-                if is_hash && value.dig(:parameters)
-                  schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
-                  mime_list = value.dig(:consumes) || doc[:consumes]
+                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]
                     mime_list.each do |mime|
                       value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
                     end
@@ -196,8 +198,8 @@ module Rswag
 
       def remove_invalid_operation_keys!(value)
         is_hash = value.is_a?(Hash)
-        value.delete(:consumes) if is_hash && value.dig(:consumes)
-        value.delete(:produces) if is_hash && value.dig(:produces)
+        value.delete(:consumes) if is_hash && value[:consumes]
+        value.delete(:produces) if is_hash && value[:produces]
       end
     end
   end

data/lib/tasks/rswag-specs_tasks.rake

@@ -11,10 +11,15 @@ namespace :rswag do
         'spec/requests/**/*_spec.rb, spec/api/**/*_spec.rb, spec/integration/**/*_spec.rb'
       )
 
-      # NOTE: rspec 2.x support
+      additional_rspec_opts = ENV.fetch(
+        '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']
+        t.rspec_opts = ['--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined'] << additional_rspec_opts
       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']
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,19 +56,53 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.21.2
 description: 'Simplify API integration testing with a succinct rspec DSL and generate
-  OpenAPI specification files directly from your rspecs. More about the OpenAPI initiative
-  here: http://spec.openapis.org/'
+  OpenAPI specification files directly from your rspec tests. More about the OpenAPI
+  initiative here: http://spec.openapis.org/'
 email:
 - domaindrivendev@gmail.com
 executables: []