rspec-openapi 0.3.14 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc3cc18aaa05b8683cb432500f56304dcea0184e6c82065656ffcd7981ebb5e
-  data.tar.gz: 5775f3b73a25c9e9288a4a0f08f61e14f1cb302e7df912d467821d8da84feda2
+  metadata.gz: 76a7b33ccfea2d2fbaf9cb45b49171c46c0b6b9df44280ac6d6bf0f864aedb60
+  data.tar.gz: d52a3651c1dc945711c378d39e53867f518c9b8aed2d6bf7502c00aade767856
 SHA512:
-  metadata.gz: b4d9d94770f14ce395366e6a0f6e84ea3105660a2417c936e0b98cf9684d3b24ff52bf5e743989679e4a126cfe279ea5e64464dab6bdf560e2bad6d88b0f4089
-  data.tar.gz: 61693320247f631552d5692fdf8e1894cf7bbc798a402488c7fe833613fb47548a01acc81123a0682f50b957664150fade4a429a7e7d4f511e7930a71f9209ca
+  metadata.gz: f8eac8961aa0b71a48f3af48c118dad88b8e4e90767dfb37c87d0902422a9ed6bea2c43cf87c713c209be0d7284f114cd455d49069b8521d3d34ad6ffcd901eb
+  data.tar.gz: d2a984317e8b93f8f2f29540c2a34af9fa89b46aadbdd300cc2247212d338530aff7d53aae75b27cabbd1d21ea3a30698051e1cd836509bf36c202f5c538eec9

data/.github/FUNDING.yml

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

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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`

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

@@ -47,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
@@ -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' }
@@ -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.14'
+    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.14
+  version: 0.3.15
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-20 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.2.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs