pact_broker-client 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3553f62a8b0f25fd43c38284289fb14cad42f68
-  data.tar.gz: 454ee12554927fb5e771b7d2afe6b59bf37bcfcb
+  metadata.gz: a630ec3051f4b51d5a8acb1ca7365bf47742eecd
+  data.tar.gz: 73f384f4e4609e169e54b4bcc464cc670c43b483
 SHA512:
-  metadata.gz: 48f3d3a99d610f7702b47771134035a6a79134f8cb24b3321d019e62edf683e353b45af9b5eb99d31af1efd54758ee54ec9f7beaf82d8b591c7f2e5445fcf01d
-  data.tar.gz: 9586956310869d128a46c3fbd7664aa09ffa9fe49220a5ef7cf80362454951ba6d318069f92ea3ec6298284aeadeb51a50d6ff715066851a832301b29b90b5a3
+  metadata.gz: 7f0803e0421cf2499da988d58e6de8156fc2bfcd8c8ffab89e139431b51907c3c42d32293c754f98a64051c878dc942b17915038b6d563a155be5f3c5d5cbf90
+  data.tar.gz: 9ccc081095706def8781febb131ee1d85616e33eede87f554dc4c9d7e34728e427f4babe6f2f97b8ddb18a03e7cdac99259d93926d025c68d6fb288c1140343c

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+<a name="v1.5.0"></a>
+### v1.5.0 (2017-09-28)
+
+#### Features
+
+* **cli**
+  * add command line tool to publish pacts   ([d031b98](/../../commit/d031b98))
+
+* **publish pacts**
+  * merge pact files with same consumer/provider before publishing   ([1c039a0](/../../commit/1c039a0))
+
 <a name="v1.4.0"></a>
 ### v1.4.0 (2017-09-07)
 

data/RELEASING.md

@@ -8,7 +8,7 @@
 
 4. Add files to git
 
-      $ git add CHANGELOG.md lib/pact_broker/client/version.rb
+      $ git add CHANGELOG.md lib/pact_broker/client/version.rb gemfiles
       $ git commit -m "Releasing version $(ruby -r ./lib/pact_broker/client/version.rb -e "puts PactBroker::Client::VERSION")"
 
 5. Release:

data/Rakefile

@@ -4,9 +4,15 @@ require 'conventional_changelog'
 
 Dir.glob('lib/tasks/**/*.rake').each { |task| load "#{Dir.pwd}/#{task}" }
 Dir.glob('tasks/**/*.rake').each { |task| load "#{Dir.pwd}/#{task}" }
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do | task |
+  task.rspec_opts = "--pattern spec/lib/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:providers') do | task |
+  task.rspec_opts = "--pattern spec/service_providers/**/*_spec.rb"
+end
 
-task :default => [:spec]
+task :default => [:spec, 'spec:providers']
 
 task :generate_changelog do
   require 'pact_broker/client/version'

data/bin/pact-publish

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'pact_broker/client/cli/publish'
+
+PactBroker::Client::CLI::Publish.start

data/gemfiles/default.gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: ..
   specs:
-    pact_broker-client (1.4.0)
+    pact_broker-client (1.5.0)
       httparty
       json
-      pact
       term-ansicolor
 
 GEM
@@ -18,21 +17,22 @@ GEM
       thor (>= 0.14.0)
     awesome_print (1.8.0)
     coderay (1.1.2)
+    conventional-changelog (1.3.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    fakefs (0.11.1)
+    fakefs (0.11.2)
     find_a_port (1.0.1)
     hashdiff (0.3.6)
     httparty (0.15.6)
       multi_xml (>= 0.5.2)
     json (2.1.0)
-    method_source (0.8.2)
+    method_source (0.9.0)
     multi_xml (0.6.0)
-    pact (1.15.0)
+    pact (1.16.0)
       json (> 1.8.5)
       pact-mock_service (~> 2.0)
-      pact-support (~> 1.1)
+      pact-support (~> 1.1, >= 1.1.8)
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
       rspec (>= 2.14)
@@ -49,7 +49,7 @@ GEM
       term-ansicolor (~> 1.0)
       thor
       webrick
-    pact-support (1.1.6)
+    pact-support (1.2.0)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
@@ -58,10 +58,9 @@ GEM
       rspec (>= 2.14)
       term-ansicolor (~> 1.0)
       thor
-    pry (0.10.4)
+    pry (0.11.1)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
     public_suffix (3.0.0)
     rack (2.0.3)
     rack-test (0.6.3)
@@ -84,7 +83,6 @@ GEM
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
     safe_yaml (1.0.4)
-    slop (3.6.0)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.20.0)
@@ -100,7 +98,9 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  conventional-changelog
   fakefs (~> 0.4)
