pact_broker-client 1.25.0 → 1.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c23dc5746d9c229a4e357c8fe96273902ba48eb009a23feba13ec82e176bbb30
-  data.tar.gz: 482f212c6ed800809fe09ac51cc42b4bddf726fc0a1d37d9ad271cdbb12378d4
+  metadata.gz: 7c78c1aac0ad2d50892f581f5bf0bb77b4b73e32b1ae359ae94a62eb4d62855b
+  data.tar.gz: 509cc602635703e5ff07520ef5b0163ff47ed4cbaadebca33de0ebced3d34bdd
 SHA512:
-  metadata.gz: b5dc6e9ffc7ee3d88711cc0a606d2616e00c826e6681bc84a652e37f18a944f8e402b7265a828a4ddbd16a7d5591fd9e40f8938761112411f58a08c2cc1cc3c6
-  data.tar.gz: c28296e8fc790b329061809abaa58af206765061fdb5d07bf2c1d60861408184b304f20c725faf2b3a4ebb59ca3e8cf23f8d8d992f9069da63b55ba60826b13d
+  metadata.gz: 38988ea9692c16df96c3ba1c18cbd2509286efede5b7e72d2561540ffeb78e0d5e442a83aacd26f2ca61f4939a2e4458130bcdc0f605e1711c304590f281e9e0
+  data.tar.gz: 2efd70539e123a3b2b7ffbe7f2c691f497ba4dc1034fb25d4fd5800faa4cae50bbd2960ba3a87a149decb5127bdc7621873f51d60ab48dc988f5059bad3a6125

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+<a name="v1.25.1"></a>
+### v1.25.1 (2020-04-02)
+
+
+#### Features
+
+* **create-or-update-webhook**
+  * print 'created' or 'updated' based on response status	 ([0c34090](/../../commit/0c34090))
+
+
+#### Bug Fixes
+
+* incorrect require path for hal entity	 ([64f3b7b](/../../commit/64f3b7b))
+* correctly handle multiple parameters specified in the format --name=value	 ([946001b](/../../commit/946001b))
+
+
 <a name="v1.25.0"></a>
 ### v1.25.0 (2020-02-18)
 

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

@@ -92,6 +92,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 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
 
 #### Interactions
@@ -766,6 +768,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -864,6 +867,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -917,6 +921,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -967,6 +972,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1072,6 +1078,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1120,6 +1127,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1182,6 +1190,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
+    "description": "a webhook",
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1800,6 +1809,63 @@ Pact Broker will respond with:
   }
 }
 ```
+<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
+{
+  "method": "put",
+  "path": "/webhooks/696c5f93-1b7f-44bc-8d03-59440fcaa9a0",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      },
+      "username": "username",
+      "password": "password"
+    },
+    "provider": {
+      "name": "Pricing Service"
+    },
+    "consumer": {
+      "name": "Condor"
+    }
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```
 <a name="an_invalid_request_to_create_a_webhook_for_a_consumer_and_provider_given_the_&#39;Pricing_Service&#39;_and_&#39;Condor&#39;_already_exist_in_the_pact-broker"></a>
 Given **the 'Pricing Service' and 'Condor' already exist in the pact-broker**, upon receiving **an invalid request to create a webhook for a consumer and provider** from Pact Broker Client, with
 ```json

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

@@ -249,6 +249,7 @@ module PactBroker
 
             {
               uuid: options.uuid,
+              description: options.description,
               http_method: options.request,
               url: webhook_url,
               headers: headers,

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

@@ -45,20 +45,31 @@ module PactBroker
           def self.turn_muliple_tag_options_into_array argv
             new_argv = []
             opt_name = nil
-            argv.each_with_index do | arg, i |
-              if arg.start_with?('-')
-                opt_name = arg
-                existing = new_argv.find { | a | a.first == opt_name }
-                if !existing
-                  new_argv << [arg]
+            argv.each_with_index do | word, i |
+              if word.start_with?('-')
+                if word.include?('=')
+                  opt_name, opt_value = word.split('=', 2)
+
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  if existing
+                    existing << opt_value
+                  else
+                    new_argv << [opt_name, opt_value]
+                  end
+                else
+                  opt_name = word
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  if !existing
+                    new_argv << [word]
+                  end
                 end
               else
                 if opt_name
                   existing = new_argv.find { | a | a.first == opt_name }
-                  existing << arg
+                  existing << word
                   opt_name = nil
                 else
-                  new_argv << [arg]
+                  new_argv << [word]
                 end
               end
             end
@@ -76,17 +87,17 @@ module PactBroker
           end
 
           def self.shared_options_for_webhook_commands
-            method_option :request, banner: "METHOD", aliases: "-X", desc: "HTTP method", required: true
-            method_option :header, aliases: "-H", type: :array, desc: "Header"
-            method_option :data, aliases: "-d", desc: "Data"
-            method_option :user, aliases: "-u", desc: "Basic auth username and password eg. username:password"
+            method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
+            method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
+            method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
+            method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
             method_option :consumer, desc: "Consumer name"
             method_option :provider, desc: "Provider name"
             method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
             method_option :broker_username, desc: "Pact Broker basic auth username"
             method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
             method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
-            method_option :description, desc: "The description of the webhook"
+            method_option :description, desc: "Wwebhook description"
             method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
             method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
             method_option :provider_verification_published, type: :boolean, desc: "Trigger this webhook when a provider verification result is published"

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

@@ -6,11 +6,9 @@ module PactBroker
   module Client
     module Hal
       class RelationNotFoundError < ::PactBroker::Client::Error; end
-
       class ErrorResponseReturned < ::PactBroker::Client::Error; end
 
       class Entity
-
         def initialize(href, data, http_client, response = nil)
           @href = href
           @data = data
@@ -71,7 +69,7 @@ module PactBroker
           elsif @links.key?(method_name)
             Link.new(@links[method_name], @client).run(*args)
           else
-            super
+            nil
           end
         end
 

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

@@ -62,7 +62,7 @@ module PactBroker
         private
 
         def wrap_response(href, http_response)
-          require 'pact/hal/entity' # avoid circular reference
+          require 'pact_broker/client/hal/entity' # avoid circular reference
           if http_response.success?
             Entity.new(href, http_response.body, @http_client, http_response)
           else

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.25.0'
+    VERSION = '1.25.1'
   end
 end

data/lib/pact_broker/client/webhooks/create.rb

@@ -101,7 +101,13 @@ module PactBroker
         end
 
         def success_result(webhook_entity)
-          CommandResult.new(true, "Webhook #{webhook_entity._link('self').title_or_name.inspect} created")
+          action = webhook_entity.response.status == 201 ? "created" : "updated"
+          name = if webhook_entity.description && webhook_entity.description.size > 0
+            webhook_entity.description
+          else
+            webhook_entity._link('self').title_or_name
+          end
+          CommandResult.new(true, "Webhook #{name.inspect} #{action}")
         end
 
         def error_result(message)

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

@@ -22,6 +22,7 @@ module PactBroker
           let(:options_hash) do
             {
               uuid: '9999',
+              description: "some webhook",
               request: "POST",
               header: header,
               data: data,
@@ -39,6 +40,7 @@ module PactBroker
           let(:expected_params) do
             {
               uuid: '9999',
+              description: "some webhook",
               http_method: "POST",
               url: "http://webhook",
               headers: { "Foo" => "bar", "Bar" => "foo"},

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

@@ -109,6 +109,12 @@ module PactBroker::Client::CLI
         expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
       end
 
+      it "turns '--tag=foo --tag=bar' into '--tag foo bar'" do
+        input = %w{--ignore this --tag=foo --tag=bar --wiffle --that}
+        output = %w{--ignore this --tag foo bar --wiffle --that }
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
       it "doesn't change anything when there are no duplicate options" do
         input = %w{--ignore this --taggy foo --blah bar --wiffle --that}
         expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq input

data/spec/lib/pact_broker/client/hal/entity_spec.rb

@@ -17,6 +17,7 @@ module PactBroker::Client
           "name" => "Provider"
         }
       end
+
       let(:pact_hash) do
         {
           "name" => "a name",

data/spec/lib/pact_broker/client/webhooks/create_spec.rb

@@ -70,6 +70,28 @@ module PactBroker
               expect(subject.message).to match /"some":"error"/
             end
           end
+
+          context "when there is an empty description returned" do
+            let!(:webhook_request) do
+              stub_request(:post, "http://broker/webhooks").to_return(status: 200, body: response_body.to_json, headers: { "Content-Type" => "application/hal+json" })
+            end
+
+            let(:response_body) do
+              {
+                description: "",
+                _links: {
+                  self: {
+                    href: "href",
+                    title: "the title"
+                  }
+                }
+              }
+            end
+
+            it "uses the self title in the message instead" do
+              expect(subject.message).to include "the title"
+            end
+          end
         end
       end
     end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1287,6 +1287,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1295,6 +1296,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1355,6 +1359,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1363,6 +1368,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1409,6 +1417,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1417,6 +1426,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1590,6 +1602,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1598,6 +1611,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1705,6 +1721,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1713,6 +1730,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1760,6 +1780,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1768,6 +1789,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1852,6 +1876,73 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to update a webhook",
+      "providerState": "a webhook with the uuid 696c5f93-1b7f-44bc-8d03-59440fcaa9a0 exists",
+      "request": {
+        "method": "put",
+        "path": "/webhooks/696c5f93-1b7f-44bc-8d03-59440fcaa9a0",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "consumer": {
+            "name": "Condor"
+          }
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1860,6 +1951,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"

data/spec/service_providers/webhooks_create_spec.rb

@@ -47,11 +47,13 @@ RSpec.describe "creating a webhook", pact: true do
     }
   end
 
+  let(:response_status) { 201 }
   let(:success_response) do
     {
-      status: 201,
+      status: response_status,
       headers: pact_broker_response_headers,
       body: {
+        description: Pact.like("a webhook"),
         _links: {
           self: {
             href: Pact.term('http://localhost:1234/some-url', %r{http://.*}),
@@ -82,7 +84,7 @@ RSpec.describe "creating a webhook", pact: true do
     it "returns a CommandResult with success = true" do
       expect(subject).to be_a PactBroker::Client::CommandResult
       expect(subject.success).to be true
-      expect(subject.message).to eq "Webhook \"A title\" created"
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
     end
   end
 
@@ -201,7 +203,7 @@ RSpec.describe "creating a webhook", pact: true do
 
     it "returns a CommandResult with success = true" do
       expect(subject.success).to be true
-      expect(subject.message).to eq "Webhook \"A title\" created"
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
     end
   end
 
@@ -282,23 +284,50 @@ RSpec.describe "creating a webhook", pact: true do
       request_body["provider"] = { "name" => "Pricing Service" }
       request_body["consumer"] = { "name" => "Condor" }
       mock_pact_broker_index_with_webhook_relation(self)
-
-      pact_broker
-        .upon_receiving("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")
-        .with(
-            method: :put,
-            path: "/webhooks/#{uuid}",
-            headers: put_request_headers,
-            body: request_body)
-        .will_respond_with(success_response)
     end
+
     let(:uuid) { '696c5f93-1b7f-44bc-8d03-59440fcaa9a0' }
 
-    it "returns a CommandResult with success = true" do
-      expect(subject).to be_a PactBroker::Client::CommandResult
-      expect(subject.success).to be true
-      expect(subject.message).to eq "Webhook \"A title\" created"
+    context "when the webhook does not already exist" do
+      before do
+        pact_broker
+          .upon_receiving("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")
+          .with(
+              method: :put,
+              path: "/webhooks/#{uuid}",
+              headers: put_request_headers,
+              body: request_body)
+          .will_respond_with(success_response)
+      end
+
+      it "returns a CommandResult with success = true" do
+        expect(subject).to be_a PactBroker::Client::CommandResult
+        expect(subject.success).to be true
+        expect(subject.message).to eq "Webhook \"a webhook\" created"
+      end
+    end
+
+    context "when the webhook does exist" do
+      before do
+        pact_broker
+          .upon_receiving("a request to update a webhook")
+          .given("a webhook with the uuid #{uuid} exists")
+          .with(
+              method: :put,
+              path: "/webhooks/#{uuid}",
+              headers: put_request_headers,
+              body: request_body)
+          .will_respond_with(success_response)
+      end
+
+      let(:response_status) { 200 }
+
+      it "returns a CommandResult with success = true" do
+        expect(subject).to be_a PactBroker::Client::CommandResult
+        expect(subject.success).to be true
+        expect(subject.message).to eq "Webhook \"a webhook\" updated"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.25.1
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty