rspec-openapi 0.3.15 → 0.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a7b33ccfea2d2fbaf9cb45b49171c46c0b6b9df44280ac6d6bf0f864aedb60
-  data.tar.gz: d52a3651c1dc945711c378d39e53867f518c9b8aed2d6bf7502c00aade767856
+  metadata.gz: bc42fc95d88e3523412bf9efbee6066b2789637a5b0213550f9d16711c1c9a94
+  data.tar.gz: fcaa99b78c4cc3404b9ee5b8cb9906fb3872b8c06ceb8ceb5d38f775015ae6ed
 SHA512:
-  metadata.gz: f8eac8961aa0b71a48f3af48c118dad88b8e4e90767dfb37c87d0902422a9ed6bea2c43cf87c713c209be0d7284f114cd455d49069b8521d3d34ad6ffcd901eb
-  data.tar.gz: d2a984317e8b93f8f2f29540c2a34af9fa89b46aadbdd300cc2247212d338530aff7d53aae75b27cabbd1d21ea3a30698051e1cd836509bf36c202f5c538eec9
+  metadata.gz: aa9865db15800d17549ee640ed88b2d5f32289e4ac61a30db43cf0adf7021889123cedb96558032c0c8b25c03d5390897fa716352edb98c7a5c091b64210b924
+  data.tar.gz: 5da282aa5811e4a61f24f4c853200c3e8e786704d737eff325651eca75cef49c06fb96d1d7c9547afa821e98e807fa8cf1509c672b934a296e57927f584c3e14

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## v0.3.19
+
+* Add `server_urls` and `request_headers` configs
+  [#30](https://github.com/k0kubun/rspec-openapi/pull/30)
+
+## v0.3.18
+
+* Support nested query parameters
+  [#29](https://github.com/k0kubun/rspec-openapi/pull/29)
+
+## v0.3.17
+
+* Rescue NotImplementedError in the after suite hook as well
+  [#28](https://github.com/k0kubun/rspec-openapi/pull/28)
+
+## v0.3.16
+
+* Use `media_type` instead of `content_type` for Rails 6.1
+  [#26](https://github.com/k0kubun/rspec-openapi/pull/26)
+* Avoid crashing the after suite hook when it fails to build schema
+  [#27](https://github.com/k0kubun/rspec-openapi/pull/27)
+
 ## v0.3.15
 
 * Fix an error when Content-Disposition header is inline

data/README.md

@@ -114,6 +114,14 @@ RSpec::OpenAPI.enable_example = false
 # Change `info.version`
 RSpec::OpenAPI.application_version = '1.0.0'
 
+# Set `headers` - generate parameters with headers for a request
+RSpec::OpenAPI.request_headers = %w[X-Authorization-Token]
+
+# Set `server_urls` - generate servers of a schema file
+RSpec::OpenAPI.server_urls = %w[
+  http://localhost:3000
+]
+
 # 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

data/lib/rspec/openapi/default_schema.rb

@@ -6,6 +6,7 @@ class << RSpec::OpenAPI::DefaultSchema = Object.new
         title: title,
         version: RSpec::OpenAPI.application_version,
       },
+      servers: RSpec::OpenAPI.server_urls.map { |url| { url: url } } || [],
       paths: {},
     }.freeze
   end

data/lib/rspec/openapi/hooks.rb

@@ -6,6 +6,7 @@ require 'rspec/openapi/schema_file'
 require 'rspec/openapi/schema_merger'
 
 records = []
+records_errors = []
 
 RSpec.configuration.after(:each) do |example|
   if example.metadata[:type] == :request && example.metadata[:openapi] != false
@@ -19,7 +20,21 @@ RSpec.configuration.after(:suite) do
   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))
+      begin
+        RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
+      rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
+        # NOTE: Don't fail the build
+        records_errors << [e, record]
+      end
     end
   end
+  if records_errors.any?
+    error_message = <<~EOS
+      RSpec::OpenAPI got errors building #{records_errors.size} requests
+      
+      #{records_errors.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

data/lib/rspec/openapi/record.rb

@@ -5,6 +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"
+  :request_headers,       # @param [Array]  - [["header_key1", "header_value1"], ["header_key2", "header_value2"]]
   :summary,               # @param [String]  - "v1/statuses #show"
   :tags,                  # @param [Array]   - ["Status"]
   :description,           # @param [String]  - "returns a status"

data/lib/rspec/openapi/record_builder.rb

@@ -34,19 +34,26 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
         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
+
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
       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,
+      request_content_type: request.media_type,
+      request_headers: request_headers,
       summary: summary,
       tags: tags,
       description: RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
       response_body: response_body,
-      response_content_type: response.content_type,
+      response_content_type: response.media_type,
       response_content_disposition: response.header["Content-Disposition"],
     ).freeze
   end

data/lib/rspec/openapi/schema_builder.rb

@@ -50,7 +50,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     record.path_params.each do |key, value|
       parameters << {
-        name: key.to_s,
+        name: build_parameter_name(key, value),
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
@@ -60,17 +60,37 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     record.query_params.each do |key, value|
       parameters << {
-        name: key.to_s,
+        name: build_parameter_name(key, value),
         in: 'query',
         schema: build_property(try_cast(value)),
         example: (try_cast(value) if example_enabled?),
       }.compact
     end
 
+    record.request_headers.each do |key, value|
+      parameters << {
+        name: build_parameter_name(key, value),
+        in: 'header',
+        required: true,
+        schema: build_property(try_cast(value)),
+        example: (try_cast(value) if example_enabled?),
+      }.compact
+    end
+
     return nil if parameters.empty?
     parameters
   end
 
+  def build_parameter_name(key, value)
+    key = key.to_s
+    if value.is_a?(Hash) && (value_keys = value.keys).size == 1
+      value_key = value_keys.first
+      build_parameter_name("#{key}[#{value_key}]", value[value_key])
+    else
+      key
+    end
+  end
+
   def build_request_body(record)
     return nil if record.request_content_type.nil?
     return nil if record.request_params.empty?

data/lib/rspec/openapi/schema_merger.rb

@@ -30,6 +30,13 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
         deep_reverse_merge!(base[key], value)
       elsif !base.key?(key)
         base[key] = value
+      elsif base[key].is_a?(Array) && value.is_a?(Array)
+        if key == "parameters"
+          # merge arrays
+          base[key] |= value
+        end
+      else
+        # no-op
       end
     end
     base

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.15'
+    VERSION = '0.3.19'
   end
 end

data/lib/rspec/openapi.rb

@@ -7,8 +7,10 @@ module RSpec::OpenAPI
   @enable_example = true
   @description_builder = -> (example) { example.description }
   @application_version = '1.0.0'
+  @request_headers = []
+  @server_urls = []
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.19
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs