rspec-openapi 0.2.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2aae5a8366967c1ce6a904bb990372af7f5d3b09d4c81fad3866e590c168c3
-  data.tar.gz: 0665f9348a14cb0eb77c37368f69d3952d6eb71e919d8864931cdfbbbc3055dc
+  metadata.gz: b483a73ef32d771b4da3e66f3c63d1cd0a1cfbb839752546d5465cda43ff8444
+  data.tar.gz: cf8ec362c29193e2434db5433170ec655008cd5f636a8f2341f9abf7e7f3d454
 SHA512:
-  metadata.gz: 69ec6408d396d9e4c75bc4ba3ef1c71f82ea2a7bbd67def082262b275c20b9769db851fdb2c1bea971a4ede35c10b6f325fbc35a73be8591f12a986e94a01637
-  data.tar.gz: b71662890f9710012a329db3f380f831e10a8d37671fd9db2a9e3b84d237c699c0c40892020e4f20c781b36ab68563205208bc51607f73f5b2f002c80b5c48de
+  metadata.gz: de935612cc1afdd9c8ccca7d69711beca33dea36ec97555293978544c9c1a978c04cdc196c42a39888408d7575e40d0d6dff76adf1d629b27512c569feb9b29a
+  data.tar.gz: 423d62a92e8a9b143fae9304af57d893e079dbc9cb956e17320ea45a3bf30d8084f88395fdeaa835cd8689c3b72ecba2b40812bd9c81a0f044ddf91754169f9c

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,26 @@
+## 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 [#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

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,41 +1,80 @@
+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
+
+    response_body =
+      begin
+        response.parsed_body
+      rescue JSON::ParserError
+        nil
+      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: 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_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_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)

data/lib/rspec/openapi/schema_builder.rb

@@ -2,23 +2,28 @@ 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.controller} ##{record.action}",
+            summary: record.summary,
             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,
-                  },
-                },
-              },
+              record.status.to_s => response,
             },
           }.compact,
         },
@@ -28,18 +33,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),
-      }
+        example: (try_cast(value) if example_enabled?),
+      }.compact
     end
 
     record.query_params.each do |key, value|
@@ -47,8 +55,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         name: key.to_s,
         in: 'query',
         schema: build_property(try_cast(value)),
-        example: try_cast(value),
-      }
+        example: (try_cast(value) if example_enabled?),
+      }.compact
     end
 
     return nil if parameters.empty?
@@ -63,8 +71,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,
-        }
+          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.1'
+    VERSION = '0.3.3'
   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.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-09-11 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.2.0.pre1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs