rspec-openapi 0.3.7 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31d1b980670f03ab900ae31ecd241ce6a2b44edfbbc79839c9dc948c22ffa6b0
-  data.tar.gz: 51eead9afb87f8303cdb1d5b4fcb8331bfc01f534127c038be1394e6e598d9dc
+  metadata.gz: 727ee90aa68d99aa8748b948fc70449163127e0ea0d0b1bfd5eadc5a1cbc8c2c
+  data.tar.gz: 2d9746ec612b49af4c9482ffe608489e4ac55416aeed8e774ae642cf62af77ce
 SHA512:
-  metadata.gz: ddd8900e0365e487f42411e3cbfc7a8c23d33cdd0376da9d705311e8ba7e5c8d95e97859a8b10e0e1b5f83da2e6a1e4166993adc6a8dddb704cc3949a02eae7a
-  data.tar.gz: 3bd25b3e5d2ce70c0961d3bcd471d0c6ff6d36e5bc2a7d72fd43f594f698a56a38774bc0d298a936987db54eca6995f098817adbabf232433dc4f2f26232f4f9
+  metadata.gz: 3af2e86ba1321f7ab8cade64796a6e13a7f39f3d3363212dc6e93a550a2615d5fbed13e239dc2a78d54d757d4d0ed875a636af9c45a65d4b891731772ddeab91
+  data.tar.gz: daa2a965e6b8b0c2e53fded5ae6de2980c277712b3230077d71ba39e6da977e2fb8fbd5995e13a018595473c034c0154e017b69a7e22e16bad555b3d14a67d6f

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

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/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'
+      { nullable: true }
     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.7'
+    VERSION = '0.3.12'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.12
 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