pact_broker-client 1.50.0 → 1.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebb0899f37221475b93ac43b01a535aa03a0f991fcf367556e83697f293873b8
-  data.tar.gz: 1627a56a6fc1302c6bc381786c4a6f385485fa26a75cded5b3630ffb5afa1809
+  metadata.gz: 854312863c664ff8f355fcab3d2cb3733bf7c229f75b98aa9f2f9187a93d5409
+  data.tar.gz: c02cfe9055664950a2811e3351c701431e5a6916a6a06e21e34aab14ee94520c
 SHA512:
-  metadata.gz: 45636dfd9a5b865d870baf6147833562365e4fbf9fbbe80b9b0d5f34779defd3dacec69ddf1772167a65ab17da6389d8c7f183764e594fc23b85cecfe15b60ca
-  data.tar.gz: 02d6f6a5a7514a32711179de4667bd57a247c440d6c95c046eacd291b0a31bf2eff89f9027bf79a0f14bf78fcb45aa9102b415c0945bee13477de539bfa4f4f8
+  metadata.gz: d5be4a8a3fc89a6606aac689d9da2a335393d0ef8e0b01e7f09c5745798c475ff1b53be34b00284c00e0cadaffecd834a75d03cca9805c8b386e2c9f223af8ec
+  data.tar.gz: dc9192512acf2a696f635274b504042a960c8d3eded2ae7b07e17e1dc982de0badc177686fb62d9516d9976cc5d9a5fd9564b4d02bf47f6ad2bcc3e56576a590

data/.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        feature: ["", "publish_contracts"]
+        feature: [""]
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="v1.51.0"></a>
+### v1.51.0 (2021-09-22)
+
+#### Features
+
+* enable use of the new 'all in one' contracts publishing endpoint without a feature toggle	 ([6850ace](/../../commit/6850ace))
+
 <a name="v1.50.0"></a>
 ### v1.50.0 (2021-08-16)
 

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

@@ -42,6 +42,8 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource) given the pb:pacticipant-version relation exists in the index resource
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource) given the pb:publish-contracts relations exists in the index resource
+
 * [A request for the index resource with the webhook relation](#a_request_for_the_index_resource_with_the_webhook_relation)
 
 * [A request for the list of the latest pacts from all consumers for the Pricing Service'](#a_request_for_the_list_of_the_latest_pacts_from_all_consumers_for_the_Pricing_Service'_given_a_latest_pact_between_Condor_and_the_Pricing_Service_exists) given a latest pact between Condor and the Pricing Service exists
@@ -100,6 +102,8 @@
 
 * [A request to publish a pact with method put](#a_request_to_publish_a_pact_with_method_put_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker,_and_Condor_already_has_a_pact_published_for_version_1.3.0) given the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0
 
+* [A request to publish contracts](#a_request_to_publish_contracts)
+
 * [A request to record a deployment](#a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
 
 * [A request to record a release](#a_request_to_record_a_release_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
@@ -882,6 +886,33 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource"></a>
+Given **the pb:publish-contracts relations exists in the index resource**, 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:publish-contracts": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_with_the_webhook_relation"></a>
 Upon receiving **a request for the index resource with the webhook relation** from Pact Broker Client, with
 ```json
@@ -2119,6 +2150,75 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_publish_contracts"></a>
+Upon receiving **a request to publish contracts** from Pact Broker Client, with
+```json
+{
+  "method": "POST",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "pacticipantName": "Foo",
+    "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+    "branch": "main",
+    "tags": [
+      "dev"
+    ],
+    "buildUrl": "http://build",
+    "contracts": [
+      {
+        "consumerName": "Foo",
+        "providerName": "Bar",
+        "specification": "pact",
+        "contentType": "application/json",
+        "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
+        "onConflict": "merge"
+      }
+    ]
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_embedded": {
+      "pacticipant": {
+        "name": "Foo"
+      },
+      "version": {
+        "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "buildUrl": "http://build"
+      }
+    },
+    "logs": [
+      {
+        "level": "info",
+        "message": "some message"
+      }
+    ],
+    "_links": {
+      "pb:pacticipant-version-tags": [
+        {
+          "name": "dev"
+        }
+      ],
+      "pb:contracts": [
+        {
+          "href": "http://some-pact"
+        }
+      ]
+    }
+  }
+}
+```
 <a name="a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
 Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request to record a deployment** from Pact Broker Client, with
 ```json

data/lib/pact_broker/client/publish_pacts.rb

@@ -28,7 +28,7 @@ module PactBroker
 
       def call
         validate
-        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("publish_contracts") && index_resource.can?("pb:publish-contracts")
+        if index_resource.can?("pb:publish-contracts")
           publish_pacts
           PactBroker::Client::CommandResult.new(success?, message)
         else
@@ -115,9 +115,8 @@ module PactBroker
             specification: "pact",
             contentType: "application/json",
             content: Base64.strict_encode64(pact_hash.to_json),
-            writeMode: write_mode,
-            onConflict: write_mode
-          }
+            onConflict: on_conflict
+          }.compact
         end
       end
 
@@ -137,8 +136,8 @@ module PactBroker
         pact_files.collect(&:consumer_name).uniq
       end
 
-      def write_mode
-        options[:merge] ? "merge" : "overwrite"
+      def on_conflict
+        options[:merge] ? "merge" : nil
       end
 
       def validate

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.50.0'
+    VERSION = '1.51.0'
   end
 end

data/script/publish-pact.sh

@@ -28,7 +28,7 @@ bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --contract-published
 
 
-PACT_BROKER_FEATURES=publish_contracts bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
   --consumer-app-version 1.2.26 \
   --broker-base-url http://localhost:9292 \
    --broker-token localhost \

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1636,6 +1636,112 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:publish-contracts relations exists in the index resource",
+      "request": {
+        "method": "GET",
+        "path": "/",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:publish-contracts": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:publish-contracts.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to publish contracts",
+      "request": {
+        "method": "POST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "pacticipantName": "Foo",
+          "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+          "branch": "main",
+          "tags": [
+            "dev"
+          ],
+          "buildUrl": "http://build",
+          "contracts": [
+            {
+              "consumerName": "Foo",
+              "providerName": "Bar",
+              "specification": "pact",
+              "contentType": "application/json",
+              "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
+              "onConflict": "merge"
+            }
+          ]
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_embedded": {
+            "pacticipant": {
+              "name": "Foo"
+            },
+            "version": {
+              "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+              "buildUrl": "http://build"
+            }
+          },
+          "logs": [
+            {
+              "level": "info",
+              "message": "some message"
+            }
+          ],
+          "_links": {
+            "pb:pacticipant-version-tags": [
+              {
+                "name": "dev"
+              }
+            ],
+            "pb:contracts": [
+              {
+                "href": "http://some-pact"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body.logs": {
+            "min": 1
+          },
+          "$.body.logs[*].*": {
+            "match": "type"
+          },
+          "$.body._links.pb:contracts[0].href": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request for the index resource",
       "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",

data/spec/service_providers/publish_pacts_spec.rb

@@ -1,9 +1,7 @@
 require 'pact_broker/client/publish_pacts'
 require 'service_providers/pact_helper'
 
-publish_contracts_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("publish_contracts")
-
-RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feature_on do
+RSpec.describe "publishing contracts", pact: true do
   before do
     allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
     allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
@@ -27,7 +25,7 @@ RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feat
   end
   let(:pact_file_path_1) { "spec/fixtures/foo-bar.json" }
   let(:pact_file_paths) { [pact_file_path_1] }
-  let(:options) { {} }
+  let(:options) { { merge: true } }
   let(:pact_broker_client_options) { {} }
   let(:expected_content) { Base64.strict_encode64(JSON.parse(File.read(pact_file_path_1)).to_json) }
   let(:request_body) do
@@ -44,8 +42,7 @@ RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feat
           specification: "pact",
           contentType: "application/json",
           content: expected_content,
-          writeMode: "overwrite",
-          onConflict: "overwrite"
+          onConflict: "merge"
         }
       ]
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.50.0
+  version: 1.51.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -431,7 +431,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.27
 signing_key: 
 specification_version: 4
 summary: See description