rspec-openapi 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b221d36e6ff92306e1bd720b4bb07e114839c8e047ad530f6ac4cb2a11eb4ae5
-  data.tar.gz: 5f5daf56dddc8a7b9477f961611d3bd4550eb498aa38d166035e5b18fe7027bd
+  metadata.gz: 032e7acfd3a1818b7bffc9130fb58116cc8f8e2045d40e426cabb9c47d37d323
+  data.tar.gz: 4dad6278000051a228fbe41f0210931411ddb119730055bd9262bd8dfd18ea23
 SHA512:
-  metadata.gz: 18410768ff613a19b39f910e20e58ecda87337095b354e718bdb5f6b6e2713429acd26a289fd4ffa89a493348aa226561d89340d9685d37caa30b44c54d17be8
-  data.tar.gz: 5542bf85a5f1d46eacbdc0936b57ae197279bf618fa1628082e7d33c5600a2583f450426999dbc6eea4d4a401ffb307ea5d207b551aa27d586eb4682e572c9fb
+  metadata.gz: 75d7e8fb034bffdb1ed6d5dafbd1acdffd45d28db52bcb39c5606dad7bac41656415b2b0473a9aaed24bc2a9577ab9dd0bc8c413f547fabaaa5e4df7fe62f806
+  data.tar.gz: 2489d638c378f1f061ba992804761af38795a414535df628a5a3b419fcc73f11b116a23bb9d1a3f5a90f687fb30a70e220417463f75c33519194068440e155a2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# THIS CHANGELOG IS DEPRECATED!!
+
+Refer https://github.com/exoego/rspec-openapi/releases instead.
+
 ## v0.12.0
 
 - feat: Initial support of complex schema with manually-added `oneOf`

data/README.md

@@ -184,6 +184,12 @@ RSpec::OpenAPI.example_types = %i[request]
 # :controller and :action always exist. :format is added when routes is configured as such.
 RSpec::OpenAPI.ignored_path_params = %i[controller action format]
 
+# Configure which paths to ignore.
+# You can exclude some specs via `openapi: false`.
+# But, in a complex API usage scenario, you may need to include spec itself, but exclude some private paths.
+# In that case, you can specify the paths to ignore.
+# String or Regexp is acceptable.
+RSpec::OpenAPI.ignored_paths = ["/admin/full/path/", Regexp.new("^/_internal/")]
 ```
 
 ### Can I use rspec-openapi with `$ref` to minimize duplication of schema?

data/lib/rspec/openapi/minitest_hooks.rb

@@ -10,7 +10,7 @@ module RSpec::OpenAPI::Minitest
       result = super
       if ENV['OPENAPI'] && self.class.openapi?
         file_path = method(name).source_location.first
-        human_name = name.sub(/^test_/, '').gsub(/_/, ' ')
+        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)

data/lib/rspec/openapi/record_builder.rb

@@ -14,6 +14,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     path, summary, tags, operation_id, required_request_params, raw_path_params, description, security =
       extract_request_attributes(request, example)
 
+    return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| path.match?(ignored_path) }
+
     request_headers, response_headers = extract_headers(request, response)
 
     RSpec::OpenAPI::Record.new(
@@ -48,7 +50,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   def extract_headers(request, response)
     request_headers = RSpec::OpenAPI.request_headers.each_with_object([]) do |header, headers_arr|
-      header_key = header.gsub(/-/, '_').upcase
+      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

data/lib/rspec/openapi/schema_merger.rb

@@ -42,7 +42,8 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
         # parameters need to be merged as if `name` and `in` were the Hash keys.
         merge_arrays(base, key, value)
       else
-        base[key] = value
+        # do not ADD `properties` or `required` fields if `additionalProperties` field is present
+        base[key] = value unless base.key?('additionalProperties') && %w[properties required].include?(key)
       end
     end
     base

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.12.0'
+    VERSION = '0.14.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -31,6 +31,7 @@ module RSpec::OpenAPI
   @response_headers = []
   @path_records = Hash.new { |h, k| h[k] = [] }
   @ignored_path_params = %i[controller action format]
+  @ignored_paths = []
 
   # This is the configuraion override file name we look for within each path.
   @config_filename = 'rspec_openapi.rb'
@@ -51,6 +52,7 @@ module RSpec::OpenAPI
                   :example_types,
                   :response_headers,
                   :path_records,
+                  :ignored_paths,
                   :ignored_path_params
 
     attr_reader   :config_filename

data/rspec-openapi.gemspec

@@ -14,9 +14,12 @@ Gem::Specification.new do |spec|
   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'] = File.join(spec.homepage, 'blob/master/CHANGELOG.md')
+  spec.metadata = {
+    '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/releases/tag/v#{RSpec::OpenAPI::VERSION}",
+    'rubygems_mfa_required' => 'true',
+  }
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -88,7 +88,7 @@ licenses:
 metadata:
   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
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.14.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []