pact_broker-client 1.66.1 → 1.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff5c17fff5ecf49ba126154617cba59267fdfe34e3e0dae905ee476408319b1
-  data.tar.gz: cd232d89597a0a2f79726a0464cf30a0e671056b8898ecb39f9fef8e1359df99
+  metadata.gz: 6f188bc33e3294bd2bea28a4bebd4f3d9c2047da2e36b1e4a435e04878d89b4b
+  data.tar.gz: fab940f0461e06d9ed0fb81be5947ad749a75616c85c42c312d8aecfc038eb86
 SHA512:
-  metadata.gz: 352eb1d1ba20242adc03af2c0f51883ffaca332b7affaebb48db63358b8f5e13198cb280987a49ed4becd3e8c97b5a8d59f6fc2deabfda0b95ed1b990d2acc48
-  data.tar.gz: 6682af8dce2ee94a56bc81cd03b633074e14a8e85a0c68a5e7c0393bf08faa3ab64fb26fcee7589f37f4c89cdbaa9b1ad83de95f5f41992cd5d6b2ea883b213f
+  metadata.gz: '0129bc2ee4f7e871adc49c1e21056dff0c49d8ff286582a0c01418c317e29c04b543ab70b41e52ccdffd64bfbffec712fd7fe930f1ffe8971d5c9d9b17fad747'
+  data.tar.gz: 3a76b75837e15f3e9a31a3bd8624a3d160d5c9e547235fb4d01f688906decd9ab2819a359c9fb22224707c6e17b5b1f8826bf93c1146439c6268ae20bb62d506

data/.github/workflows/release_gem.yml

@@ -10,12 +10,12 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '2.6'
+        ruby-version: '3.2'
     - run: |
-        gem install bundler -v 2.1
+        gem install bundler -v 2.4
         bundle install
     - name: Test
       run: bundle exec rake
@@ -28,7 +28,7 @@ jobs:
       version: ${{ steps.release.outputs.version }}
       increment: ${{ steps.release.outputs.increment }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
     - uses: pact-foundation/release-gem@v0.0.13

data/.github/workflows/smartbear-issue-label-added.yml

@@ -0,0 +1,11 @@
+name: SmartBear Supported Issue Label Added
+
+on:
+  issues:
+    types:
+      - labeled
+
+jobs:
+  call-workflow:
+    uses: pact-foundation/.github/.github/workflows/smartbear-issue-label-added.yml@master
+    secrets: inherit

data/.github/workflows/test.yml

@@ -4,15 +4,14 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: "ubuntu-latest"
-    continue-on-error: ${{ matrix.experimental }}
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        ruby_version: ["2.7", "3.0", "3.1"]
-        experimental: [false]
+        ruby_version: ["2.7", "3.0", "3.1", "3.2"]
+        os: ["ubuntu-latest","windows-latest","macos-latest"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
@@ -26,10 +25,10 @@ jobs:
       matrix:
         feature: [""]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: "3.2"
       - run: "bundle install"
       - run: |
           rm -rf spec/pacts/*

data/.github/workflows/trigger_pact_docs_update.yml

@@ -9,6 +9,7 @@ on:
   repository_dispatch:
     types:
       - gem-released
+  workflow_dispatch:
 
 jobs:
   build:

data/.ruby-version

@@ -1 +1 @@
-2.7
+3.2

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+<a name="v1.67.0"></a>
+### v1.67.0 (2023-05-04)
+
+#### Features
+
+* colour first url in magenta for ease of reading	 ([90e8f51](/../../commit/90e8f51))
+* output provider contract link on publish (#118)	 ([132b024](/../../commit/132b024))
+* add helper text for Docker usage when pact file not found	 ([2aab2d5](/../../commit/2aab2d5))
+
+#### Bug Fixes
+
+* trim trailing slash from base url	 ([ccd6417](/../../commit/ccd6417))
+* do not allow an empty environment name to be used in the can-i-deploy command	 ([a3bfe8a](/../../commit/a3bfe8a))
+
 <a name="v1.66.1"></a>
 ### v1.66.1 (2023-01-11)
 
@@ -214,7 +228,7 @@
 
 #### Features
 
-* support specifying team UUID when creating a webhook in Pactflow	 ([c4201e1](/../../commit/c4201e1))
+* support specifying team UUID when creating a webhook in PactFlow	 ([c4201e1](/../../commit/c4201e1))
 
 <a name="v1.45.0"></a>
 ### v1.45.0 (2021-06-16)

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.1-alpine
+FROM ruby:3.2-alpine
 
 RUN apk add --no-cache -X http://dl-cdn.alpinelinux.org/alpine/edge/testing hub
 RUN apk add --update --no-cache git openssh bash

data/README.md

@@ -1,6 +1,6 @@
 # Pact Broker Client
 
-A client for the [Pact Broker](https://docs.pact.io/pact_broker/) and [Pactflow](https://pactflow.io/?utm_source=ossdocs&utm_campaign=pact_broker_client_readme). Publishes and retrieves pacts, pacticipants, pacticipant versions, environments, deployments and releases. Supports publishing provider contracts for Pactflow. 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](https://docs.pact.io/pact_broker/) and [PactFlow](https://pactflow.io/?utm_source=ossdocs&utm_campaign=pact_broker_client_readme). Publishes and retrieves pacts, pacticipants, pacticipant versions, environments, deployments and releases. Supports publishing provider contracts for PactFlow. 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://github.com/pact-foundation/pact_broker-client/workflows/Test/badge.svg)
 
@@ -32,7 +32,7 @@ To connect to a Pact Broker that uses custom SSL cerificates, set the environmen
 
 ## Usage - CLI
 
-All commands prefixed with `pact-broker` can be used with the OSS Pact Broker and Pactflow. Commands prefixed with `pactflow` can only be used with Pactflow.
+All commands prefixed with `pact-broker` can be used with the OSS Pact Broker and PactFlow. Commands prefixed with `pactflow` can only be used with PactFlow.
 
 The Pact Broker base URL can be specified either using the environment variable `$PACT_BROKER_BASE_URL` or the `-b` or `--broker-base-url` parameters.
 
@@ -40,7 +40,7 @@ Pact Broker authentication can be performed either using basic auth or a bearer
 
 Basic auth parameters can be specified using the `$PACT_BROKER_USERNAME` and `$PACT_BROKER_PASSWORD` environment variables, or the `-u` or `--broker-username` and `-p` or `--broker-password` parameters.
 
-Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This bearer token authentication is used by [Pactflow](https://pactflow.io) and is not available in the [OSS Pact Broker](https://docs.pact.io/pact_broker/), which only supports basic auth.
+Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This bearer token authentication is used by [PactFlow](https://pactflow.io) and is not available in the [OSS Pact Broker](https://docs.pact.io/pact_broker/), which only supports basic auth.
 
 
 <!-- start-autogenerated-docs -->
@@ -522,6 +522,12 @@ Description:
 
   $ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar --latest main
 
+##### Polling
+
+If the verification process takes a long time and there are results missing when the can-i-deploy command runs in your CI/CD pipeline, you can configure the
+command to poll and wait for the missing results to arrive. The arguments to specify are `--retry-while-unknown TIMES` and `--retry-interval SECONDS`, set to
+appropriate values for your pipeline.
+
 ### Pacticipants
 
 #### create-or-update-pacticipant
@@ -650,8 +656,8 @@ Options:
               # Trigger this webhook when a contract is published that
                 requires verification
       [--team-uuid=UUID]
-              # UUID of the Pactflow team to which the webhook should be
-                assigned (Pactflow only)
+              # UUID of the PactFlow team to which the webhook should be
+                assigned (PactFlow only)
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -713,8 +719,8 @@ Options:
               # Trigger this webhook when a contract is published that
                 requires verification
       [--team-uuid=UUID]
-              # UUID of the Pactflow team to which the webhook should be
-                assigned (Pactflow only)
+              # UUID of the PactFlow team to which the webhook should be
+                assigned (PactFlow only)
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -875,7 +881,7 @@ Options:
 
 Generate a UUID for use when calling create-or-update-webhook
 
-### Provider contracts (Pactflow only)
+### Provider contracts (PactFlow only)
 
 #### publish-provider-contract
 
@@ -931,7 +937,7 @@ Options:
               # Verbose output. Default: false
 ```
 
-Publish provider contract to Pactflow
+Publish provider contract to PactFlow
 
 <!-- end-autogenerated-docs -->
 

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

@@ -1,11 +1,13 @@
-### A pact between Pact Broker Client and Pactflow
+### A pact between Pact Broker Client and PactFlow
 
-#### Requests from Pact Broker Client to Pactflow
+#### Requests from Pact Broker Client to PactFlow
 
 * [A request for the index resource](#a_request_for_the_index_resource)
 
 * [A request to create a provider contract](#a_request_to_create_a_provider_contract)
 
+* [A request to create a provider contract](#a_request_to_create_a_provider_contract_given_there_is_a_pf:ui_href_in_the_response) given there is a pf:ui href in the response
+
 * [A request to create a webhook for a team](#a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists) given a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists
 
 #### Interactions
@@ -21,7 +23,7 @@ Upon receiving **a request for the index resource** from Pact Broker Client, wit
   }
 }
 ```
-Pactflow will respond with:
+PactFlow will respond with:
 ```json
 {
   "status": 200,
@@ -68,12 +70,53 @@ Upon receiving **a request to create a provider contract** from Pact Broker Clie
   }
 }
 ```
+PactFlow will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  }
+}
+```
+<a name="a_request_to_create_a_provider_contract_given_there_is_a_pf:ui_href_in_the_response"></a>
+Given **there is a pf:ui href in the response**, upon receiving **a request to create a provider contract** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/contracts/provider/Bar/version/1",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+    "contractType": "oas",
+    "contentType": "application/yaml",
+    "verificationResults": {
+      "success": true,
+      "content": "c29tZSByZXN1bHRz",
+      "contentType": "text/plain",
+      "format": "text",
+      "verifier": "my custom tool",
+      "verifierVersion": "1.0"
+    }
+  }
+}
+```
 Pactflow will respond with:
 ```json
 {
   "status": 201,
   "headers": {
     "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pf:ui": {
+        "href": "http://localhost:1235/contracts/bi-directional/provider/Bar/version/1/provider-contract"
+      }
+    }
   }
 }
 ```
@@ -109,7 +152,7 @@ Given **a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists**, upon rec
   }
 }
 ```
-Pactflow will respond with:
+PactFlow will respond with:
 ```json
 {
   "status": 201,

data/doc/pacts/markdown/README.md

@@ -1,4 +1,4 @@
 ### Pacts for Pact Broker Client
 
 * [Pact Broker](Pact%20Broker%20Client%20-%20Pact%20Broker.md)
-* [Pactflow](Pact%20Broker%20Client%20-%20Pactflow.md)
+* [PactFlow](Pact%20Broker%20Client%20-%20Pactflow.md)

data/example/scripts/oas.yml

@@ -0,0 +1,116 @@
+openapi: 3.0.1
+info:
+  title: Product API
+  description: Pactflow Product API demo
+  version: 1.0.0
+paths:
+  /products:
+    post:
+      summary: Create a product
+      description: Creates a new product
+      operationId: createProduct
+      requestBody:
+        description: Create a new Product
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Product'
+            examples:
+              application/json:
+                value:
+                  id: "1234"
+                  type: "food"
+                  price: 42
+      responses:
+        "200":
+          description: successful operation
+          content:
+            "application/json; charset=utf-8":
+              schema:
+                  $ref: '#/components/schemas/Product'
+              examples:
+                application/json:
+                  value:
+                    id: "1234"
+                    type: "food"
+                    price: 42
+    get:
+      summary: List all products
+      description: Returns all products
+      operationId: getAllProducts
+      responses:
+        "200":
+          description: successful operation
+          content:
+            "application/json; charset=utf-8":
+              schema:
+                type: "array"
+                items:
+                  $ref: '#/components/schemas/Product'
+              examples:
+                application/json:
+                  value:
+                    - id: "1234"
+                      type: "food"
+                      price: 42
+                      # name: "pizza"
+                      # version: "1.0.0"
+                      # see https://github.com/apiaryio/dredd/issues/1430 for why
+        "400":
+          description: Invalid ID supplied
+          content: {}
+  /product/{id}:
+    get:
+      summary: Find product by ID
+      description: Returns a single product
+      operationId: getProductByID
+      parameters:
+      - name: id
+        in: path
+        description: ID of product to get
+        schema:
+          type: string
+        required: true
+        example: 10
+      responses:
+        "200":
+          description: successful operation
+          content:
+            "application/json; charset=utf-8":
+              schema:
+                $ref: '#/components/schemas/Product'
+              examples:
+                application/json:
+                  value:
+                    id: "1234"
+                    type: "food"
+                    price: 42
+                    # name: "pizza"
+                    # version: "1.0.0"
+                    # see https://github.com/apiaryio/dredd/issues/1430 for why
+        "400":
+          description: Invalid ID supplied
+          content: {}
+        "404":
+          description: Product not found
+          content: {}
+components:
+  schemas:
+    Product:
+      type: object
+      required:
+        - id
+        - name
+        - price
+      properties:
+        id:
+          type: string
+        type:
+          type: string
+        name:
+          type: string
+        version:
+          type: string
+        price:
+          type: number

data/example/scripts/publish-provider-contract.sh

@@ -0,0 +1,12 @@
+# assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+
+bundle exec bin/pactflow publish-provider-contract $(dirname "$0")/oas.yml \
+    --provider pactflow-cli-test-provider \
+    --provider-app-version 1.0.0 \
+    --branch master \
+    --tag master \
+    --content-type application/yaml \
+    --verification-exit-code=0 \
+    --verification-results $(dirname "$0")/oas.yml \
+    --verification-results-content-type application/yaml \
+    --verifier pactflow-cli-test-provider

data/lib/pact_broker/client/base_client.rb

@@ -125,7 +125,7 @@ module PactBroker
             end
             url
           else
-            raise PactBroker::Client::RelationNotFound.new("Could not find relation #{relation_name} in index resource. Try upgrading your Pact Broker as the feature you require may not exist in your version. If you are using Pactflow, you may not have the permissions required for this action.")
+            raise PactBroker::Client::RelationNotFound.new("Could not find relation #{relation_name} in index resource. Try upgrading your Pact Broker as the feature you require may not exist in your version. If you are using PactFlow, you may not have the permissions required for this action.")
           end
         end
       end

data/lib/pact_broker/client/base_command.rb

@@ -90,9 +90,21 @@ module PactBroker
         ::Term::ANSIColor.green(text)
       end
 
+      def blue(text)
+        ::Term::ANSIColor.blue(text)
+      end
+
+      def magenta(text)
+        ::Term::ANSIColor.magenta(text)
+      end
+
       def red(text)
         ::Term::ANSIColor.red(text)
       end
+
+      def yellow(text)
+        ::Term::ANSIColor.yellow(text)
+      end
     end
   end
 end

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

@@ -22,3 +22,7 @@ Can-i-deploy can also be used to check if arbitrary versions have a successful v
 
     $ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \
                                --pacticipant Bar --latest main
+
+##### Polling
+
+If the verification process takes a long time and there are results missing when the can-i-deploy command runs in your CI/CD pipeline, you can configure the command to poll and wait for the missing results to arrive. The arguments to specify are `--retry-while-unknown TIMES` and `--retry-interval SECONDS`, set to appropriate values for your pipeline.

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

@@ -15,6 +15,19 @@ module PactBroker
         using PactBroker::Client::HashRefinements
 
         no_commands do
+          def initialize(args = [], options = {}, config = {})
+            super
+            postprocess_options
+          end
+
+          def postprocess_options
+            new_options = {}
+            if options.include?("broker_base_url")
+              new_options["broker_base_url"] = options["broker_base_url"].chomp('/')
+            end
+            self.options = options.merge(new_options)
+          end
+
           def self.exit_on_failure?
             true
           end

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

@@ -31,6 +31,7 @@ module PactBroker
               selectors = VersionSelectorOptionsParser.call(ARGV).select { |s| !s[:ignore] }
               ignore_selectors = VersionSelectorOptionsParser.call(ARGV).select { |s| s[:ignore] } + ignore_selectors_from_environment_variable
               validate_can_i_deploy_selectors(selectors)
+              validate_can_i_deploy_options
               dry_run = options.dry_run || ENV["PACT_BROKER_CAN_I_DEPLOY_DRY_RUN"] == "true"
               can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval, dry_run: dry_run, verbose: options.verbose }
               result = CanIDeploy.call(selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit, ignore_selectors: ignore_selectors }, can_i_deploy_options, pact_broker_client_options)
@@ -82,6 +83,12 @@ module PactBroker
                 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
 
+              def validate_can_i_deploy_options
+                if options[:to_environment] && options[:to_environment].blank?
+                  raise ::Thor::RequiredArgumentMissingError, "The environment name cannot be blank"
+                end
+              end
+
               def ignore_selectors_from_environment_variable
                 ENV.fetch("PACT_BROKER_CAN_I_DEPLOY_IGNORE", "").split(",").collect(&:strip).collect{ |i| { pacticipant: i } }
               end

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

@@ -93,7 +93,7 @@ module PactBroker
                   elsif path.start_with?("-")
                     raise Thor::Error.new("ERROR: pact-broker publish was called with invalid arguments #{[path]}")
                   else
-                    raise Thor::Error.new("Specified pact file '#{path}' does not exist. This sometimes indicates one of the arguments has been specified with the wrong name and has been incorrectly identified as a file path.")
+                    raise Thor::Error.new("Specified pact file '#{path}' does not exist. This sometimes indicates one of the arguments has been specified with the wrong name and has been incorrectly identified as a file path. If you are using Docker, check that you have mounted the pact file or directory into the container correctly using `-v`, and have specified the location of the pact file or directory in the *Docker container*, not the *host*.")
                   end
                 end
               end

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

@@ -25,7 +25,7 @@ module PactBroker
                 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 :contract_requiring_verification_published, type: :boolean, desc: "Trigger this webhook when a contract is published that requires verification"
-                method_option :team_uuid, banner: "UUID", desc: "UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)"
+                method_option :team_uuid, banner: "UUID", desc: "UUID of the PactFlow team to which the webhook should be assigned (PactFlow only)"
                 shared_authentication_options
               end
             end

data/lib/pact_broker/client/colorize_notices.rb

@@ -1,5 +1,5 @@
 require 'term/ansicolor'
-
+require "uri"
 module PactBroker
   module Client
     class ColorizeNotices
@@ -11,16 +11,27 @@ module PactBroker
 
       def self.colorized_message(notice)
         color = color_for_type(notice.type)
-        if color
+        uri_strings = ::URI.extract(notice.text, %w(http https))
+        if color && uri_strings.any?
+          color_for_url(::Term::ANSIColor.color(color, notice.text || ''), uri_strings)
+        elsif color
           ::Term::ANSIColor.color(color, notice.text || '')
+        elsif uri_strings.any?
+          color_for_url(notice.text, uri_strings)
         else
           notice.text
         end
       end
 
+      def self.color_for_url(text, uris)
+        uris.inject(text) do | new_text, uri  |
+          new_text.gsub(uri, ::Term::ANSIColor.magenta(uri))
+        end
+      end
+
       def self.color_for_type(type)
         case type
-        when "warning", "prompt" then "yellow"
+        when "warning", "prompt" then :yellow
         when "error", "danger" then :red
         when "success" then :green
         else nil

data/lib/pact_broker/client/deployments/record_release.rb

@@ -31,7 +31,7 @@ module PactBroker
 
         def not_supported_message
           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."
+            "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

data/lib/pact_broker/client/environments/environment_command.rb

@@ -8,7 +8,7 @@ module PactBroker
         using PactBroker::Client::HashRefinements
 
         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."
+        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
 

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

@@ -163,7 +163,7 @@ module PactBroker
         end
 
         def relation_not_found_error_message(key, href)
-          "Could not find relation '#{key}' in resource at #{href}. The most likely reason for this is that you are on an old version of the Pact Broker and you need to upgrade, or you are using Pactflow and you don't have the permissions required for this action."
+          "Could not find relation '#{key}' in resource at #{href}. The most likely reason for this is that you are on an old version of the Pact Broker and you need to upgrade, or you are using PactFlow and you don't have the permissions required for this action."
         end
       end
 

data/lib/pact_broker/client/hal_client_methods.rb

@@ -29,7 +29,7 @@ module PactBroker
       end
 
       def pact_broker_name
-        is_pactflow? ? "Pactflow" : "the Pact Broker"
+        is_pactflow? ? "PactFlow" : "the Pact Broker"
       end
     end
   end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.66.1'
+    VERSION = '1.67.0'
   end
 end

data/lib/pactflow/client/cli/provider_contract_commands.rb

@@ -10,7 +10,7 @@ module Pactflow
 
         def self.included(thor)
           thor.class_eval do
-            desc 'publish-provider-contract CONTRACT_FILE ...', "Publish provider contract to Pactflow"
+            desc 'publish-provider-contract CONTRACT_FILE ...', "Publish provider contract to PactFlow"
             method_option :provider, required: true, desc: "The provider name"
             method_option :provider_app_version, required: true, aliases: "-a", desc: "The provider application version"
             method_option :branch, aliases: "-h", desc: "Repository branch of the provider version"

data/lib/pactflow/client/provider_contracts/publish.rb

@@ -1,5 +1,6 @@
 require "pact_broker/client/base_command"
 require "pact_broker/client/versions/create"
+require 'pact_broker/client/colorize_notices'
 require "base64"
 
 module Pactflow
@@ -22,8 +23,33 @@ module Pactflow
 
         def do_call
           create_branch_version_and_tags
-          create_contract
-          PactBroker::Client::CommandResult.new(true, green("Successfully published provider contract for #{provider_name} version #{provider_version_number} to Pactflow"))
+          render_response(create_contract)
+        end
+
+        def render_response(res)
+          notices = [
+            { type: 'success', text: "Successfully published provider contract for #{provider_name} version #{provider_version_number} to PactFlow"},
+          ]
+          if res.body && res.body['_links'] && res.body['_links']['pf:ui']['href']
+            notices.concat([{ text: "View the uploaded contract at #{res.body['_links']['pf:ui']['href']}" }])
+          end
+          notices.concat(next_steps)
+          PactBroker::Client::CommandResult.new(true, PactBroker::Client::ColorizeNotices.call(notices.collect do |n|
+                                                                                                 OpenStruct.new(n)
+                                                                                               end).join("\n"))
+        end
+
+        def next_steps
+          [
+            { type: 'prompt', text: 'Next steps:' },
+            { type: 'prompt',
+              text: '  * Check your application is safe to deploy - https://docs.pact.io/can_i_deploy' },
+            { text: "       pact-broker can-i-deploy --pacticipant #{provider_name} --version #{provider_version_number} --to-environment <your environment name>" },
+            { type: 'prompt',
+              text: '  * Record deployment or release to specified environment (choose one) - https://docs.pact.io/go/record-deployment' },
+            { text: "       pact-broker record-deployment --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" },
+            { text: "       pact-broker record-release --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" }
+          ]
         end
 
         def create_branch_version_and_tags
@@ -44,7 +70,7 @@ module Pactflow
         def create_contract
           contract_path = "#{pact_broker_base_url}/contracts/provider/{provider}/version/{version}"
           entrypoint = create_entry_point(contract_path, pact_broker_client_options)
-          entrypoint.expand(provider: provider_name, version: provider_version_number).put!(contract_params)
+          entrypoint.expand(provider: provider_name, version: provider_version_number).put!(contract_params).response
         end
 
         def contract_params
@@ -56,7 +82,7 @@ module Pactflow
                                           verifier: verification_results[:verifier],
                                           verifierVersion: verification_results[:verifier_version]
                                         }.compact
-
+                                        
           body_params = {
                           content: encode_content(contract[:content]),
                           contractType: contract[:specification],
@@ -66,7 +92,6 @@ module Pactflow
           if verification_results_params.any?
             body_params[:verificationResults] = verification_results_params
           end
-
           body_params
         end
 

data/pact-broker-client.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
   gem.add_runtime_dependency 'dig_rb', '~> 1.0'
 
-  gem.add_development_dependency 'fakefs', '~> 0.4'
+  gem.add_development_dependency 'fakefs', '~> 2.4'
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
   gem.add_development_dependency 'pact', '~> 1.16'
   gem.add_development_dependency 'pact-support', '~> 1.16'
-  gem.add_development_dependency 'approvals', '0.0.18' 
+  gem.add_development_dependency 'approvals', '0.0.26' 
   gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

data/script/update-cli-usage-in-readme.rb

@@ -22,7 +22,7 @@ PACT_BROKER_COMMAND_GROUPS = [
 ]
 
 PACTFLOW_COMMAND_GROUPS = [
-  [Pactflow::Client::CLI::Pactflow, "Provider contracts (Pactflow only)", %w[publish-provider-contract]]
+  [Pactflow::Client::CLI::Pactflow, "Provider contracts (PactFlow only)", %w[publish-provider-contract]]
 ]
 
 def print_wrapped(message, options = {})
@@ -86,12 +86,16 @@ STATES = {
     /^Usage:/ => :usage
   },
   usage: {
-    /^Options:/ => :options
+    /^Options:/ => :options,
   },
   options: {
     /^$/ => :after_options
   },
   after_options: {
+    /^Usage:/ => :usage,
+    /^  ##### / => :section_in_usage
+  },
+  section_in_usage: {
     /^Usage:/ => :usage
   }
 }
@@ -126,13 +130,14 @@ def reformat_docs(generated_thor_docs, command)
       @current_state = transitions[line_starts_with]
     end
 
-
     lines = if has_option_and_banner(line)
       option, banner = line.split("#", 2)
       [option] + format_banner("# " + banner)
     elsif has_only_banner(line)
       space, banner = line.split("#", 2)
       format_banner("#  " + banner)
+    elsif @current_state == :section_in_usage
+      [line.strip]
     else
       [line]
     end

data/spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb

@@ -70,6 +70,16 @@ module PactBroker
             expect(CanIDeploy).to receive(:call).with(anything, {to_tag: nil, to_environment: 'prod', limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
+
+          context "when the environment is an empty string" do
+            before do
+              subject.options.to_environment = ' '
+            end
+
+            it "raises an error" do
+              expect { invoke_can_i_deploy }.to raise_error ::Thor::RequiredArgumentMissingError
+            end
+          end
         end
 
         context "with basic auth" do

data/spec/lib/pact_broker/client/cli/custom_thor_spec.rb

@@ -72,6 +72,21 @@ module PactBroker::Client::CLI
       end
     end
 
+    it "removes trailing slashes from the broker base url when passed as an arg" do
+      expect(Delegate).to receive(:call) do | options |
+        expect(options.broker_base_url).to eq 'http://bar'
+      end
+      TestThor.start(%w{test_using_env_vars --broker-base-url http://bar/})
+    end
+
+    it "removes trailing slashes from the broker base url when passed as an env var" do
+      ENV['PACT_BROKER_BASE_URL'] = 'http://bar/'
+      expect(Delegate).to receive(:call) do | options |
+        expect(options.broker_base_url).to eq 'http://bar'
+      end
+      TestThor.start(%w{test_using_env_vars})
+    end
+
     describe ".turn_muliple_tag_options_into_array" do
       it "turns '--tag foo --tag bar' into '--tag foo bar'" do
         input = %w{--ignore this --tag foo --tag bar --wiffle --that}

data/spec/lib/pact_broker/client/deployments/record_deployment_spec.rb

@@ -96,7 +96,7 @@ module PactBroker
               expect(subject.message).to include "does not support"
             end
 
-            context "when the server is Pactflow" do
+            context "when the server is PactFlow" do
               let(:index_headers) { { "Content-Type" => "application/hal+json", "Pactflow-Something" => "foo" } }
 
               it "returns an error response" do
@@ -165,7 +165,7 @@ module PactBroker
                 expect(subject.message).to include "No environment found with name 'test'. Available options: prod"
               end
 
-              context "when the server is Pactflow" do
+              context "when the server is PactFlow" do
                 let(:index_headers) { { "Content-Type" => "application/hal+json", "X-Pactflow-Sha" => "123" } }
 
                 it "returns a customised message" do
@@ -191,7 +191,7 @@ module PactBroker
             end
           end
 
-          context "when the response headers contain Pactflow" do
+          context "when the response headers contain PactFlow" do
             before do
               allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
               allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
@@ -205,8 +205,8 @@ module PactBroker
               double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
             end
 
-            it "indicates the API was Pactflow" do
-              expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment (application instance blue) in Pactflow"
+            it "indicates the API was PactFlow" do
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment (application instance blue) in PactFlow"
             end
 
             context "when application_instance is nil" do

data/spec/pacts/pact_broker_client-pactflow.json

@@ -3,7 +3,7 @@
     "name": "Pact Broker Client"
   },
   "provider": {
-    "name": "Pactflow"
+    "name": "PactFlow"
   },
   "interactions": [
     {
@@ -36,6 +36,44 @@
         }
       }
     },
+    {
+      "description": "a request to create a provider contract",
+      "providerState": "there is a pf:ui href in the response",
+      "request": {
+        "method": "put",
+        "path": "/contracts/provider/Bar/version/1",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+          "contractType": "oas",
+          "contentType": "application/yaml",
+          "verificationResults": {
+            "success": true,
+            "content": "c29tZSByZXN1bHRz",
+            "contentType": "text/plain",
+            "format": "text",
+            "verifier": "my custom tool",
+            "verifierVersion": "1.0"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pf:ui": {
+              "href": "http://localhost:1235/contracts/bi-directional/provider/Bar/version/1/provider-contract"
+            }
+          }
+        }
+      }
+    },
     {
       "description": "a request for the index resource",
       "request": {

data/spec/service_providers/pact_helper.rb

@@ -15,7 +15,7 @@ Pact.service_consumer 'Pact Broker Client' do
     end
   end
 
-  has_pact_with "Pactflow" do
+  has_pact_with "PactFlow" do
     mock_service :pactflow do
       port 1235
       pact_specification_version "2.0"

data/spec/service_providers/pactflow_publish_provider_contract_spec.rb

@@ -2,7 +2,7 @@ require_relative "pact_helper"
 require "pactflow/client/provider_contracts/publish"
 require "yaml"
 
-RSpec.describe "publishing a provider contract to Pactflow", pact: true do
+RSpec.describe "publishing a provider contract to PactFlow", pact: true do
   before do
     # no point re-testing this
     allow(PactBroker::Client::Versions::Create).to receive(:call).and_return(double("result", success: true))
@@ -87,6 +87,41 @@ RSpec.describe "publishing a provider contract to Pactflow", pact: true do
       expect(subject).to be_a PactBroker::Client::CommandResult
       expect(subject.success).to be true
       expect(subject.message).to include "Successfully published provider contract for Bar version 1"
+      expect(subject.message).not_to include pactflow.mock_service_base_url
     end
   end
-end
+
+  context "creating a provider contract with valid parameters with pf:ui return results" do
+    let(:success_response_with_pf_ui_url) do
+      {
+        status: response_status,
+        headers: pact_broker_response_headers,
+        body: { "_links": {
+          "pf:ui": {
+            "href": "#{pactflow.mock_service_base_url}/contracts/bi-directional/provider/Bar/version/1/provider-contract"
+          }
+        } }
+      }
+    end
+    before do
+      pactflow
+        .given("there is a pf:ui href in the response")
+        .upon_receiving("a request to create a provider contract")
+        .with(
+          method: :put,
+          path: "/contracts/provider/Bar/version/1",
+          headers: put_request_headers,
+          body: request_body
+        )
+        .will_respond_with(success_response_with_pf_ui_url)
+    end
+
+    it "returns a CommandResult with success = true and a provider contract ui url" do
+      expect(subject).to be_a PactBroker::Client::CommandResult
+      expect(subject.success).to be true
+      expect(subject.message).to include "Successfully published provider contract for Bar version 1"
+      expect(subject.message).to include "Next steps:"
+      expect(subject.message).to include success_response_with_pf_ui_url[:body][:_links][:'pf:ui'][:href]
+    end
+  end
+end

data/spec/service_providers/pactflow_webhooks_create_spec.rb

@@ -1,7 +1,7 @@
 require_relative 'pact_helper'
 require 'pact_broker/client/webhooks/create'
 
-RSpec.describe "creating a webhook in Pactflow", pact: true do
+RSpec.describe "creating a webhook in PactFlow", pact: true do
 
   include_context "pact broker"
   include PactBrokerPactHelperMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.66.1
+  version: 1.67.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -112,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -182,14 +182,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.18
+        version: 0.0.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.18
+        version: 0.0.26
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +215,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/release_gem.yml"
+- ".github/workflows/smartbear-issue-label-added.yml"
 - ".github/workflows/test.yml"
 - ".github/workflows/trigger_pact_docs_update.yml"
 - ".gitignore"
@@ -236,8 +237,10 @@ files:
 - doc/pacts/markdown/README.md
 - example/scripts/README.md
 - example/scripts/deploy-consumer.sh
+- example/scripts/oas.yml
 - example/scripts/pact.json
 - example/scripts/publish-pact.sh
+- example/scripts/publish-provider-contract.sh
 - example/scripts/publish-verification.sh
 - example/scripts/verification.json
 - example/scripts/verify-changed-pact.sh
@@ -446,7 +449,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: See description