pact_broker-client 1.53.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6662ad835f144252e2a6fd78f98e52b381794629dcbfb8085fa1acb0b28ece0
-  data.tar.gz: b0ec70c258bb01ae05801070596dbb02fe23a8f674d2bab53117c40b75a6d59f
+  metadata.gz: 2d919435a18e3fdcfa55f3c4e75194c950e027924b2fb274a88bb78ce04035be
+  data.tar.gz: b80790889dde8ee96a98d48b8558608ca0f240da15ece8d57cdc15d646317d42
 SHA512:
-  metadata.gz: 0f20176d5773873c3cd9a41711a7d4405721f95017132702e6be84430a63baef7101aefcb2b43e05546536d974306c7677b529bd8c2d6e32701432de67e0fe44
-  data.tar.gz: b4fc4fa3bd5096b5281d98478cc59d8732a31c29ec7f959922c064193135fd613740220230449e2c5ea3b98611f555b372545549fd22fb52050cc7710a582023
+  metadata.gz: 9c36cfba633f104712099c648e8ef1ccf58dfd1e3025fc44719cdaf6b3e4b47af0ba27af0da7d01074ffc8f6c01cbc4e3e0195b5d95f18e5e960bbac038c6370
+  data.tar.gz: 33526cff8acc17cd129b2521127f4abc3f73eac56b4f1c3e832fe0fb3583bdbe3a1917ae2ac9ec8796414584ad97777e89f163c5732ac5f5f4a879a6c4955be3

data/.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
       - run: |
           rm -rf spec/pacts/*
           bundle exec rspec spec/service_providers/
-          bundle exec rake pact:publish:pactflow
+          VERBOSE=true bundle exec rake pact:publish:pactflow
         env:
           PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}
           PACT_BROKER_FEATURES: ${{ matrix.feature }}

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+<a name="v1.57.0"></a>
+### v1.57.0 (2021-11-05)
+
+#### Features
+
+* support the --branch option in the version selectors for can-i-deploy	 ([dba8ec4](/../../commit/dba8ec4))
+* show more helpful error message if pb:environments not available for pactflow	 ([1bf38e3](/../../commit/1bf38e3))
+* print out notices if returned from publish pacts request	 ([86caf7e](/../../commit/86caf7e))
+
+<a name="v1.56.0"></a>
+### v1.56.0 (2021-10-06)
+
+#### Features
+
+* add pacticipant label options to webhook create/update commands (#96)	 ([710293f](/../../commit/710293f))
+
+<a name="v1.55.0"></a>
+### v1.55.0 (2021-10-03)
+
+#### Features
+
+* support Github Actions environment variables for --tag-with-git-branch	 ([2b8dac5](/../../commit/2b8dac5))
+
+<a name="v1.54.0"></a>
+### v1.54.0 (2021-10-01)
+
+#### Features
+
+* disable SSL verification for HAL client and HTTParty client when environment variable PACT_DISABLE_SSL_VERIFICATION=true	 ([470aafa](/../../commit/470aafa))
+* support setting the --main-branch for a pacticipant	 ([1f18e70](/../../commit/1f18e70))
+
 <a name="v1.53.0"></a>
 ### v1.53.0 (2021-09-29)
 

data/README.md

@@ -517,6 +517,8 @@ Options:
               # Pacticipant name
       [--display-name=DISPLAY_NAME]        
               # Display name
+      [--main-branch=MAIN_BRANCH]          
+              # The main development branch of the pacticipant repository
       [--repository-url=REPOSITORY_URL]    
               # The repository URL of the pacticipant
   -o, [--output=OUTPUT]                    
@@ -605,8 +607,12 @@ Options:
               # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]                                                        
               # Consumer name
+      [--consumer-label=CONSUMER_LABEL]                                                        
+              # Consumer label
       [--provider=PROVIDER]                                                        
               # Provider name
+      [--provider-label=PROVIDER_LABEL]                                                        
+              # Provider label
       [--description=DESCRIPTION]                                                  
               # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]                
@@ -661,8 +667,12 @@ Options:
               # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]                                                        
               # Consumer name
+      [--consumer-label=CONSUMER_LABEL]                                                        
+              # Consumer label
       [--provider=PROVIDER]                                                        
               # Provider name
+      [--provider-label=PROVIDER_LABEL]                                                        
+              # Provider label
       [--description=DESCRIPTION]                                                  
               # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]                
@@ -827,11 +837,13 @@ require 'pact_broker/client/tasks'
 
 PactBroker::Client::PublicationTask.new do | task |
   require 'my_consumer/version'
-  task.consumer_version = MyConsumer::VERSION
+  task.consumer_version = ENV["GIT_COMMIT"]
   task.pattern = 'custom/path/to/pacts/*.json' # optional, default value is 'spec/pacts/*.json'
   task.pact_broker_base_url = "http://pact-broker"
-  task.tag_with_git_branch = true|false # Optional but STRONGLY RECOMMENDED as it will greatly assist with your pact workflow. Result will be merged with other specified task.tags
+  task.branch = ENV["GIT_BRANCH"] # Optional but STRONGLY RECOMMENDED.
+  task.tag_with_git_branch = true|false # Superseeded by the `branch` property
   task.tags = ["dev"] # optional
+  task.build_url = ENV["CI_BUILD_URL"]
   task.pact_broker_basic_auth =  { username: 'basic_auth_user', password: 'basic_auth_pass'} # optional
   task.pact_broker_token = "1234abcd" # Bearer token
   task.write_method = :merge # optional, this will merge the published pact into an existing pact rather than overwriting it if one exists. Not recommended, as it makes a mulch of the workflow on the broker.

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

@@ -64,10 +64,14 @@
 
 * [A request to create a webhook with a JSON body for a consumer and provider](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_and_provider_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
+* [A request to create a webhook with a JSON body for a consumer specified by a label](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_specified_by_a_label)
+
 * [A request to create a webhook with a JSON body for a consumer that does not exist](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_that_does_not_exist)
 
 * [A request to create a webhook with a JSON body for a provider](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_provider_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
+* [A request to create a webhook with a JSON body for a provider specified by a label](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_provider_specified_by_a_label)
+
 * [A request to create a webhook with a non-JSON body for a consumer and provider](#a_request_to_create_a_webhook_with_a_non-JSON_body_for_a_consumer_and_provider_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
 * [A request to create a webhook with every possible event type](#a_request_to_create_a_webhook_with_every_possible_event_type_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
@@ -1089,6 +1093,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1222,6 +1236,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1276,6 +1300,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1327,6 +1361,80 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_specified_by_a_label"></a>
+Upon receiving **a request to create a webhook with a JSON body for a consumer specified by a label** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      },
+      "username": "username",
+      "password": "password"
+    },
+    "consumer": {
+      "label": "consumer_label"
+    }
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1433,6 +1541,80 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_with_a_JSON_body_for_a_provider_specified_by_a_label"></a>
+Upon receiving **a request to create a webhook with a JSON body for a provider specified by a label** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      },
+      "username": "username",
+      "password": "password"
+    },
+    "provider": {
+      "label": "provider_label"
+    }
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1482,6 +1664,14 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": "<xml></xml>"
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1545,6 +1735,28 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      },
+      {
+        "name": "contract_published"
+      },
+      {
+        "name": "provider_verification_published"
+      },
+      {
+        "name": "provider_verification_succeeded"
+      },
+      {
+        "name": "provider_verification_failed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -2550,6 +2762,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",

data/lib/pact_broker/client/base_client.rb

@@ -54,6 +54,8 @@ module PactBroker
         self.class.headers('Authorization' => "Bearer #{client_options[:token]}") if client_options[:token]
         self.class.ssl_ca_file(ENV['SSL_CERT_FILE']) if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
         self.class.ssl_ca_path(ENV['SSL_CERT_DIR']) if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+        @default_options = {}
+        @default_options[:verify] = false if (ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true')
       end
 
       def default_request_headers
@@ -102,15 +104,15 @@ module PactBroker
       end
 
       def patch url, options
-        self.class.patch(url, options.merge(body: options[:body].to_json))
+        self.class.patch(url, @default_options.merge(options.merge(body: options[:body].to_json)))
       end
 
-      def put url, *args
-        self.class.put(url, *args)
+      def put url, options = {}, &block
+        self.class.put(url, @default_options.merge(options), &block)
       end
 
-      def get url, *args
-        self.class.get(url, *args)
+      def get url, options = {}, &block
+        self.class.get(url, @default_options.merge(options), &block)
       end
 
       def url_for_relation relation_name, params

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/pacticipant_commands.rb

@@ -2,13 +2,14 @@ module PactBroker
   module Client
     module CLI
       module PacticipantCommands
-        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :repository_url]
+        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :main_branch, :repository_url]
 
         def self.included(thor)
           thor.class_eval do
             desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
             method_option :name, type: :string, required: true, desc: "Pacticipant name"
             method_option :display_name, type: :string, desc: "Display name"
+            method_option :main_branch, type: :string, required: false, desc: "The main development branch of the pacticipant repository"
             method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
             output_option_json_or_text
             shared_authentication_options

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

@@ -15,7 +15,9 @@ module PactBroker
                 method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
                 method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
                 method_option :consumer, desc: "Consumer name"
+                method_option :consumer_label, desc: "Consumer label, mutually exclusive with consumer name"
                 method_option :provider, desc: "Provider name"
+                method_option :provider_label, desc: "Provider label, mutually exclusive with provider name"
                 method_option :description, desc: "Webhook description"
                 method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
                 method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
@@ -70,6 +72,7 @@ module PactBroker
               end
 
               def parse_webhook_options(webhook_url)
+                validate_mutual_exclusiveness_of_participant_name_and_label_options
                 events = parse_webhook_events
 
                 # TODO update for contract_requiring_verification_published when released
@@ -102,7 +105,9 @@ module PactBroker
                   password: password,
                   body: body,
                   consumer: options.consumer,
+                  consumer_label: options.consumer_label,
                   provider: options.provider,
+                  provider_label: options.provider_label,
                   events: events,
                   team_uuid: options.team_uuid
                 }
@@ -118,10 +123,20 @@ module PactBroker
               rescue PactBroker::Client::Error => e
                 raise WebhookCreationError, "#{e.class} - #{e.message}"
               end
+
+              def validate_mutual_exclusiveness_of_participant_name_and_label_options
+                if options.consumer && options.consumer_label
+                  raise WebhookCreationError.new("Consumer name (--consumer) and label (--consumer_label) options are mutually exclusive")
+                end
+
+                if options.provider && options.provider_label
+                  raise WebhookCreationError.new("Provider name (--provider) and label (--provider_label) options are mutually exclusive")
+                end
+              end
             end
           end
         end
       end
     end
   end
-end
+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
 
@@ -39,7 +40,7 @@ module PactBroker
           @existing_environment_params ||= existing_environment_resource!
             .response
             .body
-            .except("uuid", "_links", "createdAt", "updatedAt")
+            .except("uuid", "_links", "_embedded", "createdAt", "updatedAt")
         end
 
         def contacts
@@ -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,9 +25,8 @@ module PactBroker
       using PactBroker::Client::HashRefinements
 
       COMMAND = 'git rev-parse --abbrev-ref 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 BITBUCKET_BRANCH}.freeze
-      COMMIT_ENV_VAR_NAMES = %w{BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}
-
+      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
+      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 }
 
       def self.commit
@@ -38,6 +37,10 @@ module PactBroker
         find_branch_from_known_env_vars || find_branch_from_env_var_ending_with_branch || branch_from_git_command(options[:raise_error])
       end
 
+      def self.build_url
+        github_build_url || BUILD_URL_ENV_VAR_NAMES.collect{ | name | value_from_env_var(name) }.compact.first
+      end
+
       # private
 
       def self.find_commit_from_env_vars
@@ -45,7 +48,8 @@ module PactBroker
       end
 
       def self.find_branch_from_known_env_vars
-        BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
+        val = BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
+        val.gsub(%r{^refs/heads/}, "") if val
       end
 
       def self.find_branch_from_env_var_ending_with_branch
@@ -104,6 +108,13 @@ module PactBroker
           return []
         end
       end
+
+      def self.github_build_url
+        parts = %w{GITHUB_SERVER_URL GITHUB_REPOSITORY GITHUB_RUN_ID}.collect{ | name | value_from_env_var(name) }
+        if parts.all?
+          [parts[0], parts[1], "actions", "runs", parts[2]].join("/")
+        end
+      end
     end
   end
 end

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

@@ -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