pact_broker-client 1.25.1 → 1.27.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c78c1aac0ad2d50892f581f5bf0bb77b4b73e32b1ae359ae94a62eb4d62855b
-  data.tar.gz: 509cc602635703e5ff07520ef5b0163ff47ed4cbaadebca33de0ebced3d34bdd
+  metadata.gz: 711ccd7e9c78c20b610a6d6018bae6412dfaca133c5ddb9e2c2532d45b315d63
+  data.tar.gz: 21d2caf30f8967bb28bff27eb4db553a6a77681f01131507c0a42df9076e5a80
 SHA512:
-  metadata.gz: 38988ea9692c16df96c3ba1c18cbd2509286efede5b7e72d2561540ffeb78e0d5e442a83aacd26f2ca61f4939a2e4458130bcdc0f605e1711c304590f281e9e0
-  data.tar.gz: 2efd70539e123a3b2b7ffbe7f2c691f497ba4dc1034fb25d4fd5800faa4cae50bbd2960ba3a87a149decb5127bdc7621873f51d60ab48dc988f5059bad3a6125
+  metadata.gz: 1b46459fd5fb59d335a647e6000272f346f4a8b44845644249d7e870b0a54a60fe9daa0071c1dadcc260967395367ee688123021bfa9a7eb988d12d011d7842f
+  data.tar.gz: 368645a3cf3f8890ec85e158dd2406ebeb7e98fcd6be608fe802357ba34ab53192e6312774a05788d93caea23b3d92ec54df7cc60740ffa9b607b83f4c5a1204

data/.github/workflows/release_gem.yml

@@ -0,0 +1,35 @@
+name: Release gem
+
+on:
+  repository_dispatch:
+    types:
+      - release-patch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.6'
+    - name: Install gems
+      run: |
+        gem install bundler -v 2.0.2
+        bundle install
+    - name: Configure git
+      run: |
+        git config user.email "beth@bethesque.com"
+        git config user.name "Beth Skurrie via Github Actions"
+    - name: Prepare release
+      run: script/prepare-release.sh
+      env:
+        INCREMENT: patch
+    - name: Release gem
+      run: script/release-gem.sh
+      env:
+        BUNDLE_GEM__PUSH_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'
+        BUNDLE_GITHUB__COM: x-access-token:${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

data/.github/workflows/trigger_pact_cli_release.yml

@@ -0,0 +1,15 @@
+name: Trigger release of the pact-cli Docker image
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
+          repository: pact-foundation/pact-ruby-cli
+          event-type: gem-released

data/.github/workflows/trigger_pact_docs_update.yml

@@ -0,0 +1,19 @@
+name: Trigger update to docs.pact.io
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '**.md'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger docs.pact.io update workflow
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GHTOKENFORTRIGGERINGPACTDOCSUPDATE }}
+          repository: pact-foundation/docs.pact.io
+          event-type: pact-broker-client-docs-updated

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+<a name="v1.27.1"></a>
+### v1.27.1 (2020-07-10)
+
+
+#### Features
+
+* **deps**
+  * this isn't really a feature, but I want to test the release workflow	 ([29a7b72](/../../commit/29a7b72))
+
+
+<a name="v1.27.0"></a>
+### v1.27.0 (2020-05-09)
+
+
+#### Features
+
+* add BITBUCKET_BRANCH to list of known branch variables (#69)	 ([d1dc088](/../../commit/d1dc088))
+* add list-latest-pact-versions command	 ([ed45d58](/../../commit/ed45d58))
+
+
+<a name="v1.26.0"></a>
+### v1.26.0 (2020-04-17)
+
+
+#### Features
+
+* update message when waiting for verification results	 ([68df012](/../../commit/68df012))
+* add create-or-update-pacticipant	 ([f1c33ae](/../../commit/f1c33ae))
+
+* **can i deploy**
+  * put out a message while waiting for verification results to be published	 ([cc1ba5f](/../../commit/cc1ba5f))
+
+* **publish pacts**
+  * improve message when overwriting pacts	 ([17b93f3](/../../commit/17b93f3))
+
+* **webhooks**
+  * add command to test webhook execution	 ([0ee1f7a](/../../commit/0ee1f7a))
+
+
 <a name="v1.25.1"></a>
 ### v1.25.1 (2020-04-02)
 

data/Gemfile

@@ -4,4 +4,13 @@ gemspec
 
 # Not sure why jruby on Travis fails saying rake is not part of the bundle,
 # even thought it's in the development dependencies. Trying it here.
-gem 'rake', '~> 10.0.3'
+gem 'rake', '~> 13.0'
+
+group :release do
+  gem 'bump', git: 'https://github.com/bethesque/bump.git'
+end
+
+if ENV['X_PACT_DEVELOPMENT'] == 'true'
+  gem 'pact-mock_service', path: '../pact-mock_service'
+  gem 'pact-support', path: '../pact-support'
+end

data/README.md

@@ -1,9 +1,11 @@
 # Pact Broker Client
 
-A client for the Pact Broker. Publishes pacts to, and retrieves pacts from, a Pact Broker. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
+A client for the Pact Broker. Publishes and retrieves pacts, verification results, pacticipants, pacticipant versions and tags. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
 
 [![Build Status](https://travis-ci.org/pact-foundation/pact_broker-client.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker-client)
 
+![Trigger update to docs.pact.io](https://github.com/pact-foundation/pact_broker-client/workflows/Trigger%20update%20to%20docs.pact.io/badge.svg)
+
 ## Installation
 
 ### CLI
@@ -345,6 +347,5 @@ end
 bundle exec rake pact:publish
 ```
 
-[wiki-tags]: https://github.com/pact-foundation/pact_broker/wiki/Using-tags
 [pact-ruby-standalone]: https://github.com/pact-foundation/pact-ruby-standalone/releases
-[docker]: https://cloud.docker.com/u/pactfoundation/repository/docker/pactfoundation/pact-cli
+[docker]: https://hub.docker.com/r/pactfoundation/pact-cli

data/appveyor.yml

@@ -6,7 +6,7 @@ build: off
 
 install:
   - set PATH=C:\Ruby22\bin;%PATH%
-  - bundle install
+  - bundle install --without release
 
 before_test:
   - ruby -v

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

@@ -22,6 +22,8 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource)
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pacticipant_relations_are_present) given the pacticipant relations are present
+
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-tagged-version_relation_exists_in_the_index_resource) given the pb:latest-tagged-version relation exists in the index resource
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
@@ -38,6 +40,8 @@
 
 * [A request to create a global webhook with a JSON body](#a_request_to_create_a_global_webhook_with_a_JSON_body)
 
+* [A request to create a pacticipant](#a_request_to_create_a_pacticipant)
+
 * [A request to create a webhook for a consumer and provider](#a_request_to_create_a_webhook_for_a_consumer_and_provider_given_'Condor'_does_not_exist_in_the_pact-broker) given 'Condor' does not exist in the pact-broker
 
 * [A request to create a webhook with a JSON body and a uuid](#a_request_to_create_a_webhook_with_a_JSON_body_and_a_uuid_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
@@ -76,6 +80,10 @@
 
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_does_not_exist_in_the_pact-broker) given the 'Pricing Service' does not exist in the pact-broker
 
+* [A request to retrieve a pacticipant](#a_request_to_retrieve_a_pacticipant_given_a_pacticipant_with_name_Foo_exists) given a pacticipant with name Foo exists
+
+* [A request to retrieve a pacticipant](#a_request_to_retrieve_a_pacticipant)
+
 * [A request to retrieve the latest 'production' version of Condor](#a_request_to_retrieve_the_latest_'production'_version_of_Condor_given_'Condor'_exists_in_the_pact-broker_with_the_latest_tagged_'production'_version_1.2.3) given 'Condor' exists in the pact-broker with the latest tagged 'production' version 1.2.3
 
 * [A request to retrieve the latest pact between Condor and the Pricing Service](#a_request_to_retrieve_the_latest_pact_between_Condor_and_the_Pricing_Service_given_a_pact_between_Condor_and_the_Pricing_Service_exists) given a pact between Condor and the Pricing Service exists
@@ -92,6 +100,8 @@
 
 * [A request to tag the production version of Condor](#a_request_to_tag_the_production_version_of_Condor_given_'Condor'_exists_in_the_pact-broker) given 'Condor' exists in the pact-broker
 
+* [A request to update a pacticipant](#a_request_to_update_a_pacticipant_given_a_pacticipant_with_name_Foo_exists) given a pacticipant with name Foo exists
+
 * [A request to update a webhook](#a_request_to_update_a_webhook_given_a_webhook_with_the_uuid_696c5f93-1b7f-44bc-8d03-59440fcaa9a0_exists) given a webhook with the uuid 696c5f93-1b7f-44bc-8d03-59440fcaa9a0 exists
 
 * [An invalid request to create a webhook for a consumer and provider](#an_invalid_request_to_create_a_webhook_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
@@ -104,7 +114,7 @@ Upon receiving **a request for the compatibility matrix for a pacticipant that d
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Wiffle&q[][version]=1.2.3&q[][pacticipant]=Meep&q[][version]=9.9.9&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Wiffle&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Meep&q%5B%5D%5Bversion%5D=9.9.9&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -127,7 +137,7 @@ Given **the pact for Foo version 1.2.3 and 1.2.4 has been verified by Bar versio
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bpacticipant%5D=Bar&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -191,7 +201,7 @@ Given **the pact for Foo Thing version 1.2.3 has been verified by Bar version 4.
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo%20Thing&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo%20Thing&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -239,7 +249,7 @@ Given **the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6**,
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -287,7 +297,7 @@ Given **the pact for Foo version 1.2.3 has been successfully verified by Bar ver
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Blatest%5D=true&q%5B%5D%5Btag%5D=prod&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -335,7 +345,7 @@ Given **the pact for Foo version 1.2.3 has been successfully verified by Bar ver
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp&latest=true&tag=prod"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&latestby=cvp&latest=true&tag=prod"
 }
 ```
 Pact Broker will respond with:
@@ -371,7 +381,7 @@ Given **the pact for Foo version 1.2.3 has been successfully verified by Bar ver
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.4&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Blatest%5D=true&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -419,7 +429,7 @@ Given **the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6**,
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9&latestby=cvpv"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=9.9.9&latestby=cvpv"
 }
 ```
 Pact Broker will respond with:
@@ -442,7 +452,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&latest=true"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&latestby=cvp&latest=true"
 }
 ```
 Pact Broker will respond with:
@@ -506,6 +516,42 @@ Pact Broker will respond with:
     "_links": {
       "pb:webhooks": {
         "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+      },
+      "pb:pacticipants": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANTS"
+      },
+      "pb:pacticipant": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-{pacticipant}"
+      }
+    }
+  }
+}
+```
+<a name="a_request_for_the_index_resource_given_the_pacticipant_relations_are_present"></a>
+Given **the pacticipant relations are present**, upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipants": {
+        "href": "http://localhost:1234/pacticipants"
+      },
+      "pb:pacticipant": {
+        "href": "http://localhost:1234/pacticipants/{pacticipant}"
       }
     }
   }
@@ -657,7 +703,7 @@ Given **the pact for Foo version 1.2.3 has been successfully verified by Bar ver
 {
   "method": "get",
   "path": "/matrix",
-  "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv&success[]=true"
+  "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bpacticipant%5D=Bar&latestby=cvpv&success%5B%5D=true"
 }
 ```
 Pact Broker will respond with:
@@ -778,6 +824,40 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_create_a_pacticipant"></a>
+Upon receiving **a request to create a pacticipant** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/pacticipants",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "name": "Foo",
+    "repositoryUrl": "http://foo"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "name": "Foo",
+    "repositoryUrl": "http://foo",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/pacticipants/Foo"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_create_a_webhook_for_a_consumer_and_provider_given_&#39;Condor&#39;_does_not_exist_in_the_pact-broker"></a>
 Given **'Condor' does not exist in the pact-broker**, upon receiving **a request to create a webhook for a consumer and provider** from Pact Broker Client, with
 ```json
@@ -1598,6 +1678,50 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_retrieve_a_pacticipant_given_a_pacticipant_with_name_Foo_exists"></a>
+Given **a pacticipant with name Foo exists**, upon receiving **a request to retrieve a pacticipant** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/pacticipants/Foo",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/pacticipants/Foo"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_retrieve_a_pacticipant"></a>
+Upon receiving **a request to retrieve a pacticipant** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/pacticipants/Foo",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 404
+}
+```
 <a name="a_request_to_retrieve_the_latest_&#39;production&#39;_version_of_Condor_given_&#39;Condor&#39;_exists_in_the_pact-broker_with_the_latest_tagged_&#39;production&#39;_version_1.2.3"></a>
 Given **'Condor' exists in the pact-broker with the latest tagged 'production' version 1.2.3**, upon receiving **a request to retrieve the latest 'production' version of Condor** from Pact Broker Client, with
 ```json
@@ -1809,6 +1933,40 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_update_a_pacticipant_given_a_pacticipant_with_name_Foo_exists"></a>
+Given **a pacticipant with name Foo exists**, upon receiving **a request to update a pacticipant** from Pact Broker Client, with
+```json
+{
+  "method": "patch",
+  "path": "/pacticipants/Foo",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "name": "Foo",
+    "repositoryUrl": "http://foo"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "name": "Foo",
+    "repositoryUrl": "http://foo",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/pacticipants/Foo"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_update_a_webhook_given_a_webhook_with_the_uuid_696c5f93-1b7f-44bc-8d03-59440fcaa9a0_exists"></a>
 Given **a webhook with the uuid 696c5f93-1b7f-44bc-8d03-59440fcaa9a0 exists**, upon receiving **a request to update a webhook** from Pact Broker Client, with
 ```json