openapi_contracts 0.4.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c495a3bb1abc5e8a6da67fc5ed5dc7a9ba98a42ebd84d5f80bc7665cb5badded
-  data.tar.gz: bcfc21e9c2b09c02f32a6e9eec7644a7790b94ac7c92a25c4aa54a55a46d307b
+  metadata.gz: dc0a8f6f92b0615788c15cd3d715fe4308e1058616c6f892140addbcae3b9232
+  data.tar.gz: f7328963227bc196797674e1bd5f04af471a05507d0ec848a8386da5a568c1aa
 SHA512:
-  metadata.gz: d82aab412b36a2669556e69b0cdbec4f793076b4757050ad1b6b943856446f66e01d2b17f0d296e521fc04d39ebbfd83e481d1341de1c18290044d4baed0fd0c
-  data.tar.gz: 6fd2334e58fc53fd75b41c1ba9df2dd2a4da2925920c9ffcf2562df3f01b03e66e5801f88fbb691d5b73225ba9817bc1e42d89846f2b15ecaffa5a0e126e6b17
+  metadata.gz: 550501aa45c7e5b66dfa666ecc3354b41a5f8c49d067490c91a964b0bf338ca55b5e785ae578c0e82da15f5d5fdbe2bcd94c99e716fee81d7506ccd7cc05aa24
+  data.tar.gz: fa614dbb218e74bf497ac25d46d284bf32e6c9de9bda65a819f12f26a8172e405c9cd8ad1958fd760b69501e8e98214bdfb63c97e404bdfcb2590c47f1c21a8e

data/README.md

@@ -43,6 +43,19 @@ it 'responds with 200 and matches the doc' do
 }
 ```
 
+### Options
+
+The `match_openapi_doc($doc)` method allows passing options as a 2nd argument.
+This allows overriding the default request.path lookup in case this does not find
+the correct response definition in your schema. This is especially important with
+dynamic paths.
+
+Example:
+
+```ruby
+it { is_expected.to match_openapi_doc($api_doc, path: '/messages/{id}').with_http_status(:ok) }
+```
+
 ### How it works
 
 It uses the `request.path`, `request.method`, `status` and `headers` on the test subject (which must be the response) to find the response schema in the OpenAPI document. Then it does the following checks:

data/lib/openapi_contracts/doc/parser.rb

@@ -1,14 +1,14 @@
 module OpenapiContracts
   class Doc::Parser
-    def self.call(dir)
-      new(dir).parse('openapi.yaml')
+    def self.call(dir, filename)
+      new(dir).parse(filename)
     end
 
     def initialize(dir)
       @dir = dir
     end
 
-    def parse(path = 'openapi.yaml')
+    def parse(path)
       abs_path = @dir.join(path)
       data = parse_file(abs_path, translate: false)
       data.deep_merge! merge_components

data/lib/openapi_contracts/doc.rb

@@ -5,8 +5,8 @@ module OpenapiContracts
     autoload :Response, 'openapi_contracts/doc/response'
     autoload :Schema,   'openapi_contracts/doc/schema'
 
-    def self.parse(dir)
-      new Parser.call(dir)
+    def self.parse(dir, filename = 'openapi.yaml')
+      new Parser.call(dir, filename)
     end
 
     def initialize(schema)

data/lib/openapi_contracts/matchers/match_openapi_doc.rb

@@ -1,8 +1,9 @@
 module OpenapiContracts
   module Matchers
     class MatchOpenapiDoc
-      def initialize(doc)
+      def initialize(doc, options)
         @doc = doc
+        @options = options
         @errors = []
       end
 
@@ -43,7 +44,7 @@ module OpenapiContracts
 
       def response_spec
         @response_spec ||= @doc.response_for(
-          @response.request.path,
+          @options.fetch(:path, @response.request.path),
           @response.request.request_method.downcase,
           @response.status.to_s
         )

data/lib/openapi_contracts/matchers.rb

@@ -2,8 +2,8 @@ module OpenapiContracts
   module Matchers
     autoload :MatchOpenapiDoc, 'openapi_contracts/matchers/match_openapi_doc'
 
-    def match_openapi_doc(doc)
-      MatchOpenapiDoc.new(doc)
+    def match_openapi_doc(doc, options = {})
+      MatchOpenapiDoc.new(doc, options)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_contracts
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.0
 platform: ruby
 authors:
 - mkon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,70 +50,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.44.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.11.1
+        version: 2.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.11.1
+        version: 2.18.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
 description:
 email:
 - konstantin@munteanu.de