rspec-openapi 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11f6fd4a506ac6f481fa67c33e2bacecba3ee4e568339338acf4237f4f599bac
-  data.tar.gz: 45ea7bbf466a413d3eb5d32ae19a38591c542431eee4dcb21905b8070b2280ac
+  metadata.gz: 4bf20b571bfadeda67cae266f85c87530c32067d5b1d9934a16ea423652a17be
+  data.tar.gz: ae4222d06d8d4aaee18ddcabc26808fe84cdfcf1ea6674527af7ffd7aa5e0d38
 SHA512:
-  metadata.gz: 3b98372303bb006dba766c0b48218c4be8a45a84f470d6cdfc40b3e7f9d780edb484ca58373239a6aeeba83c7f4c8c3daf8c241cdcb903cc1158c80c92269203
-  data.tar.gz: 8a198194bdc3e4bf0d09f6fe66b1893da1eaa4b0333c1168b9bd309ba26634ab16d53342c140f8d7b4c0f31e02cfc1ba9629b5dc12905dfc5e6eb35990f23c30
+  metadata.gz: ef3047477727572e3c8bdab0680b5fe82264aa6653c33e5ea19c7680739db5b55bde2c51d11a3cce6c422d487f445705d549eca82068f474fcb750b6d21fdc59
+  data.tar.gz: b3e03fedec66b64f24e83fe1023abaea2fb4accdb2e1da7dab78eb4870c0cc1338e9453e6c9cd345fe01e77258cbe39f01223b0ff4e708fd568c98dc5315b8d4

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,7 @@
+## v0.3.0
+
+* Initial support of rack-test and non-Rails apps
+
 ## v0.2.2
 
 * Allow disabling `example` by `RSpec::OpenAPI.enable_example = false`

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
@@ -145,11 +145,9 @@ Beta
 
 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/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,24 +1,37 @@
+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 defined?(Rails) && Rails.application
+      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: path,
       path_params: request.path_parameters,
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
       request_content_type: request.content_type,
-      controller: route.requirements[:controller],
-      action: route.requirements[:action],
+      summary: summary,
       description: example.description,
       status: response.status,
       response_body: response.parsed_body,
@@ -28,8 +41,12 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   private
 
+  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

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: {

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   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.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-10 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