rspec-openapi 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a131e530d729238260cf30416962eccbcbde9e1dc93aa0dc14065fe245621671
-  data.tar.gz: c94f05ec6f9ffe4b8f72e0bc6bf0f5cc1a7395977c6a2a671b361dcc1ba9f354
+  metadata.gz: a6a204535e3afe650434a20936c2d1ec34bc5136071cb76e48f1481b13629de8
+  data.tar.gz: d102d224884511c60d2b15030083d382d5c8da0bbbfa12dc3c293248456fd7ed
 SHA512:
-  metadata.gz: acd6e8a4757c7610d5d92a5ee167995fe029f435b1c1bacf8f1b8eda8099b5fe3eef5e71eb4db26863e6fde7102abdcf7620896abec4da143ce2bd3d4ee3e9ef
-  data.tar.gz: 66f7a5be114b32fcda8cd61236acda18e399ecb4a38daa30ee4b050d87f19aa604a3c84a6c82682dda5069a3affa3369d13521600b4f4e06210e3f6b49f96fb0
+  metadata.gz: 241b1dd789ae12fa853dc90b12cb497945dfc1bf4da0974a93d097c9f685ce6d585ddf08874a8dccfdec22467a8e47428e3a85a68ce847e8d306821b402b36fa
+  data.tar.gz: 60f6569f6d91262742732d45eacf8ef3192e201ddf91254b49fe00bdeada72ef05db02f3fcc61a817ed9ff54dc44a12fc45ffc4a1ee95e229f93c9e14b0e5b08

data/.rspec

@@ -1,3 +1,4 @@
+--exclude-pattern spec/requests/**/*_spec.rb
 --format documentation
+--require rspec/openapi
 --color
---require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 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 [#5](https://github.com/k0kubun/rspec-openapi/issues/5)
+
+## 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)

data/Gemfile

@@ -4,5 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rails', '6.0.3.2'
+gem 'roda'
 gem 'rspec-rails'
-gem 'pry'
+
+group :development do
+  gem 'pry'
+end

data/README.md

@@ -29,7 +29,7 @@ $ OPENAPI=1 rspec
 
 ### Example
 
-Let's say you have [a request spec](./spec/requests/tables_spec.rb) like this:
+Let's say you have [a request spec](./spec/requests/rails/tables_spec.rb) like this:
 
 ```rb
 RSpec.describe 'Tables', type: :request do
@@ -55,7 +55,7 @@ If you run the spec with `OPENAPI=1`,
 OPENAPI=1 rspec spec/requests/tables_spec.rb
 ```
 
-It will generate [`doc/openapi.yaml` file](./spec/railsapp/doc/openapi.yaml) like:
+It will generate [`doc/openapi.yaml` file](./spec/rails/doc/openapi.yaml) like:
 
 ```yml
 openapi: 3.0.3
@@ -93,7 +93,7 @@ paths:
 
 and the schema file can be used as an input of [Swagger UI](https://github.com/swagger-api/swagger-ui) or [Redoc](https://github.com/Redocly/redoc).
 
-![Redoc example](./spec/railsapp/doc/screenshot.png)
+![Redoc example](./spec/rails/doc/screenshot.png)
 
 
 ### Configuration
@@ -104,6 +104,9 @@ The following configurations are optional.
 # 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
@@ -111,6 +114,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?
@@ -138,15 +144,13 @@ 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
+### Current limitation
 
 * Generating a JSON file is not supported yet
-* This only works for RSpec request specs
-* Only Rails is supported for looking up a request route
 
 ### Other missing features with notes
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/rspec/openapi/**/*_spec.rb'
+end
 
-task :default => :spec
+task default: :spec

data/lib/rspec/openapi.rb

@@ -3,8 +3,11 @@ require 'rspec/openapi/hooks' if ENV['OPENAPI']
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
+  @comment = nil
+  @enable_example = true
+  @description_builder = -> (example) { example.description }
 
   class << self
-    attr_accessor :path, :comment
+    attr_accessor :path, :comment, :enable_example, :description_builder
   end
 end

data/lib/rspec/openapi/hooks.rb

@@ -8,8 +8,9 @@ require 'rspec/openapi/schema_merger'
 records = []
 
 RSpec.configuration.after(:each) do |example|
-  if example.metadata[:type] == :request && example.metadata[:openapi] != false && request && response
-    records << RSpec::OpenAPI::RecordBuilder.build(self, example: example)
+  if example.metadata[:type] == :request && example.metadata[:openapi] != false
+    record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
+    records << record if record
   end
 end
 

data/lib/rspec/openapi/record.rb

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

data/lib/rspec/openapi/record_builder.rb

@@ -1,25 +1,38 @@
+require 'action_dispatch'
 require 'rspec/openapi/record'
 
 class << RSpec::OpenAPI::RecordBuilder = Object.new
   # @param [RSpec::ExampleGroups::*] context
   # @param [RSpec::Core::Example] example
-  # @return [RSpec::OpenAPI::Record]
+  # @return [RSpec::OpenAPI::Record,nil]
   def build(context, example:)
-    # TODO: Support Non-Rails frameworks
-    request = context.request
-    response = context.response
-    route = find_route(request)
+    if rack_test?(context)
+      request = ActionDispatch::Request.new(context.last_request.env)
+      response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
+    else
+      request = context.request
+      response = context.response
+    end
+
+    # Generate `path` and `summary` in a framework-friendly manner when possible
+    if rails?
+      route = find_rails_route(request)
+      path = route.path.spec.to_s.delete_suffix('(.:format)')
+      summary = "#{route.requirements[:controller]} ##{route.requirements[:action]}"
+    else
+      path = request.path
+      summary = "#{request.method} #{request.path}"
+    end
 
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
-      path: route.path.spec.to_s.delete_suffix('(.:format)'),
-      path_params: request.path_parameters,
+      path: path,
+      path_params: raw_path_params(request),
       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],
-      description: example.description,
+      summary: summary,
+      description: RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
       response_body: response.parsed_body,
       response_content_type: response.content_type,
@@ -28,11 +41,39 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   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_route(request)
+  def find_rails_route(request)
     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)
+    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.summary,
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
             responses: {
@@ -15,8 +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,
-                  },
+                    example: (record.response_body if example_enabled?),
+                  }.compact,
                 },
               },
             },
@@ -28,17 +28,21 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   private
 
+  def example_enabled?
+    RSpec::OpenAPI.enable_example
+  end
+
   def build_parameters(record)
     parameters = []
 
     record.path_params.each do |key, value|
-      next if %i[controller action].include?(key)
       parameters << {
         name: key.to_s,
         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|
@@ -46,7 +50,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?
@@ -61,7 +66,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

data/lib/rspec/openapi/version.rb

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

data/rspec-openapi.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'actionpack'
   spec.add_dependency 'rspec'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +88,7 @@ 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 schema from RSpec request specs