rspec-openapi 0.3.13 → 0.3.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2d47641978a7e3644aefc735a5ff71495bd12ab22d3371ff386d5733226afea
-  data.tar.gz: ccd481a8593efa2a9d0db0cc10a7bb751df1cefac913b44aa93cdc70e7309d0b
+  metadata.gz: cd7d2eb0e69e2e60405a7d71d10acd3b2edf2d4db0358297a900200a0a69012e
+  data.tar.gz: 577545384d404ba11382ab4425e0bd40abeeb3e58db922e82d923f0d6d6ae8e9
 SHA512:
-  metadata.gz: '097a157b4b7c17a1bef1aeb949d41507e09aa72f43dba5158b4a50b0659e44470b59e29d4609d24f04f4936a43e867a4e85834c0cdaa6ddde1096d304d194530'
-  data.tar.gz: eb1a0c743fb8b64edf56d5a67165ef77afc6c0b48317c0bdfcda7449b1322591fd1c0539b9c4c5992efbab26c6fb3928ec156bcfa137200dce4535b35e0d85b6
+  metadata.gz: 5f60ee2cf93946405e3e151786965b3a0f68e53ad147a6d7613f59f46f834efd9a641d0f878943af934879d2f5e27e8c8d4cd55dac5288d62a85dc2b77009ddb
+  data.tar.gz: 7dc56150dfb4a8a5b526d7ec626b4ebc9c0680878cd1f976213490a489a598dfe2a285f01029e5a17cdbbe0d8b492fe79a2e51148ac24df94d532c404b0231fd

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: k0kubun

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## v0.3.18
+
+* Support nested query parameters
+  [#29](https://github.com/k0kubun/rspec-openapi/pull/29)
+
+## v0.3.17
+
+* Rescue NotImplementedError in the after suite hook as well
+  [#28](https://github.com/k0kubun/rspec-openapi/pull/28)
+
+## v0.3.16
+
+* Use `media_type` instead of `content_type` for Rails 6.1
+  [#26](https://github.com/k0kubun/rspec-openapi/pull/26)
+* Avoid crashing the after suite hook when it fails to build schema
+  [#27](https://github.com/k0kubun/rspec-openapi/pull/27)
+
+## v0.3.15
+
+* Fix an error when Content-Disposition header is inline
+  [#24](https://github.com/k0kubun/rspec-openapi/pull/24)
+
+## v0.3.14
+
+* Avoid an error when an application calls `request.body.read`
+  [#20](https://github.com/k0kubun/rspec-openapi/pull/20)
+
 ## v0.3.13
 
 * Avoid crashing when there's no request made in a spec

data/lib/rspec/openapi/hooks.rb

@@ -6,6 +6,7 @@ require 'rspec/openapi/schema_file'
 require 'rspec/openapi/schema_merger'
 
 records = []
+records_errors = []
 
 RSpec.configuration.after(:each) do |example|
   if example.metadata[:type] == :request && example.metadata[:openapi] != false
@@ -19,7 +20,21 @@ RSpec.configuration.after(:suite) do
   RSpec::OpenAPI::SchemaFile.new(RSpec::OpenAPI.path).edit do |spec|
     RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::DefaultSchema.build(title))
     records.each do |record|
-      RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
+      begin
+        RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
+      rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
+        # NOTE: Don't fail the build
+        records_errors << [e, record]
+      end
     end
   end
+  if records_errors.any?
+    error_message = <<~EOS
+      RSpec::OpenAPI got errors building #{records_errors.size} requests
+      
+      #{records_errors.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
+    EOS
+    colorizer = ::RSpec::Core::Formatters::ConsoleCodes
+    RSpec.configuration.reporter.message colorizer.wrap(error_message, :failure)
+  end
 end

data/lib/rspec/openapi/record.rb

@@ -11,5 +11,6 @@ RSpec::OpenAPI::Record = Struct.new(
   :status,                # @param [Integer] - 200
   :response_body,         # @param [Object]  - {"status" => "ok"}
   :response_content_type, # @param [String]  - "application/json"
+  :response_content_disposition, # @param [String]  - "inline"
   keyword_init: true,
 )

data/lib/rspec/openapi/record_builder.rb

@@ -8,6 +8,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   def build(context, example:)
     if rack_test?(context)
       request = ActionDispatch::Request.new(context.last_request.env)
+      request.body.rewind if request.body.respond_to?(:rewind)
       response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
     else
       request = context.request
@@ -39,13 +40,14 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       path_params: raw_path_params(request),
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
-      request_content_type: request.content_type,
+      request_content_type: request.media_type,
       summary: summary,
       tags: tags,
       description: RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
       response_body: response_body,
-      response_content_type: response.content_type,
+      response_content_type: response.media_type,
+      response_content_disposition: response.header["Content-Disposition"],
     ).freeze
   end
 

data/lib/rspec/openapi/schema_builder.rb

@@ -7,10 +7,11 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     }
 
     if record.response_body
+      disposition = normalize_content_disposition(record.response_content_disposition)
       response[:content] = {
         normalize_content_type(record.response_content_type) => {
-          schema: build_property(record.response_body),
-          example: (record.response_body if example_enabled?),
+          schema: build_property(record.response_body, disposition: disposition),
+          example: response_example(record, disposition: disposition),
         }.compact,
       }
     end
@@ -34,6 +35,12 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   private
 
+  def response_example(record, disposition:)
+    return nil if !example_enabled? || disposition
+
+    record.response_body
+  end
+
   def example_enabled?
     RSpec::OpenAPI.enable_example
   end
@@ -43,7 +50,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     record.path_params.each do |key, value|
       parameters << {
-        name: key.to_s,
+        name: build_parameter_name(key, value),
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
@@ -53,7 +60,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     record.query_params.each do |key, value|
       parameters << {
-        name: key.to_s,
+        name: build_parameter_name(key, value),
         in: 'query',
         schema: build_property(try_cast(value)),
         example: (try_cast(value) if example_enabled?),
@@ -64,6 +71,16 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     parameters
   end
 
+  def build_parameter_name(key, value)
+    key = key.to_s
+    if value.is_a?(Hash) && (value_keys = value.keys).size == 1
+      value_key = value_keys.first
+      build_parameter_name("#{key}[#{value_key}]", value[value_key])
+    else
+      key
+    end
+  end
+
   def build_request_body(record)
     return nil if record.request_content_type.nil?
     return nil if record.request_params.empty?
@@ -78,8 +95,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     }
   end
 
-  def build_property(value)
-    property = build_type(value)
+  def build_property(value, disposition: nil)
+    property = build_type(value, disposition)
 
     case value
     when Array
@@ -94,7 +111,9 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     property
   end
 
-  def build_type(value)
+  def build_type(value, disposition)
+    return { type: 'string', format: 'binary' } if disposition
+
     case value
     when String
       { type: 'string' }
@@ -143,4 +162,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def normalize_content_type(content_type)
     content_type&.sub(/;.+\z/, '')
   end
+
+  def normalize_content_disposition(content_disposition)
+    content_disposition&.sub(/;.+\z/, '')
+  end
 end

data/lib/rspec/openapi/schema_merger.rb

@@ -30,6 +30,13 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
         deep_reverse_merge!(base[key], value)
       elsif !base.key?(key)
         base[key] = value
+      elsif base[key].is_a?(Array) && value.is_a?(Array)
+        if key == "parameters"
+          # merge arrays
+          base[key] |= value
+        end
+      else
+        # no-op
       end
     end
     base

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.13'
+    VERSION = '0.3.18'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.18
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs