pact_broker-client 1.57.0 → 1.60.0

data/lib/pact_broker/client/base_client.rb

@@ -125,7 +125,7 @@ module PactBroker
             end
             url
           else
-            raise PactBroker::Client::RelationNotFound.new("Could not find relation #{relation_name} in index resource. Try upgrading your Pact Broker as the feature you require may not exist in your version.")
+            raise PactBroker::Client::RelationNotFound.new("Could not find relation #{relation_name} in index resource. Try upgrading your Pact Broker as the feature you require may not exist in your version. If you are using Pactflow, you may not have the permissions required for this action.")
           end
         end
       end

data/lib/pact_broker/client/cli/webhook_commands.rb

@@ -24,9 +24,7 @@ module PactBroker
                 method_option :provider_verification_published, type: :boolean, desc: "Trigger this webhook when a provider verification result is published"
                 method_option :provider_verification_failed, type: :boolean, desc: "Trigger this webhook when a failed provider verification result is published"
                 method_option :provider_verification_succeeded, type: :boolean, desc: "Trigger this webhook when a successful provider verification result is published"
-                if ENV.fetch("PACT_BROKER_FEATURES", "").include?("contract_requiring_verification_published")
-                  method_option :contract_requiring_verification_published, type: :boolean, desc: "Trigger this webhook when a contract is published that requires verification"
-                end
+                method_option :contract_requiring_verification_published, type: :boolean, desc: "Trigger this webhook when a contract is published that requires verification"
                 method_option :team_uuid, banner: "UUID", desc: "UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)"
                 shared_authentication_options
               end

data/lib/pact_broker/client/git.rb

@@ -25,7 +25,7 @@ module PactBroker
       using PactBroker::Client::HashRefinements
 
       COMMAND = 'git rev-parse --abbrev-ref HEAD'.freeze
-      BRANCH_ENV_VAR_NAMES = %w{GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
+      BRANCH_ENV_VAR_NAMES = %w{GITHUB_HEAD_REF GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
       COMMIT_ENV_VAR_NAMES = %w{GITHUB_SHA BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}
       BUILD_URL_ENV_VAR_NAMES = %w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
 

data/lib/pact_broker/client/hal/entity.rb

@@ -91,11 +91,11 @@ module PactBroker
         end
 
         def _link!(key)
-          _link(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
+          _link(key) or raise RelationNotFoundError.new(relation_not_found_error_message(key, @href))
         end
 
         def _links!(key)
-          _links(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
+          _links(key) or raise RelationNotFoundError.new(relation_not_found_error_message(key, @href))
         end
 
         def embedded_entity
@@ -161,6 +161,10 @@ module PactBroker
         def self_href(entity_hash)
           entity_hash["_links"] && entity_hash["_links"]["self"] && entity_hash["_links"]["self"]["href"]
         end
+
+        def relation_not_found_error_message(key, href)
+          "Could not find relation '#{key}' in resource at #{href}. The most likely reason for this is that you are on an old version of the Pact Broker and you need to upgrade, or you are using Pactflow and you don't have the permissions required for this action."
+        end
       end
 
       class ErrorEntity < Entity

data/lib/pact_broker/client/merge_pacts.rb

@@ -18,29 +18,40 @@ module PactBroker
       def merge original, additional
         new_pact = JSON.parse(original.to_json, symbolize_names: true)
 
-        additional[:interactions].each do |new_interaction|
+        merge_interactions_or_messages(new_pact, original, additional, :interactions)
+        merge_interactions_or_messages(new_pact, original, additional, :messages)
+
+        new_pact
+      end
+
+      private
+
+      def merge_interactions_or_messages(new_pact, original, additional, key)
+        return unless additional[key] || original[key]
+
+        additional_messages_or_interactions = additional[key] || []
+        original_messages_or_interactions = original[key] || []
+        new_pact[key] ||= []
+
+        additional_messages_or_interactions.each do |new_interaction|
           # check to see if this interaction matches an existing interaction
-          overwrite_index = original[:interactions].find_index do |original_interaction|
+          overwrite_index = original_messages_or_interactions.find_index do |original_interaction|
             same_description_and_state?(original_interaction, new_interaction)
           end
 
           # overwrite existing interaction if a match is found, otherwise appends the new interaction
           if overwrite_index
-            if new_interaction == original[:interactions][overwrite_index]
-              new_pact[:interactions][overwrite_index] = new_interaction
+            if new_interaction == original_messages_or_interactions[overwrite_index]
+              new_pact[key][overwrite_index] = new_interaction
             else
-              raise PactMergeError, almost_duplicate_message(original[:interactions][overwrite_index], new_interaction)
+              raise PactMergeError, almost_duplicate_message(original_messages_or_interactions[overwrite_index], new_interaction)
             end
           else
-            new_pact[:interactions] << new_interaction
+            new_pact[key] << new_interaction
           end
         end
-
-        new_pact
       end
 
-      private
-
       def almost_duplicate_message(original, new_interaction)
         "Two interactions have been found with same description (#{new_interaction[:description].inspect}) and provider state (#{new_interaction[:providerState].inspect}) but a different request or response. " +
           "Please use a different description or provider state, or hard-code any random data.\n\n" +

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.57.0'
+    VERSION = '1.60.0'
   end
 end

data/lib/pact_broker/client/webhooks/create.rb

@@ -50,7 +50,7 @@ module PactBroker
               return error_result(CREATING_WEBHOOK_WITH_UUID_NOT_SUPPORTED)
             end
           else
-            webhook_entity = index_entity._link("pb:webhooks").post(request_body_with_optional_consumer_and_provider)
+            webhook_entity = index_entity._link!("pb:webhooks").post(request_body_with_optional_consumer_and_provider)
           end
 
           if webhook_entity.response.status == 405

data/pact-broker-client.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |gem|
   gem.name          = "pact_broker-client"
   gem.version       = PactBroker::Client::VERSION
   gem.authors       = ["Beth Skurrie"]
-  gem.email         = ["bskurrie@dius.com.au"]
-  gem.description   = %q{Client for the Pact Broker. Publish, retrieve and query pacts and verification results.}
+  gem.email         = ["beth@bethesque.com"]
+  gem.description   = %q{Client for the Pact Broker. Publish, retrieve and query pacts and verification results. Manage webhooks and environments.}
   gem.summary       = %q{See description}
-  gem.homepage      = "https://github.com/bethesque/pact_broker-client.git"
+  gem.homepage      = "https://github.com/pact-foundation/pact_broker-client.git"
 
   gem.required_ruby_version = '>= 2.0'
 
@@ -33,6 +33,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
   gem.add_development_dependency 'pact', '~> 1.16'
   gem.add_development_dependency 'pact-support', '~> 1.16'
-  gem.add_development_dependency 'approvals', '>=0.0.24', '<1.0.0'
+  gem.add_development_dependency 'approvals', '0.0.24'
   gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

data/script/update-cli-usage-in-readme.rb

@@ -137,8 +137,12 @@ def reformat_docs(generated_thor_docs)
     else
       lines
     end
-    # line
-  end.flatten.join("\n").gsub("/go/", "/").gsub(File.basename(__FILE__), "pact-broker")
+  end
+    .flatten
+    .collect { | line | line.gsub(/\s+$/, "") }
+    .join("\n")
+    .gsub("/go/", "/")
+    .gsub(File.basename(__FILE__), "pact-broker")
 end
 
 def update_readme(usage_docs)

data/spec/lib/pact_broker/client/hal/entity_spec.rb

@@ -112,7 +112,7 @@ module PactBroker::Client
 
         context 'when the key does not exist' do
           it 'raises an error' do
-            expect { subject._link!('foo') }.to raise_error RelationNotFoundError, "Could not find relation 'foo' in resource at http://pact"
+            expect { subject._link!('foo') }.to raise_error RelationNotFoundError, /Could not find relation 'foo' in resource at http:\/\/pact/
           end
         end
       end

data/spec/lib/pact_broker/client/merge_pacts_spec.rb

@@ -4,63 +4,166 @@ module PactBroker
   module Client
     describe MergePacts do
       describe ".call" do
-        let(:pact_hash_1) do
-          {
-            other: 'info',
-            interactions: [
-              {providerState: 1, description: 1, foo: 'bar' }
-            ]
-          }
-        end
+        describe "with a pact with interactions" do
+          let(:pact_hash_1) do
+            {
+              other: 'info',
+              interactions: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
 
-        let(:pact_hash_2) do
-          {
-            interactions: [
-              {providerState: 2, description: 2, foo: 'wiffle' }
-            ]
-          }
-        end
+          let(:pact_hash_2) do
+            {
+              interactions: [
+                { providerState: 2, description: 2, foo: 'wiffle' }
+              ]
+            }
+          end
 
-        let(:pact_hash_3) do
-          {
-            interactions: [
-              {providerState: 3, description: 3, foo: 'meep' },
-              {providerState: 1, description: 1, foo: 'bar' }
-            ]
-          }
-        end
+          let(:pact_hash_3) do
+            {
+              interactions: [
+                { providerState: 3, description: 3, foo: 'meep' },
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
 
-        let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
-
-        let(:expected_merge) do
-          {
-            other: 'info',
-            interactions: [
-              {providerState: 1, description: 1, foo: 'bar' },
-              {providerState: 2, description: 2, foo: 'wiffle' },
-              {providerState: 3, description: 3, foo: 'meep' }
-            ]
-          }
-        end
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
+
+          let(:expected_merge) do
+            {
+              other: 'info',
+              interactions: [
+                { providerState: 1, description: 1, foo: 'bar' },
+                { providerState: 2, description: 2, foo: 'wiffle' },
+                { providerState: 3, description: 3, foo: 'meep' }
+              ]
+            }
+          end
+
+          subject { MergePacts.call(pact_hashes) }
 
-        subject { MergePacts.call(pact_hashes) }
+          it "merges the interactions by consumer/provider" do
+            expect(subject).to eq expected_merge
+          end
+
+          context "when an interaction is found with the same state and description but has a difference elsewhere" do
+            let(:pact_hash_3) do
+              {
+                interactions: [
+                  { providerState: 3, description: 3, foo: 'meep' },
+                  { providerState: 1, description: 1, foo: 'different' }
+                ]
+              }
+            end
 
-        it "merges the interactions by consumer/provider" do
-          expect(subject).to eq expected_merge
+            it "raises an error" do
+              expect { subject }.to raise_error PactMergeError, /foo.*different/
+            end
+          end
         end
 
-        context "when an interaction is found with the same state and description but has a difference elsewhere" do
+        describe "with a pact with messages" do
+          let(:pact_hash_1) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
+
+          let(:pact_hash_2) do
+            {
+              messages: [
+                { providerState: 2, description: 2, foo: 'wiffle' }
+              ]
+            }
+          end
+
           let(:pact_hash_3) do
+            {
+              messages: [
+                { providerState: 3, description: 3, foo: 'meep' },
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
+
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
+
+          let(:expected_merge) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' },
+                { providerState: 2, description: 2, foo: 'wiffle' },
+                { providerState: 3, description: 3, foo: 'meep' }
+              ]
+            }
+          end
+
+          subject { MergePacts.call(pact_hashes) }
+
+          it "merges the messages by consumer/provider" do
+            expect(subject).to eq expected_merge
+          end
+
+          context "when an interaction is found with the same state and description but has a difference elsewhere" do
+            let(:pact_hash_3) do
+              {
+                messages: [
+                  { providerState: 3, description: 3, foo: 'meep' },
+                  { providerState: 1, description: 1, foo: 'different' }
+                ]
+              }
+            end
+
+            it "raises an error" do
+              expect { subject }.to raise_error PactMergeError, /foo.*different/
+            end
+          end
+        end
+
+        describe "with a pact with messages and a pact with interactions" do
+          let(:pact_hash_1) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
+
+          let(:pact_hash_2) do
             {
               interactions: [
-                {providerState: 3, description: 3, foo: 'meep' },
-                {providerState: 1, description: 1, foo: 'different' }
+                { providerState: 2, description: 2, foo: 'wiffle' }
               ]
             }
           end
 
-          it "raises an error" do
-            expect { subject }.to raise_error PactMergeError, /foo.*different/
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2] }
+
+          let(:expected_merge) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ],
+              interactions: [
+                { providerState: 2, description: 2, foo: 'wiffle' }
+              ]
+            }
+          end
+
+          subject { MergePacts.call(pact_hashes) }
+
+          it "merges the messages by consumer/provider" do
+            expect(subject).to eq expected_merge
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.57.0
+  version: 1.60.0
 platform: ruby
 authors:
 - Beth Skurrie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -174,22 +174,16 @@ dependencies:
   name: approvals
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.24
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.24
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -205,9 +199,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 description: Client for the Pact Broker. Publish, retrieve and query pacts and verification
-  results.
+  results. Manage webhooks and environments.
 email:
-- bskurrie@dius.com.au
+- beth@bethesque.com
 executables:
 - pact-broker
 extensions: []
@@ -412,11 +406,11 @@ files:
 - spec/support/pacts_latest_list.json
 - spec/support/shared_context.rb
 - tasks/pact.rake
-homepage: https://github.com/bethesque/pact_broker-client.git
+homepage: https://github.com/pact-foundation/pact_broker-client.git
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -431,8 +425,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.30
-signing_key: 
+rubygems_version: 3.3.12
+signing_key:
 specification_version: 4
 summary: See description
 test_files: