pact_broker-client 1.32.0 → 1.37.0

data/lib/pact_broker/client.rb

@@ -1,2 +1,2 @@
 require 'pact_broker/client/version'
-require 'pact_broker/client/pact_broker_client'
+require 'pact_broker/client/pact_broker_client'

data/lib/pact_broker/client/backports.rb

@@ -0,0 +1,13 @@
+class Hash
+  def compact
+    h = {}
+    each do |key, value|
+      h[key] = value unless value == nil
+    end
+    h
+  end unless method_defined? :compact
+
+  def compact!
+    reject! {|_key, value| value == nil}
+  end unless method_defined? :compact!
+end

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

@@ -1,4 +1,5 @@
 require 'pact_broker/client/cli/custom_thor'
+require 'pact_broker/client/hash_refinements'
 require 'thor/error'
 
 module PactBroker
@@ -11,6 +12,8 @@ module PactBroker
       class VersionCreationError < ::Thor::Error; end
 
       class Broker < CustomThor
+        using PactBroker::Client::HashRefinements
+
         desc 'can-i-deploy', ''
         long_desc File.read(File.join(File.dirname(__FILE__), 'can_i_deploy_long_desc.txt'))
 
@@ -18,16 +21,13 @@ module PactBroker
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
         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, required: false, banner: 'TAG', desc: "This is too hard to explain in a short sentence. Look at the examples.", default: nil
-        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_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+        method_option :to_environment, required: false, banner: 'ENVIRONMENT', desc: "The environment into which the pacticipant(s) are to be deployed", default: nil, hide: true
         method_option :output, aliases: "-o", desc: "json or table", default: 'table'
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
         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)"
         method_option :retry_interval, banner: 'SECONDS', type: :numeric, default: 10, required: false, desc: "The time between retries in seconds. Use in conjuction with --retry-while-unknown"
         # Allow limit to be set manually until https://github.com/pact-foundation/pact_broker-client/issues/53 is fixed
         method_option :limit, hide: true
+        shared_authentication_options
 
         def can_i_deploy(*ignored_but_necessary)
           require 'pact_broker/client/cli/version_selector_options_parser'
@@ -37,20 +37,20 @@ module PactBroker
           selectors = VersionSelectorOptionsParser.call(ARGV)
           validate_can_i_deploy_selectors(selectors)
           can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval }
-          result = CanIDeploy.call(options.broker_base_url, selectors, {to_tag: options.to, limit: options.limit}, can_i_deploy_options, pact_broker_client_options)
+          result = CanIDeploy.call(options.broker_base_url, selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit }, can_i_deploy_options, pact_broker_client_options)
           $stdout.puts result.message
           exit(1) unless result.success
         end
 
         desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
         method_option :consumer_app_version, required: true, aliases: "-a", desc: "The consumer application version"
-        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_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+        method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
+        method_option :auto_detect_version_properties, hidden: true, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI."
         method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Default: false"
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+        method_option :build_url, desc: "The build URL that created the pact"
+        method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
+        shared_authentication_options
 
         def publish(*pact_files)
           require 'pact_broker/client/error'
@@ -68,11 +68,7 @@ module PactBroker
         method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
         method_option :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist. Default: false"
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch. Default: false"
-        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_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+        shared_authentication_options
 
         def create_version_tag
           require 'pact_broker/client/create_tag'
@@ -92,12 +88,8 @@ module PactBroker
         method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the version belongs to."
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version number."
         method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Describe the latest pacticipant version. Optionally specify a TAG to describe the latest version with the specified tag."
-        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_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
         method_option :output, aliases: "-o", desc: "json or table or id", default: 'table'
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+        shared_authentication_options
 
         desc 'describe-version', 'Describes a pacticipant version. If no version or tag is specified, the latest version is described.'
         def describe_version
@@ -138,7 +130,7 @@ module PactBroker
 
         desc 'test-webhook', 'Test the execution of a webhook'
         method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
-        shared_authentication_options_for_pact_broker
+        shared_authentication_options
         def test_webhook
           require 'pact_broker/client/webhooks/test'
           result = PactBroker::Client::Webhooks::Test.call(options, pact_broker_client_options)
@@ -156,7 +148,7 @@ module PactBroker
         desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
         method_option :name, type: :string, required: true, desc: "Pacticipant name"
         method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
-        shared_authentication_options_for_pact_broker
+        shared_authentication_options
         verbose_option
         def create_or_update_pacticipant(*required_but_ignored)
           raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.name.strip.size == 0
@@ -167,7 +159,7 @@ module PactBroker
         end
 
         desc 'list-latest-pact-versions', 'List the latest pact for each integration'
-        shared_authentication_options_for_pact_broker
+        shared_authentication_options
         method_option :output, aliases: "-o", desc: "json or table", default: 'table'
         def list_latest_pact_versions(*required_but_ignored)
           require 'pact_broker/client/pacts/list_latest_versions'
@@ -176,6 +168,37 @@ module PactBroker
           exit(1) unless result.success
         end
 
+        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
+
+          ignored_and_hidden_potential_options_from_environment_variables
+          desc "record-deployment", "Record deployment of a pacticipant version to an environment"
+          method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
+          method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
+          method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
+          method_option :replaced_previous_deployed_version, type: :boolean, default: true, required: false, desc: "Whether or not this deployment replaced the previous deployed version. If it did, the previous deployed version of this pacticipant will be marked as undeployed in the Pact Broker."
+          method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+          shared_authentication_options
+
+          def record_deployment
+            require 'pact_broker/client/versions/record_deployment'
+            params = {
+              pacticipant_name: options.pacticipant,
+              version_number: options.version,
+              environment_name: options.environment,
+              replaced_previous_deployed_version: options.replaced_previous_deployed_version,
+              output: options.output
+            }
+            result = PactBroker::Client::Versions::RecordDeployment.call(
+              params,
+              options.broker_base_url,
+              pact_broker_client_options
+            )
+            $stdout.puts result.message
+            exit(1) unless result.success
+          end
+
+        end
+
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'version', "Show the pact_broker-client gem version"
         def version
@@ -210,12 +233,20 @@ module PactBroker
           def publish_pacts pact_files
             require 'pact_broker/client/publish_pacts'
 
+            write_options = options[:merge] ? { write: :merge } : {}
+            consumer_version_params = {
+              number: options.consumer_app_version,
+              branch: branch,
+              tags: tags,
+              build_url: options.build_url,
+              version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
+            }.compact
+
             PactBroker::Client::PublishPacts.call(
               options.broker_base_url,
               file_list(pact_files),
-              options.consumer_app_version,
-              tags,
-              pact_broker_client_options
+              consumer_version_params,
+              pact_broker_client_options.merge(write_options)
             )
           end
 
@@ -236,10 +267,24 @@ module PactBroker
             require 'pact_broker/client/git'
 
             t = [*options.tag]
-            t << PactBroker::Client::Git.branch if options.tag_with_git_branch
+            t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
             t.compact.uniq
           end
 
+          def branch
+            require 'pact_broker/client/git'
+
+            if options.branch.nil? && options.auto_detect_version_properties
+              PactBroker::Client::Git.branch(raise_error: explict_auto_detect_version_properties)
+            else
+              options.branch
+            end
+          end
+
+          def explict_auto_detect_version_properties
+            @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
+          end
+
           def pact_broker_client_options
             client_options = { verbose: options.verbose }
             client_options[:token] =  options.broker_token if options.broker_token

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

@@ -19,17 +19,27 @@ Using a specific version is the easiest way to ensure you get an accurate respon
 
 #### Recommended usage - allowing the Pact Broker to automatically determine the dependencies
 
-Prerequisite: 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 which version of each application is 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:
+Prerequisite: 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 which version of each application is in that environment.
+
+How you do this depends on the version of the Pact Broker you are running.
+
+If you are using a Broker version where deployment versions are supported, then you would notify the Broker of the deployment of this application version like so:
+
+    $ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment test
+
+This assumes that you have already set up an environment named "test" in the Broker.
+
+If you are using a Broker version that does not support deployment environments, then you will need to use tags to notify the broker of the deployment of this application version, like so:
 
     $ pact-broker create-version-tag --pacticipant Foo --version 173153ae0 --tag test
 
-This allows you to use the following simple command to find out if you are safe to deploy:
+Once you have configured your build to notify the Pact Broker of the successful deployment using either method describe above, you can use the following simple command to find out if you are safe to deploy (use either `--to` or  `--to-environment` as supported):
 
-    $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION \
-                               --to ENVIRONMENT \
+    $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION
+                               [--to-environment ENVIRONMENT | --to ENVIRONMENT_TAG ]
                                --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.
+If the `--to` or `--to-environment` options are omitted, then the query will return the compatiblity with the overall latest version of each of the other applications.
 
 Examples:
 
@@ -38,7 +48,7 @@ Can I deploy version 173153ae0 of application Foo to the test environment?
 
 
     $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
-                               --to test \
+                               --to-environment test \
                                --broker-base-url https://my-pact-broker
 
 
@@ -56,21 +66,20 @@ Can I deploy the latest version of the application Foo that has the tag "test" t
                                --broker-base-url https://my-pact-broker
 
 
-
 #### Alternate usage - specifying 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 one or more of the dependencies explictly. You must also do this if you want to use the `--all TAG` option for any of the pacticipants.
 
 You can specify as many application versions as you like, and you can even specify multiple versions of the same application (repeat the `--pacticipant` name and supply a different version.)
 
-You can use explictly declared dependencies with or without the `--to ENVIRONMENT`. For example, if you declare two (or more) application versions with no `--to ENVIRONMENT`, then only the applications you specify will be taken into account when determining if it is safe to deploy. If you declare two (or more) application versions _as well as_ a `--to ENVIRONMENT`, then the Pact Broker will work out what integrations your declared applications will have in that environment when determining if it safe to deploy. When using this script for a production release, and you are using tags, it is always the most future-proof option to use the `--to` if possible, as it will catch any newly added consumers or providers.
+You can use explictly declared dependencies with or without the `--to ENVIRONMENT_TAG`. For example, if you declare two (or more) application versions with no `--to ENVIRONMENT_TAG`, then only the applications you specify will be taken into account when determining if it is safe to deploy. If you declare two (or more) application versions _as well as_ a `--to ENVIRONMENT`, then the Pact Broker will work out what integrations your declared applications will have in that environment when determining if it safe to deploy. When using this script for a production release, and you are using tags, it is always the most future-proof option to use the `--to` if possible, as it will catch any newly added consumers or providers.
 
 If you are finding that your dependencies are not being automatically included when you supply multiple pacticipant versions, please upgrade to the latest version of the Pact Broker, as this is a more recently added feature.
 
 
     $ pact-broker can-i-deploy --pacticipant PACTICIPANT_1 [--version VERSION_1 | --latest [TAG_1] | --all TAG_1] \
                                --pacticipant PACTICIPANT_2 [--version VERSION_2 | --latest [TAG_2] | --all TAG_2] \
-                               [--to ENVIRONMENT] \
+                               [--to-environment ENVIRONMENT | --to ENVIRONMENT_TAG] \
                                --broker-base-url BROKER_BASE_URL
 
 Examples:

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

@@ -86,6 +86,14 @@ module PactBroker
             method_option :broker_token, hide: true
           end
 
+          def self.shared_authentication_options
+            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_password, aliases: "-p", desc: "Pact Broker basic auth password"
+            method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+          end
+
           def self.shared_options_for_webhook_commands
             method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
             method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
@@ -93,24 +101,13 @@ module PactBroker
             method_option :user, aliases: "-u", desc: "Webhook 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, 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 :description, desc: "Wwebhook 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"
             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"
-            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
-          end
-
-          def self.shared_authentication_options_for_pact_broker
-            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_password, aliases: "-p", desc: "Pact Broker basic auth password"
-            method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+            shared_authentication_options
           end
 
           def self.verbose_option

data/lib/pact_broker/client/git.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/client/error'
+require 'pact_broker/client/hash_refinements'
 
 =begin
 
@@ -16,19 +17,25 @@ BITBUCKET_BRANCH BITBUCKET_COMMIT https://confluence.atlassian.com/bitbucket/var
 =end
 
 # Keep in sync with pact-provider-verifier/lib/pact/provider_verifier/git.rb
+
+# `git name-rev --name-only HEAD` provides "tags/v1.35.0^0"
 module PactBroker
   module Client
     module Git
-      COMMAND = 'git name-rev --name-only HEAD'.freeze
+      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}
 
+      BUILD_URL_ENV_VAR_NAMES = %w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
+
       def self.commit
         find_commit_from_env_vars
       end
 
-      def self.branch
-        find_branch_from_env_vars || branch_from_git_command
+      def self.branch(options)
+        find_branch_from_known_env_vars || find_branch_from_env_var_ending_with_branch || branch_from_git_command(options[:raise_error])
       end
 
       # private
@@ -37,10 +44,21 @@ module PactBroker
         COMMIT_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
       end
 
-      def self.find_branch_from_env_vars
+      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
       end
 
+      def self.find_branch_from_env_var_ending_with_branch
+        values = ENV.keys
+          .select{ |env_var_name| env_var_name.end_with?("_BRANCH") }
+          .collect{ |env_var_name| value_from_env_var(env_var_name) }.compact
+        if values.size == 1
+          values.first
+        else
+          nil
+        end
+      end
+
       def self.value_from_env_var(env_var_name)
         val = ENV[env_var_name]
         if val && val.strip.size > 0
@@ -50,24 +68,10 @@ module PactBroker
         end
       end
 
-      def self.branch_from_git_command
-        branch_names = nil
-        begin
-          branch_names = execute_git_command
-            .split("\n")
-            .collect(&:strip)
-            .reject(&:empty?)
-            .collect(&:split)
-            .collect(&:first)
-            .collect{ |line| line.gsub(/^origin\//, '') }
-            .reject{ |line| line == "HEAD" }
-
-        rescue StandardError => e
-          raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
-        end
-
-        validate_branch_names(branch_names)
-        branch_names[0]
+      def self.branch_from_git_command(raise_error)
+        branch_names = execute_and_parse_command(raise_error)
+        validate_branch_names(branch_names) if raise_error
+        branch_names.size == 1 ? branch_names[0] : nil
       end
 
       def self.validate_branch_names(branch_names)
@@ -83,6 +87,23 @@ module PactBroker
       def self.execute_git_command
         `#{COMMAND}`
       end
+
+      def self.execute_and_parse_command(raise_error)
+        execute_git_command
+          .split("\n")
+          .collect(&:strip)
+          .reject(&:empty?)
+          .collect(&:split)
+          .collect(&:first)
+          .collect{ |line| line.gsub(/^origin\//, '') }
+          .reject{ |line| line == "HEAD" }
+      rescue StandardError => e
+        if raise_error
+          raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
+        else
+          return []
+        end
+      end
     end
   end
 end

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

@@ -1,6 +1,7 @@
 require 'erb'
 require 'delegate'
 require 'pact_broker/client/hal/link'
+require 'pact_broker/client/hal/links'
 
 module PactBroker
   module Client
@@ -51,10 +52,27 @@ module PactBroker
           end
         end
 
+        def _links(key)
+          if @links[key] && @links[key].is_a?(Array)
+            link_collection = @links[key].collect do | hash |
+              Link.new(hash, @client)
+            end
+            Links.new(@href, key, link_collection)
+          elsif @links[key].is_a?(Hash)
+            Links.new(@href, key, [Link.new(@links[key], @client)])
+          else
+            nil
+          end
+        end
+
         def _link!(key)
           _link(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
         end
 
+        def _links!(key)
+          _links(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
+        end
+
         def success?
           true
         end
@@ -85,7 +103,7 @@ module PactBroker
           @data.key?(method_name) || @links.key?(method_name)
         end
 
-        def assert_success!
+        def assert_success!(_ignored = nil)
           self
         end
       end
@@ -107,8 +125,14 @@ module PactBroker
           false
         end
 
-        def assert_success!
-          raise ErrorResponseReturned.new("Error retrieving #{@href} status=#{response ? response.code: nil} #{response ? response.raw_body : ''}")
+        def assert_success!(messages = {})
+          default_message = "Error retrieving #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
+          message = if response && messages[response.status]
+            (messages[response.status] || "") + " (#{default_message})"
+          else
+            default_message
+          end
+          raise ErrorResponseReturned.new(message)
         end
       end
     end