rspec-openapi 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f16d83f7a23388930df36ade00c6a17dfc53de509eac6c3a5d99c41235bd281b
-  data.tar.gz: 9b65d3f8942388bfe9b62435ceef108ff55bc7e9f15af2c63bfee67bb10197ec
+  metadata.gz: cb2aae5a8366967c1ce6a904bb990372af7f5d3b09d4c81fad3866e590c168c3
+  data.tar.gz: 0665f9348a14cb0eb77c37368f69d3952d6eb71e919d8864931cdfbbbc3055dc
 SHA512:
-  metadata.gz: 447d354f4c0ef64cf78fd9eb2b0f47b42d943d12f9c73cc6eb51ef3ba20a931b7a4cc6c0fd214ece15214a029fc0ab28d6b028b774f652a10940806d3df5e014
-  data.tar.gz: 44566e265fbca4419f15cc8d59948804f72b133092fe5a920bcd80bc889959ccee201395c3cf8c76849daa552d9ecbc094d271ff5885a0e972a2ad8b1752dfb1
+  metadata.gz: 69ec6408d396d9e4c75bc4ba3ef1c71f82ea2a7bbd67def082262b275c20b9769db851fdb2c1bea971a4ede35c10b6f325fbc35a73be8591f12a986e94a01637
+  data.tar.gz: b71662890f9710012a329db3f380f831e10a8d37671fd9db2a9e3b84d237c699c0c40892020e4f20c781b36ab68563205208bc51607f73f5b2f002c80b5c48de

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,6 +1,30 @@
+## 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
+
 ## v0.1.2
 
-* Generate `required: true` for path params
+* Generate `required: true` for path params [#1](https://github.com/k0kubun/rspec-openapi/issues/1)
 
 ## v0.1.1
 

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?
 
@@ -52,7 +52,7 @@ end
 If you run the spec with `OPENAPI=1`,
 
 ```
-OPENAPI=1 be rspec spec/requests/tables_spec.rb
+OPENAPI=1 rspec spec/requests/tables_spec.rb
 ```
 
 It will generate [`doc/openapi.yaml` file](./spec/railsapp/doc/openapi.yaml) like:
@@ -64,7 +64,7 @@ info:
 paths:
   "/tables":
     get:
-      summary: tables#index
+      summary: 'tables #index'
       parameters:
       - name: page
         in: query
@@ -98,10 +98,19 @@ 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'
+
+# 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
+
+  When you write a spec in spec/requests, running the spec with `OPENAPI=1 rspec` will
+  update this file automatically. You can also manually edit this file.
+EOS
 ```
 
 ### How can I add information which can't be generated from RSpec?

data/lib/rspec/openapi.rb

@@ -5,6 +5,6 @@ module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
 
   class << self
-    attr_accessor :path
+    attr_accessor :path, :comment
   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,6 +15,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
                 content: {
                   normalize_content_type(record.response_content_type) => {
                     schema: build_property(record.response_body),
+                    example: record.response_body,
                   },
                 },
               },
@@ -37,6 +38,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
+        example: try_cast(value),
       }
     end
 
@@ -45,6 +47,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         name: key.to_s,
         in: 'query',
         schema: build_property(try_cast(value)),
+        example: try_cast(value),
       }
     end
 
@@ -60,6 +63,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,
         }
       }
     }
@@ -84,6 +88,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     case value
     when String
       'string'
+    when Float
+      'float'
     when Integer
       'integer'
     when TrueClass, FalseClass
@@ -113,6 +119,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/schema_file.rb

@@ -26,6 +26,16 @@ class RSpec::OpenAPI::SchemaFile
   # @param [Hash] spec
   def write(spec)
     FileUtils.mkdir_p(File.dirname(@path))
-    File.write(@path, YAML.dump(spec))
+    File.write(@path, prepend_comment(YAML.dump(spec)))
+  end
+
+  def prepend_comment(content)
+    return content if RSpec::OpenAPI.comment.nil?
+
+    comment = RSpec::OpenAPI.comment.dup
+    unless comment.end_with?("\n")
+      comment << "\n"
+    end
+    "#{comment.gsub(/^/, '# ').gsub(/^# \n/, "#\n")}#{content}"
   end
 end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.1.2'
+    VERSION = '0.2.1'
   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.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-06-25 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:
@@ -72,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
-summary: Generate OpenAPI specs from RSpec request specs
+summary: Generate OpenAPI schema from RSpec request specs
 test_files: []