rspec-openapi 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf20b571bfadeda67cae266f85c87530c32067d5b1d9934a16ea423652a17be
-  data.tar.gz: ae4222d06d8d4aaee18ddcabc26808fe84cdfcf1ea6674527af7ffd7aa5e0d38
+  metadata.gz: d7134b7b05a91d447b6a52af56ee417e6f0c045d73526f171d9792d2301d40db
+  data.tar.gz: 8eeea5674f4e54c7ec53c1275f51b4dc47876438c64ee658db19cdbb6abc4489
 SHA512:
-  metadata.gz: ef3047477727572e3c8bdab0680b5fe82264aa6653c33e5ea19c7680739db5b55bde2c51d11a3cce6c422d487f445705d549eca82068f474fcb750b6d21fdc59
-  data.tar.gz: b3e03fedec66b64f24e83fe1023abaea2fb4accdb2e1da7dab78eb4870c0cc1338e9453e6c9cd345fe01e77258cbe39f01223b0ff4e708fd568c98dc5315b8d4
+  metadata.gz: 62b2b1e562954829ba607fa1f6713aa683fd508dde975198aa0c17c3dd7ad5db0e4d7e57aa80d6ca5a9d758a56d274128434eddc3f0dc9ac090117f80861bd7a
+  data.tar.gz: 354bb226fa980dac17d7a67d66404aad653c5fc4dd26b985fbd335152063b67716d2573e699835c5bce10d929fad08ea28a5f4545186b5b6ce17dbf13ffe01f0

data/CHANGELOG.md

@@ -1,6 +1,30 @@
+## 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
+  [#8](https://github.com/k0kubun/rspec-openapi/issues/8)
+
+## v0.3.1
+
+* Add `RSpec::OpenAPI.description_builder` config to dynamically generate a description [experimental]
+  [#6](https://github.com/k0kubun/rspec-openapi/issues/6)
+
 ## v0.3.0
 
-* Initial support of rack-test and non-Rails apps
+* Initial support of rack-test and non-Rails apps [#5](https://github.com/k0kubun/rspec-openapi/issues/5)
 
 ## v0.2.2
 

data/README.md

@@ -65,15 +65,19 @@ paths:
   "/tables":
     get:
       summary: 'tables #index'
+      tags:
+      - tables
       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
@@ -114,6 +118,9 @@ RSpec::OpenAPI.comment = <<~EOS
   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
+
+# Generate a custom description, given an RSpec example
+RSpec::OpenAPI.description_builder = -> (example) { example.description }
 ```
 
 ### How can I add information which can't be generated from RSpec?

data/lib/rspec/openapi.rb

@@ -5,8 +5,9 @@ module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
   @comment = nil
   @enable_example = true
+  @description_builder = -> (example) { example.description }
 
   class << self
-    attr_accessor :path, :comment, :enable_example
+    attr_accessor :path, :comment, :enable_example, :description_builder
   end
 end

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

@@ -15,44 +15,74 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     end
 
     # Generate `path` and `summary` in a framework-friendly manner when possible
-    if defined?(Rails) && Rails.application
+    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]]
     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,
-      path_params: request.path_parameters,
+      path_params: raw_path_params(request),
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
       request_content_type: request.content_type,
       summary: summary,
-      description: example.description,
+      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
 
   private
 
+  def rails?
+    defined?(Rails) && Rails.application
+  end
+
   def rack_test?(context)
     defined?(Rack::Test::Methods) && context.class < Rack::Test::Methods
   end
 
   # @param [ActionDispatch::Request] request
   def find_rails_route(request)
+    # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v5.2.4.4/actionpack/lib/action_dispatch/journey/router.rb#L36-L44
+    unless request.script_name.empty?
+      request = request.dup
+      request.path_info = File.join(request.script_name, request.path_info)
+    end
+
     Rails.application.routes.router.recognize(request) do |route|
       return route
     end
     raise "No route matched for #{request.request_method} #{request.path_info}"
   end
 
+  # :controller and :action always exist. :format is added when routes is configured as such.
+  def raw_path_params(request)
+    if rails?
+      request.path_parameters.reject do |key, _value|
+        %i[controller action format].include?(key)
+      end
+    else
+      request.path_parameters
+    end
+  end
+
   # workaround to get real request parameters
   # because ActionController::ParamsWrapper overwrites request_parameters
   def raw_request_params(request)

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,
         },
@@ -36,7 +42,6 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     parameters = []
 
     record.path_params.each do |key, value|
-      next if %i[controller action].include?(key)
       parameters << {
         name: key.to_s,
         in: 'path',

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.0'
+    VERSION = '0.3.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-10 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: []