rspec-openapi 0.3.9 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93751a821ec1800557dddd948ba2096f19c03f86a474dd2d63bf2c181fe44162
-  data.tar.gz: 8dfb18c46f4ba4621c1f46ff9948a2305ffd429ea39b4e36ceb005a3bbd6b8d9
+  metadata.gz: bbc3cc18aaa05b8683cb432500f56304dcea0184e6c82065656ffcd7981ebb5e
+  data.tar.gz: 5775f3b73a25c9e9288a4a0f08f61e14f1cb302e7df912d467821d8da84feda2
 SHA512:
-  metadata.gz: 0fde2eed92e5aec96e7949dc1255d9d55a3fb68cd492356dd1d05744a627f9d7ee04a5d05228f5577d9a8caa70df0d5e01b338b9b7cc65a29ee8c86eaa8c2173
-  data.tar.gz: 8564180885a24f861ca7d3a87e8e6a5f0b6d2750444efac4875b1052b8cfbcfb795157a7feb8fe966d1f8352d1847a78d4237c97b316fb02a1c62651e4974a02
+  metadata.gz: b4d9d94770f14ce395366e6a0f6e84ea3105660a2417c936e0b98cf9684d3b24ff52bf5e743989679e4a126cfe279ea5e64464dab6bdf560e2bad6d88b0f4089
+  data.tar.gz: 61693320247f631552d5692fdf8e1894cf7bbc798a402488c7fe833613fb47548a01acc81123a0682f50b957664150fade4a429a7e7d4f511e7930a71f9209ca

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.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`
+  [#16](https://github.com/k0kubun/rspec-openapi/pull/16)
+
 ## v0.3.9
 
 * Initial support for multipart/form-data

data/README.md

@@ -111,6 +111,9 @@ RSpec::OpenAPI.path = 'doc/schema.yaml'
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 
+# Change `info.version`
+RSpec::OpenAPI.application_version = '1.0.0'
+
 # Generate a comment on top of a schema file
 RSpec::OpenAPI.comment = <<~EOS
   This file is auto-generated by rspec-openapi https://github.com/k0kubun/rspec-openapi

data/lib/rspec/openapi.rb

@@ -6,8 +6,9 @@ module RSpec::OpenAPI
   @comment = nil
   @enable_example = true
   @description_builder = -> (example) { example.description }
+  @application_version = '1.0.0'
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version
   end
 end

data/lib/rspec/openapi/default_schema.rb

@@ -4,6 +4,7 @@ class << RSpec::OpenAPI::DefaultSchema = Object.new
       openapi: '3.0.3',
       info: {
         title: title,
+        version: RSpec::OpenAPI.application_version,
       },
       paths: {},
     }.freeze

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?

data/lib/rspec/openapi/schema_builder.rb

@@ -72,7 +72,7 @@ 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
       }
     }
@@ -111,7 +111,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 +126,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

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.9'
+    VERSION = '0.3.14'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.14
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -74,7 +74,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 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.6
+signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []