pact_broker-client 1.56.0 → 1.59.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/matrix_commands.rb

@@ -13,6 +13,7 @@ module PactBroker
             method_option :ignore, required: false, desc: "The pacticipant name to ignore. Use once for each pacticipant being ignored. A specific version can be ignored by also specifying a --version after the pacticipant name option."
             method_option :latest, required: false, aliases: "-l", banner: "[TAG]", desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
             method_option :to_environment, required: false, banner: "ENVIRONMENT", desc: "The environment into which the pacticipant(s) are to be deployed", default: nil
+            method_option :branch, required: false, desc: "The branch of the version for which you want to check the verification results", default: nil
             method_option :to, required: false, banner: "TAG", desc: "The tag that represents the branch or environment of the integrated applications for which you want to check the verification result status.", default: nil
             method_option :output, aliases: "-o", desc: "json or table", default: "table"
             method_option :retry_while_unknown, banner: "TIMES", type: :numeric, default: 0, required: false, desc: "The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)"
@@ -77,8 +78,8 @@ module PactBroker
               end
 
               def validate_can_i_deploy_selectors selectors
-                pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? && s[:tag].nil? }.collect{ |s| s[:pacticipant] }
-                raise ::Thor::RequiredArgumentMissingError, "The version must be specified using `--version VERSION`, `--latest`, `--latest TAG`, or `--all TAG` for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
+                pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? && s[:tag].nil? && s[:branch].nil? }.collect{ |s| s[:pacticipant] }
+                raise ::Thor::RequiredArgumentMissingError, "The version must be specified using `--version VERSION`, `--branch BRANCH` `--latest`, `--latest TAG`, or `--all TAG` for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
               end
             end
           end

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

@@ -31,6 +31,10 @@ module PactBroker
               when "--latest", "-l"
                 selectors << { pacticipant: nil } if selectors.empty?
                 selectors.last[:tag] = word
+              when "--branch"
+                selectors << { pacticipant: nil } if selectors.empty?
+                selectors.last[:branch] = word
+                selectors.last[:latest] = true
               when "--all"
                 selectors << { pacticipant: nil } if selectors.empty?
                 selectors.last[:tag] = word

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/deployments/record_release.rb

@@ -30,7 +30,11 @@ module PactBroker
         end
 
         def not_supported_message
-          "This version of the Pact Broker does not support recording #{action}s. Please upgrade to version 2.80.0 or later."
+          if is_pactflow?
+            "This version of Pactflow does not support recording #{action}s, or you do not have the required permission to read environments. Please upgrade to the latest version if using Pactflow On-Premises, and ensure the user has the environment read permission."
+          else
+            "This version of the Pact Broker does not support recording #{action}s. Please upgrade to version 2.80.0 or later."
+          end
         end
 
         def environment_exists?

data/lib/pact_broker/client/deployments/record_undeployment.rb

@@ -108,7 +108,7 @@ module PactBroker
           potential_application_instances = currently_deployed_version_entities_for_pacticipant.collect{|e| e.applicationInstance || e.target }
 
           if application_instance
-            omit_text = potential_application_instances.include?(nil) ? "omit the application instance to undeploy from the anonymous instance" : nil
+            omit_text = potential_application_instances.include?(nil) ? "omit the application instance" : nil
             specify_text = potential_application_instances.compact.any? ? "specify one of the following application instances to record the undeployment from: #{potential_application_instances.compact.join(", ")}" : nil
             "#{pacticipant_name} is not currently deployed to application instance '#{application_instance}' in #{environment_name} environment. Please #{[omit_text, specify_text].compact.join(" or ")}."
           else

data/lib/pact_broker/client/environments/environment_command.rb

@@ -5,6 +5,7 @@ module PactBroker
     module Environments
       class EnvironmentCommand < PactBroker::Client::BaseCommand
         NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support environments. Please upgrade to version 2.80.0 or later."
+        PACTFLOW_NOT_SUPPORTED_MESSAGE = "This version of Pactflow does not support environments or you do not have the required permission to read them. Please upgrade to the latest version if using Pactflow On-Premises and ensure the user has the environment read permission."
 
         private
 
@@ -57,7 +58,11 @@ module PactBroker
 
         def check_if_command_supported
           unless index_resource.can?("pb:environments")
-            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+            if is_pactflow?
+              raise PactBroker::Client::Error.new(PACTFLOW_NOT_SUPPORTED_MESSAGE)
+            else
+              raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+            end
           end
         end
       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
@@ -141,9 +141,9 @@ module PactBroker
         end
 
         def method_missing(method_name, *args, &block)
-          if @data.key?(method_name.to_s)
+          if @data.respond_to?(:key?) && @data.key?(method_name.to_s)
             @data[method_name.to_s]
-          elsif @links.key?(method_name)
+          elsif @links.respond_to?(:key?) && @links.key?(method_name)
             Link.new(@links[method_name], @client).run(*args)
           else
             nil
@@ -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/hal/http_client.rb

@@ -144,6 +144,10 @@ module PactBroker
             __getobj__().to_hash
           end
 
+          def header(name)
+            __getobj__()[name]
+          end
+
           def raw_body
             __getobj__().body
           end

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

@@ -86,11 +86,16 @@ module PactBroker
         private
 
         def wrap_response(href, http_response)
-          require 'pact_broker/client/hal/entity' # avoid circular reference
+          require "pact_broker/client/hal/entity" # avoid circular reference
           if http_response.success?
             Entity.new(href, http_response.body, @http_client, http_response)
           else
-            ErrorEntity.new(href, http_response.raw_body, @http_client, http_response)
+            body =  begin
+                      http_response.header("Content-Type") && http_response.header("Content-Type").include?("json") ? http_response.body : http_response.raw_body
+                    rescue
+                      http_response.raw_body
+                    end
+            ErrorEntity.new(href, body, @http_client, http_response)
           end
         end
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -86,7 +86,11 @@ module PactBroker
               "Successfully published pacts"
             end
           else
-            ::Term::ANSIColor.red(response_entity.response.body.to_s)
+            if response_entity.notices
+              PactBroker::Client::ColorizeNotices.call(response_entity.notices.collect{ |n| OpenStruct.new(n) } )
+            else
+              ::Term::ANSIColor.red(response_entity.response.raw_body)
+            end
           end
         end.join("\n")
       end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.56.0'
+    VERSION = '1.59.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/can-i-deploy.sh

@@ -0,0 +1,5 @@
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+  --consumer-app-version 1.2.26 \
+  --branch main
+
+bundle exec bin/pact-broker can-i-deploy --pacticipant "Pact Broker Client" --branch "main"

data/script/record-deployments-and-releases.sh

@@ -6,12 +6,12 @@ bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 2 --to-envi
 
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
-bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1
 
-bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-2
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-2
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
-bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-1
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-1
 
 bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test
 bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test

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/cli/version_selector_options_parser_spec.rb

@@ -69,6 +69,12 @@ module PactBroker
           ],[
             ["--version", "2"],
             [{ pacticipant: nil, version: "2" }]
+          ],[
+            ["--pacticipant", "Foo", "--branch", "main"],
+            [{ pacticipant: "Foo", branch: "main", latest: true }]
+          ],[
+            ["--branch", "main"],
+            [{ pacticipant: nil, branch: "main", latest: true }]
           ]
         ]
 

data/spec/lib/pact_broker/client/deployments/record_deployment_spec.rb

@@ -44,8 +44,9 @@ module PactBroker
           let(:record_deployment_body_hash) do
             { "some" => "response" }
           end
+          let(:index_headers) { { "Content-Type" => "application/hal+json" } }
           let!(:index_request) do
-            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: index_headers  )
           end
           let!(:version_request) do
             stub_request(:get, broker_base_url + "/pacticipants/Foo/versions/1").to_return(status: 200, body: version_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
@@ -89,10 +90,20 @@ module PactBroker
                 "_links" => {}
               }
             end
+
             it "returns an error response" do
               expect(subject.success).to be false
               expect(subject.message).to include "does not support"
             end
+
+            context "when the server is Pactflow" do
+              let(:index_headers) { { "Content-Type" => "application/hal+json", "Pactflow-Something" => "foo" } }
+
+              it "returns an error response" do
+                expect(subject.message).to include "permission"
+                expect(subject.message).to include "does not support"
+              end
+            end
           end
 
           context "when the specified version does not exist" do

data/spec/lib/pact_broker/client/deployments/record_undeployment_spec.rb

@@ -174,7 +174,7 @@ module PactBroker
 
         context "when a target is provided and there is no deployed version with a matching target" do
           let(:application_instance) { "wrong" }
-          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance to undeploy from the anonymous instance or specify one of the following application instances to record the undeployment from: customer-1." }
+          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance or specify one of the following application instances to record the undeployment from: customer-1." }
 
           its(:success) { is_expected.to be false }
           its(:message) { is_expected.to include expected_message }

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/hal/link_spec.rb

@@ -5,6 +5,10 @@ require 'pact_broker/client/hal/http_client'
 module PactBroker::Client
   module Hal
     describe Link do
+      before do
+        allow(response).to receive(:header).with("Content-Type").and_return(content_type)
+      end
+
       let(:http_client) do
         instance_double('PactBroker::Client::Hal::HttpClient', post: response)
       end
@@ -33,6 +37,8 @@ module PactBroker::Client
         }
       end
 
+      let(:content_type) { nil }
+
       subject { Link.new(attrs, http_client) }
 
       before do
@@ -67,6 +73,15 @@ module PactBroker::Client
             expect(PactBroker::Client::Hal::ErrorEntity).to receive(:new).with("http://foo/{bar}", response_body.to_json, http_client, response)
             do_run
           end
+
+          context "when a JSON error is returned" do
+            let(:content_type) { "application/json" }
+
+            it "parses the response body" do
+              expect(PactBroker::Client::Hal::ErrorEntity).to receive(:new).with("http://foo/{bar}", response_body, http_client, response)
+              do_run
+            end
+          end
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.59.0
 platform: ruby
 authors:
 - Beth Skurrie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2022-03-15 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: []
@@ -319,6 +313,7 @@ files:
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
 - script/approve-all.sh
+- script/can-i-deploy.sh
 - script/create-pacticipant.sh
 - script/publish-pact.sh
 - script/record-deployment.sh
@@ -411,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
@@ -430,8 +425,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
-signing_key: 
+rubygems_version: 3.3.9
+signing_key:
 specification_version: 4
 summary: See description
 test_files: