rspec-openapi 0.3.8 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d269feb84050ecb4ccc68924f76ae57ff4404521c22dc6cc004a177a579138b
-  data.tar.gz: 7df64e4c1ec76e652039e952b66d10322d3fa56f9a8af125da7872bade8ae2ad
+  metadata.gz: e2d47641978a7e3644aefc735a5ff71495bd12ab22d3371ff386d5733226afea
+  data.tar.gz: ccd481a8593efa2a9d0db0cc10a7bb751df1cefac913b44aa93cdc70e7309d0b
 SHA512:
-  metadata.gz: bbb3af75f12db96f24941fb6f14112fa860ff98a23b44fecb9a2efb87974dfdb68d11afa113cedea15761dd59b33a621357a1e829613c61235338bf436d09965
-  data.tar.gz: 552c01a691716245c43c186cc913e26578d287c54e005633901da94e286694e1b83f47a0a438aebd18a0b6b8a1b6d7cb3dd1afe21faef87dae3765613ebef57f
+  metadata.gz: '097a157b4b7c17a1bef1aeb949d41507e09aa72f43dba5158b4a50b0659e44470b59e29d4609d24f04f4936a43e867a4e85834c0cdaa6ddde1096d304d194530'
+  data.tar.gz: eb1a0c743fb8b64edf56d5a67165ef77afc6c0b48317c0bdfcda7449b1322591fd1c0539b9c4c5992efbab26c6fb3928ec156bcfa137200dce4535b35e0d85b6

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.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
+  [#12](https://github.com/k0kubun/rspec-openapi/pull/12)
+
 ## v0.3.8
 
 * Generate `type: 'number', format: 'float'` instead of `type: 'float'` for Float

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

@@ -13,6 +13,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       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
       }
     }
@@ -108,8 +108,10 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       { type: 'array' }
     when Hash
       { type: 'object' }
+    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
@@ -124,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.8'
+    VERSION = '0.3.13'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.13
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -66,6 +66,7 @@ files:
 - lib/rspec/openapi/schema_merger.rb
 - lib/rspec/openapi/version.rb
 - rspec-openapi.gemspec
+- test.png
 homepage: https://github.com/k0kubun/rspec-openapi
 licenses:
 - MIT
@@ -73,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
@@ -88,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: []