pact_broker-client 1.77.0 → 1.78.0

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

@@ -0,0 +1,267 @@
+### A pact between Pact Broker Client V2 and PactFlow
+
+#### Requests from Pact Broker Client V2 to PactFlow
+
+* [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_pb:publish-provider-contract_relation_exists_in_the_index_resource) given the pb:publish-provider-contract relation exists in 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
+
+* [A request to publish a provider contract](#a_request_to_publish_a_provider_contract)
+
+#### Interactions
+
+<a name="a_request_for_the_index_resource"></a>
+Upon receiving **a request for the index resource** from Pact Broker Client V2, with
+```json
+{
+  "method": "GET",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+PactFlow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipant": {
+        "href": "/pacticipants/{pacticipant}"
+      },
+      "pb:pacticipants": {
+        "href": "/pacticipants"
+      },
+      "pb:webhooks": {
+        "href": "/webhooks"
+      }
+    }
+  }
+}
+```
+<a name="a_request_for_the_index_resource_given_the_pb:publish-provider-contract_relation_exists_in_the_index_resource"></a>
+Given **the pb:publish-provider-contract relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client V2, with
+```json
+{
+  "method": "GET",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+PactFlow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pf:publish-provider-contract": {
+        "href": "/provider-contracts/provider/{provider}/publish"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_provider_contract"></a>
+Upon receiving **a request to create a provider contract** from Pact Broker Client V2, with
+```json
+{
+  "method": "PUT",
+  "path": "/contracts/provider/Bar/version/1",
+  "headers": {
+    "Accept": "application/hal+json",
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
+    "contentType": "application/yaml",
+    "contractType": "oas",
+    "verificationResults": {
+      "content": "c29tZSByZXN1bHRz",
+      "contentType": "text/plain",
+      "format": "text",
+      "success": true,
+      "verifier": "my custom tool",
+      "verifierVersion": "1.0"
+    }
+  }
+}
+```
+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 V2, with
+```json
+{
+  "method": "PUT",
+  "path": "/contracts/provider/Bar/version/1",
+  "headers": {
+    "Accept": "application/hal+json",
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
+    "contentType": "application/yaml",
+    "contractType": "oas",
+    "verificationResults": {
+      "content": "c29tZSByZXN1bHRz",
+      "contentType": "text/plain",
+      "format": "text",
+      "success": true,
+      "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": "some-url"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists"></a>
+Given **a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists**, upon receiving **a request to create a webhook for a team** from Pact Broker Client V2, with
+```json
+{
+  "method": "POST",
+  "path": "/webhooks",
+  "headers": {
+    "Accept": "application/hal+json",
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "body": {
+        "some": "body"
+      },
+      "headers": {
+        "Bar": "foo",
+        "Foo": "bar"
+      },
+      "method": "POST",
+      "url": "https://webhook"
+    },
+    "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9"
+  }
+}
+```
+PactFlow will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "self": {
+        "href": "/some-url",
+        "title": "A title"
+      }
+    },
+    "description": "a webhook",
+    "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9"
+  }
+}
+```
+<a name="a_request_to_publish_a_provider_contract"></a>
+Upon receiving **a request to publish a provider contract** from Pact Broker Client V2, with
+```json
+{
+  "method": "POST",
+  "path": "/provider-contracts/provider/Bar/publish",
+  "headers": {
+    "Accept": "application/hal+json, application/problem+json",
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://build",
+    "contract": {
+      "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
+      "contentType": "application/yaml",
+      "selfVerificationResults": {
+        "content": "c29tZSByZXN1bHRz",
+        "contentType": "text/plain",
+        "format": "text",
+        "success": true,
+        "verifier": "my custom tool",
+        "verifierVersion": "1.0"
+      },
+      "specification": "oas"
+    },
+    "pacticipantVersionNumber": "1",
+    "tags": [
+      "dev"
+    ]
+  }
+}
+```
+PactFlow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_embedded": {
+      "version": {
+        "number": "1"
+      }
+    },
+    "_links": {
+      "pb:branch-version": {
+        },
+      "pb:pacticipant-version-tags": [
+        {
+        }
+      ]
+    },
+    "notices": [
+      {
+        "text": "some notice",
+        "type": "info"
+      }
+    ]
+  }
+}
+```

data/doc/pacts/markdown/README.md

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

data/lib/pact_broker/client/base_client.rb

@@ -3,6 +3,7 @@
 require 'erb'
 require 'httparty'
 require 'pact_broker/client/error'
+require 'pact_broker/client/user_agent'
 require 'cgi'
 
 module PactBroker
@@ -104,15 +105,16 @@ module PactBroker
       end
 
       def patch url, options
-        self.class.patch(url, @default_options.merge(options.merge(body: options[:body].to_json)))
+        enriched = enrich_options(options)
+        self.class.patch(url, @default_options.merge(enriched.merge(body: options[:body].to_json)))
       end
 
       def put url, options = {}, &block
-        self.class.put(url, @default_options.merge(options), &block)
+        self.class.put(url, @default_options.merge(enrich_options(options)), &block)
       end
 
       def get url, options = {}, &block
-        self.class.get(url, @default_options.merge(options), &block)
+        self.class.get(url, @default_options.merge(enrich_options(options)), &block)
       end
 
       def url_for_relation relation_name, params
@@ -133,6 +135,16 @@ module PactBroker
       def verbose?
         @verbose
       end
+
+      private
+
+      def enrich_options(options)
+        options.merge(headers: user_agent_header.merge(options.fetch(:headers, {})))
+      end
+
+      def user_agent_header
+        { 'User-Agent' => PactBroker::Client.user_agent_string('httparty', HTTParty::VERSION) }
+      end
     end
   end
 end

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

@@ -1,5 +1,6 @@
 require 'pact_broker/client/retry'
 require 'pact_broker/client/hal/authorization_header_redactor'
+require 'pact_broker/client/user_agent'
 require 'net/http'
 require 'json'
 require 'openssl'
@@ -58,6 +59,9 @@ module PactBroker
           request.body = body if body
           request.basic_auth username, password if username
           request['Authorization'] = "Bearer #{token}" if token
+          unless headers.any? { |k, _| k.downcase == 'user-agent' }
+            request['User-Agent'] = PactBroker::Client.user_agent_string('net-http', Net::HTTP::VERSION)
+          end
           request
         end
 

data/lib/pact_broker/client/user_agent.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pact_broker/client/version'
+
+module PactBroker
+  module Client
+    class << self
+      attr_accessor :tool_identifier
+
+      def user_agent_string(http_lib_name, http_lib_version)
+        base = "pact_broker-client/#{VERSION} #{http_lib_name}/#{http_lib_version} ruby/#{RUBY_VERSION}"
+        if tool_identifier && !tool_identifier.empty?
+          "#{tool_identifier} #{base}"
+        else
+          base
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.77.0'
+    VERSION = '1.78.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -29,7 +29,7 @@ module PactBroker
       end
 
       def tag options
-        response = put(tag_url(options), headers: default_put_headers.merge("Content-Length" => "0"))
+        response = put(tag_url(options), headers: default_put_headers, body: {}.to_json)
         handle_response(response) do
           true
         end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.77.0
+  version: 1.78.0
 platform: ruby
 authors:
 - Beth Skurrie
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -162,6 +161,8 @@ files:
 - doc/CAN_I_DEPLOY_USAGE_WITH_TAGS.md
 - doc/pacts/markdown/Pact Broker Client - Pact Broker.md
 - doc/pacts/markdown/Pact Broker Client - PactFlow.md
+- doc/pacts/markdown/Pact Broker Client V2 - Pact Broker.md
+- doc/pacts/markdown/Pact Broker Client V2 - PactFlow.md
 - doc/pacts/markdown/README.md
 - example/scripts/README.md
 - example/scripts/deploy-consumer.sh
@@ -248,6 +249,7 @@ files:
 - lib/pact_broker/client/string_refinements.rb
 - lib/pact_broker/client/tasks.rb
 - lib/pact_broker/client/tasks/publication_task.rb
+- lib/pact_broker/client/user_agent.rb
 - lib/pact_broker/client/verification_required.rb
 - lib/pact_broker/client/version.rb
 - lib/pact_broker/client/versions.rb
@@ -266,7 +268,6 @@ files:
 - pact-broker-client.gemspec
 - script/approve-all.sh
 - script/can-i-deploy.sh
-- script/ci/delete-branch-in-pactflow.sh
 - script/ci/record-release.sh
 - script/create-pacticipant.sh
 - script/foo-bar.json
@@ -286,7 +287,6 @@ homepage: https://github.com/pact-foundation/pact_broker-client.git
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -301,8 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.14
 specification_version: 4
 summary: See description
 test_files: []

data/script/ci/delete-branch-in-pactflow.sh

@@ -1,22 +0,0 @@
-#!/bin/bash
-
-set -Eeuo pipefail
-
-echo "Deleting branch ${GIT_BRANCH} for ${PACTICIPANT} in Pactflow..."
-ENCODED_GIT_BRANCH=$(echo "$GIT_BRANCH" | ruby -e "require 'erb'; puts ERB::Util.url_encode(ARGF.read.chomp)")
-ENCODED_PACTICIPANT=$(echo "$PACTICIPANT" | ruby -e "require 'erb'; puts ERB::Util.url_encode(ARGF.read.chomp)")
-BRANCH_URL="${PACT_BROKER_BASE_URL}/pacticipants/${ENCODED_PACTICIPANT}/branches/${ENCODED_GIT_BRANCH}"
-
-output_file=$(mktemp)
-
-status=$(curl -v -X DELETE "${BRANCH_URL}" -H "Authorization: Bearer ${PACT_BROKER_TOKEN}" 2>&1 | tee "${output_file}" | awk '/^< HTTP/{print $3}')
-
-if [ "$status" = "404" ]; then
-  echo "Branch ${GIT_BRANCH} for ${PACTICIPANT} does not exist in Pactflow"
-elif [ $status -ge 400 ]; then
-  cat "${output_file}"
-  echo "Error deleting branch in Pactflow"
-  exit 1
-else
-  echo "Deleted branch ${GIT_BRANCH} for ${PACTICIPANT} in Pactflow"
-fi