rswag-specs 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df4a6de7cd0c39993e11e3cee2e4f21a1bf7175d53d467530a2d5d2fb0de62ad
-  data.tar.gz: 5845e6e3cc9368ff18a777155bb039aae5f8ad526444b9bf00ef5c3635ad732a
+  metadata.gz: 335cddedc6446301252f26bb28a0874072ebecfb5c8b35e5a2d94559a6606fcc
+  data.tar.gz: 3a2e60364a2a6e6ee463163eee2caa628ecf28c3ba9975ea239aa1106d4cd179
 SHA512:
-  metadata.gz: '088948aa3b15b493d95d678e6d30d211bc3d942d27db9f6c340acdee76b43783352b830045d118b1d91f65be068248c4a829d5f0a06fe58cd4478b903b069a25'
-  data.tar.gz: 60175ad736c79c12cfc14e1a9e810b57e0676a52ddc5b35fdb084fc6b0b8f0b1097080d6a367535287b982a71241b6675f6484252fce4a2b351972dead2664d5
+  metadata.gz: 436935923dcf3a446290c2bdf0160b399c5ba270096dc4019b1f47e2308f4e9ca66af8684fa09c6fc63f5b18069cf49b24ae124f19756480f5cff998873c26b5
+  data.tar.gz: 0c123c3e98481381a606a68c59b9cc5f0b8626a70f81c76c3d825bc3a6a46874e9524155da085baaf66abb2872c23f76a0f0931b390d669feeaccf1ba4da875d

data/lib/rswag/specs/example_group_helpers.rb

@@ -69,13 +69,34 @@ 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)
@@ -85,7 +106,7 @@ module Rswag
             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 +115,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

@@ -106,18 +106,57 @@ module Rswag
 
         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 +193,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 +206,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

@@ -60,6 +60,7 @@ module Rswag
                   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.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-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,8 +67,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.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: []