rspec-openapi 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 934be20ed834fa8fa6c975eccf5c63f218b06a80136e6a50920914d4bfd867d0
-  data.tar.gz: 4921448fe86bf5ad591cf73ab965c38667df4d37daa319d696e8c42e614dcb7a
+  metadata.gz: 11f6fd4a506ac6f481fa67c33e2bacecba3ee4e568339338acf4237f4f599bac
+  data.tar.gz: 45ea7bbf466a413d3eb5d32ae19a38591c542431eee4dcb21905b8070b2280ac
 SHA512:
-  metadata.gz: d45c922230748ab26637a1865aa4cd82a201f84a314b0c18a2a9ed820c9819b17f8506bcc8dbc6e67f0b6b84ed6eb88de061d53981ef99dacdcfdf54c09dbb27
-  data.tar.gz: 3ffb70c7167f312511febf9969e69ef8e3bc6b6757115ae3f400a46d9628475e5681e976e389011459e5a7891940fbbb62089d059b962e055e4c0306ce1a6a44
+  metadata.gz: 3b98372303bb006dba766c0b48218c4be8a45a84f470d6cdfc40b3e7f9d780edb484ca58373239a6aeeba83c7f4c8c3daf8c241cdcb903cc1158c80c92269203
+  data.tar.gz: 8a198194bdc3e4bf0d09f6fe66b1893da1eaa4b0333c1168b9bd309ba26634ab16d53342c140f8d7b4c0f31e02cfc1ba9629b5dc12905dfc5e6eb35990f23c30

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: test
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - ruby:2.5
+          - ruby:2.6
+          - ruby:2.7
+    steps:
+      - uses: actions/checkout@v2
+      - name: bundle install
+        run: bundle install -j$(nproc) --retry 3
+      - run: bundle exec rspec
+        timeout-minutes: 1

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## v0.2.2
+
+* Allow disabling `example` by `RSpec::OpenAPI.enable_example = false`
+
+## v0.2.1
+
+* Generate `example` of request body and path / query params
+  [#4](https://github.com/k0kubun/rspec-openapi/issues/4)
+* Remove a wrapper param created by Rails in request body
+  [#4](https://github.com/k0kubun/rspec-openapi/issues/4)
+
+## v0.2.0
+
+* Generate `example` of response body [#3](https://github.com/k0kubun/rspec-openapi/issues/3)
+
+## v0.1.5
+
+* Support detecting `float` type [#2](https://github.com/k0kubun/rspec-openapi/issues/2)
+
+## v0.1.4
+
+* Avoid NoMethodError on nil Content-Type
+* Include a space between controller and action in summary
+
 ## v0.1.3
 
 * Add `RSpec::OpenAPI.comment` configuration

data/README.md

@@ -1,6 +1,6 @@
-# rspec-openapi
+# rspec-openapi ![test](https://github.com/k0kubun/rspec-openapi/workflows/test/badge.svg)
 
-Generate OpenAPI specs from RSpec request specs.
+Generate OpenAPI schema from RSpec request specs.
 
 ## What's this?
 
@@ -64,7 +64,7 @@ info:
 paths:
   "/tables":
     get:
-      summary: tables#index
+      summary: 'tables #index'
       parameters:
       - name: page
         in: query
@@ -98,12 +98,15 @@ and the schema file can be used as an input of [Swagger UI](https://github.com/s
 
 ### Configuration
 
-If you want to change the path to generate a spec from `doc/openapi.yaml`, use:
+The following configurations are optional.
 
 ```rb
 # Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
 
+# Disable generating `example`
+RSpec::OpenAPI.enable_example = false
+
 # 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
@@ -138,9 +141,9 @@ end
 
 ## Project status
 
-PoC / Experimental
+Beta
 
-This worked for some of my Rails apps, but this may raise a basic error for your app.
+Basic features are there, and some people are already using this.
 
 ### Current limitations
 

data/lib/rspec/openapi.rb

@@ -3,8 +3,10 @@ require 'rspec/openapi/hooks' if ENV['OPENAPI']
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
+  @comment = nil
+  @enable_example = true
 
   class << self
-    attr_accessor :path, :comment
+    attr_accessor :path, :comment, :enable_example
   end
 end

data/lib/rspec/openapi/record_builder.rb

@@ -15,7 +15,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       path: route.path.spec.to_s.delete_suffix('(.:format)'),
       path_params: request.path_parameters,
       query_params: request.query_parameters,
-      request_params: request.request_parameters,
+      request_params: raw_request_params(request),
       request_content_type: request.content_type,
       controller: route.requirements[:controller],
       action: route.requirements[:action],
@@ -35,4 +35,13 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     end
     raise "No route matched for #{request.request_method} #{request.path_info}"
   end
+
+  # workaround to get real request parameters
+  # because ActionController::ParamsWrapper overwrites request_parameters
+  def raw_request_params(request)
+    original = request.delete_header('action_dispatch.request.request_parameters')
+    request.request_parameters
+  ensure
+    request.set_header('action_dispatch.request.request_parameters', original)
+  end
 end

data/lib/rspec/openapi/schema_builder.rb

@@ -6,7 +6,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       paths: {
         normalize_path(record.path) => {
           record.method.downcase => {
-            summary: "#{record.controller}##{record.action}",
+            summary: "#{record.controller} ##{record.action}",
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
             responses: {
@@ -15,7 +15,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
                 content: {
                   normalize_content_type(record.response_content_type) => {
                     schema: build_property(record.response_body),
-                  },
+                    example: (record.response_body if example_enabled?),
+                  }.compact,
                 },
               },
             },
@@ -27,6 +28,10 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   private
 
+  def example_enabled?
+    RSpec::OpenAPI.enable_example
+  end
+
   def build_parameters(record)
     parameters = []
 
@@ -37,7 +42,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
-      }
+        example: (try_cast(value) if example_enabled?),
+      }.compact
     end
 
     record.query_params.each do |key, value|
@@ -45,7 +51,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         name: key.to_s,
         in: 'query',
         schema: build_property(try_cast(value)),
-      }
+        example: (try_cast(value) if example_enabled?),
+      }.compact
     end
 
     return nil if parameters.empty?
@@ -60,7 +67,8 @@ 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?),
+        }.compact
       }
     }
   end
@@ -84,6 +92,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     case value
     when String
       'string'
+    when Float
+      'float'
     when Integer
       'integer'
     when TrueClass, FalseClass
@@ -113,6 +123,6 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   end
 
   def normalize_content_type(content_type)
-    content_type.sub(/;.+\z/, '')
+    content_type&.sub(/;.+\z/, '')
   end
 end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.1.3'
+    VERSION = '0.2.2'
   end
 end

data/rspec-openapi.gemspec

@@ -6,15 +6,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Takashi Kokubun']
   spec.email         = ['takashikkbn@gmail.com']
 
-  spec.summary       = %q{Generate OpenAPI specs from RSpec request specs}
-  spec.description   = %q{Generate OpenAPI specs from RSpec request specs}
+  spec.summary       = %q{Generate OpenAPI schema from RSpec request specs}
+  spec.description   = %q{Generate OpenAPI  from RSpec request specs}
   spec.homepage      = 'https://github.com/k0kubun/rspec-openapi'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  # spec.metadata['changelog_uri'] = 'TODO'
+  spec.metadata['changelog_uri'] = File.join(spec.homepage, 'blob/master/CHANGELOG.md')
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,13 +24,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate OpenAPI specs from RSpec request specs
+description: Generate OpenAPI  from RSpec request specs
 email:
 - takashikkbn@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -57,6 +58,7 @@ licenses:
 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: 
 rdoc_options: []
 require_paths:
@@ -75,5 +77,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Generate OpenAPI specs from RSpec request specs
+summary: Generate OpenAPI schema from RSpec request specs
 test_files: []