pact_broker-client 1.14.1 → 1.15.0

data/spec/service_providers/pact_broker_client_publish_spec.rb

@@ -1,3 +1,6 @@
+require 'pact_broker/client/pact_broker_client'
+require_relative 'pact_helper'
+
 module PactBroker::Client
   describe PactBrokerClient, :pact => true do
 
@@ -116,7 +119,9 @@ module PactBroker::Client
               status: 500,
               headers: {'Content-Type' => Pact.term(generate: 'application/hal+json', matcher: %r{application/.*json})},
               body: {
-                message: Pact::Term.new(matcher: /.*/, generate: 'An error occurred')
+                error: {
+                  message: Pact::Term.new(matcher: /.*/, generate: 'An error occurred')
+                }
               }
             )
         end

data/spec/service_providers/pact_broker_client_retrieve_all_pacts_for_provider_spec.rb

@@ -7,7 +7,7 @@ module PactBroker::Client
     include_context "pact broker"
 
     describe "retriving all pacts for provider" do
-      let(:response_body) { JSON.parse(File.read("./spec/support/latest_pacts_for_provider.json")) }
+      let(:response_body) { Pact.like(JSON.parse(File.read("./spec/support/latest_pacts_for_provider.json"))) }
       let(:expectedPactsArray) { [{:name => "Condor", :href => "http://example.org/pacts/provider/Pricing%20Service/consumer/Condor/version/1.3.0"}] }
 
       context "when retrieving all the latest pacts for provider with prod tag specified" do

data/spec/service_providers/{pact_broker_client_retrive_pact_spec.rb → pact_broker_client_retrieve_pact_spec.rb}

@@ -70,8 +70,7 @@ module PactBroker::Client
                 headers: {}
               ).
               will_respond_with(
-                status: 404,
-                headers: pact_broker_response_headers
+                status: 404
               )
           end
           it "returns nil" do
@@ -89,7 +88,7 @@ module PactBroker::Client
               with(
                   method: :get,
                   path: '/pacts/provider/Pricing%20Service/consumer/Condor/latest/prod',
-                  headers: { 'Accept' => 'application/json, application/hal+json'}
+                  headers: { 'Accept' => 'application/hal+json, application/json'}
               ).
               will_respond_with(
                 status: 200,

data/spec/service_providers/pact_broker_client_versions_spec.rb

@@ -6,7 +6,7 @@ describe PactBroker::Client::Versions, pact: true do
 
   include_context "pact broker"
 
-  let(:get_headers) { { "Accept" => "application/json, application/hal+json" } }
+  let(:get_headers) { { "Accept" => "application/hal+json, application/json" } }
 
   describe "retrieving the latest pacticipant version" do
     let(:latest_version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-{pacticipant}" }

data/spec/service_providers/pact_helper.rb

@@ -18,3 +18,49 @@ Pact.service_consumer 'Pact Broker Client' do
 
 end
 
+module PactBrokerPactHelperMethods
+
+  def placeholder_path(relation, params = [])
+    path = "/HAL-REL-PLACEHOLDER-#{relation.gsub(':', '-').upcase}"
+    if params.any?
+      joined_params = params.collect{ |param| "{#{param}}"}.join("-")
+      path = "#{path}-#{joined_params}"
+    end
+
+    path
+  end
+
+  def placeholder_url(relation, params = [])
+    "#{pact_broker.mock_service_base_url}#{placeholder_path(relation, params)}"
+  end
+
+  def placeholder_url_term(relation, params = [])
+    regexp = "http:\/\/.*"
+    if params.any?
+      joined_params_for_regexp = params.collect{ |param| "{#{param}}"}.join(".*")
+      regexp = "#{regexp}#{joined_params_for_regexp}"
+    end
+
+    Pact.term(placeholder_url(relation, params), /#{regexp}/)
+  end
+
+  def mock_pact_broker_index(context)
+    pact_broker
+      .upon_receiving("a request for the index resource")
+      .with(
+          method: :get,
+          path: '/',
+          headers: context.get_request_headers).
+        will_respond_with(
+          status: 200,
+          headers: context.pact_broker_response_headers,
+          body: {
+            _links: {
+              :'pb:webhooks' => {
+                href: placeholder_url_term('pb:webhooks')
+              }
+            }
+          }
+        )
+  end
+end

data/spec/service_providers/webhooks_create_spec.rb

@@ -0,0 +1,255 @@
+require_relative 'pact_helper'
+require 'pact_broker/client/webhooks/create'
+
+RSpec.describe "creating a webhook", pact: true do
+
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) do
+    {
+      http_method: "POST",
+      url: "https://webhook",
+      headers: { "Foo" => "bar", "Bar" => "foo"},
+      username: "username",
+      password: "password",
+      body: body,
+      consumer: "Condor",
+      provider: "Pricing Service",
+      events: ["contract_content_changed"]
+    }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
+  end
+
+  let(:body) { { some: "body" }.to_json }
+
+  let(:request_body) do
+    {
+      "events" => [
+        {
+          "name" => "contract_content_changed"
+        }
+      ],
+      "request" => {
+        "url" => "https://webhook",
+        "method" => "POST",
+        "headers" => {
+          "Foo" => "bar",
+          "Bar" => "foo"
+        },
+        "body" => {
+          "some" => "body"
+        },
+        "username" => "username",
+        "password" => "password"
+      }
+    }
+  end
+
+  let(:success_response) do
+    {
+      status: 201,
+      headers: pact_broker_response_headers,
+      body: {
+        _links: {
+          self: {
+            href: Pact.term('http://localhost:1234/some-url', %r{http://.*}),
+            title: Pact.like("A title")
+          }
+        }
+      }
+    }
+  end
+
+  let(:pact_broker_client_options) { {} }
+
+  subject { PactBroker::Client::Webhooks::Create.call(params, broker_base_url, pact_broker_client_options) }
+
+  context "when a valid webhook with a JSON body is submitted" do
+    before do
+      pact_broker
+        .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
+        .upon_receiving("a request to create a webhook with a JSON body for a consumer and provider")
+        .with(
+            method: :post,
+            path: '/webhooks/provider/Pricing%20Service/consumer/Condor',
+            headers: post_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 title\" created"
+    end
+  end
+
+  context "when a valid webhook with an XML body is submitted" do
+    before do
+      request_body["request"]["body"] = body
+
+      pact_broker
+        .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
+        .upon_receiving("a request to create a webhook with a non-JSON body for a consumer and provider")
+        .with(
+            method: :post,
+            path: '/webhooks/provider/Pricing%20Service/consumer/Condor',
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    let(:body) { "<xml></xml>" }
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+    end
+  end
+
+  context "when an invalid webhook is submitted" do
+    before do
+      params[:url] = nil
+      request_body["request"]["url"] = nil
+
+      pact_broker
+        .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")
+        .with(
+            method: :post,
+            path: '/webhooks/provider/Pricing%20Service/consumer/Condor',
+            headers: post_request_headers,
+            body: request_body).
+          will_respond_with(
+            status: 400,
+            headers: pact_broker_response_headers,
+            body: {
+              errors: {
+                "request.url" => Pact.each_like("Some error")
+              }
+            }
+          )
+    end
+
+    it "returns a CommandResult 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
+
+  context "when one of the pacticipants does not exist" do
+    before do
+      pact_broker
+        .given("'Condor' does not exist in the pact-broker")
+        .upon_receiving("a request to create a webhook for a consumer and provider")
+        .with(
+            method: :post,
+            path: '/webhooks/provider/Pricing%20Service/consumer/Condor',
+            headers: post_request_headers,
+            body: request_body).
+          will_respond_with(
+            status: 404,
+            headers: pact_broker_response_headers
+          )
+    end
+
+    it "returns a CommandResult with success = false" do
+      expect(subject.success).to be false
+      expect(subject.message).to match /404/
+    end
+  end
+
+  context "when only a consumer is specified" do
+    before do
+      params.delete(:provider)
+      request_body["consumer"] = { "name" => "Condor" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
+        .upon_receiving("a request to create a webhook with a JSON body for a consumer")
+        .with(
+            method: :post,
+            path: placeholder_path('pb:webhooks'),
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"A title\" created"
+    end
+  end
+
+  context "when only a consumer is specified and it does not exist" do
+    before do
+      params.delete(:provider)
+      request_body["consumer"] = { "name" => "Condor" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .upon_receiving("a request to create a webhook with a JSON body for a consumer that does not exist")
+        .with(
+            method: :post,
+            path: placeholder_path('pb:webhooks'),
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(
+            status: 400,
+            headers: pact_broker_response_headers,
+            body: {
+              errors: {
+                "consumer.name" => Pact.each_like("Some error")
+              }
+            })
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be false
+    end
+  end
+
+  context "when only a provider is specified" do
+    before do
+      params.delete(:consumer)
+      request_body["provider"] = { "name" => "Pricing Service" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
+        .upon_receiving("a request to create a webhook with a JSON body for a provider")
+        .with(
+            method: :post,
+            path: placeholder_path('pb:webhooks'),
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+    end
+  end
+
+  context "when neither consumer nor provider are specified" do
+    before do
+      params.delete(:consumer)
+      params.delete(:provider)
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .upon_receiving("a request to create a global webhook with a JSON body")
+        .with(
+            method: :post,
+            path: placeholder_path('pb:webhooks'),
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,10 +4,42 @@ WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"
 
+is_windows = (RbConfig::CONFIG['host_os'] =~ /bccwin|cygwin|djgpp|mingw|mswin|wince/i) != nil
+
 RSpec.configure do | config |
 
   config.before(:each) do
     ENV.delete('PACT_BROKER_BASE_URL')
+    ENV.delete('PACT_BROKER_USERNAME')
+    ENV.delete('PACT_BROKER_PASSWORD')
+  end
+
+  config.after(:all) do
+    Pact::Fixture.check_fixtures
   end
 
+  config.filter_run_excluding :skip_windows => is_windows
+  config.example_status_persistence_file_path = "./spec/examples.txt"
+end
+
+module Pact
+  module Fixture
+
+    def self.add_fixture key, value
+      fixtures[key] ||= []
+      fixtures[key] << value
+    end
+
+    def self.fixtures
+      @fixtures ||= {}
+    end
+
+    def self.check_fixtures
+      fixtures.each do | fixture_group |
+        if fixture_group.size > 1
+          #TODO compare fixtures to ensure they match
+        end
+      end
+    end
+  end
 end

data/spec/support/latest_pacts_for_provider.json

@@ -4,7 +4,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",

data/spec/support/shared_context.rb

@@ -5,13 +5,16 @@ shared_context "pact broker" do
   let(:consumer_contract) { Pact::ConsumerContract.from_hash pact_hash }
   let(:pact_json) { pact_hash.to_json }
   let(:pact_broker_client) { PactBroker::Client::PactBrokerClient.new(client_config) }
-  let(:client_config) { { base_url: 'http://localhost:1234' } }
+  let(:broker_base_url) { 'http://localhost:1234' }
+  let(:client_config) { { base_url: broker_base_url } }
   let(:consumer_version) { '1.3.0' }
   let(:version) { '1.3.0' }
   let(:pact_broker_version) { Pact::Term.new(:matcher => /\d+\.\d+\.\d+/, :generate => '1.0.0') }
-  let(:pact_broker_response_headers) { {} }
+  let(:pact_broker_response_headers) { {'Content-Type' => 'application/hal+json;charset=utf-8'} }
   let(:default_request_headers) { { 'Content-Type' => 'application/json'} }
   let(:patch_request_headers)   { { 'Content-Type' => 'application/json'} }
-  let(:get_request_headers)     { { 'Accept' => 'application/json'} }
+  let(:put_request_headers)     { { 'Content-Type' => 'application/json', 'Accept' => 'application/hal+json'} }
+  let(:post_request_headers)    { { 'Content-Type' => 'application/json', 'Accept' => 'application/hal+json'} }
+  let(:get_request_headers)     { { 'Accept' => 'application/hal+json'} }
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.15.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -185,11 +185,18 @@ files:
 - lib/pact_broker/client/can_i_deploy.rb
 - lib/pact_broker/client/cli/broker.rb
 - lib/pact_broker/client/cli/can_i_deploy_long_desc.txt
+- lib/pact_broker/client/cli/create_webhook_long_desc.txt
 - lib/pact_broker/client/cli/custom_thor.rb
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
+- lib/pact_broker/client/command_result.rb
 - lib/pact_broker/client/create_tag.rb
 - lib/pact_broker/client/error.rb
 - lib/pact_broker/client/git.rb
+- lib/pact_broker/client/hal.rb
+- lib/pact_broker/client/hal/entity.rb
+- lib/pact_broker/client/hal/entry_point.rb
+- lib/pact_broker/client/hal/http_client.rb
+- lib/pact_broker/client/hal/link.rb
 - lib/pact_broker/client/matrix.rb
 - lib/pact_broker/client/matrix/formatter.rb
 - lib/pact_broker/client/matrix/json_formatter.rb
@@ -210,6 +217,7 @@ files:
 - lib/pact_broker/client/versions/formatter.rb
 - lib/pact_broker/client/versions/json_formatter.rb
 - lib/pact_broker/client/versions/text_formatter.rb
+- lib/pact_broker/client/webhooks/create.rb
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
 - script/generate-cli-usage.sh
@@ -220,9 +228,13 @@ files:
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
+- spec/lib/pact_broker/client/cli/broker_create_webhook_spec.rb
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/hal/entity_spec.rb
+- spec/lib/pact_broker/client/hal/http_client_spec.rb
+- spec/lib/pact_broker/client/hal/link_spec.rb
 - spec/lib/pact_broker/client/matrix/text_formatter_spec.rb
 - spec/lib/pact_broker/client/matrix_spec.rb
 - spec/lib/pact_broker/client/merge_pacts_spec.rb
@@ -232,6 +244,7 @@ files:
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
 - spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
+- spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/pact_broker_client_matrix_spec.rb
@@ -239,10 +252,11 @@ files:
 - spec/service_providers/pact_broker_client_publish_spec.rb
 - spec/service_providers/pact_broker_client_register_repository_spec.rb
 - spec/service_providers/pact_broker_client_retrieve_all_pacts_for_provider_spec.rb
-- spec/service_providers/pact_broker_client_retrive_pact_spec.rb
+- spec/service_providers/pact_broker_client_retrieve_pact_spec.rb
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli_test_pacts/bar.json
 - spec/support/cli_test_pacts/foo.json
@@ -285,9 +299,13 @@ test_files:
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
+- spec/lib/pact_broker/client/cli/broker_create_webhook_spec.rb
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/hal/entity_spec.rb
+- spec/lib/pact_broker/client/hal/http_client_spec.rb
+- spec/lib/pact_broker/client/hal/link_spec.rb
 - spec/lib/pact_broker/client/matrix/text_formatter_spec.rb
 - spec/lib/pact_broker/client/matrix_spec.rb
 - spec/lib/pact_broker/client/merge_pacts_spec.rb
@@ -297,6 +315,7 @@ test_files:
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
 - spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
+- spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/pact_broker_client_matrix_spec.rb
@@ -304,10 +323,11 @@ test_files:
 - spec/service_providers/pact_broker_client_publish_spec.rb
 - spec/service_providers/pact_broker_client_register_repository_spec.rb
 - spec/service_providers/pact_broker_client_retrieve_all_pacts_for_provider_spec.rb
-- spec/service_providers/pact_broker_client_retrive_pact_spec.rb
+- spec/service_providers/pact_broker_client_retrieve_pact_spec.rb
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli_test_pacts/bar.json
 - spec/support/cli_test_pacts/foo.json