+  pact (~> 1.16)
   pact_broker-client!
   pry
   rake (~> 10.0.3)

data/gemfiles/ruby_under_22.gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: ..
   specs:
-    pact_broker-client (1.4.0)
+    pact_broker-client (1.5.0)
       httparty
       json
-      pact
       term-ansicolor
 
 GEM
@@ -18,21 +17,22 @@ GEM
       thor (>= 0.14.0)
     awesome_print (1.8.0)
     coderay (1.1.2)
+    conventional-changelog (1.3.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    fakefs (0.11.1)
+    fakefs (0.11.2)
     find_a_port (1.0.1)
     hashdiff (0.3.6)
     httparty (0.15.6)
       multi_xml (>= 0.5.2)
     json (2.1.0)
-    method_source (0.8.2)
+    method_source (0.9.0)
     multi_xml (0.6.0)
-    pact (1.15.0)
+    pact (1.16.0)
       json (> 1.8.5)
       pact-mock_service (~> 2.0)
-      pact-support (~> 1.1)
+      pact-support (~> 1.1, >= 1.1.8)
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
       rspec (>= 2.14)
@@ -49,7 +49,7 @@ GEM
       term-ansicolor (~> 1.0)
       thor
       webrick
-    pact-support (1.1.6)
+    pact-support (1.2.0)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
@@ -58,10 +58,9 @@ GEM
       rspec (>= 2.14)
       term-ansicolor (~> 1.0)
       thor
-    pry (0.10.4)
+    pry (0.11.1)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
     public_suffix (3.0.0)
     rack (1.6.8)
     rack-test (0.6.3)
@@ -84,7 +83,6 @@ GEM
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
     safe_yaml (1.0.4)
-    slop (3.6.0)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.20.0)
@@ -100,7 +98,9 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  conventional-changelog
   fakefs (~> 0.4)
+  pact (~> 1.16)
   pact_broker-client!
   pry
   rack (< 2.0)

data/lib/pact_broker/client/cli/custom_thor.rb

@@ -0,0 +1,71 @@
+require 'thor'
+
+module PactBroker
+  module Client
+    module CLI
+      ##
+      # Custom Thor task allows the following:
+      #
+      # `script arg1 arg2` to be interpreted as `script <default_task> arg1 arg2`
+      # `--option 1 --option 2` to be interpreted as `--option 1 2` (the standard Thor format for multiple value options)
+      # `script --help` to display the help for the default task instead of the command list
+      #
+      class CustomThor < ::Thor
+
+        no_commands do
+          def self.start given_args = ARGV, config = {}
+            super(massage_args(given_args))
+          end
+
+          def help *args
+            if args.empty?
+              super(self.class.default_task)
+            else
+              super
+            end
+          end
+
+          def self.massage_args argv
+            prepend_default_task_name(turn_muliple_tag_options_into_array(argv))
+          end
+
+          def self.prepend_default_task_name argv
+            if known_first_arguments.include?(argv[0])
+              argv
+            else
+              [default_command] + argv
+            end
+          end
+
+          # other task names, help, and the help shortcuts
+          def self.known_first_arguments
+            @known_first_arguments ||= tasks.keys + ::Thor::HELP_MAPPINGS + ['help']
+          end
+
+          def self.turn_muliple_tag_options_into_array argv
+            new_argv = []
+            opt_name = nil
+            argv.each_with_index do | arg, i |
+              if arg.start_with?('-')
+                opt_name = arg
+                existing = new_argv.find { | a | a.first == opt_name }
+                if !existing
+                  new_argv << [arg]
+                end
+              else
+                if opt_name
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  existing << arg
+                  opt_name = nil
+                else
+                  new_argv << [arg]
+                end
+              end
+            end
+            new_argv.flatten
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/cli/publish.rb

@@ -0,0 +1,82 @@
+require 'pact_broker/client/cli/custom_thor'
+require 'pact_broker/client/publish_pacts'
+require 'pact_broker/client/version'
+require 'rake/file_list'
+
+module PactBroker
+  module Client
+    module CLI
+
+      # Thor::Error will have its backtrace hidden
+      class PactPublicationError < ::Thor::Error; end
+
+      class Publish < CustomThor
+        desc 'PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
+        method_option :consumer_version, required: true, aliases: "-v", desc: "The consumer application version"
+        method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
+        method_option :username, aliases: "-u", desc: "Basic auth username for Pact Broker"
+        method_option :password, aliases: "-p", desc: "Basic auth password for Pact Broker"
+        method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
+
+        def broker(*pact_files)
+          validate(pact_files)
+          success = publish_pacts(pact_files)
+          raise PactPublicationError, "One or more pacts failed to be published" unless success
+        rescue PactBroker::Client::Error => e
+          raise PactPublicationError, "#{e.class} - #{e.message}"
+        end
+
+        desc 'version', "Show the pact_broker-client gem version"
+        def version
+          $stdout.puts PactBroker::Client::VERSION
+        end
+
+        default_task :broker
+
+        no_commands do
+
+          def validate pact_files
+            unless pact_files && pact_files.any?
+              raise RequiredArgumentMissingError, "No value provided for required pact_files"
+            end
+          end
+
+          def publish_pacts pact_files
+            PactBroker::Client::PublishPacts.call(
+              options[:broker_base_url],
+              file_list(pact_files),
+              options[:consumer_version],
+              tags,
+              pact_broker_client_options
+            )
+          end
+
+          def file_list pact_files
+            Rake::FileList[pact_files].collect do | path |
+              if File.directory?(path)
+                Rake::FileList[File.join(path, "*.json")]
+              else
+                path
+              end
+            end.flatten
+          end
+
+          def tags
+            [*options[:tag]].compact
+          end
+
+          def pact_broker_client_options
+            if options[:username]
+              {
+                username: options[:username],
+                password: options[:password]
+              }
+            else
+              {}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/error.rb

@@ -0,0 +1,5 @@
+module PactBroker
+  module Client
+    class Error < StandardError; end
+  end
+end

data/lib/pact_broker/client/merge_pacts.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'pact_broker/client/error'
+
+module PactBroker
+  module Client
+
+    class PactMergeError < PactBroker::Client::Error; end
+
+    module MergePacts
+      extend self
+
+      def call pact_hashes
+        pact_hashes.reduce{|p1, p2| merge(p1, p2) }
+      end
+
+      # Accepts two hashes representing pacts, outputs a merged hash
+      # Does not make any guarantees about order of interactions
+      def merge original, additional
+        new_pact = JSON.parse(original.to_json, symbolize_names: true)
+
+        additional[:interactions].each do |new_interaction|
+          # check to see if this interaction matches an existing interaction
+          overwrite_index = original[:interactions].find_index do |original_interaction|
+            same_description_and_state?(original_interaction, new_interaction)
+          end
+
+          # overwrite existing interaction if a match is found, otherwise appends the new interaction
+          if overwrite_index
+            if new_interaction == original[:interactions][overwrite_index]
+              new_pact[:interactions][overwrite_index] = new_interaction
+            else
+              raise PactMergeError, almost_duplicate_message(original[:interactions][overwrite_index], new_interaction)
+            end
+          else
+            new_pact[:interactions] << new_interaction
+          end
+        end
+
+        new_pact
+      end
+
+      private
+
+      def almost_duplicate_message(original, new_interaction)
+        "An interaction with same description (#{new_interaction[:description].inspect}) and provider state (#{new_interaction[:providerState].inspect}) but a different request or response has already been used. " +
+          "Please use a different description or provider state, or hard-code any random data.\n" +
+          original.to_json + "\n\n"
+          new_interaction.to_json
+      end
+
+      def same_description_and_state? original, additional
+        original[:description] == additional[:description] &&
+          original[:providerState] == additional[:providerState]
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pact_file.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'pact_broker/client/pact_hash'
+
+module PactBroker
+  module Client
+    class PactFile
+      def initialize path
+        @path = path
+      end
+
+      def path
+        @path
+      end
+
+      def pact_name
+        pact_hash.pact_name
+      end
+
+      def consumer_name
+        pact_hash.consumer_name
+      end
+
+      def provider_name
+        pact_hash.provider_name
+      end
+
+      def pact_hash
+        @pact_hash ||= PactHash[JSON.parse(read, symbolize_names: true)]
+      end
+
+      def read
+        @read ||= File.read(@path)
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pact_hash.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module PactBroker
+  module Client
+    class PactHash < ::Hash
+      def pact_name
+        "#{consumer_name}/#{provider_name} pact"
+      end
+
+      def consumer_name
+        self[:consumer][:name]
+      end
+
+      def provider_name
+        self[:provider][:name]
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pacts.rb

@@ -1,6 +1,5 @@
-require 'pact/consumer_contract'
 require_relative 'base_client'
-
+require 'pact_broker/client/pact_hash'
 
 module PactBroker
   module Client
@@ -8,9 +7,9 @@ module PactBroker
 
       def publish options
         consumer_version = options[:consumer_version]
-        pact_string = options[:pact_json]
-        consumer_contract = ::Pact::ConsumerContract.from_json pact_string
-        url = save_consumer_contract_url consumer_contract, consumer_version
+        pact_hash = options[:pact_hash]
+        pact_string = pact_hash.to_json
+        url = save_consumer_contract_url pact_hash, consumer_version
 
         if @client_options[:write] == :merge
           response = self.class.patch(url, body: pact_string, headers: default_patch_headers)
@@ -128,9 +127,9 @@ module PactBroker
         "/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)
+      def save_consumer_contract_url pact_hash, consumer_version
+        consumer_name = encode_param(pact_hash.consumer_name)
+        provider_name = encode_param(pact_hash.provider_name)
         version = encode_param(consumer_version)
         "/pacts/provider/#{provider_name}/consumer/#{consumer_name}/version/#{version}"
       end

data/lib/pact_broker/client/publish_pacts.rb

@@ -1,14 +1,21 @@
 require 'term/ansicolor'
 require 'pact_broker/client'
 require 'pact_broker/client/retry'
+require 'pact_broker/client/pact_file'
+require 'pact_broker/client/pact_hash'
+require 'pact_broker/client/merge_pacts'
 
 module PactBroker
   module Client
     class PublishPacts
 
-      def initialize pact_broker_base_url, pact_files, consumer_version, tags, pact_broker_client_options={}
+      def self.call(pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options={})
+        new(pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options).call
+      end
+
+      def initialize pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options={}
         @pact_broker_base_url = pact_broker_base_url
-        @pact_files = pact_files
+        @pact_file_paths = pact_file_paths
         @consumer_version = consumer_version
         @tags = tags
         @pact_broker_client_options = pact_broker_client_options
@@ -24,22 +31,33 @@ module PactBroker
 
       private
 
-      attr_reader :pact_broker_base_url, :pact_files, :consumer_version, :tags, :pact_broker_client_options
+      attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version, :tags, :pact_broker_client_options
 
       def pact_broker_client
         @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
       end
 
       def publish_pacts
-        pact_files.collect{ | pact_file | publish_pact pact_file }.all?
+        pact_files.group_by(&:pact_name).collect do | pact_name, pact_files |
+          $stdout.puts "Merging #{pact_files.collect(&:path).join(", ")}" if pact_files.size > 1
+          publish_pact(PactHash[merge_contents(pact_files)])
+        end.all?
       end
 
-      def publish_pact pact_file
+      def merge_contents(pact_files)
+        MergePacts.call(pact_files.collect(&:pact_hash))
+      end
+
+      def pact_files
+        @pact_files ||= pact_file_paths.collect{ |pact_file_path| PactFile.new(pact_file_path) }
+      end
+
+      def publish_pact pact
         begin
-          $stdout.puts ">> Publishing #{pact_file} to pact broker at #{pact_broker_base_url}"
-          publish_pact_contents File.read(pact_file)
+          $stdout.puts "Publishing #{pact.pact_name} to pact broker at #{pact_broker_base_url}"
+          publish_pact_contents pact
         rescue => e
-          $stderr.puts "Failed to publish pact: #{pact_file} due to error: #{e.to_s}\n#{e.backtrace.join("\n")}"
+          $stderr.puts "Failed to publish #{pact.pact_name} due to error: #{e.class} - #{e}"
           false
         end
       end
@@ -59,38 +77,32 @@ module PactBroker
           true
         end
       rescue => e
-        $stderr.puts "Failed to tag version #{consumer_version} of #{consumer_name} due to error: #{e.to_s}\n#{e.backtrace.join("\n")}"
+        $stderr.puts "Failed to tag version #{consumer_version} of #{consumer_name} due to error: #{e.class} - #{e}}"
         false
       end
 
-      def publish_pact_contents(pact_file_contents)
+      def publish_pact_contents(pact)
         Retry.until_true do
-          contract = contract_from_file(pact_file_contents)
           pacts = pact_broker_client.pacticipants.versions.pacts
-          if pacts.version_published?(consumer: contract.consumer.name, provider: contract.provider.name, consumer_version: consumer_version)
-            $stdout.puts ::Term::ANSIColor.yellow("The given version of pact is already published. Will Overwrite...")
+          if pacts.version_published?(consumer: pact.consumer_name, provider: pact.provider_name, consumer_version: consumer_version)
+            $stdout.puts ::Term::ANSIColor.yellow("The given version of pact is already published. Overwriting...")
           end
 
-          latest_pact_url = pacts.publish(pact_json: pact_file_contents, consumer_version: consumer_version)
+          latest_pact_url = pacts.publish(pact_hash: pact, 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}"
           true
         end
       end
 
       def consumer_name
-        contract_from_file(File.read(pact_files.first)).consumer.name
-      end
-
-      def contract_from_file pact_file_contents
-        ::Pact::ConsumerContract.from_json(pact_file_contents)
+        pact_files.first.consumer_name
       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)
-        raise "No pact files found" unless (pact_files && pact_files.any?)
+        raise PactBroker::Client::Error.new("Please specify the consumer_version") unless (consumer_version && consumer_version.to_s.strip.size > 0)
+        raise PactBroker::Client::Error.new("Please specify the pact_broker_base_url") unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)
+        raise PactBroker::Client::Error.new("No pact files found") unless (pact_file_paths && pact_file_paths.any?)
       end
-
     end
   end
 end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

data/pact-broker-client.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency 'pact'
   gem.add_runtime_dependency 'httparty'
   gem.add_runtime_dependency 'json'
   gem.add_runtime_dependency 'term-ansicolor'
@@ -32,4 +31,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'appraisal'
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'conventional-changelog'
+  gem.add_development_dependency 'pact', '~> 1.16'
 end

data/spec/lib/pact_broker/client/cli/custom_thor_spec.rb

@@ -0,0 +1,105 @@
+require 'pact_broker/client/cli/custom_thor'
+
+module PactBroker::Client::CLI
+
+  class Delegate
+    def self.call options; end
+  end
+
+  class TestThor < CustomThor
+    desc 'ARGUMENT', 'This is the description'
+    def test_default(argument)
+      Delegate.call(argument: argument)
+    end
+
+    desc '', ''
+    method_option :multi, type: :array
+    def test_multiple_options
+      Delegate.call(options)
+    end
+
+    default_command :test_default
+  end
+
+  describe CustomThor do
+    subject { TestThor.new }
+
+    it "invokes the default task when aguments are given without specifying a task" do
+      expect(Delegate).to receive(:call).with(argument: 'foo')
+      TestThor.start(%w{foo})
+    end
+
+    it "converts options that are specified multiple times into a single array" do
+      expect(Delegate).to receive(:call).with({'multi' => ['one', 'two']})
+      TestThor.start(%w{test_multiple_options --multi one --multi two})
+    end
+
+    describe ".prepend_default_task_name" do
+      let(:argv_with) { [TestThor.default_command, 'foo'] }
+
+      context "when the default task name is given" do
+        it "does not prepend the default task name" do
+          expect(TestThor.prepend_default_task_name(argv_with)).to eq(argv_with)
+        end
+      end
+
+      context "when the first argument is --help" do
+        let(:argv) { ['--help', 'foo'] }
+
+        it "does not prepend the default task name" do
+          expect(TestThor.prepend_default_task_name(argv)).to eq(argv)
+        end
+      end
+
+      context "when the default task name is not given" do
+        let(:argv) { ['foo'] }
+
+        it "prepends the default task name" do
+          expect(TestThor.prepend_default_task_name(argv)).to eq(argv_with)
+        end
+      end
+    end
+
+    describe ".turn_muliple_tag_options_into_array" do
+      it "turns '--tag foo --tag bar' into '--tag foo bar'" do
+        input = %w{--ignore this --tag foo --tag bar --wiffle --that}
+        output = %w{--ignore this --tag foo bar --wiffle --that }
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
+      it "turns '--tag foo bar --tag meep' into '--tag foo meep bar'" do
+        input = %w{--ignore this --tag foo bar --tag meep --wiffle --that}
+        output = %w{--ignore this --tag foo meep bar --wiffle --that}
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
+      it "turns '--tag foo --tag bar wiffle' into '--tag foo bar wiffle' which is silly" do
+        input = %w{--ignore this --tag foo --tag bar wiffle}
+        output = %w{--ignore this --tag foo bar wiffle}
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
+      it "maintains '--tag foo bar wiffle'" do
+        input = %w{--ignore this --tag foo bar wiffle --meep}
+        output = %w{--ignore this --tag foo bar wiffle --meep}
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
+      it "turns '-t foo -t bar' into '-t foo bar'" do
+        input = %w{--ignore this -t foo -t bar --meep --that 1 2 3}
+        output = %w{--ignore this -t foo bar --meep --that 1 2 3}
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
+      it "doesn't change anything when there are no duplicate options" do
+        input = %w{--ignore this --taggy foo --blah bar --wiffle --that}
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq input
+      end
+
+      it "return an empty array when given an empty array" do
+        input = []
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq input
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/cli/publish_spec.rb

@@ -0,0 +1,128 @@
+require 'pact_broker/client/cli/publish'
+
+module PactBroker::Client::CLI
+  describe Publish do
+    describe ".broker" do
+      before do
+        allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(true)
+        subject.options = minimum_valid_options
+      end
+
+      let(:file_list) { ["spec/support/cli_test_pacts/foo.json"] }
+      let(:minimum_valid_options) do
+        {
+          pact_dir: 'spec/pacts',
+          consumer_version: '1.2.3',
+          broker_base_url: 'http://pact-broker'
+        }
+      end
+
+      let(:invoke_broker) { subject.broker(*file_list) }
+
+      context "with minimum valid options" do
+        it "invokes the PublishPacts command" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            "http://pact-broker",
+            ["spec/support/cli_test_pacts/foo.json"],
+            "1.2.3",
+            [],
+            {}
+          )
+          invoke_broker
+        end
+      end
+
+      context "with a file pattern specified" do
+        let(:file_list) { ["spec/support/cli_test_pacts/*.json"] }
+
+        it "invokes the PublishPacts command with the expanded list of files" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
+            anything,
+            anything,
+            anything
+          )
+          invoke_broker
+        end
+      end
+
+      context "with a pact directory specified" do
+        let(:file_list) { ["spec/support/cli_test_pacts"] }
+
+        it "invokes the PublishPacts command with the list of files in the directory" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
+            anything,
+            anything,
+            anything
+          )
+          invoke_broker
+        end
+      end
+
+      context "with a tag" do
+        before do
+          subject.options = minimum_valid_options.merge(tag: ['foo'])
+        end
+
+        it "passes in the tag" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            anything,
+            anything,
+            ['foo'],
+            anything
+          )
+          invoke_broker
+        end
+      end
+
+      context "with basic auth options specified" do
+        before do
+          subject.options = minimum_valid_options.merge(username: 'foo', password: 'bar')
+        end
+
+        it "passes in the basic auth options" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            anything,
+            anything,
+            anything,
+            {username: 'foo', password: 'bar'}
+          )
+          invoke_broker
+        end
+      end
+
+      context "when no pact files are specified" do
+        let(:file_list) { [] }
+
+        it "raises an error" do
+          expect { invoke_broker }.to raise_error ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
+        end
+      end
+
+      context "when an error is raised publishing" do
+        before do
+          allow(PactBroker::Client::PublishPacts).to receive(:call).and_raise(PactBroker::Client::Error.new('foo'))
+        end
+
+        it "raises a PactPublicationError" do
+          expect { invoke_broker }.to raise_error PactPublicationError, /foo/
+        end
+      end
+
+      context "when the publish command is not successful" do
+        before do
+          allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(false)
+        end
+
+        it "raises a PactPublicationError" do
+          expect { invoke_broker }.to raise_error PactPublicationError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'pact_broker/client/merge_pacts'
+
+module PactBroker
+  module Client
+    describe MergePacts do
+      describe ".call" do
+        let(:pact_hash_1) do
+          {
+            other: 'info',
+            interactions: [
+              {providerState: 1, description: 1, foo: 'bar' }
+            ]
+          }
+        end
+
+        let(:pact_hash_2) do
+          {
+            interactions: [
+              {providerState: 2, description: 2, foo: 'wiffle' }
+            ]
+          }
+        end
+
+        let(:pact_hash_3) do
+          {
+            interactions: [
+              {providerState: 3, description: 3, foo: 'meep' },
+              {providerState: 1, description: 1, foo: 'bar' }
+            ]
+          }
+        end
+
+        let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
+
+        let(:expected_merge) do
+          {
+            other: 'info',
+            interactions: [
+              {providerState: 1, description: 1, foo: 'bar' },
+              {providerState: 2, description: 2, foo: 'wiffle' },
+              {providerState: 3, description: 3, foo: 'meep' }
+            ]
+          }
+        end
+
+        subject { MergePacts.call(pact_hashes) }
+
+        it "merges the interactions by consumer/provider" do
+          expect(subject).to eq expected_merge
+        end
+
+        context "when an interaction is found with the same state and description but has a difference elsewhere" do
+          let(:pact_hash_3) do
+            {
+              interactions: [
+                {providerState: 3, description: 3, foo: 'meep' },
+                {providerState: 1, description: 1, foo: 'different' }
+              ]
+            }
+          end
+
+          it "raises an error" do
+            expect { subject }.to raise_error PactMergeError
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,24 @@ module PactBroker
   module Client
     describe PublishPacts do
 
+      # The amount of stubbing that we have to do here indicates this class is doing
+      # TOO MUCH and needs to be split up!
       before do
         FakeFS.activate!
         allow(pacts_client).to receive(:publish).and_return(latest_pact_url)
-        allow(PactBroker::Client::PactBrokerClient).to receive(:new).with(base_url: pact_broker_base_url, client_options: pact_broker_client_options).and_return(pact_broker_client)
+        allow(PactBroker::Client::PactBrokerClient).to receive(:new)
+          .with(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
+          .and_return(pact_broker_client)
+        allow(pact_broker_client).to receive_message_chain(:pacticipants, :versions).and_return(pact_versions_client)
+        allow(pact_broker_client).to receive_message_chain(:pacticipants, :versions, :pacts).and_return(pacts_client)
+        allow(pacts_client).to receive(:version_published?).and_return(false)
         allow($stdout).to receive(:puts)
+        allow(Retry).to receive(:sleep)
+        allow(MergePacts).to receive(:call) { | pact_hashes | pact_hashes[0] }
+        FileUtils.mkdir_p "spec/pacts"
+        File.open("spec/pacts/consumer-provider.json", "w") { |file| file << pact_hash.to_json }
+        File.open("spec/pacts/consumer-provider-2.json", "w") { |file| file << pact_hash.to_json }
+        File.open("spec/pacts/foo-bar.json", "w") { |file| file << pact_hash_2.to_json }
       end
 
       after do
@@ -20,10 +33,11 @@ module PactBroker
 
       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(:pact_file_paths) { ['spec/pacts/consumer-provider.json']}
       let(:consumer_version) { "1.2.3" }
       let(:tags) { nil }
       let(:pact_hash) { {consumer: {name: 'Consumer'}, provider: {name: 'Provider'}, interactions: [] } }
+      let(:pact_hash_2) { {consumer: {name: 'Foo'}, provider: {name: 'Bar'}, interactions: [] } }
       let(:pacts_client) { instance_double("PactBroker::ClientSupport::Pacts")}
       let(:pact_versions_client) { instance_double("PactBroker::Client::Versions", tag: false) }
       let(:pact_broker_base_url) { 'http://some-host'}
@@ -36,20 +50,12 @@ module PactBroker
         }
       end
 
-      subject { PublishPacts.new(pact_broker_base_url, pact_files, consumer_version, tags, pact_broker_client_options) }
-
-      before do
-        FileUtils.mkdir_p "spec/pacts"
-        File.open("spec/pacts/consumer-provider.json", "w") { |file| file << pact_hash.to_json }
-        allow(pact_broker_client).to receive_message_chain(:pacticipants, :versions).and_return(pact_versions_client)
-        allow(pact_broker_client).to receive_message_chain(:pacticipants, :versions, :pacts).and_return(pacts_client)
-        allow(pacts_client).to receive(:version_published?).and_return(false)
-      end
+      subject { PublishPacts.new(pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options) }
 
       describe "call" do
 
         it "uses the pact_broker client to publish the given pact" do
-          expect(pacts_client).to receive(:publish).with(pact_json: pact_hash.to_json, consumer_version: consumer_version)
+          expect(pacts_client).to receive(:publish).with(pact_hash: pact_hash, consumer_version: consumer_version)
           subject.call
         end
 
@@ -65,20 +71,34 @@ module PactBroker
           end
         end
 
+        context "when publishing multiple files with the same consumer/provider" do
+          let(:pact_file_paths) { ['spec/pacts/consumer-provider.json','spec/pacts/consumer-provider-2.json']}
+          it "merges the files" do
+            expect(MergePacts).to receive(:call).with([pact_hash, pact_hash])
+            subject.call
+          end
+        end
+
         context "when publishing one or more pacts fails" do
-          let(:pact_files) { ['spec/pacts/doesnotexist.json','spec/pacts/consumer-provider.json']}
+          let(:pact_file_paths) { ['spec/pacts/consumer-provider.json','spec/pacts/foo-bar.json']}
 
           before do
+            allow(pacts_client).to receive(:publish).with(
+              pact_hash: pact_hash,
+              consumer_version: consumer_version
+            ).and_raise("an error")
+
             allow($stderr).to receive(:puts)
           end
 
           it "logs an message to stderr" do
-            expect($stderr).to receive(:puts).with(/Failed to publish pact/)
+            expect($stderr).to receive(:puts).with(/Failed to publish Consumer\/Provider pact/)
             subject.call
           end
 
           it "continues publishing the rest" do
-            expect(pacts_client).to receive(:publish).with(pact_json: pact_hash.to_json, consumer_version: consumer_version)
+            expect(pacts_client).to receive(:publish).with(
+              pact_hash: pact_hash_2, consumer_version: consumer_version)
             subject.call
           end
 
@@ -88,7 +108,7 @@ module PactBroker
         end
 
         context "when no pact files are specified" do
-          let(:pact_files) { [] }
+          let(:pact_file_paths) { [] }
           it "raises a validation error" do
             expect { subject.call }.to raise_error(/No pact files found/)
           end
@@ -112,7 +132,8 @@ module PactBroker
           let(:tags) { ["dev"] }
 
           it "tags the consumer version" do
-            expect(pact_versions_client).to receive(:tag).with({pacticipant: "Consumer", version: consumer_version, tag: "dev"})
+            expect(pact_versions_client).to receive(:tag).with({pacticipant: "Consumer",
+              version: consumer_version, tag: "dev"})
             subject.call
           end
 

data/spec/service_providers/pact_broker_client_publish_spec.rb

@@ -5,7 +5,7 @@ module PactBroker::Client
 
     describe "publishing a pact" do
 
-      let(:options) { { pact_json: pact_json, consumer_version: consumer_version }}
+      let(:options) { { pact_hash: pact_hash, consumer_version: consumer_version }}
       let(:location) { 'http://example.org/pacts/provider/Pricing%20Service/consumer/Condor/latest' }
       context "when the provider already exists in the pact-broker" do
 

data/spec/support/shared_context.rb

@@ -1,6 +1,7 @@
+require 'pact_broker/client/pact_hash'
 shared_context "pact broker" do
 
-  let(:pact_hash) { {consumer: {name: 'Condor'}, provider: {name: 'Pricing Service'}, interactions: []} }
+  let(:pact_hash) { PactBroker::Client::PactHash[consumer: {name: 'Condor'}, provider: {name: 'Pricing Service'}, interactions: []] }
   let(:consumer_contract) { Pact::ConsumerContract.from_hash pact_hash }
   let(:pact_json) { pact_hash.to_json }
   let(:pact_broker_client) { PactBroker::Client::PactBrokerClient.new(client_config) }

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Bethany Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: pact
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -150,10 +136,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pact
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 description: Publishes pacts to, and retrieves pacts from, the pact broker server.
 email:
 - bskurrie@dius.com.au
-executables: []
+executables:
+- pact-publish
 extensions: []
 extra_rdoc_files: []
 files:
@@ -166,6 +167,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- bin/pact-publish
 - ci.sh
 - doc/markdown/Pact Broker Client - Pact Broker.md
 - doc/markdown/README.md
@@ -175,7 +177,13 @@ files:
 - gemfiles/ruby_under_22.gemfile.lock
 - lib/pact_broker/client.rb
 - lib/pact_broker/client/base_client.rb
+- lib/pact_broker/client/cli/custom_thor.rb
+- lib/pact_broker/client/cli/publish.rb
+- lib/pact_broker/client/error.rb
+- lib/pact_broker/client/merge_pacts.rb
 - lib/pact_broker/client/pact_broker_client.rb
+- lib/pact_broker/client/pact_file.rb
+- lib/pact_broker/client/pact_hash.rb
 - lib/pact_broker/client/pacticipants.rb
 - lib/pact_broker/client/pacts.rb
 - lib/pact_broker/client/publish_pacts.rb
@@ -187,6 +195,9 @@ files:
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
 - spec/lib/pact_broker/client/base_client_spec.rb
+- spec/lib/pact_broker/client/cli/custom_thor_spec.rb
+- spec/lib/pact_broker/client/cli/publish_spec.rb
+- spec/lib/pact_broker/client/merge_pacts_spec.rb
 - spec/lib/pact_broker/client/pact_broker_client_spec.rb
 - spec/lib/pact_broker/client/pacticipants_spec.rb
 - spec/lib/pact_broker/client/publish_pacts_spec.rb
@@ -202,6 +213,8 @@ files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/spec_helper.rb
+- spec/support/cli_test_pacts/bar.json
+- spec/support/cli_test_pacts/foo.json
 - spec/support/latest_pacts_for_provider.json
 - spec/support/pacticipant_get.json
 - spec/support/pacticipants_list.json
@@ -234,6 +247,9 @@ specification_version: 4
 summary: See description
 test_files:
 - spec/lib/pact_broker/client/base_client_spec.rb
+- spec/lib/pact_broker/client/cli/custom_thor_spec.rb
+- spec/lib/pact_broker/client/cli/publish_spec.rb
+- spec/lib/pact_broker/client/merge_pacts_spec.rb
 - spec/lib/pact_broker/client/pact_broker_client_spec.rb
 - spec/lib/pact_broker/client/pacticipants_spec.rb
 - spec/lib/pact_broker/client/publish_pacts_spec.rb
@@ -249,6 +265,8 @@ test_files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/spec_helper.rb
+- spec/support/cli_test_pacts/bar.json
+- spec/support/cli_test_pacts/foo.json
 - spec/support/latest_pacts_for_provider.json
 - spec/support/pacticipant_get.json
 - spec/support/pacticipants_list.json