rspec-openapi 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b6910e5f6511e985a899e1c3b7dacec413924a6f19d79fddc5b9e4c5059c4a
-  data.tar.gz: 8bccc7c850b4d1f1cea4125abba829fc8a128bc2bfe448ae4fa1523a11f0a414
+  metadata.gz: f835fe8be895164639ec2bfdbb6414b922734cc9598b30b100ac7da15d31b98f
+  data.tar.gz: 60ba1234561313d8e9fbe5c1f5667e6c759d477ad124867045e3e2e516174ece
 SHA512:
-  metadata.gz: 60661ba7a0f3828bcbe20437c280a791e90fcd0b00e64f4d27a7052b000c3c70640b45ba1976749df47693d956b97cf4aa491db7957ceb3383dba16e3901da38
-  data.tar.gz: 3a4431f735c5b2bc6684d8f79ed5ced925edb1c8941f449ccbc02e80bec4401ef4fe65bd5af45c1096fee4b6ca766b46b7bc15d49e4aad0405feb70f44f5b3cd
+  metadata.gz: 44c56d011d95c1350eef4ed83011ff00c749cf9e83ec3cb44f605a6e3ee50c05173117d618d3472ea44b20aeef8981c17ae35f8b91220ff8891382447c1a4679
+  data.tar.gz: c264b04decebbcd4389633eed77cd98a0241980fa283c320e99c5bdaf5a5b5be36e242367da23abcefbf0f31802dd27f1d123324005c8234657d11328e9e1e60

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,39 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '20 22 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/rubocop.yml

@@ -0,0 +1,35 @@
+name: "Rubocop"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+        bundler-cache: true
+
+    - name: Rubocop run
+      run: |
+        bash -c "
+          bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+          [[ $? -ne 2 ]]
+        "
+
+    - name: Upload Sarif output
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: rubocop.sarif

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'spec/rails/**/*'
+    - 'vendor/**/*'
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - 'lib/rspec/openapi/version.rb'
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,41 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-04-14 06:22:29 UTC using RuboCop version 1.49.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 10
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 31
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 13
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 30
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/integration_tests/roda_test.rb'
+
+# Offense count: 5
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rspec/openapi.rb'
+    - 'lib/rspec/openapi/minitest_hooks.rb'
+    - 'lib/rspec/openapi/result_recorder.rb'
+    - 'lib/rspec/openapi/schema_file.rb'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
+## v0.8.0
+- Set `required` in request body and response body
+  [#95](https://github.com/exoego/rspec-openapi/pull/95), [#98](https://github.com/exoego/rspec-openapi/pull/98)
+- Generate OpenAPI with minitest instead of RSpec
+  [#90](https://github.com/exoego/rspec-openapi/pull/90)
+- Generate security schemas via RSpec::OpenAPI.security_schemes
+  [#84](https://github.com/exoego/rspec-openapi/pull/84)
+- Bunch of refactorings
+
+## v0.7.2
+- $ref enhancements: Support $ref in arbitrary depth
+  [#82](https://github.com/k0kubun/rspec-openapi/pull/82)
+
 ## v0.7.1
-- $ref enhancements: Generate Response Headers
+- $ref enhancements: Auto-generate components referenced in "items"
   [#80](https://github.com/k0kubun/rspec-openapi/pull/80)
 - Administration
   - Setup RuboCop

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-openapi.gemspec
@@ -12,5 +14,6 @@ group :test do
 end
 
 group :development do
+  gem 'code-scanning-rubocop'
   gem 'pry'
 end

data/README.md

@@ -146,6 +146,16 @@ RSpec::OpenAPI.response_headers = %w[X-Cursor]
 # Set `servers` - generate servers of a schema file
 RSpec::OpenAPI.servers = [{ url: 'http://localhost:3000' }]
 
+# Set `security_schemes` - generate security schemes
+RSpec::OpenAPI.security_schemes = {
+  'MyToken' => {
+    description: 'Authenticate API requests via a JWT',
+    type: 'http',
+    scheme: 'bearer',
+    bearerFormat: 'JWT',
+  },
+}
+
 # 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
@@ -189,7 +199,7 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/User"
-# Note) #/components/schamas is not needed to be defined. 
+# Note) #/components/schamas is not needed to be defined.
 ```
 
 3. Then, re-run rspec-openapi. It will generate `#/components/schemas` with the referenced schema (`User` for example) newly-generated or updated.
@@ -298,6 +308,7 @@ Some examples' attributes can be overwritten via RSpec metadata options. Example
     summary: 'list all posts',
     description: 'list all posts ordered by pub_date',
     tags: %w[v1 posts],
+    security: [{"MyToken" => []}],
   } do
     # ...
   end
@@ -305,6 +316,34 @@ Some examples' attributes can be overwritten via RSpec metadata options. Example
 
 **NOTE**: `description` key will override also the one provided by `RSpec::OpenAPI.description_builder` method.
 
+## Experimental minitest support
+
+Even if you are not using `rspec` this gem might help you with its experimental support for `minitest`.
+
+Example:
+
+```rb
+class TablesTest < ActionDispatch::IntegrationTest
+  openapi!
+
+  test "GET /index returns a list of tables" do
+    get '/tables', params: { page: '1', per: '10' }, headers: { authorization: 'k0kubun' }
+    assert_response :success
+  end
+
+  test "GET /index does not return tables if unauthorized" do
+    get '/tables'
+    assert_response :unauthorized
+  end
+
+  # ...
+end
+```
+
+It should work with both classes inheriting from `ActionDispatch::IntegrationTest` and with classes using `Rack::Test` directly, as long as you call `openapi!` in your test class.
+
+Please note that not all features present in the rspec integration work with minitest (yet). For example, custom per test case metadata is not supported. A custom `description_builder` will not work either.
+
 ## Links
 
 Existing RSpec plugins which have OpenAPI integration:
@@ -315,9 +354,9 @@ Existing RSpec plugins which have OpenAPI integration:
 
 ## Acknowledgements
 
-This gem was heavily inspired by the following gem:
+* Heavily inspired by [r7kamura/autodoc](https://github.com/r7kamura/autodoc)
+* Orignally created by [k0kubun](https://github.com/k0kubun) and the ownership was transferred to [exoego](https://github.com/exoego) in 2022-11-29.
 
-* [r7kamura/autodoc](https://github.com/r7kamura/autodoc)
 
 ## License
 

data/Rakefile

@@ -1,5 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/rspec/openapi/**/*_spec.rb'

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rspec/openapi"
+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.
@@ -10,5 +11,5 @@ require "rspec/openapi"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rspec/openapi/components_updater.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'hash_helper'
 
 class << RSpec::OpenAPI::ComponentsUpdater = Object.new
@@ -7,15 +9,22 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
     # Top-level schema: Used as the body of request or response
     top_level_refs = paths_to_top_level_refs(base)
     return if top_level_refs.empty?
+
     fresh_schemas = build_fresh_schemas(top_level_refs, base, fresh)
 
     # Nested schema: References in Top-level schemas. May contain some top-level schema.
     generated_schema_names = fresh_schemas.keys
     nested_refs = find_non_top_level_nested_refs(base, generated_schema_names)
     nested_refs.each do |paths|
-      parent_name = paths[-4]
-      property_name = paths[-2]
-      nested_schema = fresh_schemas.dig(parent_name, 'properties', property_name)
+      # Slice between the parent name and the element before "$ref"
+      # ["components", "schema", "Table", "properties", "database",                       "$ref"]
+      #  0             1         2 ^....................^
+      # ["components", "schema", "Table", "properties", "columns", "items",               "$ref"]
+      #  0             1         2 ^...............................^
+      # ["components", "schema", "Table", "properties", "owner", "properties", "company", "$ref"]
+      #  0             1         2 ^...........................................^
+      needle = paths.slice(2, paths.size - 3)
+      nested_schema = fresh_schemas.dig(*needle)
 
       # Skip if the property using $ref is not found in the parent schema. The property may be removed.
       next if nested_schema.nil?
@@ -25,7 +34,7 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
       RSpec::OpenAPI::SchemaMerger.merge!(fresh_schemas[schema_name], nested_schema)
     end
 
-    RSpec::OpenAPI::SchemaMerger.merge!(base, { 'components' => { 'schemas' => fresh_schemas }})
+    RSpec::OpenAPI::SchemaMerger.merge!(base, { 'components' => { 'schemas' => fresh_schemas } })
     RSpec::OpenAPI::SchemaCleaner.cleanup_components_schemas!(base, { 'components' => { 'schemas' => fresh_schemas } })
   end
 
@@ -33,7 +42,7 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
 
   def build_fresh_schemas(references, base, fresh)
     references.inject({}) do |acc, paths|
-      ref_link = dig_schema(base, paths).dig('$ref')
+      ref_link = dig_schema(base, paths)['$ref']
       schema_name = ref_link.gsub('#/components/schemas/', '')
       schema_body = dig_schema(fresh, paths)
       RSpec::OpenAPI::SchemaMerger.merge!(acc, { schema_name => schema_body })
@@ -45,16 +54,18 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
   end
 
   def paths_to_top_level_refs(base)
-    request_bodies = RSpec::OpenAPI::HashHelper::matched_paths(base, 'paths.*.*.requestBody.content.application/json')
-    responses = RSpec::OpenAPI::HashHelper::matched_paths(base, 'paths.*.*.responses.*.content.application/json')
+    request_bodies = RSpec::OpenAPI::HashHelper.matched_paths(base, 'paths.*.*.requestBody.content.application/json')
+    responses = RSpec::OpenAPI::HashHelper.matched_paths(base, 'paths.*.*.responses.*.content.application/json')
     (request_bodies + responses).select do |paths|
       dig_schema(base, paths)&.dig('$ref')&.start_with?('#/components/schemas/')
     end
   end
 
   def find_non_top_level_nested_refs(base, generated_names)
-    nested_refs = RSpec::OpenAPI::HashHelper::matched_paths(base, 'components.schemas.*.properties.*.$ref')
-
+    nested_refs = [
+      *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties.*.$ref'),
+      *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties.*.items.$ref'),
+    ]
     # Reject already-generated schemas to reduce unnecessary loop
     nested_refs.reject do |paths|
       ref_link = base.dig(*paths)

data/lib/rspec/openapi/default_schema.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::DefaultSchema = Object.new
   def build(title)
-    {
+    spec = {
       openapi: '3.0.3',
       info: {
         title: title,
@@ -8,6 +10,14 @@ class << RSpec::OpenAPI::DefaultSchema = Object.new
       },
       servers: RSpec::OpenAPI.servers,
       paths: {},
-    }.freeze
+    }
+
+    if RSpec::OpenAPI.security_schemes.present?
+      spec[:components] = {
+        securitySchemes: RSpec::OpenAPI.security_schemes,
+      }
+    end
+
+    spec.freeze
   end
 end

data/lib/rspec/openapi/hash_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::HashHelper = Object.new
   def paths_to_all_fields(obj)
     case obj
@@ -13,11 +15,23 @@ class << RSpec::OpenAPI::HashHelper = Object.new
 
   def matched_paths(obj, selector)
     selector_parts = selector.split('.').map(&:to_s)
-    selectors = paths_to_all_fields(obj).select do |key_parts|
+    paths_to_all_fields(obj).select do |key_parts|
       key_parts.size == selector_parts.size && key_parts.zip(selector_parts).all? do |kp, sp|
-        kp == sp || (sp == '*' && kp != nil)
+        kp == sp || (sp == '*' && !kp.nil?)
       end
     end
-    selectors
+  end
+
+  def matched_paths_deeply_nested(obj, begin_selector, end_selector)
+    path_depth_sizes = paths_to_all_fields(obj).map(&:size).uniq
+    path_depth_sizes.map do |depth|
+      diff = depth - begin_selector.count('.') - end_selector.count('.')
+      if diff >= 0
+        selector = "#{begin_selector}.#{'*.' * diff}#{end_selector}"
+        matched_paths(obj, selector)
+      else
+        []
+      end
+    end.flatten(1)
   end
 end

data/lib/rspec/openapi/minitest_hooks.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'minitest'
+
+module RSpec::OpenAPI::Minitest
+  Example = Struct.new(:context, :description, :metadata, :file_path)
+
+  module TestPatch
+    def self.prepended(base)
+      base.extend(ClassMethods)
+    end
+
+    def run(*args)
+      result = super
+      if ENV['OPENAPI'] && self.class.openapi?
+        file_path = method(name).source_location.first
+        human_name = name.sub(/^test_/, '').gsub(/_/, ' ')
+        example = Example.new(self, human_name, {}, file_path)
+        path = RSpec::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(example) : p }
+        record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
+        RSpec::OpenAPI.path_records[path] << record if record
+      end
+      result
+    end
+
+    module ClassMethods
+      def openapi?
+        @openapi
+      end
+
+      def openapi!
+        @openapi = true
+      end
+    end
+  end
+end
+
+Minitest::Test.prepend RSpec::OpenAPI::Minitest::TestPatch
+
+Minitest.after_run do
+  if ENV['OPENAPI']
+    result_recorder = RSpec::OpenAPI::ResultRecorder.new(RSpec::OpenAPI.path_records)
+    result_recorder.record_results!
+    puts result_record.error_message if result_recorder.errors?
+  end
+end

data/lib/rspec/openapi/record.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 RSpec::OpenAPI::Record = Struct.new(
-  :method,                # @param [String]  - "GET"
+  :http_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"}
@@ -9,6 +11,7 @@ RSpec::OpenAPI::Record = Struct.new(
   :summary,               # @param [String]  - "v1/statuses #show"
   :tags,                  # @param [Array]   - ["Status"]
   :description,           # @param [String]  - "returns a status"
+  :security,              # @param [Array]  - [{securityScheme1: []}]
   :status,                # @param [Integer] - 200
   :response_body,         # @param [Object]  - {"status" => "ok"}
   :response_headers,      # @param [Array]  - [["header_key1", "header_value1"], ["header_key2", "header_value2"]]

data/lib/rspec/openapi/record_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_dispatch'
 require 'rspec/openapi/record'
 
@@ -6,71 +8,90 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   # @param [RSpec::Core::Example] example
   # @return [RSpec::OpenAPI::Record,nil]
   def build(context, example:)
-    if rack_test?(context)
-      request = ActionDispatch::Request.new(context.last_request.env)
-      request.body.rewind if request.body.respond_to?(:rewind)
-      response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
-    else
-      request = context.request
-      response = context.response
-    end
+    request, response = extract_request_response(context)
     return if request.nil?
 
-    # 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[:action] || "#{request.method} #{path}"
-      tags = [route.requirements[:controller]&.classify].compact
-    else
-      path = request.path
-      summary = "#{request.method} #{request.path}"
-    end
+    path, summary, tags, raw_path_params, description, security = extract_request_attributes(request, example)
 
-    response_body =
-      begin
-        response.parsed_body
-      rescue JSON::ParserError
-        nil
-      end
-
-    request_headers = RSpec::OpenAPI.request_headers.each_with_object([]) do |header, headers_arr|
-      header_key = header.gsub(/-/, '_').upcase
-      header_value = request.get_header(['HTTP', header_key].join('_')) || request.get_header(header_key)
-      headers_arr << [header, header_value] if header_value
-    end
-
-    metadata_options = example.metadata[:openapi] || {}
-
-    response_headers = RSpec::OpenAPI.response_headers.each_with_object([]) do |header, headers_arr|
-      header_key = header
-      header_value = response.headers[header_key]
-      headers_arr << [header_key, header_value] if header_value
-    end
+    request_headers, response_headers = extract_headers(request, response)
 
     RSpec::OpenAPI::Record.new(
-      method: request.request_method,
+      http_method: request.method,
       path: path,
-      path_params: raw_path_params(request),
+      path_params: raw_path_params,
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
       request_content_type: request.media_type,
       request_headers: request_headers,
-      summary: metadata_options[:summary] || summary,
-      tags: metadata_options[:tags] || tags,
-      description: metadata_options[:description] || RSpec::OpenAPI.description_builder.call(example),
+      summary: summary,
+      tags: tags,
+      description: description,
+      security: security,
       status: response.status,
-      response_body: response_body,
+      response_body: safe_parse_body(response),
       response_headers: response_headers,
       response_content_type: response.media_type,
-      response_content_disposition: response.header["Content-Disposition"],
+      response_content_disposition: response.header['Content-Disposition'],
     ).freeze
   end
 
   private
 
+  def safe_parse_body(response)
+    response.parsed_body
+  rescue JSON::ParserError
+    nil
+  end
+
+  def extract_headers(request, response)
+    request_headers = RSpec::OpenAPI.request_headers.each_with_object([]) do |header, headers_arr|
+      header_key = header.gsub(/-/, '_').upcase
+      header_value = request.get_header(['HTTP', header_key].join('_')) || request.get_header(header_key)
+      headers_arr << [header, header_value] if header_value
+    end
+    response_headers = RSpec::OpenAPI.response_headers.each_with_object([]) do |header, headers_arr|
+      header_key = header
+      header_value = response.headers[header_key]
+      headers_arr << [header_key, header_value] if header_value
+    end
+    [request_headers, response_headers]
+  end
+
+  def extract_request_attributes(request, example)
+    metadata = example.metadata[:openapi] || {}
+    summary = metadata[:summary]
+    tags = metadata[:tags]
+    security = metadata[:security]
+    description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
+    raw_path_params = request.path_parameters
+    path = request.path
+    if rails?
+      route = find_rails_route(request)
+      path = route.path.spec.to_s.delete_suffix('(.:format)')
+      summary ||= route.requirements[:action]
+      tags ||= [route.requirements[:controller]&.classify].compact
+      # :controller and :action always exist. :format is added when routes is configured as such.
+      # TODO: Use .except(:controller, :action, :format) when we drop support for Ruby 2.x
+      raw_path_params = raw_path_params.slice(*(raw_path_params.keys - %i[controller action format]))
+    end
+    summary ||= "#{request.method} #{path}"
+    [path, summary, tags, raw_path_params, description, security]
+  end
+
+  def extract_request_response(context)
+    if rack_test?(context)
+      request = ActionDispatch::Request.new(context.last_request.env)
+      request.body.rewind if request.body.respond_to?(:rewind)
+      response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
+    else
+      request = context.request
+      response = context.response
+    end
+    [request, response]
+  end
+
   def rails?
-    defined?(Rails) && Rails.application
+    defined?(Rails) && Rails.respond_to?(:application) && Rails.application
   end
 
   def rack_test?(context)
@@ -87,25 +108,12 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
     app.routes.router.recognize(request) do |route|
       if route.app.matches?(request)
-        if route.app.engine?
-          return find_rails_route(request, app: route.app.app, fix_path: false)
-        else
-          return route
-        end
-      end
-    end
-    raise "No route matched for #{request.request_method} #{request.path_info}"
-  end
+        return find_rails_route(request, app: route.app.app, fix_path: false) if route.app.engine?
 
-  # :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)
+        return route
       end
-    else
-      request.path_parameters
     end
+    raise "No route matched for #{request.request_method} #{request.path_info}"
   end
 
   # workaround to get real request parameters

data/lib/rspec/openapi/result_recorder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class RSpec::OpenAPI::ResultRecorder
+  def initialize(path_records)
+    @path_records = path_records
+    @error_records = {}
+  end
+
+  def record_results!
+    title = File.basename(Dir.pwd)
+    @path_records.each do |path, records|
+      RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
+        schema = RSpec::OpenAPI::DefaultSchema.build(title)
+        schema[:info].merge!(RSpec::OpenAPI.info)
+        RSpec::OpenAPI::SchemaMerger.merge!(spec, schema)
+        new_from_zero = {}
+        records.each do |record|
+          File.open('/tmp/records', 'a') { |f| f.puts record.to_yaml }
+          begin
+            record_schema = RSpec::OpenAPI::SchemaBuilder.build(record)
+            RSpec::OpenAPI::SchemaMerger.merge!(spec, record_schema)
+            RSpec::OpenAPI::SchemaMerger.merge!(new_from_zero, record_schema)
+          rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
+            @error_records[e] = record # Avoid failing the build
+          end
+        end
+        RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
+        RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
+      end
+    end
+  end
+
+  def errors?
+    @error_records.any?
+  end
+
+  def error_message
+    <<~ERR_MSG
+      RSpec::OpenAPI got errors building #{@error_records.size} requests
+
+      #{@error_records.map { |e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
+    ERR_MSG
+  end
+end

data/lib/rspec/openapi/rspec_hooks.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+
+RSpec.configuration.after(:each) do |example|
+  if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
+    path = RSpec::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(example) : p }
+    record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
+    RSpec::OpenAPI.path_records[path] << record if record
+  end
+end
+
+RSpec.configuration.after(:suite) do
+  result_recorder = RSpec::OpenAPI::ResultRecorder.new(RSpec::OpenAPI.path_records)
+  result_recorder.record_results!
+  if result_recorder.errors?
+    error_message = result_recorder.error_message
+    colorizer = RSpec::Core::Formatters::ConsoleCodes
+    RSpec.configuration.reporter.message colorizer.wrap(error_message, :failure)
+  end
+end

data/lib/rspec/openapi/schema_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::SchemaBuilder = Object.new
   # @param [RSpec::OpenAPI::Record] record
   # @return [Hash]
@@ -22,9 +24,10 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     {
       paths: {
         normalize_path(record.path) => {
-          record.method.downcase => {
+          record.http_method.downcase => {
             summary: record.summary,
             tags: record.tags,
+            security: record.security,
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
             responses: {
@@ -38,6 +41,11 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   private
 
+  def enrich_with_required_keys(obj)
+    obj[:required] = obj[:properties]&.keys
+    obj
+  end
+
   def response_example(record, disposition:)
     return nil if !example_enabled? || disposition
 
@@ -81,6 +89,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     end
 
     return nil if parameters.empty?
+
     parameters
   end
 
@@ -115,8 +124,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         normalize_content_type(record.request_content_type) => {
           schema: build_property(record.request_params),
           example: (build_example(record.request_params) if example_enabled?),
-        }.compact
-      }
+        }.compact,
+      },
     }
   end
 
@@ -125,17 +134,18 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     case value
     when Array
-      if value.empty?
-        property[:items] = {} # unknown
-      else
-        property[:items] = build_property(value.first)
-      end
+      property[:items] = if value.empty?
+                           {} # unknown
+                         else
+                           build_property(value.first)
+                         end
     when Hash
       property[:properties] = {}.tap do |properties|
         value.each do |key, v|
           properties[key] = build_property(v)
         end
       end
+      property = enrich_with_required_keys(property)
     end
     property
   end
@@ -167,15 +177,14 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   # Convert an always-String param to an appropriate type
   def try_cast(value)
-    begin
-      Integer(value)
-    rescue TypeError, ArgumentError
-      value
-    end
+    Integer(value)
+  rescue TypeError, ArgumentError
+    value
   end
 
   def build_example(value)
     return nil if value.nil?
+
     value = value.dup
     adjust_params(value)
   end
@@ -191,7 +200,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   end
 
   def normalize_path(path)
-    path.gsub(%r|/:([^:/]+)|, '/{\1}')
+    path.gsub(%r{/:([^:/]+)}, '/{\1}')
   end
 
   def normalize_content_type(content_type)

data/lib/rspec/openapi/schema_cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # For Ruby 3.0+
 require 'set'
 
@@ -44,15 +46,14 @@ class << RSpec::OpenAPI::SchemaCleaner = Object.new
       Marshal.dump(slice(obj, fields_for_identity))
     end
 
-    RSpec::OpenAPI::HashHelper::matched_paths(base, selector).each do |paths|
+    RSpec::OpenAPI::HashHelper.matched_paths(base, selector).each do |paths|
       target_array = base.dig(*paths)
       spec_array = spec.dig(*paths)
-      unless target_array.is_a?(Array) && spec_array.is_a?(Array)
-        next
-      end
+      next unless target_array.is_a?(Array) && spec_array.is_a?(Array)
+
       spec_identities = Set.new(spec_array.map(&marshal))
       target_array.select! { |e| spec_identities.include?(marshal.call(e)) }
-      target_array.sort_by! { |param| fields_for_identity.map {|f| param[f] }.join('-') }
+      target_array.sort_by! { |param| fields_for_identity.map { |f| param[f] }.join('-') }
       # Keep the last duplicate to produce the result stably
       deduplicated = target_array.reverse.uniq { |param| slice(param, fields_for_identity) }.reverse
       target_array.replace(deduplicated)
@@ -61,7 +62,7 @@ class << RSpec::OpenAPI::SchemaCleaner = Object.new
   end
 
   def cleanup_hash!(base, spec, selector)
-    RSpec::OpenAPI::HashHelper::matched_paths(base, selector).each do |paths|
+    RSpec::OpenAPI::HashHelper.matched_paths(base, selector).each do |paths|
       exist_in_base = !base.dig(*paths).nil?
       not_in_spec = spec.dig(*paths).nil?
       if exist_in_base && not_in_spec

data/lib/rspec/openapi/schema_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'yaml'
 require 'json'
@@ -21,7 +23,8 @@ class RSpec::OpenAPI::SchemaFile
   # @return [Hash]
   def read
     return {} unless File.exist?(@path)
-    YAML.load(File.read(@path)) # this can also parse JSON
+
+    YAML.safe_load(File.read(@path)) # this can also parse JSON
   end
 
   # @param [Hash] spec
@@ -40,9 +43,7 @@ class RSpec::OpenAPI::SchemaFile
     return content if RSpec::OpenAPI.comment.nil?
 
     comment = RSpec::OpenAPI.comment.dup
-    unless comment.end_with?("\n")
-      comment << "\n"
-    end
+    comment << "\n" unless comment.end_with?("\n")
     "#{comment.gsub(/^/, '# ').gsub(/^# \n/, "#\n")}#{content}"
   end
 

data/lib/rspec/openapi/schema_merger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::SchemaMerger = Object.new
   # @param [Hash] base
   # @param [Hash] spec
@@ -22,28 +24,35 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   end
 
   # Not doing `base.replace(deep_merge(base, spec))` to preserve key orders.
-  # Also this needs to be aware of OpenAPI details because a Hash-like structure 
+  # Also this needs to be aware of OpenAPI details because a Hash-like structure
   # may be an array whose Hash elements have a key name.
   #
   # TODO: Should we probably force-merge `summary` regardless of manual modifications?
   def merge_schema!(base, spec)
     spec.each do |key, value|
       if base[key].is_a?(Hash) && value.is_a?(Hash)
-        if !base[key].key?("$ref")
-          merge_schema!(base[key], value)
-        end
+        merge_schema!(base[key], value) unless base[key].key?('$ref')
       elsif base[key].is_a?(Array) && value.is_a?(Array)
         # parameters need to be merged as if `name` and `in` were the Hash keys.
-        if key == 'parameters'
-          base[key] = value | base[key]
-          base[key].uniq! { |param| param.slice('name', 'in') }
-        else
-          base[key] = value
-        end
+        merge_arrays(base, key, value)
       else
         base[key] = value
       end
     end
     base
   end
+
+  def merge_arrays(base, key, value)
+    case key
+    when 'parameters'
+      base[key] = value | base[key]
+      base[key].uniq! { |param| param.slice('name', 'in') }
+    when 'required'
+      # Preserve properties that appears in all test cases
+      base[key] = value & base[key]
+    else
+      # last one wins
+      base[key] = value
+    end
+  end
 end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RSpec
   module OpenAPI
-    VERSION = '0.7.1'.freeze
+    VERSION = '0.8.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -1,17 +1,33 @@
+# frozen_string_literal: true
+
 require 'rspec/openapi/version'
-require 'rspec/openapi/hooks' if ENV['OPENAPI']
+require 'rspec/openapi/components_updater'
+require 'rspec/openapi/default_schema'
+require 'rspec/openapi/record_builder'
+require 'rspec/openapi/result_recorder'
+require 'rspec/openapi/schema_builder'
+require 'rspec/openapi/schema_file'
+require 'rspec/openapi/schema_merger'
+require 'rspec/openapi/schema_cleaner'
+
+if ENV['OPENAPI']
+  require 'rspec/openapi/minitest_hooks'
+  require 'rspec/openapi/rspec_hooks'
+end
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
   @comment = nil
   @enable_example = true
-  @description_builder = -> (example) { example.description }
+  @description_builder = ->(example) { example.description }
   @info = {}
   @application_version = '1.0.0'
   @request_headers = []
   @servers = []
+  @security_schemes = []
   @example_types = %i[request]
   @response_headers = []
+  @path_records = Hash.new { |h, k| h[k] = [] }
 
   class << self
     attr_accessor :path,
@@ -22,7 +38,9 @@ module RSpec::OpenAPI
                   :application_version,
                   :request_headers,
                   :servers,
+                  :security_schemes,
                   :example_types,
-                  :response_headers
+                  :response_headers,
+                  :path_records
   end
 end

data/rspec-openapi.gemspec

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 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.authors       = ['Takashi Kokubun', 'TATSUNO Yasuhiro']
+  spec.email         = ['takashikkbn@gmail.com', 'ytatsuno.jp@gmail.com']
 
-  spec.summary       = %q{Generate OpenAPI schema from RSpec request specs}
-  spec.description   = %q{Generate OpenAPI  from RSpec request specs}
-  spec.homepage      = 'https://github.com/k0kubun/rspec-openapi'
+  spec.summary       = 'Generate OpenAPI schema from RSpec request specs'
+  spec.description   = 'Generate OpenAPI from RSpec request specs'
+  spec.homepage      = 'https://github.com/exoego/rspec-openapi'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
@@ -16,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = File.join(spec.homepage, 'blob/master/CHANGELOG.md')
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
@@ -24,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'actionpack', '>= 5.2.0'
-  spec.add_dependency 'rspec'
+  spec.add_dependency 'rspec-core'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+- TATSUNO Yasuhiro
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -25,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,17 +39,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate OpenAPI  from RSpec request specs
+description: Generate OpenAPI from RSpec request specs
 email:
 - takashikkbn@gmail.com
+- ytatsuno.jp@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/rubocop.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -60,9 +65,11 @@ files:
 - lib/rspec/openapi/components_updater.rb
 - lib/rspec/openapi/default_schema.rb
 - lib/rspec/openapi/hash_helper.rb
-- lib/rspec/openapi/hooks.rb
+- lib/rspec/openapi/minitest_hooks.rb
 - lib/rspec/openapi/record.rb
 - lib/rspec/openapi/record_builder.rb
+- lib/rspec/openapi/result_recorder.rb
+- lib/rspec/openapi/rspec_hooks.rb
 - lib/rspec/openapi/schema_builder.rb
 - lib/rspec/openapi/schema_cleaner.rb
 - lib/rspec/openapi/schema_file.rb
@@ -70,14 +77,15 @@ files:
 - lib/rspec/openapi/version.rb
 - rspec-openapi.gemspec
 - test.png
-homepage: https://github.com/k0kubun/rspec-openapi
+homepage: https://github.com/exoego/rspec-openapi
 licenses:
 - MIT
 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: 
+  homepage_uri: https://github.com/exoego/rspec-openapi
+  source_code_uri: https://github.com/exoego/rspec-openapi
+  changelog_uri: https://github.com/exoego/rspec-openapi/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []

data/.github/FUNDING.yml

@@ -1 +0,0 @@
-github: k0kubun

data/lib/rspec/openapi/hooks.rb

@@ -1,51 +0,0 @@
-require 'rspec'
-require 'rspec/openapi/components_updater'
-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'
-require 'rspec/openapi/schema_cleaner'
-
-path_records = Hash.new { |h, k| h[k] = [] }
-error_records = {}
-
-RSpec.configuration.after(:each) do |example|
-  if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
-    path = RSpec::OpenAPI.path.yield_self { |path| path.is_a?(Proc) ? path.call(example) : path }
-    record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
-    path_records[path] << record if record
-  end
-end
-
-RSpec.configuration.after(:suite) do
-  title = File.basename(Dir.pwd)
-  path_records.each do |path, records|
-    RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
-      schema = RSpec::OpenAPI::DefaultSchema.build(title)
-      schema[:info].merge!(RSpec::OpenAPI.info)
-      RSpec::OpenAPI::SchemaMerger.merge!(spec, schema)
-      new_from_zero = {}
-      records.each do |record|
-        begin
-          record_schema = RSpec::OpenAPI::SchemaBuilder.build(record)
-          RSpec::OpenAPI::SchemaMerger.merge!(spec, record_schema)
-          RSpec::OpenAPI::SchemaMerger.merge!(new_from_zero, record_schema)
-        rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
-          error_records[e] = record # Avoid failing the build
-        end
-      end
-      RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
-      RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
-    end
-  end
-  if error_records.any?
-    error_message = <<~EOS
-      RSpec::OpenAPI got errors building #{error_records.size} requests
-
-      #{error_records.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
-    EOS
-    colorizer = ::RSpec::Core::Formatters::ConsoleCodes
-    RSpec.configuration.reporter.message colorizer.wrap(error_message, :failure)
-  end
-end