rspec-openapi 0.3.6 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2228341b1c207993fd9f98f74069e06a14fde9107d2fce34d4d6ae6d2c2184
-  data.tar.gz: 23b931010297c4618edac4ce3b51e0d78a9f052891c1c9384844742846988424
+  metadata.gz: 07e405e19fc7324fbfb0c67f18643ef3a924441f75971920e29dcb074c5fee41
+  data.tar.gz: 55ed7e046ef1dccb8e51d5d9d04012f32007a22da8d20217a582e14112eadc64
 SHA512:
-  metadata.gz: fc620c878f8bc514b6f802c324984d16029632f819d2b92815f3a5c9122e93b982658c28ba1a6bf20b4c0021c0570d634a807f9d1e90cd6782f1dc0805aa3762
-  data.tar.gz: 2cbc49093a983dcd0c1efdf2a41785ec202b6cc582ba72a7fe2f2a4339dbfbcffcab56bf13d2899fa7e7ef067fd794362ae0ffecd1aa52980e8ecc56fa667142
+  metadata.gz: d8784246f9827274f9a16ad7e70201f0470a63c9568109ae8e5f02a6a154a02829d6ae8e34d6e4b767ec92afa470a3b72be2bf32dcb2c51b6a628b0fdfa3c8fe
+  data.tar.gz: b690fb8885f58626825f072cd75e740649faa05e1b398bf26480a2b8b6013f51f0596c177c92ed57c23fa7c5e49d92d3110c6af406c17bf0f570a8fdcc50f272

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,27 @@
+## 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
+  [#11](https://github.com/k0kubun/rspec-openapi/issues/11)
+
+## v0.3.7
+
+* Classify tag names and remove controller names from summary in Rails
+
 ## v0.3.6
 
 * Fix documents generated by Rails engines

data/README.md

@@ -64,9 +64,9 @@ info:
 paths:
   "/tables":
     get:
-      summary: 'tables #index'
+      summary: index
       tags:
-      - tables
+      - Table
       parameters:
       - name: page
         in: query
@@ -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

@@ -18,8 +18,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     if rails?
       route = find_rails_route(request)
       path = route.path.spec.to_s.delete_suffix('(.:format)')
-      summary = "#{route.requirements[:controller]} ##{route.requirements[:action]}"
-      tags = [route.requirements[:controller]]
+      summary = "#{route.requirements[:action]}"
+      tags = [route.requirements[:controller].classify]
     else
       path = request.path
       summary = "#{request.method} #{request.path}"

data/lib/rspec/openapi/schema_builder.rb

@@ -72,14 +72,15 @@ 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 = { type: build_type(value) }
+    property = build_type(value)
+
     case value
     when Array
       property[:items] = build_property(value.first)
@@ -96,19 +97,21 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def build_type(value)
     case value
     when String
-      'string'
-    when Float
-      'float'
+      { type: 'string' }
     when Integer
-      'integer'
+      { type: 'integer' }
+    when Float
+      { type: 'number', format: 'float' }
     when TrueClass, FalseClass
-      'boolean'
+      { type: 'boolean' }
     when Array
-      'array'
+      { type: 'array' }
     when Hash
-      'object'
+      { type: 'object' }
+    when ActionDispatch::Http::UploadedFile
+      { type: 'string', format: 'binary' }
     when NilClass
-      'null'
+      { type: 'null' }
     else
       raise NotImplementedError, "type detection is not implemented for: #{value.inspect}"
     end
@@ -123,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.6'
+    VERSION = '0.3.11'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.11
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2021-01-27 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
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.6
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs