pact_broker-client 0.0.6 → 1.0.0

data/doc/markdown/README.md

@@ -0,0 +1,3 @@
+### Pacts for Pact Broker Client
+
+* [Pact Broker Client](Pact Broker Client - Pact Broker.md)

data/lib/pact_broker/client/base_client.rb

@@ -26,11 +26,13 @@ module PactBroker
       include HTTParty
       include StringToSymbol
 
-      attr_reader :base_url
+      attr_reader :base_url, :client_options
 
       def initialize options
         @base_url = options[:base_url]
+        @client_options = options[:client_options] || {}
         self.class.base_uri base_url
+        self.class.basic_auth(client_options[:basic_auth][:username], client_options[:basic_auth][:password]) if client_options[:basic_auth]
       end
 
       def default_request_headers

data/lib/pact_broker/client/pact_broker_client.rb

@@ -14,19 +14,20 @@ module PactBroker
 
       DEFAULT_OPTIONS = {base_url: DEFAULT_PACT_BROKER_BASE_URL}
 
-      attr_reader :base_url
+      attr_reader :base_url, :client_options
 
       def initialize options = {}
         merged_options = DEFAULT_OPTIONS.merge(options)
         @base_url = merged_options[:base_url]
+        @client_options = merged_options[:client_options] || {}
       end
 
       def pacticipants
-        PactBroker::Client::Pacticipants.new base_url: base_url
+        PactBroker::Client::Pacticipants.new base_url: base_url, client_options: client_options
       end
 
       def pacts
-        PactBroker::Client::Pacts.new base_url: base_url
+        PactBroker::Client::Pacts.new base_url: base_url, client_options: client_options
       end
 
     end

data/lib/pact_broker/client/pacticipants.rb

@@ -5,7 +5,7 @@ module PactBroker
     class Pacticipants < BaseClient
 
       def versions
-        Versions.new base_url: base_url
+        Versions.new base_url: base_url, client_options: client_options
       end
 
       def update options

data/lib/pact_broker/client/pacts.rb

@@ -13,7 +13,11 @@ module PactBroker
         url = save_consumer_contract_url consumer_contract, consumer_version
         response = self.class.put(url, body: pact_string, headers: default_put_headers)
         handle_response(response) do
-          true
+          latest_link = find_latest_link JSON.parse(response.body)
+          if latest_link.nil?
+            "Please upgrade to the latest version of the pact broker to see the URL of the latest pact!"
+          end
+          latest_link
         end
       end
 
@@ -28,7 +32,7 @@ module PactBroker
       def list_latest
         response = self.class.get("/pacts/latest", headers: default_get_headers)
         handle_response(response) do
-          map_pact_list_do_hash JSON.parse(response.body)["pacts"]
+          map_pact_list_to_hash JSON.parse(response.body)["pacts"]
         end
       end
 
@@ -43,7 +47,7 @@ module PactBroker
       private
 
       #TODO Move into mapper class
-      def map_pact_list_do_hash pacts_list
+      def map_pact_list_to_hash pacts_list
         pacts_list.collect do | pact_hash |
           {
             consumer: {
@@ -59,6 +63,18 @@ module PactBroker
         end
       end
 
+      def find_latest_link response
+        links = response['_links']
+        return nil unless links
+        key = links.keys.find{ | key | key =~ /latest/ && key =~ /pact/ && key =~ /version/ }
+        return links[key]['href'] if key
+        key = links.keys.find{ | key | key =~ /latest/ && key =~ /pact/ }
+        return links[key]['href'] if key
+        nil
+      end
+
+
+
       def find_latest_consumer_contract_query options
         query = {:consumer => options[:consumer], :provider => options[:provider]}
         query[:tag] = options[:tag] if options[:tag]
@@ -69,21 +85,21 @@ module PactBroker
         consumer_name = encode_param(options[:consumer])
         provider_name = encode_param(options[:provider])
         tag = options[:tag] ? "/#{options[:tag]}" : ""
-        "/pact/provider/#{provider_name}/consumer/#{consumer_name}/latest#{tag}"
+        "/pacts/provider/#{provider_name}/consumer/#{consumer_name}/latest#{tag}"
       end
 
       def get_consumer_contract_url options
         consumer_name = encode_param(options[:consumer])
         provider_name = encode_param(options[:provider])
         consumer_version = encode_param(options[:consumer_version])
-        "/pact/provider/#{provider_name}/consumer/#{consumer_name}/version/#{consumer_version}"
+        "/pacts/provider/#{provider_name}/consumer/#{consumer_name}/version/#{consumer_version}"
       end
 
       def save_consumer_contract_url consumer_contract, consumer_version
         consumer_name = encode_param(consumer_contract.consumer.name)
         provider_name = encode_param(consumer_contract.provider.name)
         version = encode_param(consumer_version)
-        "/pact/provider/#{provider_name}/consumer/#{consumer_name}/version/#{version}"
+        "/pacts/provider/#{provider_name}/consumer/#{consumer_name}/version/#{version}"
       end
     end
   end

data/lib/pact_broker/client/publish_pacts.rb

@@ -1,39 +1,49 @@
 require 'pact_broker/client'
+require 'pact_broker/client/retry'
 
 module PactBroker
   module Client
     class PublishPacts
 
-      def initialize pact_broker_base_url, pact_files, consumer_version
+      def initialize pact_broker_base_url, pact_files, consumer_version, pact_broker_client_options={}
         @pact_broker_base_url = pact_broker_base_url
         @pact_files = pact_files
         @consumer_version = consumer_version
+        @pact_broker_client_options = pact_broker_client_options
       end
 
       def call
         validate
+        $stdout.puts("")
         pact_files.collect{ | pact_file | publish_pact pact_file }.all?
       end
 
       private
 
-      attr_reader :pact_broker_base_url, :pact_files, :consumer_version
+      attr_reader :pact_broker_base_url, :pact_files, :consumer_version, :pact_broker_client_options
 
       def pact_broker_client
-        @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url)
+        @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
       end
 
       def publish_pact pact_file
         begin
-          puts "Publishing #{pact_file} to pact broker at #{pact_broker_base_url}"
-          pact_broker_client.pacticipants.versions.pacts.publish(pact_json: File.read(pact_file), consumer_version: consumer_version)
-          true
+          $stdout.puts ">> Publishing #{pact_file} to pact broker at #{pact_broker_base_url}"
+          publish_pact_contents File.read(pact_file)
         rescue => e
           $stderr.puts "Failed to publish pact: #{pact_file} due to error: #{e.to_s}\n#{e.backtrace.join("\n")}"
           false
         end
       end
 
+      def publish_pact_contents pact_file_contents
+        Retry.until_true do
+          latest_pact_url = pact_broker_client.pacticipants.versions.pacts.publish(pact_json: pact_file_contents, consumer_version: consumer_version)
+          $stdout.puts "The latest version of this pact can be accessed at the following URL (use this to configure the provider verification):\n#{latest_pact_url}\n\n"
+          true
+        end
+      end
+
       def validate
         raise "Please specify the consumer_version" unless (consumer_version && consumer_version.to_s.strip.size > 0)
         raise "Please specify the pact_broker_base_url" unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)

data/lib/pact_broker/client/retry.rb

@@ -0,0 +1,26 @@
+module PactBroker
+  module Client
+    class Retry
+
+      def self.until_true options = {}
+        max_tries = options.fetch(:times, 3)
+        tries = 0
+        while true
+          begin
+            return yield
+          rescue StandardError => e
+            tries += 1
+            $stderr.puts "Error publishing pact - #{e.message}, attempt #{tries} of #{max_tries}"
+            sleep options
+            raise e if max_tries == tries
+          end
+        end
+      end
+
+      def self.sleep options
+        Kernel.sleep options.fetch(:sleep, 5)
+      end
+
+    end
+  end
+end

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -15,7 +15,7 @@ module PactBroker
   module Client
     class PublicationTask < ::Rake::TaskLib
 
-      attr_accessor :pattern, :pact_broker_base_url, :consumer_version
+      attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :pact_broker_basic_auth
 
       def initialize name = nil, &block
         @name = name
@@ -32,7 +32,8 @@ module PactBroker
           task task_name do
             block.call(self)
             require 'pact_broker/client/publish_pacts'
-            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version).call
+            pact_broker_client_options = pact_broker_basic_auth ? {basic_auth: pact_broker_basic_auth} :{}
+            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version, pact_broker_client_options).call
             raise "One or more pacts failed to be published" unless success
           end
         end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '0.0.6'
+    VERSION = '1.0.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -32,7 +32,7 @@ module PactBroker
       end
 
       def pacts
-        Pacts.new base_url: base_url
+        Pacts.new base_url: base_url, client_options: client_options
       end
 
       private

data/spec/lib/pact_broker/client/base_client_spec.rb

@@ -0,0 +1,51 @@
+require 'pact_broker/client/base_client'
+module PactBroker
+  module Client
+    describe BaseClient do
+      describe '#initialize' do
+        let(:base_url) { 'http://pact_broker_base_url'}
+        let(:username) { 'pact_repo_username'}
+        let(:password) { 'pact_repo_password'}
+        let(:client_options) do
+          {
+            basic_auth: {
+              username: username,
+              password: password
+            }
+          }
+        end
+        context 'with basic url' do
+          it 'should set base url' do
+            base_client = BaseClient.new(base_url: base_url)
+            expect(base_client.base_url).to eq(base_url)
+            expect(BaseClient.base_uri).to eq(base_url)
+          end
+        end
+
+        context 'with client options' do
+          subject { BaseClient.new(base_url: base_url, client_options: client_options) }
+          it 'should set client options ' do
+            expect(subject.client_options).to eq(client_options)
+          end
+
+          it 'should set httpparty basic auth when client options contains basic auth' do
+            expect(BaseClient).to receive(:basic_auth).with(username, password)
+            subject
+          end
+        end
+
+        context 'without client options' do
+          subject { BaseClient.new(base_url: base_url) }
+          it 'should set client options to empty hash ' do
+            expect(subject.client_options).to eq({})
+          end
+
+          it 'should not set httpparty basic auth' do
+            expect(BaseClient).to_not receive(:basic_auth).with(username, password)
+            subject
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/pact_broker_client_spec.rb

@@ -5,14 +5,41 @@ require 'pact_broker/client'
 module PactBroker::Client
   describe PactBrokerClient do
 
+    let(:client_options) do
+      { some_option: 'option value'}
+    end
+    let(:base_url) { 'https://blah' }
+
     describe 'initialize' do
       subject { PactBrokerClient.new }
       it 'sets the base_uri to http://pact-broker by default' do
         expect(subject.base_url).to eq('http://pact-broker')
       end
 
+      it 'sets the client options to empty hash by default' do
+        expect(subject.client_options).to eq({})
+      end
+
       it 'allows configuration of the base_uri' do
-        expect(PactBrokerClient.new(base_url: 'https://blah').base_url).to eq('https://blah')
+        expect(PactBrokerClient.new(base_url: base_url).base_url).to eq(base_url)
+      end
+
+      it 'allows configuration of the client options' do
+        expect(PactBrokerClient.new(client_options: client_options).client_options).to eq(client_options)
+      end
+    end
+
+    describe 'pacticipants' do
+      it 'initializes pacticipants with base url and client options' do
+        expect(PactBroker::Client::Pacticipants).to receive(:new).with(base_url: base_url, client_options: client_options)
+        PactBrokerClient.new(base_url: base_url, client_options: client_options).pacticipants
+      end
+    end
+
+    describe 'pacts' do
+      it 'initializes [act] with base url and client options' do
+        expect(PactBroker::Client::Pacts).to receive(:new).with(base_url: base_url, client_options: client_options)
+        PactBrokerClient.new(base_url: base_url, client_options: client_options).pacts
       end
     end
   end

data/spec/lib/pact_broker/client/pacticipants_spec.rb

@@ -0,0 +1,18 @@
+require 'pact_broker/client/pacticipants'
+module PactBroker
+  module Client
+    describe Pacticipants do
+      let(:client_options) do
+        { some_option: 'option value'}
+      end
+      let(:base_url) { 'https://blah' }
+
+      describe 'versions' do
+        it 'initializes versions with base url and client options' do
+          expect(PactBroker::Client::Versions).to receive(:new).with(base_url: base_url, client_options: client_options)
+          Pacticipants.new(base_url: base_url, client_options: client_options).versions
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/publish_pacts_spec.rb

@@ -9,22 +9,31 @@ module PactBroker
 
       before do
         FakeFS.activate!
-        pacts_client.stub(:publish)
-        PactBroker::Client::PactBrokerClient.stub(:new).with(base_url: pact_broker_base_url).and_return(pact_broker_client)
+        pacts_client.stub(:publish).and_return(latest_pact_url)
+        PactBroker::Client::PactBrokerClient.stub(:new).with(base_url: pact_broker_base_url, client_options: pact_broker_client_options).and_return(pact_broker_client)
       end
 
       after do
         FakeFS.deactivate!
       end
 
+      let(:latest_pact_url) { 'http://example.org/latest/pact' }
       let(:pact_broker_client) { double("PactBroker::Client")}
       let(:pact_files) { ['spec/pacts/consumer-provider.json']}
       let(:consumer_version) { "1.2.3" }
       let(:pact_hash) { {consumer: {name: 'Consumer'}, provider: {name: 'Provider'} } }
       let(:pacts_client) { instance_double("PactBroker::ClientSupport::Pacts")}
       let(:pact_broker_base_url) { 'http://some-host'}
+      let(:pact_broker_client_options) do
+        {
+          basic_auth: {
+            username: 'user',
+            password: 'pass'
+          }
+        }
+      end
 
-      subject { PublishPacts.new(pact_broker_base_url, pact_files, consumer_version) }
+      subject { PublishPacts.new(pact_broker_base_url, pact_files, consumer_version, pact_broker_client_options) }
 
       before do
         FileUtils.mkdir_p "spec/pacts"
@@ -40,13 +49,20 @@ module PactBroker
         end
 
         context "when publishing is successful" do
+
+          it "puts the location of the latest pact" do
+            allow($stdout).to receive(:puts)
+            expect($stdout).to receive(:puts).with(/#{latest_pact_url}/)
+            subject.call
+          end
           it "returns true" do
-            expect(subject.call).to be_true
+            expect(subject.call).to be true
           end
         end
 
         context "when publishing one or more pacts fails" do
           let(:pact_files) { ['spec/pacts/doesnotexist.json','spec/pacts/consumer-provider.json']}
+
           before do
             $stderr.stub(:puts)
           end
@@ -62,7 +78,7 @@ module PactBroker
           end
 
           it "returns false" do
-            expect(subject.call).to be_false
+            expect(subject.call).to be false
           end
         end
 
@@ -86,6 +102,52 @@ module PactBroker
             expect { subject.call }.to raise_error(/Please specify the pact_broker_base_url/)
           end
         end
+
+        context "when an error occurs every time while publishing a pact" do
+
+          before do
+            allow(Retry).to receive(:sleep)
+            allow(pacts_client).to receive(:publish).and_raise("an error")
+            allow($stderr).to receive(:puts)
+          end
+
+          it "retries multiple times" do
+            expect(pacts_client).to receive(:publish).exactly(3).times
+            subject.call
+          end
+
+          it "returns false" do
+            expect(subject.call).to eq false
+          end
+        end
+
+        context "when an error occurs less than the maximum number of retries" do
+
+          before do
+            allow(Retry).to receive(:sleep)
+            tries = 0
+            allow(pacts_client).to receive(:publish) do
+              if tries == 0
+                tries += 1
+                raise "an error"
+              else
+                latest_pact_url
+              end
+            end
+            allow($stderr).to receive(:puts)
+          end
+
+          it "retries multiple times" do
+            expect(pacts_client).to receive(:publish).exactly(2).times
+            subject.call
+          end
+
+          it "returns true" do
+            expect(subject.call).to eq true
+          end
+
+        end
+
       end
     end
   end