rspec-openapi 0.3.2 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6a204535e3afe650434a20936c2d1ec34bc5136071cb76e48f1481b13629de8
-  data.tar.gz: d102d224884511c60d2b15030083d382d5c8da0bbbfa12dc3c293248456fd7ed
+  metadata.gz: 31d1b980670f03ab900ae31ecd241ce6a2b44edfbbc79839c9dc948c22ffa6b0
+  data.tar.gz: 51eead9afb87f8303cdb1d5b4fcb8331bfc01f534127c038be1394e6e598d9dc
 SHA512:
-  metadata.gz: 241b1dd789ae12fa853dc90b12cb497945dfc1bf4da0974a93d097c9f685ce6d585ddf08874a8dccfdec22467a8e47428e3a85a68ce847e8d306821b402b36fa
-  data.tar.gz: 60f6569f6d91262742732d45eacf8ef3192e201ddf91254b49fe00bdeada72ef05db02f3fcc61a817ed9ff54dc44a12fc45ffc4a1ee95e229f93c9e14b0e5b08
+  metadata.gz: ddd8900e0365e487f42411e3cbfc7a8c23d33cdd0376da9d705311e8ba7e5c8d95e97859a8b10e0e1b5f83da2e6a1e4166993adc6a8dddb704cc3949a02eae7a
+  data.tar.gz: 3bd25b3e5d2ce70c0961d3bcd471d0c6ff6d36e5bc2a7d72fd43f594f698a56a38774bc0d298a936987db54eca6995f098817adbabf232433dc4f2f26232f4f9

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## v0.3.7
+
+* Classify tag names and remove controller names from summary in Rails
+
+## v0.3.6
+
+* Fix documents generated by Rails engines
+
+## v0.3.5
+
+* Support finding routes in Rails engines
+
+## v0.3.4
+
+* Generate tags by controller names
+  [#10](https://github.com/k0kubun/rspec-openapi/issues/10)
+
+## v0.3.3
+
+* Avoid `JSON::ParserError` when a response body is no content
+  [#9](https://github.com/k0kubun/rspec-openapi/issues/9)
+
 ## v0.3.2
 
 * Stop generating format as path parameters in Rails

data/README.md

@@ -64,16 +64,20 @@ info:
 paths:
   "/tables":
     get:
-      summary: 'tables #index'
+      summary: index
+      tags:
+      - Table
       parameters:
       - name: page
         in: query
         schema:
           type: integer
+        example: 1
       - name: per
         in: query
         schema:
           type: integer
+        example: 10
       responses:
         '200':
           description: returns a list of tables

data/lib/rspec/openapi/record.rb

@@ -6,6 +6,7 @@ RSpec::OpenAPI::Record = Struct.new(
   :request_params,        # @param [Hash]    - {:request=>"body"}
   :request_content_type,  # @param [String]  - "application/json"
   :summary,               # @param [String]  - "v1/statuses #show"
+  :tags,                  # @param [Array]   - ["Status"]
   :description,           # @param [String]  - "returns a status"
   :status,                # @param [Integer] - 200
   :response_body,         # @param [Object]  - {"status" => "ok"}

data/lib/rspec/openapi/record_builder.rb

@@ -18,12 +18,20 @@ 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]}"
+      summary = "#{route.requirements[:action]}"
+      tags = [route.requirements[:controller].classify]
     else
       path = request.path
       summary = "#{request.method} #{request.path}"
     end
 
+    response_body =
+      begin
+        response.parsed_body
+      rescue JSON::ParserError
+        nil
+      end
+
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
       path: path,
@@ -32,9 +40,10 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       request_params: raw_request_params(request),
       request_content_type: request.content_type,
       summary: summary,
+      tags: tags,
       description: RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
-      response_body: response.parsed_body,
+      response_body: response_body,
       response_content_type: response.content_type,
     ).freeze
   end
@@ -50,8 +59,17 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   end
 
   # @param [ActionDispatch::Request] request
-  def find_rails_route(request)
-    Rails.application.routes.router.recognize(request) do |route|
+  def find_rails_route(request, app: Rails.application, fix_path: true)
+    # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_dispatch/journey/router.rb#L33-L41
+    if fix_path && !request.script_name.empty?
+      request = request.dup
+      request.path_info = File.join(request.script_name, request.path_info)
+    end
+
+    app.routes.router.recognize(request) do |route|
+      unless route.path.anchored
+        route = find_rails_route(request, app: route.app.app, fix_path: false)
+      end
       return route
     end
     raise "No route matched for #{request.request_method} #{request.path_info}"

data/lib/rspec/openapi/schema_builder.rb

@@ -2,23 +2,29 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   # @param [RSpec::OpenAPI::Record] record
   # @return [Hash]
   def build(record)
+    response = {
+      description: record.description,
+    }
+
+    if record.response_body
+      response[:content] = {
+        normalize_content_type(record.response_content_type) => {
+          schema: build_property(record.response_body),
+          example: (record.response_body if example_enabled?),
+        }.compact,
+      }
+    end
+
     {
       paths: {
         normalize_path(record.path) => {
           record.method.downcase => {
             summary: record.summary,
+            tags: record.tags,
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
             responses: {
-              record.status.to_s => {
-                description: record.description,
-                content: {
-                  normalize_content_type(record.response_content_type) => {
-                    schema: build_property(record.response_body),
-                    example: (record.response_body if example_enabled?),
-                  }.compact,
-                },
-              },
+              record.status.to_s => response,
             },
           }.compact,
         },

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.2'
+    VERSION = '0.3.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.7
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-01 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -73,7 +73,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 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []