rspec-openapi 0.3.11 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e405e19fc7324fbfb0c67f18643ef3a924441f75971920e29dcb074c5fee41
-  data.tar.gz: 55ed7e046ef1dccb8e51d5d9d04012f32007a22da8d20217a582e14112eadc64
+  metadata.gz: 799f75b4bb5607dff7ab4a556b5d27d72b587af88636e7b510533724a1ede97a
+  data.tar.gz: 71aedf1e1610f23106dd778a2b9d9f4677c73c280127ff61300afa024068bef8
 SHA512:
-  metadata.gz: d8784246f9827274f9a16ad7e70201f0470a63c9568109ae8e5f02a6a154a02829d6ae8e34d6e4b767ec92afa470a3b72be2bf32dcb2c51b6a628b0fdfa3c8fe
-  data.tar.gz: b690fb8885f58626825f072cd75e740649faa05e1b398bf26480a2b8b6013f51f0596c177c92ed57c23fa7c5e49d92d3110c6af406c17bf0f570a8fdcc50f272
+  metadata.gz: e65865ca2d26e66f6fa560fe3fc157a491786ba7243d267dcdd4f22e3e5c28c29895384a32b8b19c095317a0447453ad292bfe91ff4059395f8ee08f0763f738
+  data.tar.gz: fda7f3678e952359a356069353d0756890edd7da50e4cd422489db091f9223439e1385d7939f27bd55d4c4afc7e6760bd55805275f932345273e6d5528a2b036

data/.github/FUNDING.yml

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

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 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
+  [#19](https://github.com/k0kubun/rspec-openapi/pull/19)
+
+## v0.3.12
+
+* Generate `nullable: true` for null fields in schema
+  [#18](https://github.com/k0kubun/rspec-openapi/pull/18)
+
 ## v0.3.11
 
 * Show a filename as an `example` for `ActionDispatch::Http::UploadedFile`

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 => 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,11 +8,13 @@ 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
       response = context.response
     end
+    return if request.nil?
 
     # Generate `path` and `summary` in a framework-friendly manner when possible
     if rails?
@@ -38,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
@@ -78,8 +85,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 +101,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' }
@@ -111,7 +120,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     when ActionDispatch::Http::UploadedFile
       { type: 'string', format: 'binary' }
     when NilClass
-      { type: 'null' }
+      { nullable: true }
     else
       raise NotImplementedError, "type detection is not implemented for: #{value.inspect}"
     end
@@ -143,4 +152,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/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.11'
+    VERSION = '0.3.16'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.16
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-06-12 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"
@@ -74,7 +75,7 @@ metadata:
   homepage_uri: https://github.com/k0kubun/rspec-openapi
   source_code_uri: https://github.com/k0kubun/rspec-openapi
   changelog_uri: https://github.com/k0kubun/rspec-openapi/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []