pact_broker 1.3.0 → 1.3.1

data/lib/pact_broker/models/webhook_request.rb

@@ -2,6 +2,7 @@ require 'pact_broker/models/webhook_request_header'
 require 'pact_broker/models/webhook_execution_result'
 require 'pact_broker/logging'
 require 'pact_broker/messages'
+require 'net/http'
 
 module PactBroker
 
@@ -23,6 +24,10 @@ module PactBroker
 
       attr_accessor :method, :url, :headers, :body, :username, :password
 
+      # Reform gets confused by the :method method, as :method is a standard
+      # Ruby method.
+      alias_method :http_method, :method
+
       def initialize attributes = {}
         @method = attributes[:method]
         @url = attributes[:url]
@@ -70,15 +75,6 @@ module PactBroker
 
       end
 
-      def validate
-        messages = []
-        messages << message('errors.validation.attribute_missing', attribute: 'method') unless method
-        messages << message('errors.validation.attribute_missing', attribute: 'url') unless url
-        messages << message('errors.validation.invalid_http_method', method: method) unless method && method_valid?
-        messages << message('errors.validation.invalid_url', url: url) unless url && url_valid?
-        messages
-      end
-
       private
 
       def to_s
@@ -89,14 +85,6 @@ module PactBroker
         Net::HTTP.const_get(method.capitalize).new(url)
       end
 
-      def method_valid?
-        Net::HTTP.const_defined?(method.capitalize)
-      end
-
-      def url_valid?
-        uri.scheme && uri.host
-      end
-
       def uri
         URI(url)
       end

data/lib/pact_broker/pacts/pact_params.rb

@@ -0,0 +1,79 @@
+require 'pact_broker/json'
+require 'pact_broker/constants'
+require 'ostruct'
+
+module PactBroker
+  module Pacts
+    class PactParams < Hash
+
+      def initialize attributes
+        merge!(attributes)
+      end
+
+      def self.from_request request, path_info
+        json_content = request.body.to_s
+        pact_hash = begin
+          JSON.parse(json_content, PACT_PARSING_OPTIONS)
+        rescue
+          {}
+        end
+
+        new(
+          consumer_name: path_info.fetch(:consumer_name),
+          provider_name: path_info.fetch(:provider_name),
+          consumer_version_number: path_info.fetch(:consumer_version_number),
+          consumer_name_in_pact: pact_hash.fetch('consumer',{})['name'],
+          provider_name_in_pact: pact_hash.fetch('provider',{})['name'],
+          json_content: json_content
+        )
+      end
+
+      def pacticipant_names
+        [consumer_name, provider_name]
+      end
+
+      def consumer_name
+        self[:consumer_name]
+      end
+
+      def provider_name
+        self[:provider_name]
+      end
+
+      def consumer_version_number
+        self[:consumer_version_number]
+      end
+
+      def json_content
+        self[:json_content]
+      end
+
+      def consumer_name_in_pact
+        self[:consumer_name_in_pact]
+      end
+
+      def provider_name_in_pact
+        self[:provider_name_in_pact]
+      end
+
+      def consumer
+        PacticipantName.new(consumer_name, consumer_name_in_pact, 'consumer')
+      end
+
+      def provider
+        PacticipantName.new(provider_name, provider_name_in_pact, 'provider')
+      end
+
+      class PacticipantName < Struct.new(:name, :name_in_pact, :pacticipant)
+        def message_args
+          {
+            name: name,
+            name_in_pact: name_in_pact,
+            pacticipant: pacticipant
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/pact_broker/services/webhook_service.rb

@@ -14,6 +14,12 @@ module PactBroker
         SecureRandom.urlsafe_base64
       end
 
+      def self.errors webhook
+        contract = PactBroker::Api::Contracts::WebhookContract.new(webhook)
+        contract.validate
+        contract.errors
+      end
+
       def self.create uuid, webhook, consumer, provider
         webhook_repository.create uuid, webhook, consumer, provider
       end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/pact_broker.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |gem|
   #gem.add_runtime_dependency 'pact'
   gem.add_runtime_dependency 'httparty'
   gem.add_runtime_dependency 'json'
-  gem.add_runtime_dependency 'roar'
+  gem.add_runtime_dependency 'roar', '~> 0.12.9'
+  gem.add_runtime_dependency 'reform', '~> 1.0'
   gem.add_runtime_dependency 'sequel', '~> 4.12'
-  gem.add_runtime_dependency 'webmachine'
-  gem.add_runtime_dependency 'versionomy'
+  gem.add_runtime_dependency 'webmachine', '~> 1.2'
+  gem.add_runtime_dependency 'versionomy', '~> 0.4'
   gem.add_runtime_dependency 'rack'
   gem.add_runtime_dependency 'redcarpet', '~>3.1'
   gem.add_runtime_dependency 'pact', '~>1.3', '>=1.3.2'

data/spec/fixtures/webhook_valid.json

@@ -0,0 +1,14 @@
+{
+  "request": {
+    "method": "POST",
+    "url": "http://some.url",
+    "username": "username",
+    "password": "password",
+    "headers": {
+      "Accept": "application/json"
+    },
+    "body": {
+      "a" : "body"
+    }
+  }
+}

data/spec/integration/endpoints/pact_put_spec.rb

@@ -39,5 +39,21 @@ describe "pacts/provider/:provider/consumer/:consumer/version/:version" do
         expect(response_body_json).to include JSON.parse(pact_content)
       end
     end
+
+    context "when the pacticipant names in the path do not match those in the pact" do
+      let(:path) { "/pacts/provider/Another%20Provider/consumer/A%20Consumer/version/1.2.3" }
+
+      it "returns a json error response" do
+        expect(subject).to be_a_json_error_response "does not match"
+      end
+    end
+
+    context "when the pact is another type of CDC that doesn't have the Consumer or Provider names in the expected places" do
+      let(:pact_content) { {}.to_json }
+
+      it "accepts the un-pact Pact" do
+        expect(subject.status).to be 201
+      end
+    end
   end
 end

data/spec/integration/endpoints/pact_webhooks_spec.rb

@@ -0,0 +1,96 @@
+
+require 'support/provider_state_builder'
+
+module PactBroker::Api
+
+  module Resources
+
+    describe PactWebhooks do
+
+      before do
+        ProviderStateBuilder.new.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+      end
+
+
+      let(:path) { "/webhooks/provider/Some%20Provider/consumer/Some%20Consumer" }
+      let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
+
+      describe "POST" do
+
+        subject { post path, webhook_json, headers }
+
+        context "with invalid attributes" do
+
+          let(:errors) { ["Request can't be blank"] }
+
+          let(:webhook_json) do
+            {
+
+            }.to_json
+          end
+
+          it "returns a 400" do
+            subject
+            expect(last_response.status).to be 400
+          end
+
+          it "returns a JSON content type" do
+            subject
+            expect(last_response.headers['Content-Type']).to eq 'application/json'
+          end
+
+          it "returns the validation errors" do
+            subject
+            expect(JSON.parse(last_response.body, symbolize_names: true)).to eq errors: errors
+          end
+
+        end
+
+        xcontext "with valid attributes" do
+
+          let(:webhook_response_json) { {some: 'webhook'}.to_json }
+          let(:decorator) { instance_double(Decorators::WebhookDecorator) }
+
+          before do
+            allow_any_instance_of(Decorators::WebhookDecorator).to receive(:to_json).and_return(webhook_response_json)
+          end
+
+          it "saves the webhook" do
+            expect(PactBroker::Services::WebhookService).to receive(:create).with(next_uuid, webhook, consumer, provider)
+            subject
+          end
+
+          it "returns a 201 response" do
+            subject
+            expect(last_response.status).to be 201
+          end
+
+          it "returns the Location header" do
+            subject
+            expect(last_response.headers['Location']).to include(next_uuid)
+          end
+
+          it "returns a JSON content type" do
+            subject
+            expect(last_response.headers['Content-Type']).to eq 'application/hal+json'
+          end
+
+          it "generates the JSON response body" do
+            allow(Decorators::WebhookDecorator).to receive(:new).and_call_original #Deserialise
+            expect(Decorators::WebhookDecorator).to receive(:new).with(saved_webhook).and_return(decorator) #Serialize
+            expect(decorator).to receive(:to_json).with(base_url: 'http://example.org')
+            subject
+          end
+
+          it "returns the JSON representation of the webhook" do
+            subject
+            expect(last_response.body).to eq webhook_response_json
+          end
+        end
+
+      end
+
+    end
+  end
+
+end

data/spec/lib/pact_broker/api/contracts/put_pact_params_contract_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require 'pact_broker/api/contracts/put_pact_params_contract'
+
+module PactBroker
+  module Api
+    module Contracts
+
+      describe PutPactParamsContract do
+
+        let(:json_content) { {'some' => 'json' }.to_json }
+        let(:pact_params) { Pacts::PactParams.new(attributes) }
+
+        let(:valid_attributes) do
+          {
+            consumer_name: "consumer",
+            provider_name: "provider",
+            consumer_version_number: '1.2.3',
+            json_content: json_content,
+            consumer_name_in_pact: "consumer",
+            provider_name_in_pact: "provider"
+          }
+        end
+
+        subject { PutPactParamsContract.new(pact_params) }
+
+        describe "errors" do
+
+          let(:attributes) { valid_attributes }
+
+          before do
+            subject.validate
+          end
+
+          context "with valid params" do
+
+            it "is empty" do
+              expect(subject.errors.any?).to be false
+            end
+          end
+
+          context "with a nil consumer version number" do
+            let(:attributes) do
+              valid_attributes.merge(consumer_version_number: nil)
+            end
+
+            it "returns an error" do
+              expect(subject.errors.full_messages).to include "Consumer version number can't be blank"
+            end
+          end
+
+          context "with an empty consumer version number" do
+            let(:attributes) do
+              valid_attributes.merge(consumer_version_number: '')
+            end
+
+            it "returns an error" do
+              expect(subject.errors.full_messages).to include "Consumer version number can't be blank"
+            end
+          end
+
+          context "with an invalid version number" do
+            let(:attributes) { {consumer_version_number: 'blah'} }
+
+            it "returns an error" do
+              expect(subject.errors[:base]).to include "Consumer version number 'blah' is not recognised as a standard semantic version. eg. 1.3.0 or 2.0.4.rc1"
+            end
+          end
+
+          context "with a consumer name in the pact that does not match the consumer name in the path" do
+
+            let(:attributes) do
+              valid_attributes.merge(consumer_name: "another consumer")
+            end
+
+            it "returns an error" do
+              expect(subject.errors.full_messages).to include "Consumer name in pact ('consumer') does not match consumer name in path ('another consumer')."
+            end
+          end
+
+          context "with a provider name in the pact that does not match the provider name in the path" do
+
+            let(:attributes) do
+              valid_attributes.merge(provider_name: "another provider")
+            end
+
+            it "returns an error" do
+              expect(subject.errors.full_messages).to include "Provider name in pact ('provider') does not match provider name in path ('another provider')."
+            end
+          end
+
+          context "when the consumer name in the pact is not present" do
+
+            let(:attributes) do
+              valid_attributes.tap do | atts |
+                atts.delete(:consumer_name_in_pact)
+              end
+            end
+
+            it "returns no error because I don't want to stop a different CDC from being published" do
+              expect(subject.errors.any?).to be false
+            end
+          end
+
+          context "when the provider name in the pact is not present" do
+
+            let(:attributes) do
+              valid_attributes.tap do | atts |
+                atts.delete(:provider_name_in_pact)
+              end
+            end
+
+            it "returns no error because I don't want to stop a different CDC from being published" do
+              expect(subject.errors.any?).to be false
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'pact_broker/api/contracts/webhook_contract'
+require 'pact_broker/api/decorators/webhook_decorator'
+
+module PactBroker
+  module Api
+    module Contracts
+      describe WebhookContract do
+
+        let(:json) { load_fixture 'webhook_valid.json' }
+        let(:webhook) { PactBroker::Api::Decorators::WebhookDecorator.new(Models::Webhook.new).from_json(json) }
+        let(:subject) { WebhookContract.new(webhook) }
+
+        def valid_webhook_with
+          hash = load_json_fixture 'webhook_valid.json'
+          yield hash
+          hash.to_json
+        end
+
+        describe "errors" do
+
+          before do
+            subject.validate
+          end
+
+          context "with valid fields" do
+            it "is empty" do
+              expect(subject.errors.any?).to be false
+            end
+          end
+
+          context "with no request defined" do
+
+            let(:json) { {}.to_json }
+
+            it "contains an error for missing request" do
+              subject.validate
+              expect(subject.errors[:request]).to eq ["can't be blank"]
+            end
+          end
+
+          context "with no method" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash['request'].delete('method')
+              end
+            end
+
+            it "contains an error for missing method" do
+              expect(subject.errors[:"request.http_method"]).to eq ["can't be blank"]
+            end
+          end
+
+          context "with an invalid method" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash['request']['method'] = 'blah'
+              end
+            end
+
+            it "contains an error for invalid method" do
+              expect(subject.errors[:"request.method"]).to eq ["is not a recognised HTTP method"]
+            end
+          end
+
+          context "with no URL" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash['request'].delete('url')
+              end
+            end
+
+            it "contains an error for missing URL" do
+              expect(subject.errors[:"request.url"]).to eq ["can't be blank"]
+            end
+          end
+
+          context "with an invalid URL" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash['request']['url'] = 'bl ah'
+              end
+            end
+
+            it "contains an error for invalid URL" do
+              expect(subject.errors[:"request.url"]).to eq ["is not a valid URL eg. http://example.org"]
+            end
+          end
+
+          context "with an URL missing a scheme" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash['request']['url'] = 'blah'
+              end
+            end
+
+            it "contains an error for invalid URL" do
+              expect(subject.errors[:"request.url"]).to eq ["is not a valid URL eg. http://example.org"]
+            end
+          end
+        end
+
+      end
+    end
+  end
+end