pact_broker-client 1.14.1 → 1.15.0

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

@@ -0,0 +1,61 @@
+require 'pact_broker/client/webhooks/create'
+
+module PactBroker
+  module Client
+    module Webhooks
+      describe Create do
+        describe ".call" do
+          let(:index_body) do
+            {
+              "_links" => {
+                "pb:webhooks" => {
+                  "href" => "http://broker/webhooks"
+                }
+              }
+            }.to_json
+          end
+          let!(:index_request) do
+            stub_request(:get, "http://broker").to_return(status: 200, body: index_body, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+
+          let!(:webhook_request) do
+            stub_request(:post, "http://broker/webhooks").to_return(status: 405)
+          end
+
+          let(:params) do
+            {
+              http_method: "POST",
+              url: "https://webhook",
+              headers: { "Foo" => "bar", "Bar" => "foo"},
+              username: "username",
+              password: "password",
+              body: "body",
+              events: ["contract_content_changed"]
+            }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
+          end
+
+          subject { Create.call(params, "http://broker", {}) }
+
+          context "when a 405 is returned from the webhook creation request" do
+
+            it "raises an error with a message to upgrade the Pact Broker" do
+              expect { subject }.to raise_error PactBroker::Client::Error, /Your version of the Pact Broker/
+            end
+          end
+
+          context "when a 400 is returned from the webhook creation request" do
+            let!(:webhook_request) do
+              stub_request(:post, "http://broker/webhooks").to_return(status: 400, body: '{"some":"error"}', headers: { "Content-Type" => "application/hal+json" })
+            end
+
+            it "returns a result with success=false" do
+              expect(subject.success).to be false
+              expect(subject.message).to match /400/
+              expect(subject.message).to match /"some":"error"/
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -197,6 +197,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "summary": {
@@ -245,6 +246,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "summary": {
@@ -293,6 +295,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "summary": {
@@ -341,6 +344,7 @@
       "response": {
         "status": 400,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "errors": [
@@ -367,6 +371,7 @@
       "response": {
         "status": 400,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "errors": [
@@ -394,6 +399,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "matrix": [
@@ -462,6 +468,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "summary": {
@@ -510,6 +517,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "summary": {
@@ -558,6 +566,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "summary": {
@@ -606,6 +615,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "matrix": [
@@ -651,6 +661,7 @@
       "response": {
         "status": 201,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -685,6 +696,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -719,6 +731,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -753,6 +766,7 @@
       "response": {
         "status": 201,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -790,14 +804,16 @@
           "Content-Type": "application/hal+json"
         },
         "body": {
-          "message": "An error occurred"
+          "error": {
+            "message": "An error occurred"
+          }
         },
         "matchingRules": {
           "$.headers.Content-Type": {
             "match": "regex",
             "regex": "application\\/.*json"
           },
-          "$.body.message": {
+          "$.body.error.message": {
             "match": "regex",
             "regex": ".*"
           }
@@ -820,6 +836,7 @@
       "response": {
         "status": 201,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         }
       }
     },
@@ -839,6 +856,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         }
       }
     },
@@ -861,7 +879,7 @@
               "href": "http://example.org/pacticipants/Pricing%20Service",
               "title": "Pricing Service"
             },
-            "pacts": [
+            "pb:pacts": [
               {
                 "href": "http://example.org/pacts/provider/Pricing%20Service/consumer/Condor/version/1.3.0",
                 "title": "Pact between Condor (v1.3.0) and Pricing Service",
@@ -869,6 +887,11 @@
               }
             ]
           }
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
         }
       }
     },
@@ -891,7 +914,7 @@
               "href": "http://example.org/pacticipants/Pricing%20Service",
               "title": "Pricing Service"
             },
-            "pacts": [
+            "pb:pacts": [
               {
                 "href": "http://example.org/pacts/provider/Pricing%20Service/consumer/Condor/version/1.3.0",
                 "title": "Pact between Condor (v1.3.0) and Pricing Service",
@@ -899,6 +922,11 @@
               }
             ]
           }
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
         }
       }
     },
@@ -914,6 +942,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "consumer": {
@@ -984,12 +1013,13 @@
         "method": "get",
         "path": "/pacts/provider/Pricing%20Service/consumer/Condor/latest/prod",
         "headers": {
-          "Accept": "application/json, application/hal+json"
+          "Accept": "application/hal+json, application/json"
         }
       },
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "consumer": {
@@ -1017,6 +1047,7 @@
       "response": {
         "status": 201,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -1046,6 +1077,7 @@
       "response": {
         "status": 201,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -1075,6 +1107,7 @@
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -1098,12 +1131,13 @@
         "method": "get",
         "path": "/",
         "headers": {
-          "Accept": "application/json, application/hal+json"
+          "Accept": "application/hal+json, application/json"
         }
       },
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -1127,12 +1161,13 @@
         "method": "get",
         "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-Condor",
         "headers": {
-          "Accept": "application/json, application/hal+json"
+          "Accept": "application/hal+json, application/json"
         }
       },
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "number": "1.2.3",
@@ -1157,12 +1192,13 @@
         "method": "get",
         "path": "/",
         "headers": {
-          "Accept": "application/json, application/hal+json"
+          "Accept": "application/hal+json, application/json"
         }
       },
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "_links": {
@@ -1186,12 +1222,13 @@
         "method": "get",
         "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-TAGGED-VERSION-Condor-production",
         "headers": {
-          "Accept": "application/json, application/hal+json"
+          "Accept": "application/hal+json, application/json"
         }
       },
       "response": {
         "status": 200,
         "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
           "number": "1.2.3",
@@ -1208,6 +1245,459 @@
           }
         }
       }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a consumer and provider",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/webhooks/provider/Pricing%20Service/consumer/Condor",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a non-JSON body for a consumer and provider",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/webhooks/provider/Pricing%20Service/consumer/Condor",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": "<xml></xml>",
+            "username": "username",
+            "password": "password"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "an invalid request to create a webhook for a consumer and provider",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/webhooks/provider/Pricing%20Service/consumer/Condor",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": null,
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          }
+        }
+      },
+      "response": {
+        "status": 400,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "errors": {
+            "request.url": [
+              "Some error"
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body.errors['request.url']": {
+            "min": 1
+          },
+          "$.body.errors['request.url'][*].*": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook for a consumer and provider",
+      "providerState": "'Condor' does not exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/webhooks/provider/Pricing%20Service/consumer/Condor",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          }
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        }
+      }
+    },
+    {
+      "description": "a request for 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:webhooks": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:webhooks.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a consumer",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "consumer": {
+            "name": "Condor"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a consumer that does not exist",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "consumer": {
+            "name": "Condor"
+          }
+        }
+      },
+      "response": {
+        "status": 400,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "errors": {
+            "consumer.name": [
+              "Some error"
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body.errors['consumer.name']": {
+            "min": 1
+          },
+          "$.body.errors['consumer.name'][*].*": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a provider",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "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"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a global webhook with a JSON body",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
     }
   ],
   "metadata": {