pact_broker 2.79.1 → 2.80.0

data/spec/lib/pact_broker/api/decorators/webhook_execution_result_decorator_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
-require 'pact_broker/api/decorators/webhook_execution_result_decorator'
+require "spec_helper"
+require "pact_broker/api/decorators/webhook_execution_result_decorator"
 
 module PactBroker
   module Api
@@ -11,25 +11,25 @@ module PactBroker
           let(:headers) { { "Something" => ["blah", "thing"]} }
           let(:request) do
             req = Net::HTTP::Get.new("http://example.org?foo=bar")
-            req['Foo'] = ['bar', 'wiffle']
-            req.body = { foo: 'bar' }.to_json
+            req["Foo"] = ["bar", "wiffle"]
+            req.body = { foo: "bar" }.to_json
             req
           end
-          let(:response) { double('http_response', code: '200', body: response_body, to_hash: headers) }
-          let(:response_body) { 'body' }
+          let(:response) { double("http_response", code: "200", body: response_body, to_hash: headers) }
+          let(:response_body) { "body" }
           let(:error) { nil }
           let(:webhook) { instance_double(PactBroker::Domain::Webhook, uuid: uuid) }
-          let(:uuid) { 'some-uuid' }
+          let(:uuid) { "some-uuid" }
           let(:show_response) { true }
           let(:json) {
             WebhookExecutionResultDecorator.new(webhook_execution_result)
-            .to_json(user_options: { resource_url: 'http://resource-url', base_url: 'http://example.org', webhook: webhook, show_response: show_response })
+            .to_json(user_options: { resource_url: "http://resource-url", base_url: "http://example.org", webhook: webhook, show_response: show_response })
           }
 
           let(:subject) { JSON.parse(json, symbolize_names: true) }
 
           it "includes a link to execute the webhook again" do
-            expect(subject[:_links][:'try-again'][:href]).to eq 'http://resource-url'
+            expect(subject[:_links][:'try-again'][:href]).to eq "http://resource-url"
           end
 
           it "includes a success flag" do
@@ -42,7 +42,7 @@ module PactBroker
 
           context "when there is a uuid" do
             it "include a link to the webhook" do
-              expect(subject[:_links][:webhook][:href]).to eq 'http://example.org/webhooks/some-uuid'
+              expect(subject[:_links][:webhook][:href]).to eq "http://example.org/webhooks/some-uuid"
             end
           end
 
@@ -55,10 +55,10 @@ module PactBroker
           end
 
           context "when there is an error" do
-            let(:error) { double('error', message: 'message', backtrace: ['blah','blah']) }
+            let(:error) { double("error", message: "message", backtrace: ["blah","blah"]) }
 
             it "includes the message" do
-              expect(subject[:error][:message]).to eq 'message'
+              expect(subject[:error][:message]).to eq "message"
             end
           end
 
@@ -73,7 +73,7 @@ module PactBroker
 
             context "when the request body is JSON" do
               it "includes the request body as JSON" do
-                expect(subject[:request][:body]).to include( foo: 'bar' )
+                expect(subject[:request][:body]).to include( foo: "bar" )
               end
             end
 
@@ -102,7 +102,7 @@ module PactBroker
             end
 
             context "when the response body is JSON" do
-              let(:response_body_hash) { {some: 'json'} }
+              let(:response_body_hash) { {some: "json"} }
               let(:response_body) { response_body_hash.to_json }
               it "returns the response as JSON" do
                 expect(subject[:response][:body]).to eq response_body_hash
@@ -118,7 +118,7 @@ module PactBroker
             end
 
             it "includes a message about why the response is hidden" do
-              expect(subject[:message]).to match /security purposes/
+              expect(subject[:message]).to match(/security purposes/)
             end
           end
         end

data/spec/lib/pact_broker/api/decorators/webhook_request_template_decorator_spec.rb

@@ -1,24 +1,24 @@
-require 'spec_helper'
-require 'pact_broker/api/decorators/webhook_request_template_decorator'
-require 'json'
+require "spec_helper"
+require "pact_broker/api/decorators/webhook_request_template_decorator"
+require "json"
 
 module PactBroker
   module Api
     module Decorators
       describe WebhookRequestTemplateDecorator do
 
-        let(:username) { 'username' }
-        let(:display_password) { '*****' }
+        let(:username) { "username" }
+        let(:display_password) { "*****" }
         let(:webhook_request) do
           instance_double(
             PactBroker::Webhooks::WebhookRequestTemplate,
             username: username,
             display_password: display_password,
-            method: 'POST',
-            url: 'url',
-            body: 'body',
+            method: "POST",
+            url: "url",
+            body: "body",
             redacted_headers: {
-              'foo' => '***'
+              "foo" => "***"
             })
         end
 
@@ -47,14 +47,14 @@ module PactBroker
         end
 
         describe "from_json" do
-          let(:password) { 'password' }
+          let(:password) { "password" }
           let(:hash) do
             {
               username: username,
               password: password,
-              method: 'POST',
-              url: 'url',
-              body: 'body',
+              method: "POST",
+              url: "url",
+              body: "body",
               headers: {}
             }
           end

data/spec/lib/pact_broker/api/decorators/webhooks_decorator_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
-require 'pact_broker/api/decorators/webhooks_decorator'
+require "spec_helper"
+require "pact_broker/api/decorators/webhooks_decorator"
 
 module PactBroker
   module Api
@@ -8,16 +8,16 @@ module PactBroker
 
         let(:webhook) do
           instance_double(Domain::Webhook,
-            uuid: 'some-uuid',
-            display_description: 'description',
-            scope_description: 'scope description'
+            uuid: "some-uuid",
+            display_description: "description",
+            scope_description: "scope description"
           )
         end
-        let(:base_url) { 'http://example.org' }
-        let(:resource_url) { 'http://example.org/webhooks' }
+        let(:base_url) { "http://example.org" }
+        let(:resource_url) { "http://example.org/webhooks" }
 
         let(:decorator_context) do
-          DecoratorContext.new(base_url, resource_url, {}, resource_title: 'Title')
+          DecoratorContext.new(base_url, resource_url, {}, resource_title: "Title")
         end
 
         let(:webhooks) { [webhook] }
@@ -30,12 +30,12 @@ module PactBroker
 
           it "includes a link to itself with a title" do
             expect(subject[:_links][:self][:href]).to eq resource_url
-            expect(subject[:_links][:self][:title]).to eq 'Title'
+            expect(subject[:_links][:self][:title]).to eq "Title"
           end
 
           it "includes a list of links to the webhooks" do
             expect(subject[:_links][:'pb:webhooks']).to be_instance_of(Array)
-            expect(subject[:_links][:'pb:webhooks'].first).to eq title: 'scope description', name: 'description', href: 'http://example.org/webhooks/some-uuid'
+            expect(subject[:_links][:'pb:webhooks'].first).to eq title: "scope description", name: "description", href: "http://example.org/webhooks/some-uuid"
           end
 
           it "includes curies" do

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/pact_broker_urls'
+require "pact_broker/api/pact_broker_urls"
 
 module PactBroker
   module Api
@@ -6,7 +6,7 @@ module PactBroker
       before do
         allow(PactBrokerUrls).to receive(:logger).and_return(logger)
       end
-      let(:logger) { double('logger').as_null_object }
+      let(:logger) { double("logger").as_null_object }
 
       # Regex find all the URL parameter names
       # \/\{[^\}\s\[\(\.]+\}
@@ -15,15 +15,15 @@ module PactBroker
       let(:consumer_name) { "Foo/Foo" }
       let(:provider_name) { "Bar/Bar" }
       let(:pact) do
-        double('pact',
+        double("pact",
           consumer: consumer,
           provider: provider,
           consumer_version_number: "123/456",
           pact_version_sha: "5hbfu",
           consumer_version_tag_names: ["dev"])
       end
-      let(:consumer) { double('pacticipant', name: consumer_name) }
-      let(:provider) { double('pacticipant', name: provider_name) }
+      let(:consumer) { double("pacticipant", name: consumer_name) }
+      let(:provider) { double("pacticipant", name: provider_name) }
       let(:verification) do
         instance_double(PactBroker::Domain::Verification,
           consumer_name: consumer_name,
@@ -32,11 +32,11 @@ module PactBroker
           number: "1")
       end
       let(:version) do
-        double('version',
+        double("version",
           pacticipant: consumer,
           number: "2/4")
       end
-      let(:tag) { double('tag', name: "feat/foo", version: version) }
+      let(:tag) { double("tag", name: "feat/foo", version: version) }
 
       matcher :match_route_in_api do |api|
         match do |url|
@@ -126,14 +126,40 @@ module PactBroker
           end
         end
 
+        context "with padding" do
+          let(:encoded_metadata) { Base64.urlsafe_encode64("foo=bar", padding: true) }
+
+          it "can still handle it" do
+            expect(PactBrokerUrls.decode_pact_metadata(encoded_metadata)).to eq("foo" => "bar")
+          end
+        end
+
+        context "when the padding has been removed" do
+          let(:encoded_metadata) { Base64.urlsafe_encode64("foo=bar", padding: false) }
+
+          it "can still handle it" do
+            expect(PactBrokerUrls.decode_pact_metadata(encoded_metadata)).to eq("foo" => "bar")
+          end
+        end
+
+        context "another example without the padding" do
+          let(:encoded_metadata) { "c1tdW2xdPXRydWUmc1tdW2" }
+
+          it "can still handle it" do
+            expect(PactBrokerUrls.decode_pact_metadata(encoded_metadata)).to eq({ "s" => [{ "l" => "true" }, nil] })
+          end
+        end
+
         context "when the metadata is not valid base64" do
+          let(:encoded_metadata) { "%" }
+
           it "returns an empty hash" do
-            expect(PactBrokerUrls.decode_pact_metadata("foo==,")).to eq({})
+            expect(PactBrokerUrls.decode_pact_metadata(encoded_metadata)).to eq({})
           end
 
           it "logs a warning" do
-            expect(logger).to receive(:warn).with("Exception parsing webhook metadata: foo==,", ArgumentError)
-            PactBrokerUrls.decode_pact_metadata("foo==,")
+            expect(logger).to receive(:warn).with("Exception parsing webhook metadata: '%'. Parsing using Base64.decode64 returns ''", ArgumentError)
+            PactBrokerUrls.decode_pact_metadata(encoded_metadata)
           end
         end
       end

data/spec/lib/pact_broker/api/renderers/html_pact_renderer_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
-require 'pact_broker/api/renderers/html_pact_renderer'
-require 'timecop'
+require "spec_helper"
+require "pact_broker/api/renderers/html_pact_renderer"
+require "timecop"
 
 module PactBroker
   module Api
@@ -8,31 +8,31 @@ module PactBroker
       describe HtmlPactRenderer do
 
         before do
-          ENV['BACKUP_TZ'] = ENV['TZ']
-          ENV['TZ'] = "Australia/Melbourne"
+          ENV["BACKUP_TZ"] = ENV["TZ"]
+          ENV["TZ"] = "Australia/Melbourne"
           PactBroker.configuration.enable_public_badge_access = true
-          allow(PactBroker::Api::PactBrokerUrls).to receive(:pact_url).with('http://base', pact).and_return(pact_url)
-          allow(PactBroker::Api::PactBrokerUrls).to receive(:matrix_for_pact_url).with(pact, 'http://base').and_return(matrix_url)
+          allow(PactBroker::Api::PactBrokerUrls).to receive(:pact_url).with("http://base", pact).and_return(pact_url)
+          allow(PactBroker::Api::PactBrokerUrls).to receive(:matrix_for_pact_url).with(pact, "http://base").and_return(matrix_url)
           allow_any_instance_of(HtmlPactRenderer).to receive(:logger).and_return(logger)
 
           Timecop.freeze(created_at + 3)
         end
 
         after do
-          ENV['TZ'] = ENV['BACKUP_TZ']
+          ENV["TZ"] = ENV["BACKUP_TZ"]
           Timecop.return
         end
 
-        let(:consumer_name) { 'Consumer' }
-        let(:provider_name) { 'Provider' }
-        let(:consumer_version_number) { '1.2.3' }
-        let(:consumer) { double('consumer', name: consumer_name) }
-        let(:provider) { double('provider', name: provider_name) }
-        let(:consumer_version) { double('consumer version') }
+        let(:consumer_name) { "Consumer" }
+        let(:provider_name) { "Provider" }
+        let(:consumer_version_number) { "1.2.3" }
+        let(:consumer) { double("consumer", name: consumer_name) }
+        let(:provider) { double("provider", name: provider_name) }
+        let(:consumer_version) { double("consumer version") }
         let(:created_at) { DateTime.new(2014, 02, 27) }
-        let(:json_content) { load_fixture('renderer_pact.json') }
+        let(:json_content) { load_fixture("renderer_pact.json") }
         let(:pact) do
-          double('pact',
+          double("pact",
             json_content: json_content,
             consumer_version_number: consumer_version_number,
             consumer: consumer,
@@ -42,16 +42,16 @@ module PactBroker
             consumer_version: consumer_version
             )
         end
-        let(:consumer_version_tag_names) { ['prod', 'master'] }
-        let(:pact_url) { '/pact/url' }
-        let(:matrix_url) { '/matrix/url' }
+        let(:consumer_version_tag_names) { ["prod", "master"] }
+        let(:pact_url) { "/pact/url" }
+        let(:matrix_url) { "/matrix/url" }
         let(:options) do
           {
-            base_url: 'http://base',
-            badge_url: 'http://badge'
+            base_url: "http://base",
+            badge_url: "http://badge"
            }
         end
-        let(:logger) { double('logger').as_null_object }
+        let(:logger) { double("logger").as_null_object }
 
         subject { HtmlPactRenderer.call(pact, options) }
 
@@ -61,15 +61,15 @@ module PactBroker
             expect(subject).to include("</html>")
             expect(subject).to include("<link rel='stylesheet'")
             expect(subject).to include("href='http://base/stylesheets/github.css'")
-            expect(subject).to include('<pre><code')
-            expect(subject).to include('&quot;method&quot;:')
-            expect(subject).to match /<h\d>.*Some Consumer/
-            expect(subject).to match /<h\d>.*Some Provider/
+            expect(subject).to include("<pre><code")
+            expect(subject).to include("&quot;method&quot;:")
+            expect(subject).to match(/<h\d>.*Some Consumer/)
+            expect(subject).to match(/<h\d>.*Some Provider/)
             expect(subject).to include("Date published:")
             expect(subject).to include("Thu 27 Feb 2014, 11:00am +11:00")
             expect(subject).to include("3 days ago")
-            expect(subject).to match /title.*Pact between Consumer and Provider/
-            expect(subject).to match /prod, master/
+            expect(subject).to match(/title.*Pact between Consumer and Provider/)
+            expect(subject).to match(/prod, master/)
           end
 
           it "renders the badge image" do
@@ -114,7 +114,7 @@ module PactBroker
               allow(pact).to receive(:content_hash).and_return(content_hash)
             end
 
-            let(:json_content) { '[1]' }
+            let(:json_content) { "[1]" }
             let(:content_hash) { [1] }
 
             it "includes a dismissive title" do
@@ -126,7 +126,7 @@ module PactBroker
             end
 
             it "renders the JSON in HTML" do
-              expect(subject).to match /\[\s+1\s+\]/m
+              expect(subject).to match(/\[\s+1\s+\]/m)
             end
 
             it "logs a warning" do

data/spec/lib/pact_broker/api/renderers/integrations_dot_renderer_spec.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/renderers/integrations_dot_renderer'
+require "pact_broker/api/renderers/integrations_dot_renderer"
 
 module PactBroker
   module Api
@@ -9,12 +9,12 @@ module PactBroker
 
         let(:integrations) do
           [
-            double('integration', consumer_name: "Foo", provider_name: "Bar"),
-            double('integration', consumer_name: "Wiffle", provider_name: "Foo Thing")
+            double("integration", consumer_name: "Foo", provider_name: "Bar"),
+            double("integration", consumer_name: "Wiffle", provider_name: "Foo Thing")
           ]
         end
 
-        let(:expected_content) { load_fixture('expected.gv') }
+        let(:expected_content) { load_fixture("expected.gv") }
 
         describe "#call" do
           subject { IntegrationsDotRenderer.call(integrations) }

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

@@ -1,41 +1,28 @@
-require 'spec_helper'
-require 'pact_broker/api/resources/all_webhooks'
+require "spec_helper"
+require "pact_broker/api/resources/all_webhooks"
 
 module PactBroker::Api
-
   module Resources
-
     describe AllWebhooks do
+      before do
+        allow(PactBroker::Pacticipants::Service).to receive(:find_pacticipant_by_name).with("Some Provider").and_return(provider)
+        allow(PactBroker::Pacticipants::Service).to receive(:find_pacticipant_by_name).with("Some Consumer").and_return(consumer)
+        allow(Decorators::WebhookDecorator).to receive(:new).and_return(webhook_decorator)
+      end
 
       let(:webhook_service) { PactBroker::Webhooks::Service }
-      let(:uuid) { '1483234k24DKFGJ45K' }
+      let(:uuid) { "1483234k24DKFGJ45K" }
       let(:path) { "/webhooks" }
-      let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
-      let(:webhook) { double('webhook', consumer: parsed_consumer, provider: parsed_provider) }
+      let(:headers) { {"CONTENT_TYPE" => "application/json"} }
+      let(:webhook) { double("webhook", consumer: parsed_consumer, provider: parsed_provider) }
       let(:parsed_provider) { instance_double(PactBroker::Domain::Pacticipant, name: "Some Provider") }
       let(:parsed_consumer) { instance_double(PactBroker::Domain::Pacticipant, name: "Some Consumer") }
-      let(:consumer) { double('consumer', name: "Some Consumer") }
-      let(:provider) { double('provider', name: "Some Provider") }
-      let(:saved_webhook) { double('saved_webhook')}
+      let(:consumer) { double("consumer", name: "Some Consumer") }
+      let(:provider) { double("provider", name: "Some Provider") }
+      let(:saved_webhook) { double("saved_webhook")}
       let(:webhook_decorator) { instance_double(Decorators::WebhookDecorator, from_json: webhook) }
 
-      before do
-        allow(PactBroker::Pacticipants::Service).to receive(:find_pacticipant_by_name).with("Some Provider").and_return(provider)
-        allow(PactBroker::Pacticipants::Service).to receive(:find_pacticipant_by_name).with("Some Consumer").and_return(consumer)
-        allow(Decorators::WebhookDecorator).to receive(:new).and_return(webhook_decorator)
-      end
-
       describe "POST" do
-        let(:webhook_json) do
-          {
-            some: 'json'
-          }.to_json
-        end
-
-        let(:next_uuid) { '123k2nvkkwjrwk34' }
-        let(:valid) { true }
-        let(:errors) { double("errors", empty?: valid, messages: ['messages']) }
-
         before do
           allow(webhook_service).to receive(:create).and_return(saved_webhook)
           allow(webhook_service).to receive(:next_uuid).and_return(next_uuid)
@@ -43,6 +30,16 @@ module PactBroker::Api
           allow(PactBroker::Domain::Webhook).to receive(:new).and_return(webhook)
         end
 
+        let(:webhook_json) do
+          {
+            some: "json"
+          }.to_json
+        end
+
+        let(:next_uuid) { "123k2nvkkwjrwk34" }
+        let(:valid) { true }
+        let(:errors) { double("errors", empty?: valid, messages: ["messages"]) }
+
         subject { post path, webhook_json, headers }
 
         context "with malformed JSON" do
@@ -55,7 +52,6 @@ module PactBroker::Api
         end
 
         context "with invalid attributes" do
-
           let(:valid) { false }
 
           it "returns a 400" do
@@ -65,25 +61,24 @@ module PactBroker::Api
 
           it "returns a HAL JSON content type" do
             subject
-            expect(last_response.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+            expect(last_response.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
           end
 
           it "returns the validation errors" do
             subject
-            expect(JSON.parse(last_response.body, symbolize_names: true)).to eq errors: ['messages']
+            expect(JSON.parse(last_response.body, symbolize_names: true)).to eq errors: ["messages"]
           end
 
         end
 
         context "with valid attributes" do
-
-          let(:webhook_response_json) { { some: 'webhook' }.to_json }
-
           before do
             allow_any_instance_of(Decorators::WebhookDecorator).to receive(:to_json).and_return(webhook_response_json)
             allow(webhook_decorator).to receive(:to_json).and_return(webhook_response_json)
           end
 
+          let(:webhook_response_json) { { some: "webhook" }.to_json }
+
           it "saves the webhook" do
             expect(webhook_service).to receive(:create).with(next_uuid, webhook, consumer, provider)
             subject
@@ -96,17 +91,17 @@ module PactBroker::Api
 
           it "returns the Location header" do
             subject
-            expect(last_response.headers['Location']).to include(next_uuid)
+            expect(last_response.headers["Location"]).to include(next_uuid)
           end
 
           it "returns a HAL JSON content type" do
             subject
-            expect(last_response.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+            expect(last_response.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
           end
 
           it "generates the JSON response body" do
             expect(Decorators::WebhookDecorator).to receive(:new).with(saved_webhook).and_return(webhook_decorator)
-            expect(webhook_decorator).to receive(:to_json).with(user_options: hash_including({ base_url: 'http://example.org' }))
+            expect(webhook_decorator).to receive(:to_json).with(user_options: hash_including({ base_url: "http://example.org" }))
             subject
           end
 
@@ -118,12 +113,11 @@ module PactBroker::Api
       end
 
       describe "GET" do
-
         subject { get "/webhooks" }
 
-        let(:webhooks) { [double('webhook')]}
+        let(:webhooks) { [double("webhook")]}
         let(:decorator) { double(Decorators::WebhooksDecorator, to_json: json)}
-        let(:json) { {some: 'json'}.to_json }
+        let(:json) { {some: "json"}.to_json }
 
         before do
           allow(Decorators::WebhooksDecorator).to receive(:new).and_return(decorator)
@@ -145,10 +139,7 @@ module PactBroker::Api
           subject
           expect(last_response.body).to eq json
         end
-
       end
-
     end
   end
-
 end