rspec-openapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9534432fc4ab2f67ce016ed07e0c36c687c201e4c1c01388beb4d845a24def6d
+  data.tar.gz: e7884e1ea34519588d2c008af56faaf7c7435f5c287ec5408515a6b66d16cb7c
+SHA512:
+  metadata.gz: 50af774aa04fc4fc47a52b89ce4355b313faa5d201796aff05f30fdb275d411b6f1bfcbb7762f3a6363484cec9ab69067c70dba1fc867f163631061d0629c874
+  data.tar.gz: 7498b91af6496b0d4a500405c194584425ca32276f6c9fedbbe92f431c370a035210f99ec103a33d595dc4f18cc2de361cea98f327a4324d3ebbd23a3bcfbb54

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-openapi.gemspec
+gemspec
+
+gem 'rails', '6.0.3.2'
+gem 'rspec-rails'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Takashi Kokubun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,169 @@
+# rspec-openapi
+
+Generate OpenAPI specs from RSpec request specs.
+
+## What's this?
+
+There are some gems which generate OpenAPI specs from RSpec request specs.
+However, they require a special DSL specific to these gems, and we can't reuse existing request specs as they are.
+
+Unlike such [existing gems](#links), rspec-openapi can generate OpenAPI specs from request specs without requiring any special DSL.
+Furthermore, rspec-openapi keeps manual modifications when it merges automated changes to OpenAPI specs
+in case we can't generate everything from request specs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-openapi', group: :test
+```
+
+## Usage
+
+Run rspec with OPENAPI=1 to generate `doc/openapi.yaml` for your request specs.
+
+```bash
+$ OPENAPI=1 rspec
+```
+
+### Example
+
+Let's say you have [a request spec](./spec/requests/table_spec.rb) like this:
+
+```rb
+RSpec.describe 'Tables', type: :request do
+  describe '#index' do
+    it 'returns a list of tables' do
+      get '/tables', params: { page: '1', per: '10' }, headers: { authorization: 'k0kubun' }
+      expect(response.status).to eq(200)
+    end
+
+    it 'does not return tables if unauthorized' do
+      get '/tables'
+      expect(response.status).to eq(401)
+    end
+  end
+
+  # ...
+end
+```
+
+If you run the spec with `OPENAPI=1`,
+
+```
+OPENAPI=1 be rspec spec/requests/tables_spec.rb
+```
+
+It will generate [`doc/openapi.yaml` file](./spec/railsapp/doc/openapi.yaml) like:
+
+```yml
+openapi: 3.0.3
+info:
+  title: rspec-openapi
+paths:
+  "/tables":
+    get:
+      summary: tables#index
+      parameters:
+      - name: page
+        in: query
+        schema:
+          type: integer
+      - name: per
+        in: query
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: returns a list of tables
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                    name:
+                      type: string
+                    # ...
+```
+
+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)
+
+
+### Configuration
+
+If you want to change the path to generate a spec from `doc/openapi.yaml`, use:
+
+```rb
+RSpec::OpenAPI.path = 'doc/schema.yaml'
+```
+
+### How can I add information which can't be generated from RSpec?
+
+rspec-openapi tries to keep manual modifications as much as possible when generating specs.
+You can directly edit `doc/openapi.yaml` as you like without spoiling the automatic generation capability.
+
+### Can I exclude specific specs from OpenAPI generation?
+
+Yes, you can specify `openapi: false` to disable the automatic generation.
+
+```rb
+RSpec.describe '/resources', type: :request, openapi: false do
+  # ...
+end
+
+# or
+
+RSpec.describe '/resources', type: :request do
+  it 'returns a resource', openapi: false do
+    # ...
+  end
+end
+```
+
+## Project status
+
+PoC / Experimental
+
+This worked for some of my Rails apps, but this may raise a basic error for your app.
+
+### Current limitations
+
+* 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
+
+* Delete obsoleted endpoints
+  * Give up, or at least make the feature optional?
+  * Running all to detect obsoleted endpoints is sometimes not realistic anyway.
+* Intelligent merges
+  * To maintain both automated changes and manual edits, the schema merge needs to be intelligent.
+  * We'll just deep-reverse-merge schema for now, but if there's a $ref for example, modifications
+    there should be rerouted to the referenced object.
+  * A type could be an array of all possible types when merged.
+
+## Links
+
+Existing RSpec plugins which have OpenAPI integration:
+
+* [zipmark/rspec\_api\_documentation](https://github.com/zipmark/rspec_api_documentation)
+* [rswag/rswag](https://github.com/rswag/rswag)
+* [drewish/rspec-rails-swagger](https://github.com/drewish/rspec-rails-swagger)
+
+## Acknowledgements
+
+This gem was heavily inspired by the following gem:
+
+* [r7kamura/autodoc](https://github.com/r7kamura/autodoc)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/openapi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/openapi.rb

@@ -0,0 +1,10 @@
+require 'rspec/openapi/version'
+require 'rspec/openapi/hooks' if ENV['OPENAPI']
+
+module RSpec::OpenAPI
+  @path = 'doc/openapi.yaml'
+
+  class << self
+    attr_accessor :path
+  end
+end

data/lib/rspec/openapi/default_schema.rb

@@ -0,0 +1,11 @@
+class << RSpec::OpenAPI::DefaultSchema = Object.new
+  def build(title)
+    {
+      openapi: '3.0.3',
+      info: {
+        title: title,
+      },
+      paths: {},
+    }.freeze
+  end
+end

data/lib/rspec/openapi/hooks.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+require 'rspec/openapi/default_schema'
+require 'rspec/openapi/record_builder'
+require 'rspec/openapi/schema_builder'
+require 'rspec/openapi/schema_file'
+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)
+  end
+end
+
+RSpec.configuration.after(:suite) do
+  title = File.basename(Dir.pwd)
+  RSpec::OpenAPI::SchemaFile.new(RSpec::OpenAPI.path).edit do |spec|
+    RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::DefaultSchema.build(title))
+    records.each do |record|
+      RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
+    end
+  end
+end

data/lib/rspec/openapi/record.rb

@@ -0,0 +1,15 @@
+RSpec::OpenAPI::Record = Struct.new(
+  :method,                # @param [String]  - "GET"
+  :path,                  # @param [String]  - "/v1/status/:id"
+  :path_params,           # @param [Hash]    - {:controller=>"v1/statuses", :action=>"create", :id=>"1"}
+  :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"
+  :description,           # @param [String]  - "returns a status"
+  :status,                # @param [Integer] - 200
+  :response_body,         # @param [Object]  - {"status" => "ok"}
+  :response_content_type, # @param [String]  - "application/json"
+  keyword_init: true,
+)

data/lib/rspec/openapi/record_builder.rb

@@ -0,0 +1,38 @@
+require 'rspec/openapi/record'
+
+class << RSpec::OpenAPI::RecordBuilder = Object.new
+  # @param [RSpec::ExampleGroups::*] context
+  # @param [RSpec::Core::Example] example
+  # @return [RSpec::OpenAPI::Record]
+  def build(context, example:)
+    # TODO: Support Non-Rails frameworks
+    request = context.request
+    response = context.response
+    route = find_route(request)
+
+    RSpec::OpenAPI::Record.new(
+      method: request.request_method,
+      path: route.path.spec.to_s.delete_suffix('(.:format)'),
+      path_params: request.path_parameters,
+      query_params: request.query_parameters,
+      request_params: request.request_parameters,
+      request_content_type: request.content_type,
+      controller: route.requirements[:controller],
+      action: route.requirements[:action],
+      description: example.description,
+      status: response.status,
+      response_body: response.parsed_body,
+      response_content_type: response.content_type,
+    ).freeze
+  end
+
+  private
+
+  # @param [ActionDispatch::Request] request
+  def find_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
+end

data/lib/rspec/openapi/schema_builder.rb

@@ -0,0 +1,113 @@
+class << RSpec::OpenAPI::SchemaBuilder = Object.new
+  # @param [RSpec::OpenAPI::Record] record
+  # @return [Hash]
+  def build(record)
+    {
+      paths: {
+        record.path => {
+          record.method.downcase => {
+            summary: "#{record.controller}##{record.action}",
+            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),
+                  },
+                },
+              },
+            },
+          }.compact,
+        },
+      },
+    }
+  end
+
+  private
+
+  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',
+        schema: build_property(try_cast(value)),
+      }
+    end
+
+    record.query_params.each do |key, value|
+      parameters << {
+        name: key.to_s,
+        in: 'query',
+        schema: build_property(try_cast(value)),
+      }
+    end
+
+    return nil if parameters.empty?
+    parameters
+  end
+
+  def build_request_body(record)
+    return nil if record.request_content_type.nil?
+    return nil if record.request_params.empty?
+
+    {
+      content: {
+        normalize_content_type(record.request_content_type) => {
+          schema: build_property(record.request_params),
+        }
+      }
+    }
+  end
+
+  def build_property(value)
+    property = { type: build_type(value) }
+    case value
+    when Array
+      property[:items] = build_property(value.first)
+    when Hash
+      property[:properties] = {}.tap do |properties|
+        value.each do |key, v|
+          properties[key] = build_property(v)
+        end
+      end
+    end
+    property
+  end
+
+  def build_type(value)
+    case value
+    when String
+      'string'
+    when Integer
+      'integer'
+    when TrueClass, FalseClass
+      'boolean'
+    when Array
+      'array'
+    when Hash
+      'object'
+    when NilClass
+      'null'
+    else
+      raise NotImplementedError, "type detection is not implemented for: #{value.inspect}"
+    end
+  end
+
+  # Convert an always-String param to an appropriate type
+  def try_cast(value)
+    begin
+      Integer(value)
+    rescue TypeError, ArgumentError
+      value
+    end
+  end
+
+  def normalize_content_type(content_type)
+    content_type.sub(/;.+\z/, '')
+  end
+end

data/lib/rspec/openapi/schema_file.rb

@@ -0,0 +1,31 @@
+require 'fileutils'
+require 'yaml'
+
+# TODO: Support JSON
+class RSpec::OpenAPI::SchemaFile
+  # @param [String] path
+  def initialize(path)
+    @path = path
+  end
+
+  def edit(&block)
+    spec = read
+    block.call(spec)
+  ensure
+    write(spec)
+  end
+
+  private
+
+  # @return [Hash]
+  def read
+    return {} unless File.exist?(@path)
+    YAML.load(File.read(@path))
+  end
+
+  # @param [Hash] spec
+  def write(spec)
+    FileUtils.mkdir_p(File.dirname(@path))
+    File.write(@path, YAML.dump(spec))
+  end
+end

data/lib/rspec/openapi/schema_merger.rb

@@ -0,0 +1,37 @@
+class << RSpec::OpenAPI::SchemaMerger = Object.new
+  # @param [Hash] base
+  # @param [Hash] spec
+  def reverse_merge!(base, spec)
+    spec = normalize_keys(spec)
+    deep_reverse_merge!(base, spec)
+  end
+
+  private
+
+  def normalize_keys(spec)
+    case spec
+    when Hash
+      spec.map do |key, value|
+        [key.to_s, normalize_keys(value)]
+      end.to_h
+    when Array
+      spec.map { |s| normalize_keys(s) }
+    else
+      spec
+    end
+  end
+
+  # Not doing `base.replace(deep_merge(base, spec))` to preserve key orders
+  # TODO: Perform more intelligent merges like rerouting edits / merging types
+  # Should we probably force-merge `summary` regardless of manual modifications?
+  def deep_reverse_merge!(base, spec)
+    spec.each do |key, value|
+      if base[key].is_a?(Hash) && value.is_a?(Hash)
+        deep_reverse_merge!(base[key], value)
+      elsif !base.key?(key)
+        base[key] = value
+      end
+    end
+    base
+  end
+end

data/lib/rspec/openapi/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module OpenAPI
+    VERSION = '0.1.0'
+  end
+end

data/rspec-openapi.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/rspec/openapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-openapi'
+  spec.version       = RSpec::OpenAPI::VERSION
+  spec.authors       = ['Takashi Kokubun']
+  spec.email         = ['takashikkbn@gmail.com']
+
+  spec.summary       = %q{Generate OpenAPI specs from RSpec request specs}
+  spec.description   = %q{Generate OpenAPI specs from RSpec request specs}
+  spec.homepage      = 'https://github.com/k0kubun/rspec-openapi'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata['changelog_uri'] = 'TODO'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rspec'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rspec-openapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Generate OpenAPI specs from RSpec request specs
+email:
+- takashikkbn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/openapi.rb
+- lib/rspec/openapi/default_schema.rb
+- lib/rspec/openapi/hooks.rb
+- lib/rspec/openapi/record.rb
+- lib/rspec/openapi/record_builder.rb
+- lib/rspec/openapi/schema_builder.rb
+- lib/rspec/openapi/schema_file.rb
+- lib/rspec/openapi/schema_merger.rb
+- lib/rspec/openapi/version.rb
+- rspec-openapi.gemspec
+homepage: https://github.com/k0kubun/rspec-openapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/k0kubun/rspec-openapi
+  source_code_uri: https://github.com/k0kubun/rspec-openapi
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate OpenAPI specs from RSpec request specs
+test_files: []