pact_broker 2.48.0 → 2.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdda99358c4d4d8ca43f6e53e0e314fd24f475f1ff85fd0511743d8982224bca
-  data.tar.gz: 4f61ab3a051164ac3db85d7eef44fa088053873b2381f4c4104f4822c47bd651
+  metadata.gz: 1b99bf5d9f68ee92e651f20ad2595feb55060c1720a816179f1e143d7db4dea4
+  data.tar.gz: 174f33323d8ecb66ec0640705273b2629b4203812f1fa4f3d68a5c997db40328
 SHA512:
-  metadata.gz: e3d9f86596a6d4aa776c13f28e84af1976485dc9eff3bef98accf6e372d379cb591270354a252c88a6b2c08ac928391e2ddcf8ee19d3db6f9832a667b4a81184
-  data.tar.gz: d4b2273ab789165a3f0ca7ce8f5fdb2220814d222ea172fa02fe77d19ce6e9e251277a6c621483a41b6b9911ab207b6d59861a39d2168ecdf5b0db64d1477d9f
+  metadata.gz: 51835924b04c884319fcc89dcc729a572645ad490245d94eb77e3b7fd58df244d4980aaeb8363f10af52fae7ea8eeeb8a96096b4f6f8f711fc86ebbc30d097e9
+  data.tar.gz: d9a90fecfc31add0cfb0104eae721d55e2fb695823bbd151d12f4c9f8fdb1581ced85f679be6e489a05882bc9b04c3f448e97495e538afc98d8623ce08746050

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+<a name="v2.49.0"></a>
+### v2.49.0 (2020-02-13)
+
+
+#### Features
+
+* **webhooks**
+  * support upsert of webhook via a PUT to /webhooks/{uuid}	 ([f9ba9ab5](/../../commit/f9ba9ab5))
+
+* don't double parse the incoming JSON body when checking if it is invalid.	 ([bd74b82c](/../../commit/bd74b82c))
+* support saving symbol configuration settings	 ([73db9c2b](/../../commit/73db9c2b))
+* allow verification status badges to be served via a redirect instead of proxying the response	 ([a34d5f7f](/../../commit/a34d5f7f))
+
+
 <a name="v2.48.0"></a>
 ### v2.48.0 (2020-02-07)
 

data/lib/pact_broker/api/resources/badge.rb

@@ -5,11 +5,10 @@ require 'pact_broker/configuration'
 module PactBroker
   module Api
     module Resources
-
       class Badge < BaseResource
 
         def allowed_methods
-          ["GET", "OPTIONS", "OPTIONS"]
+          ["GET", "OPTIONS"]
         end
 
         def content_types_provided
@@ -17,6 +16,11 @@ module PactBroker
         end
 
         def resource_exists?
+          !badge_service.can_provide_badge_using_redirect?
+        end
+
+        # Only called if resource_exists? returns false
+        def previously_existed?
           true
         end
 
@@ -28,13 +32,18 @@ module PactBroker
           false
         end
 
-        private
-
         def to_svg
           response.headers['Cache-Control'] = 'no-cache'
           comment + badge_service.pact_verification_badge(pact, label, initials, pseudo_branch_verification_status)
         end
 
+        def moved_temporarily?
+          response.headers['Cache-Control'] = 'no-cache'
+          badge_service.pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status)
+        end
+
+        private
+
         def pact
           @pact ||= pact_service.find_latest_pact(identifier_from_path)
         end

data/lib/pact_broker/api/resources/base_resource.rb

@@ -84,7 +84,7 @@ module PactBroker
         end
 
         def params
-          @params ||= JSON.parse(request.body.to_s, {symbolize_names: true}.merge(PACT_PARSING_OPTIONS))
+          @params ||= JSON.parse(request.body.to_s, { symbolize_names: true }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
         end
 
         def params_with_string_keys
@@ -123,7 +123,7 @@ module PactBroker
 
         def invalid_json?
           begin
-            JSON.parse(request_body, PACT_PARSING_OPTIONS) #Not load! Otherwise it will try to load Ruby classes.
+            params
             false
           rescue StandardError => e
             logger.info "Error parsing JSON #{e} - #{request_body}"

data/lib/pact_broker/api/resources/index.rb

@@ -94,6 +94,11 @@ module PactBroker
               title: 'Webhooks',
               templated: false
             },
+            'pb:webhook' => {
+              href: base_url + '/webhooks/{uuid}',
+              title: 'Webhook',
+              templated: true
+            },
             'pb:integrations' => {
               href: base_url + '/integrations',
               title: 'Integrations',

data/lib/pact_broker/api/resources/webhook.rb

@@ -28,7 +28,7 @@ module PactBroker
 
         def malformed_request?
           if request.put?
-            return invalid_json? || webhook_validation_errors?(new_webhook)
+            return invalid_json? || webhook_validation_errors?(parsed_webhook, uuid)
           end
           false
         end
@@ -38,7 +38,9 @@ module PactBroker
             @webhook = webhook_service.update_by_uuid uuid, params_with_string_keys
             response.body = to_json
           else
-            404
+            @webhook = webhook_service.create(uuid, parsed_webhook, consumer, provider)
+            response.body = to_json
+            201
           end
         end
 
@@ -57,8 +59,8 @@ module PactBroker
           @webhook ||= webhook_service.find_by_uuid uuid
         end
 
-        def new_webhook
-          @new_webhook ||= Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
+        def parsed_webhook
+          @parsed_webhook ||= Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
         end
 
         def uuid

data/lib/pact_broker/api/resources/webhook_resource_methods.rb

@@ -2,8 +2,8 @@ module PactBroker
   module Api
     module Resources
       module WebhookResourceMethods
-        def webhook_validation_errors? webhook
-          errors = webhook_service.errors(webhook)
+        def webhook_validation_errors?(webhook, uuid = nil)
+          errors = webhook_service.errors(webhook, uuid)
           if !errors.empty?
             set_json_validation_error_messages(errors.messages)
             true

data/lib/pact_broker/badges/service.rb

@@ -15,14 +15,21 @@ module PactBroker
       SPACE_DASH_UNDERSCORE = /[\s_\-]/
       CACHE = {}
 
+      def can_provide_badge_using_redirect?
+        PactBroker.configuration.badge_provider_mode == :redirect && !!PactBroker.configuration.shields_io_base_url
+      end
+
       def pact_verification_badge pact, label, initials, pseudo_branch_verification_status
         return static_svg(pact, pseudo_branch_verification_status) unless pact
 
-        title = badge_title pact, label, initials
-        status = badge_status pseudo_branch_verification_status
-        color = badge_color pseudo_branch_verification_status
+        dynamic_svg(pact, label, initials, pseudo_branch_verification_status) || static_svg(pact, pseudo_branch_verification_status)
+      end
 
-        dynamic_svg(title, status, color) || static_svg(pact, pseudo_branch_verification_status)
+      def pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status)
+        title = badge_title(pact, label, initials)
+        status = badge_status(pseudo_branch_verification_status)
+        color = badge_color(pseudo_branch_verification_status)
+        build_shield_io_uri(title, status, color)
       end
 
       def clear_cache
@@ -78,9 +85,9 @@ module PactBroker
         end
       end
 
-      def dynamic_svg left_text, right_text, color
+      def dynamic_svg pact, label, initials, pseudo_branch_verification_status
         return nil unless PactBroker.configuration.shields_io_base_url
-        uri = build_uri(left_text, right_text, color)
+        uri = pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status)
         begin
           response = do_request(uri)
           response.code == '200' ? response.body : nil
@@ -93,7 +100,7 @@ module PactBroker
         end
       end
 
-      def build_uri left_text, right_text, color
+      def build_shield_io_uri left_text, right_text, color
         shield_base_url = PactBroker.configuration.shields_io_base_url
         path = "/badge/#{escape_text(left_text)}-#{escape_text(right_text)}-#{color}.svg"
         URI.parse(shield_base_url + path)

data/lib/pact_broker/config/setting.rb

@@ -14,6 +14,8 @@ module PactBroker
           JSON.parse(value, symbolize_names: true)
         when 'string'
           value
+        when 'symbol'
+          value.to_sym
         when 'integer'
           Integer(value)
         when 'float'
@@ -33,7 +35,7 @@ module PactBroker
           "1"
         when FalseClass
           "0"
-        when SpaceDelimitedStringList
+        when SpaceDelimitedStringList, Symbol
           object.to_s
         when Array, Hash
           object.to_json
@@ -56,6 +58,8 @@ module PactBroker
             'integer'
           when Float
             'float'
+          when Symbol
+            'symbol'
           else
             nil
           end

data/lib/pact_broker/configuration.rb

@@ -30,7 +30,8 @@ module PactBroker
       :webhook_scheme_whitelist,
       :webhook_host_whitelist,
       :base_equality_only_on_content_that_affects_verification_results,
-      :seed_example_data
+      :seed_example_data,
+      :badge_provider_mode
     ]
 
     attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
@@ -40,7 +41,7 @@ module PactBroker
     attr_accessor :webhook_retry_schedule
     attr_reader :webhook_http_method_whitelist, :webhook_scheme_whitelist, :webhook_host_whitelist
     attr_accessor :semver_formats
-    attr_accessor :enable_public_badge_access, :shields_io_base_url
+    attr_accessor :enable_public_badge_access, :shields_io_base_url, :badge_provider_mode
     attr_accessor :disable_ssl_verification
     attr_accessor :base_equality_only_on_content_that_affects_verification_results
     attr_reader :api_error_reporters
@@ -69,6 +70,7 @@ module PactBroker
       config.enable_diagnostic_endpoints = true
       config.enable_public_badge_access = false # For security
       config.shields_io_base_url = "https://img.shields.io".freeze
+      config.badge_provider_mode = :proxy # other option is :redirect
       config.use_case_sensitive_resource_names = true
       config.html_pact_renderer = default_html_pact_render
       config.version_parser = PactBroker::Versions::ParseSemanticVersion

data/lib/pact_broker/doc/controllers/app.rb

@@ -14,6 +14,7 @@ module PactBroker
         MAPPINGS = {
           'webhooks-create' => 'webhooks',
           'webhooks-webhooks' => 'webhooks',
+          'webhook' => 'webhooks',
           'can-i-deploy-pacticipant-version-to-tag' => 'can-i-deploy',
           'pacticipant' => 'pacticipants'
         }.freeze

data/lib/pact_broker/doc/views/webhooks.markdown

@@ -8,7 +8,7 @@ Allowed methods: `GET`, `POST`
 
 *Individual resource*
 
-Path: `/webhook/UUID`
+Path: `/webhook/{uuid}`
 
 Allowed methods: `GET`, `PUT`, `DELETE`
 
@@ -16,11 +16,16 @@ Webhooks are HTTP requests that are executed asynchronously after certain events
 
 ### Creating
 
-To create a webhook, send a `POST` request to `/webhooks` with the body described below. You can do this through the API Browser by clicking on the `NON-GET` button for the `pb:webhooks` relation on the index, pasting in the JSON body, and clicking "Make Request".
+To create a webhook, send a `POST` request to `/webhooks` with the body described below. You can also do a `PUT` to `/webhooks/{uuid}`, where the UUID is a identifier that you generate yourself. This supports upserting webhooks, allowing you to automate your Pact Broker set up.
+
+The easiest way to create a webhook is by using the [Pact Broker Client CLI](https://github.com/pact-foundation/pact_broker-client/#create-webhook). It is available as a docker container and a standalone executable for all platforms.
+
+You can also create webhooks through the API Browser by clicking on the `NON-GET` button for the `pb:webhooks` relation on the index, pasting in the JSON body, and clicking "Make Request".
 
 Below is an example webhook to trigger a Bamboo job when any contract for the provider "Foo" has changed. Both provider and consumer are optional - omitting either indicates that any pacticipant in that role will be matched. Webhooks with neither provider nor consumer specified are "global" webhooks that will trigger for any consumer/provider pair.
 
     {
+      "description": "Trigger SomeProject CI",
       "provider": {
         "name": "Bar"
       },
@@ -90,6 +95,7 @@ To specify an XML body, you will need to use a correctly escaped string (or use
 
 The following variables may be used in the request path, parameters or body, and will be replaced with their appropriate values at runtime.
 
+* `${pactbroker.pactUrl}`: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.)
 * `${pactbroker.consumerName}`: the consumer name
 * `${pactbroker.providerName}`: the provider name
 * `${pactbroker.consumerVersionNumber}`: the version number of the most recent consumer version associated with the pact content.
@@ -100,7 +106,6 @@ The following variables may be used in the request path, parameters or body, and
 * `${pactbroker.providerLabels}`: the list of labels for the provider associated with the pact content, separated by ", ".
 * `${pactbroker.githubVerificationStatus}`: the verification status using the correct keywords for posting to the the [Github commit status API](https://developer.github.com/v3/repos/statuses).
 * `${pactbroker.bitbucketVerificationStatus}`: the verification status using the correct keywords for posting to the the [Bitbucket commit status API](https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/).
-* `${pactbroker.pactUrl}`: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.)
 * `${pactbroker.verificationResultUrl}`: the URL to the relevant verification result.
 
 Example usage:

data/lib/pact_broker/locale/en.yml

@@ -43,6 +43,7 @@ en:
         consumer_version_number_invalid: "Consumer version number '%{consumer_version_number}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
         pacticipant_name_mismatch: "in pact ('%{name_in_pact}') does not match %{pacticipant} name in path ('%{name}')."
         connection_encoding_not_utf8: "The Sequel connection encoding (%{encoding}) is strongly recommended to be \"utf8\". If you need to set it to %{encoding} for some particular reason, then disable this check by setting config.validate_database_connection_config = false"
+        invalid_webhook_uuid: The UUID can only contain the characters A-Z, a-z, 0-9, _ and -, and must be 16 or more characters.
       duplicate_pacticipant: |
         This is the first time a pact has been published for "%{new_name}".
         The name "%{new_name}" is very similar to the following existing consumers/providers:

data/lib/pact_broker/pacts/selectors.rb

@@ -23,7 +23,6 @@ module PactBroker
         Selectors.new(super)
       end
 
-      # might actually be, but this code doesn't know it.
       def overall_latest?
         any?(&:overall_latest?)
       end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.48.0'
+  VERSION = '2.49.0'
 end

data/lib/pact_broker/webhooks/service.rb

@@ -14,6 +14,7 @@ require 'pact_broker/hash_refinements'
 require 'pact_broker/webhooks/execution_configuration'
 require 'pact_broker/messages'
 require 'pact_broker/webhooks/pact_and_verification_parameters'
+require 'reform/contract/errors'
 
 module PactBroker
   module Webhooks
@@ -28,14 +29,24 @@ module PactBroker
       include Logging
       extend PactBroker::Messages
 
+      # Not actually a UUID. Ah well.
+      def self.valid_uuid_format?(uuid)
+        !!(uuid =~ /^[A-Za-z0-9_\-]{16,}$/)
+      end
+
       def self.next_uuid
         SecureRandom.urlsafe_base64
       end
 
-      def self.errors webhook
+      def self.errors webhook, uuid = nil
         contract = PactBroker::Api::Contracts::WebhookContract.new(webhook)
         contract.validate(webhook.attributes)
-        contract.errors
+        errors = contract.errors
+
+        if uuid && !valid_uuid_format?(uuid)
+          errors.add("uuid", message("errors.validation.invalid_webhook_uuid"))
+        end
+        errors
       end
 
       def self.create uuid, webhook, consumer, provider

data/spec/features/create_webhook_spec.rb

@@ -1,13 +1,10 @@
-require 'support/test_data_builder'
-
 describe "Creating a webhook" do
-
   before do
-    TestDataBuilder.new.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+    td.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
   end
 
   let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
-  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
   let(:webhook_json) { webhook_hash.to_json }
   let(:webhook_hash) do
     {
@@ -37,40 +34,29 @@ describe "Creating a webhook" do
     context "with invalid attributes" do
       let(:webhook_hash) { {} }
 
-      it "returns a 400" do
-        subject
-        expect(last_response.status).to be 400
-      end
+      its(:status) { is_expected.to be 400 }
 
-    it "returns a JSON content type" do
-      subject
-      expect(last_response.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
-    end
+      it "returns a JSON content type" do
+        expect(subject.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+      end
 
       it "returns the validation errors" do
-        subject
         expect(response_body[:errors]).to_not be_empty
       end
     end
 
     context "with valid attributes" do
-      it "returns a 201 response" do
-        subject
-        expect(last_response.status).to be 201
-      end
+      its(:status) { is_expected.to be 201 }
 
       it "returns the Location header" do
-        subject
-        expect(last_response.headers['Location']).to match(%r{http://example.org/webhooks/.+})
+        expect(subject.headers['Location']).to match(%r{http://example.org/webhooks/.+})
       end
 
       it "returns a JSON Content Type" do
-        subject
-        expect(last_response.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+        expect(subject.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
       end
 
       it "returns the newly created webhook" do
-        subject
         expect(response_body).to include webhook_hash
       end
     end
@@ -83,10 +69,7 @@ describe "Creating a webhook" do
       webhook_hash[:provider] = { name: "Some Provider" }
     end
 
-    it "returns a 201 response" do
-      subject
-      expect(last_response.status).to be 201
-    end
+    its(:status) { is_expected.to be 201 }
 
     it "creates a webhook without a consumer" do
       subject
@@ -101,10 +84,7 @@ describe "Creating a webhook" do
       webhook_hash[:consumer] = { name: "Some Consumer" }
     end
 
-    it "returns a 201 response" do
-      subject
-      expect(last_response.status).to be 201
-    end
+    its(:status) { is_expected.to be 201 }
 
     it "creates a webhook without a provider" do
       subject
@@ -116,10 +96,7 @@ describe "Creating a webhook" do
   context "with no consumer or provider" do
     let(:path) { "/webhooks" }
 
-    it "returns a 201 response" do
-      subject
-      expect(last_response.status).to be 201
-    end
+    its(:status) { is_expected.to be 201 }
 
     it "creates a webhook without a provider" do
       subject
@@ -127,4 +104,12 @@ describe "Creating a webhook" do
       expect(PactBroker::Webhooks::Webhook.first.provider).to be nil
     end
   end
+
+  context "with a UUID" do
+    let(:path) { "/webhooks/1234123412341234" }
+
+    subject { put(path, webhook_json, headers) }
+
+    its(:status) { is_expected.to be 201 }
+  end
 end

data/spec/features/delete_verification_spec.rb

@@ -1,9 +1,7 @@
 require 'support/test_data_builder'
 require 'pact_broker/api/pact_broker_urls'
 
-
 describe "Delete a verification" do
-
   let!(:verification) do
     TestDataBuilder.new
       .create_pact_with_verification("Foo", "1", "Bar", "2")

data/spec/lib/pact_broker/api/resources/badge_spec.rb

@@ -13,7 +13,9 @@ module PactBroker
           allow(PactBroker::Pacts::Service).to receive(:find_latest_pact).and_return(pact)
           allow(PactBroker::Verifications::Service).to receive(:find_latest_verification_for).and_return(verification)
           allow(PactBroker::Badges::Service).to receive(:pact_verification_badge).and_return("badge")
+          allow(PactBroker::Badges::Service).to receive(:pact_verification_badge_url).and_return("http://badge")
           allow(PactBroker::Verifications::PseudoBranchStatus).to receive(:new).and_return(pseudo_branch_verification_status)
+          allow(PactBroker::Badges::Service).to receive(:can_provide_badge_using_redirect?).and_return(false)
         end
 
         let(:pact) { instance_double("PactBroker::Domain::Pact", consumer: consumer, provider: provider, consumer_version_number: "2", revision_number: "1") }
@@ -47,7 +49,6 @@ module PactBroker
         end
 
         context "when enable_public_badge_access is true" do
-
           before do
             PactBroker.configuration.enable_public_badge_access = true
           end
@@ -67,25 +68,48 @@ module PactBroker
             subject
           end
 
-          it "creates a badge" do
-            expect(PactBroker::Badges::Service).to receive(:pact_verification_badge).with(pact, nil, false, :verified)
-            subject
-          end
+          context "when can_provide_badge_using_redirect? is false" do
+            before do
+              allow(PactBroker::Badges::Service).to receive(:can_provide_badge_using_redirect?).and_return(false)
+            end
 
-          it "returns a 200 status" do
-            expect(subject.status).to eq 200
-          end
+            it "creates a badge" do
+              expect(PactBroker::Badges::Service).to receive(:pact_verification_badge).with(pact, nil, false, :verified)
+              subject
+            end
 
-          it "does not allow caching" do
-            expect(subject.headers['Cache-Control']).to eq 'no-cache'
-          end
+            it "returns a 200 status" do
+              expect(subject.status).to eq 200
+            end
 
-          it "returns the badge" do
-            expect(subject.body).to end_with "badge"
+            it "does not allow caching" do
+              expect(subject.headers['Cache-Control']).to eq 'no-cache'
+            end
+
+            it "returns the badge" do
+              expect(subject.body).to end_with "badge"
+            end
+
+            it "returns a comment with the consumer and provider numbers" do
+              expect(subject.body).to include "<!-- consumer version 2 revision 1 provider version 3 number 7 -->"
+            end
           end
 
-          it "returns a comment with the consumer and provider numbers" do
-            expect(subject.body).to include "<!-- consumer version 2 revision 1 provider version 3 number 7 -->"
+          context "when can_provide_badge_using_redirect? is true" do
+            before do
+              allow(PactBroker::Badges::Service).to receive(:can_provide_badge_using_redirect?).and_return(true)
+            end
+
+            it "determines the URL of the badge to redirect to" do
+              expect(PactBroker::Badges::Service).to receive(:pact_verification_badge_url).with(pact, nil, false, :verified)
+              subject
+            end
+
+            it "returns a 301 redirect to the badge URL" do
+              expect(subject.status).to eq 307
+              expect(subject.headers['Location']).to eq 'http://badge'
+              expect(subject.headers['Cache-Control']).to eq 'no-cache'
+            end
           end
 
           context "when the label param is specified" do

data/spec/lib/pact_broker/api/resources/webhook_spec.rb

@@ -2,11 +2,8 @@ require 'spec_helper'
 require 'pact_broker/api/resources/webhook'
 
 module PactBroker::Api
-
   module Resources
-
     describe Webhook do
-
       before do
         allow(PactBroker::Webhooks::Service).to receive(:find_by_uuid).and_return(webhook)
       end
@@ -23,15 +20,14 @@ module PactBroker::Api
         end
 
         context "when the webhook exists" do
+          before do
+            allow(Decorators::WebhookDecorator).to receive(:new).and_return(decorator)
+          end
 
           let(:webhook) { double("webhook") }
           let(:decorator) { double(Decorators::WebhookDecorator, to_json: json)}
           let(:json) { {some: 'json'}.to_json }
 
-          before do
-            allow(Decorators::WebhookDecorator).to receive(:new).and_return(decorator)
-          end
-
           it "finds the webhook by UUID" do
             expect(PactBroker::Webhooks::Service).to receive(:find_by_uuid).with('some-uuid')
             subject
@@ -56,14 +52,61 @@ module PactBroker::Api
       end
 
       describe "PUT" do
+        before do
+          allow(Decorators::WebhookDecorator).to receive(:new).and_return(decorator)
+          allow(PactBroker::Webhooks::Service).to receive(:create).and_return(created_webhook)
+          allow_any_instance_of(Webhook).to receive(:consumer).and_return(consumer)
+          allow_any_instance_of(Webhook).to receive(:provider).and_return(provider)
+          allow_any_instance_of(Webhook).to receive(:webhook_validation_errors?).and_return(false)
+        end
+
+        let(:consumer) { double('consumer') }
+        let(:provider) { double('provider') }
+        let(:webhook) { double("webhook") }
+        let(:decorator) { double(Decorators::WebhookDecorator, from_json: parsed_webhook, to_json: json)}
+        let(:json) { {some: 'json'}.to_json }
+
+        let(:parsed_webhook) { double('parsed_webhook') }
+        let(:created_webhook) { double('created_webhook') }
+        let(:webhook) { nil }
+        let(:webhook_json) { load_fixture('webhook_valid.json') }
+        let(:uuid) { 'some-uuid' }
+
+        subject { put("/webhooks/#{uuid}", webhook_json, 'CONTENT_TYPE' => 'application/json') }
+
+        it "validates the UUID" do
+          expect_any_instance_of(Webhook).to receive(:webhook_validation_errors?).with(parsed_webhook, uuid)
+          subject
+        end
+
         context "when the webhook does not exist" do
-          let(:webhook) { nil }
-          let(:webhook_json) { load_fixture('webhook_valid.json') }
+          it "creates the webhook" do
+            expect(PactBroker::Webhooks::Service).to receive(:create).with(uuid, parsed_webhook, consumer, provider)
+            subject
+          end
 
-          subject { put '/webhooks/some-uuid', webhook_json, {'CONTENT_TYPE' => 'application/json'}; last_response }
+          its(:status) { is_expected.to eq 201 }
 
-          it "returns a 404" do
-            expect(subject).to be_a_404_response
+          it "returns the JSON respresentation of the webhook" do
+            expect(subject.body).to eq json
+          end
+        end
+
+        context "when the webhook does exist" do
+          before do
+            allow(PactBroker::Webhooks::Service).to receive(:update_by_uuid).and_return(created_webhook)
+          end
+          let(:webhook) { double('existing webhook') }
+
+          its(:status) { is_expected.to eq 200 }
+
+          it "updates the webhook" do
+            expect(PactBroker::Webhooks::Service).to receive(:update_by_uuid).with(uuid, JSON.parse(webhook_json))
+            subject
+          end
+
+          it "returns the JSON respresentation of the webhook" do
+            expect(subject.body).to eq json
           end
         end
       end

data/spec/lib/pact_broker/badges/service_spec.rb

@@ -14,7 +14,7 @@ module PactBroker
         let(:expected_url) { "https://img.shields.io/badge/#{expected_left_text}-#{expected_right_text}-#{expected_color}.svg" }
         let(:expected_color) { "brightgreen" }
         let(:expected_right_text) { "verified" }
-        let(:expected_left_text) { "foo--bar%2Fthing__blah%20pact" }
+        let(:expected_left_text) { "foo--bar%2fthing__blah%20pact" }
         let(:response_status) { 200 }
         let!(:http_request) do
           stub_request(:get, expected_url).to_return(:status => response_status, :body => "svg")
@@ -22,6 +22,8 @@ module PactBroker
 
         subject { PactBroker::Badges::Service.pact_verification_badge pact, label, initials, pseudo_branch_verification_status }
 
+        let(:pact_verification_badge_url) { PactBroker::Badges::Service.pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status) }
+
         before do
           Service.clear_cache
           allow(Service).to receive(:logger).and_return(logger)
@@ -41,48 +43,53 @@ module PactBroker
           it "creates a badge with the consumer and provider names" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
 
           context "when initials is true" do
-            let(:expected_left_text) { "fb%2Ftb%20pact" }
+            let(:expected_left_text) { "fb%2ftb%20pact" }
             let(:initials) { true }
 
             it "creates a badge with the consumer and provider initials" do
               subject
               expect(http_request).to have_been_made
+              expect(pact_verification_badge_url).to eq URI(expected_url)
             end
           end
 
           context "when initials is true but the consumer and provider names only contain one word" do
-            let(:expected_left_text) { "foo%2Fbar%20pact" }
+            let(:expected_left_text) { "foo%2fbar%20pact" }
             let(:initials) { true }
             let(:pact) { double("pact", consumer_name: "Foo", provider_name: "Bar") }
 
             it "creates a badge with the consumer and provider names, not initials" do
               subject
               expect(http_request).to have_been_made
+              expect(pact_verification_badge_url).to eq URI(expected_url)
             end
           end
 
           context "when initials is true but the consumer and provider names are one camel cased word" do
-            let(:expected_left_text) { "fa%2Fbp%20pact" }
+            let(:expected_left_text) { "fa%2fbp%20pact" }
             let(:initials) { true }
             let(:pact) { double("pact", consumer_name: "FooApp", provider_name: "barProvider") }
 
             it "creates a badge with the consumer and provider names, not initials" do
               subject
               expect(http_request).to have_been_made
+              expect(pact_verification_badge_url).to eq URI(expected_url)
             end
           end
 
           context "when initials is true but the consumer and provider names are one camel cased word" do
-            let(:expected_left_text) { "fa%2Fdat%20pact" }
+            let(:expected_left_text) { "fa%2fdat%20pact" }
             let(:initials) { true }
             let(:pact) { double("pact", consumer_name: "FooApp", provider_name: "doAThing") }
 
             it "creates a badge with the consumer and provider names, not initials" do
               subject
               expect(http_request).to have_been_made
+              expect(pact_verification_badge_url).to eq URI(expected_url)
             end
           end
         end
@@ -94,6 +101,7 @@ module PactBroker
           it "creates a badge with only the consumer name" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
 
           context "when initials is true" do
@@ -103,6 +111,7 @@ module PactBroker
             it "creates a badge with only the consumer initials" do
               subject
               expect(http_request).to have_been_made
+              expect(pact_verification_badge_url).to eq URI(expected_url)
             end
           end
         end
@@ -114,6 +123,7 @@ module PactBroker
           it "creates a badge with only the provider name" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
 
           context "when initials is true" do
@@ -123,6 +133,7 @@ module PactBroker
             it "creates a badge with only the provider initials" do
               subject
               expect(http_request).to have_been_made
+              expect(pact_verification_badge_url).to eq URI(expected_url)
             end
           end
         end
@@ -131,6 +142,7 @@ module PactBroker
           it "create a green badge with left text 'verified'" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
         end
 
@@ -142,6 +154,7 @@ module PactBroker
           it "create a lightgrey badge with left text 'unknown'" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
         end
 
@@ -153,6 +166,7 @@ module PactBroker
           it "create a red badge with left text 'failed'" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
         end
 
@@ -164,6 +178,7 @@ module PactBroker
           it "create a orange badge with left text 'changed'" do
             subject
             expect(http_request).to have_been_made
+            expect(pact_verification_badge_url).to eq URI(expected_url)
           end
         end
 

data/spec/lib/pact_broker/config/load_spec.rb

@@ -7,7 +7,7 @@ module PactBroker
       describe ".call" do
 
         class MockConfig
-          attr_accessor :foo, :bar, :nana, :meep, :lalala, :meow, :peebo, :whitelist
+          attr_accessor :foo, :bar, :nana, :meep, :lalala, :meow, :peebo, :whitelist, :blah
         end
 
         before do
@@ -20,6 +20,7 @@ module PactBroker
           Setting.create(name: 'peebo', type: 'string', value: nil)
           Setting.create(name: 'unknown', type: 'string', value: nil)
           Setting.create(name: 'whitelist', type: 'space_delimited_string_list', value: 'foo bar')
+          Setting.create(name: 'blah', type: 'symbol', value: 'boop')
         end
 
         let(:configuration) { MockConfig.new }
@@ -36,6 +37,11 @@ module PactBroker
           expect(configuration.bar).to eq "bar"
         end
 
+        it "loads a Symbol setting" do
+          subject
+          expect(configuration.blah).to eq :boop
+        end
+
         it "loads an Integer setting" do
           subject
           expect(configuration.nana).to eq 1

data/spec/lib/pact_broker/config/save_spec.rb

@@ -7,7 +7,7 @@ module PactBroker
     describe Save do
 
       describe "#call" do
-        let(:setting_names) { [:foo, :bar, :wiffle, :meep, :flop, :peebo, :lalala, :meow, :whitelist] }
+        let(:setting_names) { [:foo, :bar, :wiffle, :meep, :flop, :peebo, :lalala, :meow, :whitelist, :blah] }
         let(:configuration) do
           double("PactBroker::Configuration",
             foo: true,
@@ -15,6 +15,7 @@ module PactBroker
             wiffle: ["a", "b", "c"],
             meep: {a: 'thing'},
             flop: nil,
+            blah: :boop,
             peebo: 1,
             lalala: 1.2,
             meow: Object.new,
@@ -23,6 +24,13 @@ module PactBroker
 
         subject { Save.call(configuration, setting_names) }
 
+        it "saves a Symbol" do
+          subject
+          setting = Setting.find(name: 'blah')
+          expect(setting.type).to eq 'symbol'
+          expect(setting.value).to eq 'boop'
+        end
+
         it "saves a false config setting to the database" do
           subject
           setting = Setting.find(name: 'foo')

data/spec/lib/pact_broker/pacts/build_verifiable_pact_notices_spec.rb

@@ -24,7 +24,6 @@ module PactBroker
 
       subject { BuildVerifiablePactNotices.call(verifiable_pact, pact_url, options) }
 
-
       context "when include_pending_status is true" do
         let(:expected_notices) do
           [

data/spec/lib/pact_broker/webhooks/service_spec.rb

@@ -14,9 +14,38 @@ module PactBroker
         allow(Service).to receive(:logger).and_return(logger)
       end
 
-      let(:td) { TestDataBuilder.new }
       let(:logger) { double('logger').as_null_object }
 
+      describe "validate - integration test" do
+        let(:invalid_webhook) { PactBroker::Domain::Webhook.new }
+
+        context "with no uuid" do
+          subject { Service.errors(invalid_webhook) }
+
+          it "does not contain an error for the uuid" do
+            expect(subject.messages).to_not have_key('uuid')
+          end
+        end
+
+        context "with a uuid" do
+          subject { Service.errors(invalid_webhook, '') }
+
+          it "merges the uuid errors with the webhook errors" do
+            expect(subject.messages['uuid'].first).to include "can only contain"
+          end
+        end
+      end
+
+      describe ".valid_uuid_format?" do
+        it 'does something' do
+          expect(Service.valid_uuid_format?("_-bcdefghigHIJKLMNOP")).to be true
+          expect(Service.valid_uuid_format?("HIJKLMNOP")).to be false
+          expect(Service.valid_uuid_format?("abcdefghigHIJKLMNOP\\")).to be false
+          expect(Service.valid_uuid_format?("abcdefghigHIJKLMNOP#")).to be false
+          expect(Service.valid_uuid_format?("abcdefghigHIJKLMNOP$")).to be false
+        end
+      end
+
       describe ".delete_by_uuid" do
         before do
           td.create_pact_with_hierarchy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.48.0
+  version: 2.49.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty