pact_broker-client 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36bf162b7373bf5c66a1144647bc90cec11eceea
-  data.tar.gz: ac2f6395bd8882eb2711af95bb999c9dda3678cb
+  metadata.gz: e1bafd46273980e0df06f1e067e9f129aa2097c4
+  data.tar.gz: 62076387c8985fb1ec56b95833f5f118e333625f
 SHA512:
-  metadata.gz: d6f31eadfca03d30063b7377d83792f45f44e0ef71f700ae34cafbe9d0d950d21e2cf19ebd57203329a7e5306ab57fb3b22ace88e42c2142b2ed3aba1ecdecbb
-  data.tar.gz: e0fd38b680973acdca44a52935f3c2317c4e23894c8642c63fdf08ebad6e848e4120d2e6a10f7a68fee291c3c17f7808a4c40ebe07dec896ba461df01bfd5c4c
+  metadata.gz: d45c1c54457176cd83bf71212d96549899236de9cfc496de52bc17dd4d39247de7b8ae53dee0119c35ebeb7b9145bfc2d325de94bed4741d9b362d06a44562ba
+  data.tar.gz: 39587a85fa5e267de6288067fcd31d981cf71edd50084430cc82d4170b3cc5447137a8084e06bb9113cc25aba08e404aae5417cdbc3c61f7650ac27e0afff34a

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 2.2.4
   - 2.3.1
-  - 2.4.1
+  - 2.4.1

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+<a name="v1.21.0"></a>
+### v1.21.0 (2020-01-16)
+
+
+#### Features
+
+* attempt to get git branch name from environment variable first before running git	 ([122973b](/../../commit/122973b))
+
+
+#### Bug Fixes
+
+* **can-i-deploy**
+  * if only one selector is specified and no --to TAG is specified, set latest=true for automatically calculated dependencies	 ([ec10b72](/../../commit/ec10b72))
+
+* remove -u alias for --broker-username for create-webhook as it clashes with the -u from the curl command	 ([9463eff](/../../commit/9463eff))
+* Fix invalid environment variable names in can-i-deploy docs	 ([2b26081](/../../commit/2b26081))
+
+
 <a name="v1.20.0"></a>
 ### v1.20.0 (2019-08-27)
 

data/README.md

@@ -59,7 +59,7 @@ Add a tag to a pacticipant version
 
 ### can-i-deploy
 
-You will need >= v2.13.0 of the Pact Broker for this feature to work.
+You will need >= v2.13.0 of the Pact Broker for this feature to work. See the [Can I Deploy](https://docs.pact.io/pact_broker/can_i_deploy) page in the Pact docs for an explanation of how `can-i-deploy` works under the hood.
 
 ```
 Usage:
@@ -88,65 +88,92 @@ Description:
 
   The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_BASE_URL_USERNAME and PACT_BROKER_BASE_URL_PASSWORD may be used
   instead of their respective command line options.
+```
 
-  SCENARIOS
+Returns exit code 0 or 1, indicating whether or not the specified application (pacticipant) versions are compatible (ie. safe to deploy). Prints out the relevant pact/verification details, indicating any missing or failed verification results.
 
-  # If every build goes straight to production
+The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD may be used instead of their respective command line options.
 
-  Check the status of the pacts for a pacticipant version. Note that this only checks that the most recent verification for each
-  pact is successful. It doesn't provide any assurance that the pact has been verified by the *production* version of the
-  provider, however, it is sufficient if you are doing true continuous deployment.
+There are two ways to use `can-i-deploy`. The first (recommended and most common) approach is to specify just the application version you want to deploy and let the Pact Broker work out the dependencies for you. The second approach is to specify each application version explicitly. This would generally only be used if there were limitations that stopped you being able to use the first approach.
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --broker-base-url BROKER_BASE_URL
+#### Specifying an application version
 
-  # If every build does NOT go straight to production
+To specify an application (pacticipant) version you need to provide:
 
-  ## Recommended approach
+* the name of the application using the `--pacticipant PACTICIPANT` parameter,
+* directly followed by *one* of the following parameters:
+    * `--version VERSION` to specify a known application version (recommended)
+    * `--latest` to specify the latest version
+    * `--latest TAG` to specify the latest version that has a particular tag
 
-  If all applications within the pact network are not being deployed continuously (ie. if there is a gap between pact
-  verification and actual deployment) then the following strategy is recommended. Each application version should be tagged in
-  the broker with the name of the stage (eg. test, staging, production) as it is deployed (see the pact-broker create-version-tag
-  CLI). This enables you to use the following very simple command to check if the application version you are about to deploy is
-  compatible with every other application version already deployed in that environment.
+Using a specific version is the easiest way to ensure you get an accurate response that won't be affected by race conditions.
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to TAG --broker-base-url BROKER_BASE_URL
+#### Recommended usage - allowing the Pact Broker to automatically determine the dependencies
 
-  ## Other approaches
+If you would like the Pact Broker to calculate the dependencies for you when you want to deploy an application into a given environment, you will need to let the Broker know what application versions are in that environment. To do this, the relevant application version resource in the Broker will need to be "tagged" with the name of the environment during the deployment process:
 
-  If you do not/cannot tag every application at deployment, you have two options. You can either use the very first form of this
-  command which just checks that the *latest* verification is successful (not recommended as it's the production version that you
-  really care about) or you will need to determine the production versions of each collaborating application from some other
-  source (eg. git) and explicitly reference each one using one using the format `--pacticipant PACTICIPANT1 --version VERSION1
-  --pacticipant PACTICIPANT2 --version VERSION2 ...`
+    $ pact-broker create-version-tag --pacticipant Foo --version 173153ae0 --tag test
 
-  # Other commands
+This allows you to use the following simple command to find out if you are safe to deploy:
 
-  Check the status of the pacts for the latest pacticipant version. This form is not recommended for use in your CI as it is
-  possible that the version you are about to deploy is not the the version that the Broker considers the latest. It's best to
-  specify the version explicitly.
+    $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION \
+                               --to ENVIRONMENT \
+                               --broker-base-url BROKER_BASE_URL
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --latest --broker-base-url BROKER_BASE_URL
+If the `--to` tag is omitted, then the query will return the compatiblity with the overall latest version of each of the other applications.
 
-  Check the status of the pacts for the latest pacticipant version for a given tag:
+Examples:
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --latest TAG --broker-base-url BROKER_BASE_URL
 
-  Check the status of the pacts between two (or more) specific pacticipant versions:
+Can I deploy version 173153ae0 of application Foo to the test environment?
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT1 --version VERSION1 --pacticipant PACTICIPANT2 --version VERSION2
-  --broker-base-url BROKER_BASE_URL
 
-  Check the status of the pacts between the latest versions of two (or more) pacticipants:
+    $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
+                               --to test \
+                               --broker-base-url https://my-pact-broker
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT1 --latest --pacticipant PACTICIPANT2 --latest --broker-base-url
-  BROKER_BASE_URL
 
-  Check the status of the pacts between the latest versions of two (or more) pacticipants with a given tag:
+Can I deploy the latest version of application Foo with the latest version of each of the applications it integrates to?
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT1 --latest TAG1 --pacticipant PACTICIPANT2 --latest TAG2 --broker-base-url
-  BROKER_BASE_URL
 
-```
+    $ pact-broker can-i-deploy --pacticipant Foo --latest \
+                               --broker-base-url https://my-pact-broker
+
+
+Can I deploy the latest version of the application Foo that has the tag "test" to the "prod" environment?
+
+    $ pact-broker can-i-deploy --pacticipant Foo --latest test \
+                               --to prod \
+                               --broker-base-url https://my-pact-broker
+
+
+
+#### Alternate usage - specifying all dependencies explicitly
+
+If you are unable to use tags, or there is some other limitation that stops you from using the recommended approach, you can specify each of the application versions explictly. You can specify as many application versions as you like.
+
+    $ pact-broker can-i-deploy --pacticipant PACTICIPANT_1 [--version VERSION_1 | --latest [TAG]] \
+                               --pacticipant PACTICIPANT_2 [--version VERSION_2 | --latest [TAG_2]] \
+                               --to ENVIRONMENT \
+                               --broker-base-url BROKER_BASE_URL
+
+Examples:
+
+
+Can I deploy version Foo version 173153ae0 and Bar version ac23df1e8 together?
+
+
+    $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
+                               --pacticipant Bar --version ac23df1e8 \
+                               --broker-base-url BROKER_BASE_URL
+
+
+Can I deploy the latest version of Foo with tag "master" and the latest version of Bar with tag "master" together?
+
+    $ pact-broker can-i-deploy --pacticipant Foo --latest master \
+                               --pacticipant Bar --latest master \
+                               --broker-base-url BROKER_BASE_URL
+
 
 ### create-webhook
 

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -434,7 +434,7 @@ Given **the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 an
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp"
+  "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp&latest=true"
 }
 ```
 Pact Broker will respond with:

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

@@ -109,14 +109,14 @@ module PactBroker
           exit(1) unless result.success
         end
 
-        method_option :request, aliases: "-X", desc: "HTTP method", required: true
+        method_option :request, banner: "METHOD", aliases: "-X", desc: "HTTP method", required: true
         method_option :header, aliases: "-H", type: :array, desc: "Header"
         method_option :data, aliases: "-d", desc: "Data"
         method_option :user, aliases: "-u", desc: "Basic auth username and password eg. username:password"
         method_option :consumer, desc: "Consumer name"
         method_option :provider, desc: "Provider name"
         method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
+        method_option :broker_username, desc: "Pact Broker basic auth username"
         method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
         method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
         method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"

data/lib/pact_broker/client/cli/can_i_deploy_long_desc.txt

@@ -1,45 +1,84 @@
-Returns exit code 0 or 1, indicating whether or not the specified pacticipant versions are compatible. Prints out the relevant pact/verification details.
+Returns exit code 0 or 1, indicating whether or not the specified application (pacticipant) versions are compatible (ie. safe to deploy). Prints out the relevant pact/verification details, indicating any missing or failed verification results.
 
-The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_BASE_URL_USERNAME and PACT_BROKER_BASE_URL_PASSWORD may be used instead of their respective command line options.
+The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD may be used instead of their respective command line options.
 
-SCENARIOS
+There are two ways to use `can-i-deploy`. The first (recommended and most common) approach is to specify just the application version you want to deploy and let the Pact Broker work out the dependencies for you. The second approach is to specify each application version explicitly. This would generally only be used if there were limitations that stopped you being able to use the first approach.
 
-# If every build goes straight to production
+#### Specifying an application version
 
-Check the status of the pacts for a pacticipant version. Note that this only checks that the most recent verification for each pact is successful. It doesn't provide any assurance that the pact has been verified by the *production* version of the provider, however, it is sufficient if you are doing true continuous deployment.
+To specify an application (pacticipant) version you need to provide:
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --broker-base-url BROKER_BASE_URL
+* the name of the application using the `--pacticipant PACTICIPANT` parameter,
+* directly followed by *one* of the following parameters:
+    * `--version VERSION` to specify a known application version (recommended)
+    * `--latest` to specify the latest version
+    * `--latest TAG` to specify the latest version that has a particular tag
 
-# If every build does NOT go straight to production
+Using a specific version is the easiest way to ensure you get an accurate response that won't be affected by race conditions.
 
-## Recommended approach
+#### Recommended usage - allowing the Pact Broker to automatically determine the dependencies
 
-If all applications within the pact network are not being deployed continuously (ie. if there is a gap between pact verification and actual deployment) then the following strategy is recommended. Each application version should be tagged in the broker with the name of the stage (eg. test, staging, production) as it is deployed (see the pact-broker create-version-tag CLI). This enables you to use the following very simple command to check if the application version you are about to deploy is compatible with every other application version already deployed in that environment.
+If you would like the Pact Broker to calculate the dependencies for you when you want to deploy an application into a given environment, you will need to let the Broker know what application versions are in that environment. To do this, the relevant application version resource in the Broker will need to be "tagged" with the name of the environment during the deployment process:
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to TAG --broker-base-url BROKER_BASE_URL
+    $ pact-broker create-version-tag --pacticipant Foo --version 173153ae0 --tag test
 
-## Other approaches
+This allows you to use the following simple command to find out if you are safe to deploy:
 
-If you do not/cannot tag every application at deployment, you have two options. You can either use the very first form of this command which just checks that the *latest* verification is successful (not recommended as it's the production version that you really care about) or you will need to determine the production versions of each collaborating application from some other source (eg. git) and explicitly reference each one using one using the format `--pacticipant PACTICIPANT1 --version VERSION1 --pacticipant PACTICIPANT2 --version VERSION2 ...`
+    $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION \
+                               --to ENVIRONMENT \
+                               --broker-base-url BROKER_BASE_URL
 
-# Other commands
+If the `--to` tag is omitted, then the query will return the compatiblity with the overall latest version of each of the other applications.
 
-Check the status of the pacts for the latest pacticipant version. This form is not recommended for use in your CI as it is possible that the version you are about to deploy is not the the version that the Broker considers the latest. It's best to specify the version explicitly.
+Examples:
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --latest --broker-base-url BROKER_BASE_URL
 
-Check the status of the pacts for the latest pacticipant version for a given tag:
+Can I deploy version 173153ae0 of application Foo to the test environment?
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --latest TAG --broker-base-url BROKER_BASE_URL
 
-Check the status of the pacts between two (or more) specific pacticipant versions:
+    $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
+                               --to test \
+                               --broker-base-url https://my-pact-broker
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT1 --version VERSION1 --pacticipant PACTICIPANT2 --version VERSION2 --broker-base-url BROKER_BASE_URL
 
-Check the status of the pacts between the latest versions of two (or more) pacticipants:
+Can I deploy the latest version of application Foo with the latest version of each of the applications it integrates to?
 
-  $ pact-broker can-i-deploy --pacticipant PACTICIPANT1 --latest --pacticipant PACTICIPANT2 --latest --broker-base-url BROKER_BASE_URL
 
-Check the status of the pacts between the latest versions of two (or more) pacticipants with a given tag:
+    $ pact-broker can-i-deploy --pacticipant Foo --latest \
+                               --broker-base-url https://my-pact-broker
+
+
+Can I deploy the latest version of the application Foo that has the tag "test" to the "prod" environment?
+
+    $ pact-broker can-i-deploy --pacticipant Foo --latest test \
+                               --to prod \
+                               --broker-base-url https://my-pact-broker
+
+
+
+#### Alternate usage - specifying all dependencies explicitly
+
+If you are unable to use tags, or there is some other limitation that stops you from using the recommended approach, you can specify each of the application versions explictly. You can specify as many application versions as you like.
+
+    $ pact-broker can-i-deploy --pacticipant PACTICIPANT_1 [--version VERSION_1 | --latest [TAG]] \
+                               --pacticipant PACTICIPANT_2 [--version VERSION_2 | --latest [TAG_2]] \
+                               --to ENVIRONMENT \
+                               --broker-base-url BROKER_BASE_URL
+
+Examples:
+
+
+Can I deploy version Foo version 173153ae0 and Bar version ac23df1e8 together?
+
+
+    $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
+                               --pacticipant Bar --version ac23df1e8 \
+                               --broker-base-url BROKER_BASE_URL
+
+
+Can I deploy the latest version of Foo with tag "master" and the latest version of Bar with tag "master" together?
+
+    $ pact-broker can-i-deploy --pacticipant Foo --latest master \
+                               --pacticipant Bar --latest master \
+                               --broker-base-url BROKER_BASE_URL
 
-$ pact-broker can-i-deploy --pacticipant PACTICIPANT1 --latest TAG1 --pacticipant PACTICIPANT2 --latest TAG2 --broker-base-url BROKER_BASE_URL

data/lib/pact_broker/client/git.rb

@@ -1,22 +1,69 @@
 require 'pact_broker/client/error'
 
- # BUILDKITE_BRANCH BUILDKITE_COMMIT https://buildkite.com/docs/pipelines/environment-variables
- # CIRCLE_BRANCH CIRCLE_SHA1 https://circleci.com/docs/2.0/env-vars/
- # TRAVIS_COMMIT TRAVIS_BRANCH - TRAVIS_PULL_REQUEST_BRANCH TRAVIS_PULL_REQUEST_SHA https://docs.travis-ci.com/user/environment-variables/
- # GIT_COMMIT GIT_BRANCH https://wiki.jenkins.io/display/JENKINS/Building+a+software+project
- # GIT_COMMIT GIT_LOCAL_BRANCH https://hudson.eclipse.org/webtools/env-vars.html/
- # APPVEYOR_REPO_COMMIT APPVEYOR_REPO_BRANCH       https://www.appveyor.com/docs/environment-variables/
- # bamboo.repository.git.branch https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
+=begin
 
+BUILDKITE_BRANCH BUILDKITE_COMMIT https://buildkite.com/docs/pipelines/environment-variables
+CIRCLE_BRANCH CIRCLE_SHA1 https://circleci.com/docs/2.0/env-vars/
+TRAVIS_COMMIT TRAVIS_BRANCH - TRAVIS_PULL_REQUEST_BRANCH TRAVIS_PULL_REQUEST_SHA https://docs.travis-ci.com/user/environment-variables/
+GIT_COMMIT GIT_BRANCH https://wiki.jenkins.io/display/JENKINS/Building+a+software+project
+GIT_COMMIT GIT_LOCAL_BRANCH https://hudson.eclipse.org/webtools/env-vars.html/
+APPVEYOR_REPO_COMMIT APPVEYOR_REPO_BRANCH       https://www.appveyor.com/docs/environment-variables/
+CI_COMMIT_REF_NAME https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
+CI_BRANCH CI_COMMIT_ID https://documentation.codeship.com/pro/builds-and-configuration/environment-variables/
+bamboo.repository.git.branch https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
+
+=end
+
+# Keep in sync with pact-provider-verifier/lib/pact/provider_verifier/git.rb
 module PactBroker
   module Client
     module Git
-      COMMAND = 'git rev-parse --abbrev-ref HEAD'
+      COMMAND = 'git name-rev --name-only HEAD'.freeze
+      BRANCH_ENV_VAR_NAMES = %w{BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME}.freeze
 
       def self.branch
-        `#{COMMAND}`.strip
-      rescue StandardError => e
-        raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
+        find_branch_from_env_vars || branch_from_git_command
+      end
+
+      # private
+
+      def self.find_branch_from_env_vars
+        BRANCH_ENV_VAR_NAMES.collect { |env_var_name| branch_from_env_var(env_var_name) }.compact.first
+      end
+
+      def self.branch_from_env_var(env_var_name)
+        val = ENV[env_var_name]
+        if val && val.strip.size > 0
+          val
+        else
+          nil
+        end
+      end
+
+      def self.branch_from_git_command
+        branch_name = nil
+        begin
+          branch_name = execute_git_command.strip
+        rescue StandardError => e
+          raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
+        end
+
+        validate_branch_name(branch_name)
+        branch_name
+      end
+
+      def self.validate_branch_name(branch_name)
+        if !branch_name || branch_name.size == 0
+          raise PactBroker::Client::Error, "Command `#{COMMAND}` returned an empty string when trying to determine the git branch name. This is most likely not the value you want. You will need to get the branch name another way."
+        end
+
+        if branch_name == "HEAD"
+          raise PactBroker::Client::Error, "Command `#{COMMAND}` returned 'HEAD' when trying to determine the git branch name. This is probably because the repository is in detatched HEAD state. HEAD is most likely not the value you want. You will need to get the branch name another way."
+        end
+      end
+
+      def self.execute_git_command
+        `#{COMMAND}`
       end
     end
   end

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

@@ -41,6 +41,10 @@ module PactBroker
           wrap_response(href, @http_client.get(href, payload, headers))
         end
 
+        def get!(*args)
+          get(*args).assert_success!
+        end
+
         def put(payload = nil, headers = {})
           wrap_response(href, @http_client.put(href, payload ? JSON.dump(payload) : nil, headers))
         end

data/lib/pact_broker/client/matrix.rb

@@ -9,7 +9,7 @@ module PactBroker
         query = {
           q: convert_selector_hashes_to_params(selectors),
           latestby: latestby
-        }.merge(query_options(options))
+        }.merge(query_options(options, selectors))
         response = self.class.get("/matrix", query: query, headers: default_get_headers)
         response = handle_response(response) do
           Matrix::Resource.new(JSON.parse(response.body, symbolize_names: true))
@@ -41,7 +41,7 @@ module PactBroker
         end
       end
 
-      def query_options(options)
+      def query_options(options, selectors)
         opts = {}
         if options.key?(:success)
           opts[:success] = [*options[:success]]
@@ -50,6 +50,8 @@ module PactBroker
         if options[:to_tag]
           opts[:latest] = 'true'
           opts[:tag] = options[:to_tag]
+        elsif selectors.size == 1
+          opts[:latest] = 'true'
         end
         opts
       end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.20.0'
+    VERSION = '1.21.0'
   end
 end

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

@@ -41,7 +41,7 @@ module PactBroker
         end
 
         def create_webhook_with_optional_consumer_and_provider
-          webhook_entity = index_link.get._link("pb:webhooks").post(request_body_with_optional_consumer_and_provider)
+          webhook_entity = index_link.get!._link("pb:webhooks").post(request_body_with_optional_consumer_and_provider)
 
           if webhook_entity.response.status == 405
             raise PactBroker::Client::Error.new(WEBHOOKS_WITH_OPTIONAL_PACTICICPANTS_NOT_SUPPORTED)

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

@@ -0,0 +1,65 @@
+require 'pact_broker/client/git'
+
+module PactBroker
+  module Client
+    module Git
+      describe ".branch" do
+        before do
+          allow(ENV).to receive(:[]).and_call_original
+          Git::BRANCH_ENV_VAR_NAMES.each do | env_var_name |
+            allow(ENV).to receive(:[]).with(env_var_name).and_return(nil)
+          end
+        end
+
+        subject { Git.branch }
+
+        context "when there is a known environment variable for the branch" do
+          before do
+            allow(ENV).to receive(:[]).with("BUILDKITE_BRANCH").and_return("")
+            allow(ENV).to receive(:[]).with("TRAVIS_BRANCH").and_return("foo")
+          end
+
+          it "returns the value of the environment variable" do
+            expect(subject).to eq "foo"
+          end
+        end
+
+        context "when there is no known environment variable for the branch" do
+          it "attempts to execute a git command to determine the value" do
+            expect { subject }.to_not raise_error
+          end
+        end
+
+        context "when the git branch name comes back as HEAD" do
+          before do
+            allow(Git).to receive(:execute_git_command).and_return("HEAD")
+          end
+
+          it "raises an error" do
+            expect { subject }.to raise_error PactBroker::Client::Error, /returned 'HEAD'/
+          end
+        end
+
+        context "when the git branch name comes back as an empty string" do
+          before do
+            allow(Git).to receive(:execute_git_command).and_return("")
+          end
+
+          it "raises an error" do
+            expect { subject }.to raise_error PactBroker::Client::Error, /an empty string/
+          end
+        end
+
+        context "when there is an error executing the git command" do
+          before do
+            allow(Git).to receive(:execute_git_command).and_raise("some error")
+          end
+
+          it "raises an error" do
+            expect { subject }.to raise_error PactBroker::Client::Error, /some error/
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -292,7 +292,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp"
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp&latest=true"
       },
       "response": {
         "status": 200,

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -67,7 +67,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp"
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp&latest=true"
             ).
             will_respond_with(
               status: 200,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -248,6 +248,7 @@ files:
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/git_spec.rb
 - spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
 - spec/lib/pact_broker/client/hal/http_client_spec.rb
@@ -308,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: See description
@@ -322,6 +323,7 @@ test_files:
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/git_spec.rb
 - spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
 - spec/lib/pact_broker/client/hal/http_client_spec.rb