pact_broker-client 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e145049914705be5d6fbf40b0c558fa03b1f721
-  data.tar.gz: 1af03d94ccc879a70f04297a8d2e3fe41878c446
+  metadata.gz: 66e0409305fdcec099daca823e1cb127ef56081d
+  data.tar.gz: 810b2cd5e4f581e229104fb30cf9fddaf1387aa6
 SHA512:
-  metadata.gz: cf7f69734f2cc5195ab2b9ad04647ef10a8d841488132fc327db0bc363076dee6ed6b2e97a7a78930e59f72fc270c62a4588387692a5b84ab6625f54b9871db4
-  data.tar.gz: 96760c522ae3663b570d53537bb0af321bd9d24cf74c945cb7a7cc96118b076e44434e09ff175b5fffef45c1f9a58896ea69a468ac5330778c6c7b98d0310015
+  metadata.gz: c5d6208dedba22ebcbd587bf593d3ca626c54d60d3f3e0a5b3fc23c2d02b6d282e416ae024fdbad77ab1a0915602f3d715fb6ad04b59bcd17c579a249be47de2
+  data.tar.gz: 4b37910c9a784962d4f9e054d0308e13227f7a267e60c8e64f8803faf6a71cb7a1d215a4eb7b35300fef35f6437dcd229bc991af636e6e7cb1de2a89051b5639

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+<a name="v1.12.0"></a>
+### v1.12.0 (2017-11-06)
+
+
+#### Features
+
+* **publish**
+  * expose tag_with_git_branch in rake publication task	 ([f28d9ad](/../../commit/f28d9ad))
+
+* **can-i-deploy**
+  * shorten header names in text output	 ([89d5a04](/../../commit/89d5a04))
+  * support invocation with only one pacticipant/version provided	 ([3d799cc](/../../commit/3d799cc))
+
+
 <a name="v1.11.0"></a>
 ### v1.11.0 (2017-11-01)
 

data/README.md

@@ -1,12 +1,106 @@
 # Pact Broker Client
 
-A client for the Pact Broker. Publishes pacts to, and retrieves pacts from, the pact broker.
+A client for the Pact Broker. Publishes pacts to, and retrieves pacts from, the pact broker. The functionality is available via a CLI, or via Ruby configuration code.
 
 [![Build Status](https://travis-ci.org/pact-foundation/pact_broker-client.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker-client)
 
-## Usage
+## Usage - CLI
 
-You will need an instance of a [Pact Broker](https://github.com/pact-foundation/pact_broker). It's URL will be used below in the configuration for the Consumer and the Provider. eg. http://pact-broker.my.org
+### publish
+
+```
+Usage:
+  pact-broker publish PACT_DIRS_OR_FILES ... -a, --consumer-app-version=CONSUMER_APP_VERSION -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+  -a, --consumer-app-version=CONSUMER_APP_VERSION          # The consumer application version
+  -b, --broker-base-url=BROKER_BASE_URL                    # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]                  # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]                  # Pact Broker basic auth password
+  -t, [--tag=TAG]                                          # Tag name for consumer version. Can be specified multiple times.
+  -g, [--tag-with-git-branch], [--no-tag-with-git-branch]  # Tag consumer version with the name of the current git branch. Default: false
+  -v, [--verbose], [--no-verbose]                          # Verbose output. Default: false
+
+Publish pacts to a Pact Broker.
+```
+
+### create-version-tag
+
+```
+Usage:
+  pact-broker create-version-tag -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
+
+Options:
+  -a, --pacticipant=PACTICIPANT                            # The pacticipant name
+  -e, --version=VERSION                                    # The pacticipant version
+  -t, [--tag=TAG]                                          # Tag name for pacticipant version. Can be specified multiple times.
+  -g, [--tag-with-git-branch], [--no-tag-with-git-branch]  # Tag pacticipant version with the name of the current git branch. Default: false
+  -b, --broker-base-url=BROKER_BASE_URL                    # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]                  # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]                  # Pact Broker basic auth password
+  -v, [--verbose], [--no-verbose]                          # Verbose output. Default: false
+
+Add a tag to a pacticipant version
+```
+
+### can-i-deploy
+
+*This feature is in beta release, and backwards compatibility is NOT guaranteed.*
+You will need the latest version of the Pact Broker for this feature to work.
+
+```
+Usage:
+  pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+  -a, --pacticipant=PACTICIPANT            # The pacticipant name. Use once for each pacticipant being checked.
+  -e, [--version=VERSION]                  # The pacticipant version. Must be entered after the --pacticipant that it relates to.
+  -l, [--latest=[TAG]]                     # Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag.
+  -b, --broker-base-url=BROKER_BASE_URL    # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
+  -o, [--output=OUTPUT]                    # json or table
+                                           # Default: table
+  -v, [--verbose], [--no-verbose]          # Verbose output. Default: false
+
+Description:
+  Returns exit code 0 or 1, indicating whether or not the specified pacticipant versions are compatible. Prints out the
+  relevant pact/verification details.
+
+  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
+
+  Check the status of the pacts for a pacticipant version:
+
+  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --broker-base-url BROKER_BASE_URL
+
+  Check the status of the pacts for the latest pacticipant version:
+
+  $ 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:
+
+  $ 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 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 PACTICIPANT1 --latest --pacticipant PACTICIPANT2 --latest --broker-base-url
+  BROKER
+
+  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 PACTICIPANT1 --latest TAG1 --pacticipant PACTICIPANT2 --latest TAG2
+  --broker-base-url BROKER_BASE_URL
+```
+
+## Usage - Ruby
 
 ### Consumer
 
@@ -25,23 +119,14 @@ PactBroker::Client::PublicationTask.new do | task |
   require 'my_consumer/version'
   task.consumer_version = MyConsumer::VERSION
   task.pattern = 'custom/path/to/pacts/*.json' # optional, default value is 'spec/pacts/*.json'
-  task.pact_broker_base_url = "http://pact-broker.my.org"
+  task.pact_broker_base_url = "http://pact-broker"
+  task.tag_with_git_branch = true|false # STRONGLY RECOMMENDED as it will greatly assist with your pact workflow. Optional, will merge result with other specified task.tags
   task.tags = ["dev"] # optional
   task.pact_broker_basic_auth =  { username: 'basic_auth_user', password: 'basic_auth_pass'} # optional
   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.
 end
 ```
 
-## Using tags
-
-Tags enable you to test different versions of your consumer and provider against each other (eg. `head` and `prod`) and to use pacts on feature branches without breaking your main line of development. You can read more about using tags on the Pact broker [wiki][wiki-tags].
-
-If you want to use the git branch name as the tag name, use:
-
-```ruby
-  task.tag = `git rev-parse --abbrev-ref HEAD`.strip
-```
-
 ```bash
 # In CI script
 
@@ -64,4 +149,6 @@ Pact.service_provider "My Provider" do
 end
 ```
 
+
+
 [wiki-tags]: https://github.com/pact-foundation/pact_broker/wiki/Using-tags

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

@@ -15,7 +15,8 @@ module PactBroker
       class PactPublicationError < ::Thor::Error; end
 
       class Broker < CustomThor
-        desc 'can-i-deploy', "Returns exit code 0 or 1, indicating whether or not the specified application versions are compatible."
+        desc 'can-i-deploy', ''
+        long_desc File.read(File.join(File.dirname(__FILE__), 'can_i_deploy_long_desc.txt'))
 
         method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."

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

@@ -0,0 +1,31 @@
+Returns exit code 0 or 1, indicating whether or not the specified pacticipant versions are compatible. Prints out the relevant pact/verification details.
+
+WARNING! This feature is in beta release, and backwards compatibility is NOT guaranteed. You will need the latest version of the Pact Broker for this feature to work.
+
+The environment variables PACT_BROKER_BASE_URL_BASE_URL, PACT_BROKER_BASE_URL_USERNAME and PACT_BROKER_BASE_URL_PASSWORD may be used instead of their respective command line options.
+
+SCENARIOS
+
+Check the status of the pacts for a pacticipant version:
+
+  $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --broker-base-url BROKER_BASE_URL
+
+Check the status of the pacts for the latest pacticipant version:
+
+  $ 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:
+
+  $ 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 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 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 PACTICIPANT1 --latest TAG1 --pacticipant PACTICIPANT2 --latest TAG2 --broker-base-url BROKER_BASE_URL

data/lib/pact_broker/client/matrix.rb

@@ -4,8 +4,10 @@ module PactBroker
   module Client
     class Matrix < BaseClient
       def get selectors, options = {}
+        latestby = selectors.size == 1 ? 'cvp' : 'cvpv'
         query = {
-          q: convert_selector_hashes_to_params(selectors)
+          q: convert_selector_hashes_to_params(selectors),
+          latestby: latestby
         }.merge(query_options(options))
         response = self.class.get("/matrix", query: query, headers: default_get_headers)
         $stdout.puts("DEBUG: Response headers #{response.headers}") if verbose?

data/lib/pact_broker/client/matrix/text_formatter.rb

@@ -7,6 +7,14 @@ module PactBroker
 
         Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success)
 
+        OPTIONS = [
+          { consumer: {} },
+          { consumer_version: {display_name: 'C.VERSION'} },
+          { provider: {} },
+          { provider_version: {display_name: 'P.VERSION'} },
+          { success: {display_name: 'SUCCESS?'} }
+        ]
+
         def self.call(matrix)
           data = matrix[:matrix].collect do | line |
             Line.new(
@@ -18,7 +26,7 @@ module PactBroker
             )
           end
 
-          printer = TablePrint::Printer.new(data)
+          printer = TablePrint::Printer.new(data, OPTIONS)
           printer.table_print
         end
 

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -1,4 +1,5 @@
 require 'rake/tasklib'
+require 'pact_broker/client/git'
 
 =begin
 require pact_broker/client/tasks
@@ -7,7 +8,8 @@ PactBroker::Client::PublicationTask.new do | task |
   require 'consumer/version'
   task.pact_broker_base_url = 'http://pact-broker'
   task.consumer_version = Consumer::VERSION
-  task.tag = "dev"
+  task.tags = ["dev"]
+  task.tag_with_git_branch = true
 end
 
 =end
@@ -16,7 +18,8 @@ module PactBroker
   module Client
     class PublicationTask < ::Rake::TaskLib
 
-      attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :pact_broker_basic_auth
+      attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :tag_with_git_branch, :pact_broker_basic_auth
+      alias_method :tags=, :tag=
       alias_method :tags, :tag
 
       def initialize name = nil, &block
@@ -36,7 +39,7 @@ module PactBroker
             require 'pact_broker/client/publish_pacts'
             basic_auth_client_options = pact_broker_basic_auth ? {basic_auth: pact_broker_basic_auth} : {}
             pact_broker_client_options = basic_auth_client_options.merge(write_method ? {write: write_method} : {})
-            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version, [*tags], pact_broker_client_options).call
+            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version, all_tags, pact_broker_client_options).call
             raise "One or more pacts failed to be published" unless success
           end
         end
@@ -46,6 +49,11 @@ module PactBroker
         @name ? "publish:#{@name}" : "publish"
       end
 
+      def all_tags
+        t = [*tags]
+        t << PactBroker::Client::Git.branch if tag_with_git_branch
+        t.compact.uniq
+      end
     end
   end
 end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.11.0'
+    VERSION = '1.12.0'
   end
 end

data/script/generate-cli-usage.sh

@@ -0,0 +1,20 @@
+echo '### publish'
+echo ''
+echo '```'
+echo "$(bundle exec bin/pact-broker help publish)"
+echo '```'
+echo ''
+echo '### create-version-tag'
+echo ''
+echo '```'
+echo "$(bundle exec bin/pact-broker help create-version-tag)"
+echo '```'
+echo ''
+echo '### can-i-deploy'
+echo ''
+echo '*This feature is in beta release, and backwards compatibility is NOT guaranteed.*'
+echo 'You will need the latest version of the Pact Broker for this feature to work.'
+echo ''
+echo '```'
+echo "$(bundle exec bin/pact-broker help can-i-deploy)"
+echo '```'

data/spec/lib/pact_broker/client/tasks/publication_task_spec.rb

@@ -10,12 +10,13 @@ module PactBroker::Client
       @consumer_version = "1.2.3"
     end
 
-    let(:publish_pacts) { instance_double("PactBroker::ClientSupport::PublishPacts")}
+    let(:publish_pacts) { instance_double("PactBroker::ClientSupport::PublishPacts", call: true)}
     let(:pact_file_list) { ['spec/pact/consumer-provider.json'] }
 
     before do
       allow(PactBroker::Client::PublishPacts).to receive(:new).and_return(publish_pacts)
       allow(FileList).to receive(:[]).with(pattern).and_return(pact_file_list)
+      allow(PactBroker::Client::Git).to receive(:branch).and_return('foo')
     end
 
     let(:pattern) { "spec/pacts/*.json" }
@@ -59,6 +60,22 @@ module PactBroker::Client
       end
     end
 
+    context "when tag_with_git_branch is true" do
+      before :all do
+        PactBroker::Client::PublicationTask.new(:git_branch) do | task |
+          task.consumer_version = '1.2.3'
+          task.tag_with_git_branch = true
+          task.tags = ['bar']
+        end
+      end
+
+      it "invokes PublishPacts with the git branch name as a tag" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, anything, ['bar', 'foo'], anything).and_return(publish_pacts)
+
+        Rake::Task['pact:publish:git_branch'].execute
+      end
+    end
+
     describe "custom task" do
 
       before :all do
@@ -85,7 +102,6 @@ module PactBroker::Client
     end
 
     describe "timing of block execution" do
-
       before :all do
         PactBroker::Client::PublicationTask.new(:exception) do | task |
           raise 'A contrived exception'
@@ -96,8 +112,5 @@ module PactBroker::Client
         expect{ Rake::Task['pact:publish:exception'].execute }.to raise_error 'A contrived exception'
       end
     end
-
-
   end
-
 end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -192,7 +192,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6"
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -240,7 +240,55 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo%20Thing&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6"
+        "query": "q[][pacticipant]=Foo%20Thing&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "summary": {
+            "deployable": true,
+            "reason": "some text"
+          },
+          "matrix": [
+            {
+              "consumer": {
+                "name": "Foo",
+                "version": {
+                  "number": "4"
+                }
+              },
+              "provider": {
+                "name": "Bar",
+                "version": {
+                  "number": "5"
+                }
+              },
+              "verificationResult": {
+                "verifiedAt": "2017-10-10T12:49:04+11:00",
+                "success": true
+              },
+              "pact": {
+                "createdAt": "2017-10-10T12:49:04+11:00"
+              }
+            }
+          ]
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for the compatibility matrix where only the version of Foo is specified",
+      "providerState": "the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 and version 5.6.7",
+      "request": {
+        "method": "get",
+        "path": "/matrix",
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp"
       },
       "response": {
         "status": 200,
@@ -288,7 +336,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9"
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9&latestby=cvpv"
       },
       "response": {
         "status": 400,
@@ -314,7 +362,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Wiffle&q[][version]=1.2.3&q[][pacticipant]=Meep&q[][version]=9.9.9"
+        "query": "q[][pacticipant]=Wiffle&q[][version]=1.2.3&q[][pacticipant]=Meep&q[][version]=9.9.9&latestby=cvpv"
       },
       "response": {
         "status": 400,
@@ -341,7 +389,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar"
+        "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -409,7 +457,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&success[]=true"
+        "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv&success[]=true"
       },
       "response": {
         "status": 200,
@@ -457,7 +505,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod"
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -505,7 +553,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true"
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true&latestby=cvpv"
       },
       "response": {
         "status": 200,

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -19,7 +19,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6"
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
             ).
             will_respond_with(
               status: 200,
@@ -42,7 +42,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo%20Thing&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6"
+              query: "q[][pacticipant]=Foo%20Thing&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
             ).
             will_respond_with(
               status: 200,
@@ -59,25 +59,30 @@ module PactBroker::Client
         end
       end
 
-      # context "with only one version selector" do
-      #   before do
-      #     pact_broker.
-      #       given("the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6").
-      #       upon_receiving("a request for the compatibility matrix where only the version of Foo is specified").
-      #       with(
-      #         method: :get,
-      #         path: "/matrix",
-      #         query: {
-      #           'selectors[]' => ['Foo/version/1.2.3']
-      #         }
-      #       ).
-      #       will_respond_with(
-      #         status: 200,
-      #         headers: pact_broker_response_headers,
-      #         body: matrix_response_body
-      #       )
-      #   end
-      # end
+      context "with only one version selector" do
+        before do
+          pact_broker.
+            given("the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 and version 5.6.7").
+            upon_receiving("a request for the compatibility matrix where only the version of Foo is specified").
+            with(
+              method: :get,
+              path: "/matrix",
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp"
+            ).
+            will_respond_with(
+              status: 200,
+              headers: pact_broker_response_headers,
+              body: matrix_response_body
+            )
+        end
+
+        let(:selectors) { [{ pacticipant: "Foo", version: "1.2.3" }] }
+
+        it 'returns the row with the lastest verification for version 1.2.3' do
+          matrix = pact_broker_client.matrix.get(selectors)
+          expect(matrix[:matrix].size).to eq 1
+        end
+      end
 
       context "when one or more of the versions does not exist" do
         before do
@@ -87,7 +92,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9"
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9&latestby=cvpv"
             ).
             will_respond_with(
               status: 400,
@@ -114,7 +119,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Wiffle&q[][version]=1.2.3&q[][pacticipant]=Meep&q[][version]=9.9.9"
+              query: "q[][pacticipant]=Wiffle&q[][version]=1.2.3&q[][pacticipant]=Meep&q[][version]=9.9.9&latestby=cvpv"
             ).
             will_respond_with(
               status: 400,
@@ -142,7 +147,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][pacticipant]=Bar"
+              query: "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv"
             ).
             will_respond_with(
               status: 200,
@@ -169,7 +174,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][pacticipant]=Bar&success[]=true"
+              query: "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv&success[]=true"
             ).
             will_respond_with(
               status: 200,
@@ -195,7 +200,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod"
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod&latestby=cvpv"
             ).
             will_respond_with(
               status: 200,
@@ -221,7 +226,7 @@ module PactBroker::Client
             with(
               method: :get,
               path: "/matrix",
-              query: "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true"
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true&latestby=cvpv"
             ).
             will_respond_with(
               status: 200,

data/spec/support/matrix.txt

@@ -1,3 +1,3 @@
-CONSUMER | CONSUMER_VERSION | PROVIDER | PROVIDER_VERSION | SUCCESS
----------|------------------|----------|------------------|--------
-Foo      | 4                | Bar      | 5                | true
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?
+---------|-----------|----------|-----------|---------
+Foo      | 4         | Bar      | 5         | true

data/spec/support/matrix_error.txt

@@ -1,3 +1,3 @@
-CONSUMER | CONSUMER_VERSION | PROVIDER | PROVIDER_VERSION | SUCCESS
----------|------------------|----------|------------------|--------
-???      | ???              | ???      | ???              | ???
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?
+---------|-----------|----------|-----------|---------
+???      | ???       | ???      | ???       | ???

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -161,6 +161,7 @@ files:
 - lib/pact_broker/client/base_client.rb
 - lib/pact_broker/client/can_i_deploy.rb
 - lib/pact_broker/client/cli/broker.rb
+- lib/pact_broker/client/cli/can_i_deploy_long_desc.txt
 - lib/pact_broker/client/cli/custom_thor.rb
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
 - lib/pact_broker/client/create_tag.rb
@@ -184,6 +185,7 @@ files:
 - lib/pact_broker/client/versions.rb
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
+- script/generate-cli-usage.sh
 - script/publish-pact.sh
 - script/release.sh
 - spec/integration/can_i_deploy_spec.rb