rspec-openapi 0.3.10 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62ae9fb333bba34df56a7675823e22ae9029852028d529ffae48ee9070eadeb0
-  data.tar.gz: 249959214fbce6ae72294f07e1a7de945c1052071d67942ec7f19c68cbe90a9f
+  metadata.gz: 76a7b33ccfea2d2fbaf9cb45b49171c46c0b6b9df44280ac6d6bf0f864aedb60
+  data.tar.gz: d52a3651c1dc945711c378d39e53867f518c9b8aed2d6bf7502c00aade767856
 SHA512:
-  metadata.gz: 8f66917401fc326b7a290892000ef82af637d959fd337ab158152176605fa5e41a8ce2e904b7c1d73cef203d1b3851912bcff0d58f5e879d27fc728f456d1569
-  data.tar.gz: abf3aee3cd216b58d53079c53372a3839c3cc89470d5a0500274fde35a3103643d8c6a3555b977989bc598f4f71e0518300cec76372dce1a8ff4bb41615a0113
+  metadata.gz: f8eac8961aa0b71a48f3af48c118dad88b8e4e90767dfb37c87d0902422a9ed6bea2c43cf87c713c209be0d7284f114cd455d49069b8521d3d34ad6ffcd901eb
+  data.tar.gz: d2a984317e8b93f8f2f29540c2a34af9fa89b46aadbdd300cc2247212d338530aff7d53aae75b27cabbd1d21ea3a30698051e1cd836509bf36c202f5c538eec9

data/.github/FUNDING.yml

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

data/.github/workflows/test.yml

@@ -19,6 +19,7 @@ jobs:
           - ruby:2.5
           - ruby:2.6
           - ruby:2.7
+          - ruby:3.0
     steps:
       - uses: actions/checkout@v2
       - name: bundle install

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 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`
+  [#17](https://github.com/k0kubun/rspec-openapi/pull/17)
+
 ## v0.3.10
 
 * Add `info.version`

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?
@@ -45,6 +47,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       status: response.status,
       response_body: response_body,
       response_content_type: response.content_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
@@ -72,14 +79,14 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       content: {
         normalize_content_type(record.request_content_type) => {
           schema: build_property(record.request_params),
-          example: (record.request_params if example_enabled?),
+          example: (build_example(record.request_params) if example_enabled?),
         }.compact
       }
     }
   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
@@ -126,6 +135,16 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     end
   end
 
+  def build_example(value)
+    return nil if value.nil?
+    value = value.dup
+    value.each do |key, v|
+      if v.is_a?(ActionDispatch::Http::UploadedFile)
+        value[key] = v.original_filename
+      end
+    end
+  end
+
   def normalize_path(path)
     path.gsub(%r|/:([^:/]+)|, '/{\1}')
   end
@@ -133,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.10'
+    VERSION = '0.3.15'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.15
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-04-24 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.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs