pact_broker-client 1.39.0 → 1.44.0

data/lib/pact_broker/client/matrix/text_formatter.rb

@@ -1,6 +1,7 @@
 require 'table_print'
 require 'dig_rb'
 require 'pact_broker/client/hash_refinements'
+require 'pact_broker/client/matrix/abbreviate_version_number'
 
 module PactBroker
   module Client
@@ -8,38 +9,44 @@ module PactBroker
       class TextFormatter
         using PactBroker::Client::HashRefinements
 
-        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref)
-
-        OPTIONS = [
-          { consumer: {} },
-          { consumer_version: {display_name: 'C.VERSION'} },
-          { provider: {} },
-          { provider_version: {display_name: 'P.VERSION'} },
-          { success: {display_name: 'SUCCESS?'} },
-          { ref: { display_name: 'RESULT#' }}
-        ]
+        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref, :ignored)
 
         def self.call(matrix)
           matrix_rows = matrix[:matrix]
           return "" if matrix_rows.size == 0
+          data = prepare_data(matrix_rows)
+          printer = TablePrint::Printer.new(data, tp_options(data))
+          printer.table_print + verification_result_urls_text(matrix)
+        end
+
+        def self.prepare_data(matrix_rows)
           verification_result_number = 0
-          data = matrix_rows.each_with_index.collect do | line |
+          matrix_rows.each_with_index.collect do | line |
             has_verification_result_url = lookup(line, nil, :verificationResult, :_links, :self, :href)
             if has_verification_result_url
               verification_result_number += 1
             end
             Line.new(
               lookup(line, "???", :consumer, :name),
-              lookup(line, "???", :consumer, :version, :number),
+              AbbreviateVersionNumber.call(lookup(line, "???", :consumer, :version, :number)),
               lookup(line, "???", :provider, :name) ,
-              lookup(line, "???", :provider, :version, :number),
-              (lookup(line, "???", :verificationResult, :success)).to_s,
-              has_verification_result_url ? verification_result_number : ""
+              AbbreviateVersionNumber.call(lookup(line, "???", :provider, :version, :number)),
+              (lookup(line, "???", :verificationResult, :success)).to_s + ( line[:ignored] ? " [ignored]" : ""),
+              has_verification_result_url ? verification_result_number : "",
+              lookup(line, nil, :ignored)
             )
           end
+        end
 
-          printer = TablePrint::Printer.new(data, OPTIONS)
-          printer.table_print + verification_result_urls_text(matrix)
+        def self.tp_options(data)
+          [
+            { consumer: { width: max_width(data, :consumer, 'CONSUMER') } },
+            { consumer_version: { display_name: 'C.VERSION', width: max_width(data, :consumer_version, 'C.VERSION') } },
+            { provider: { width: max_width(data, :provider, 'PROVIDER') } },
+            { provider_version: { display_name: 'P.VERSION', width: max_width(data, :provider_version, 'P.VERSION') } },
+            { success: { display_name: 'SUCCESS?' } },
+            { ref: { display_name: 'RESULT#' } }
+          ]
         end
 
         def self.lookup line, default, *keys
@@ -72,6 +79,10 @@ module PactBroker
             text
           end
         end
+
+        def self.max_width(data, column, title)
+          (data.collect{ |row| row.send(column) } + [title]).compact.collect(&:size).max
+        end
       end
     end
   end

data/lib/pact_broker/client/pacticipants.rb

@@ -1,3 +1,9 @@
+# New code
+require 'pact_broker/client/pacticipants/create'
+require 'pact_broker/client/pacticipants/describe'
+require 'pact_broker/client/pacticipants/list'
+
+# Old code
 require 'pact_broker/client/base_client'
 
 module PactBroker

data/lib/pact_broker/client/pacticipants/create.rb

@@ -1,55 +1,45 @@
-require 'pact_broker/client/hal'
-require 'json'
-require 'pact_broker/client/command_result'
-require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/base_command'
 
 module PactBroker
   module Client
     module Pacticipants2
-      class Create
+      class Create < PactBroker::Client::BaseCommand
 
-        include HalClientMethods
+        private
 
-        def self.call(params, pact_broker_base_url, pact_broker_client_options)
-          new(params, pact_broker_base_url, pact_broker_client_options).call
-        end
+        attr_reader :action, :response_entity
 
-        def initialize(params, pact_broker_base_url, pact_broker_client_options)
-          @params = params
-          @index_entry_point = create_index_entry_point(pact_broker_base_url, pact_broker_client_options)
-          @verbose = pact_broker_client_options[:verbose]
-        end
+        def do_call
+          pacticipant_entity = index_resource._link('pb:pacticipant').expand('pacticipant' => params[:name]).get
 
-        def call
-          pacticipant_entity = index_entity._link('pb:pacticipant').expand('pacticipant' => params[:name]).get
-          message = nil
           response_entity = if pacticipant_entity.does_not_exist?
-            message = "Pacticipant \"#{params[:name]}\" created"
-            index_entity._link!('pb:pacticipants').post(pacticipant_resource_params)
+            @action = "created"
+            index_resource._link!('pb:pacticipants').post!(pacticipant_resource_params)
+          elsif pacticipant_entity.success?
+            @action = "updated"
+            pacticipant_entity._link!('self').patch!(pacticipant_resource_params, { "Content-Type" => "application/json" })
           else
-            message = "Pacticipant \"#{params[:name]}\" updated"
-            pacticipant_entity._link!('self').patch(pacticipant_resource_params)
+            pacticipant_entity.assert_success!
           end
 
           response_entity.assert_success!
-          PactBroker::Client::CommandResult.new(true, message)
-        rescue StandardError => e
-          $stderr.puts("#{e.class} - #{e}\n#{e.backtrace.join("\n")}") if verbose
-          PactBroker::Client::CommandResult.new(false, "#{e.class} - #{e}")
+          PactBroker::Client::CommandResult.new(true, result_message)
         end
 
-        private
-
-        attr_reader :index_entry_point, :params, :verbose
-
-        def index_entity
-          @index_entity ||= index_entry_point.get!
+        def result_message
+          if json_output?
+            response_entity.response.raw_body
+          else
+            green(message = "Pacticipant \"#{params[:name]}\" #{action}")
+          end
         end
 
         def pacticipant_resource_params
-          p = { name: params[:name] }
-          p[:repositoryUrl] = params[:repository_url] if params[:repository_url]
-          p
+          {
+            name: params[:name],
+            repositoryUrl: params[:repository_url],
+            displayName: params[:display_name]
+          }.compact
         end
       end
     end

data/lib/pact_broker/client/pacticipants/describe.rb

@@ -0,0 +1,33 @@
+require 'pact_broker/client/base_command'
+require 'pact_broker/client/describe_text_formatter'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      class Describe < PactBroker::Client::BaseCommand
+
+        private
+
+        def do_call
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def pacticipant_entity
+          @pacticipant_entity ||= index_resource._link('pb:pacticipant').expand('pacticipant' => params[:name]).get!
+        end
+
+        def result_message
+          if json_output?
+            pacticipant_entity.response.raw_body
+          else
+            properties = pacticipant_entity.response.body.except("_links", "_embedded")
+            if pacticipant_entity._embedded && pacticipant_entity._embedded["labels"] && pacticipant_entity._embedded["labels"].any?
+              properties["labels"] = pacticipant_entity._embedded["labels"]
+            end
+            PactBroker::Client::DescribeTextFormatter.call(properties)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pacticipants/list.rb

@@ -0,0 +1,34 @@
+require 'pact_broker/client/base_command'
+require 'pact_broker/client/pacticipants/text_formatter'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      class List < PactBroker::Client::BaseCommand
+        private
+
+        attr_reader :environments_resource
+
+        def do_call
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def environments_resource
+          @environments_resource = environments_link.get!
+        end
+
+        def environments_link
+          index_resource._link!('pb:pacticipants')
+        end
+
+        def result_message
+          if json_output?
+            environments_resource.response.raw_body
+          else
+            TextFormatter.call(environments_resource._embedded["pacticipants"])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pacticipants/text_formatter.rb

@@ -0,0 +1,41 @@
+require 'table_print'
+require 'ostruct'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      class TextFormatter
+        def self.call(pacticipants)
+          return "" if pacticipants.size == 0
+
+          data = pacticipants.collect do | pacticipant |
+            # Might add a UUID in at some stage. Backwards compatible supporting code.
+            OpenStruct.new({ uuid: "" }.merge(pacticipant).merge(url: pacticipant["_links"]["self"]["href"]))
+          end.sort_by{ | pacticipant | pacticipant.name.downcase }
+
+          TablePrint::Printer.new(data, tp_options(data)).table_print
+        end
+
+        def self.tp_options(data)
+          uuid_width = max_width(data, :uuid, "")
+          name_width = max_width(data, :name, "NAME")
+          display_name_width = max_width(data, :displayName, "DISPLAY NAME")
+
+          tp_options = [
+            { name: { width: name_width} },
+            { displayName: { display_name: "Display name", width: display_name_width } },
+          ]
+
+          if uuid_width > 0
+            tp_options.unshift({ uuid: { width: uuid_width } })
+          end
+          tp_options
+        end
+
+        def self.max_width(data, column, title)
+          (data.collect{ |row| row.send(column) } + [title]).compact.collect(&:size).max
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/publish_pacts.rb

@@ -2,6 +2,7 @@ require 'term/ansicolor'
 require 'pact_broker/client/hal_client_methods'
 require 'base64'
 require 'pact_broker/client/publish_pacts_the_old_way'
+require 'pact_broker/client/colorize_notices'
 
 module PactBroker
   module Client
@@ -27,7 +28,7 @@ module PactBroker
 
       def call
         validate
-        if index_resource.can?("pb:publish-contracts")
+        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("publish_contracts") && index_resource.can?("pb:publish-contracts")
           publish_pacts
           PactBroker::Client::CommandResult.new(success?, message)
         else
@@ -71,7 +72,9 @@ module PactBroker
       def text_message
         response_entities.flat_map do | response_entity |
           if response_entity.success?
-            if response_entity.logs
+            if response_entity.notices
+              PactBroker::Client::ColorizeNotices.call(response_entity.notices.collect{ |n| OpenStruct.new(n) } )
+            elsif response_entity.logs
               response_entity.logs.collect do | log |
                 colorized_message(log)
               end
@@ -112,7 +115,8 @@ module PactBroker
             specification: "pact",
             contentType: "application/json",
             content: Base64.strict_encode64(pact_hash.to_json),
-            writeMode: write_mode
+            writeMode: write_mode,
+            onConflict: write_mode
           }
         end
       end

data/lib/pact_broker/client/string_refinements.rb

@@ -0,0 +1,56 @@
+module PactBroker
+  module Client
+    module StringRefinements
+      refine NilClass do
+        def blank?
+          true
+        end
+      end
+
+      refine String do
+        def not_blank?
+          !blank?
+        end
+
+        def blank?
+          self.strip.size == 0
+        end
+
+        # ripped from rubyworks/facets, thank you
+        def snakecase
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+          .tr('-', '_')
+          .gsub(/\s/, '_')
+          .gsub(/__+/, '_')
+          .downcase
+        end
+
+        # ripped from rubyworks/facets, thank you
+        def camelcase(*separators)
+          case separators.first
+          when Symbol, TrueClass, FalseClass, NilClass
+            first_letter = separators.shift
+          end
+
+          separators = ['_', '\s'] if separators.empty?
+
+          str = self.dup
+
+          separators.each do |s|
+            str = str.gsub(/(?:#{s}+)([a-z])/){ $1.upcase }
+          end
+
+          case first_letter
+          when :upper, true
+            str = str.gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+          when :lower, false
+            str = str.gsub(/(\A|\s)([A-Z])/){ $1 + $2.downcase }
+          end
+
+          str
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.39.0'
+    VERSION = '1.44.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -1,4 +1,7 @@
-require_relative 'base_client'
+require 'pact_broker/client/base_client'
+require 'pact_broker/client/versions/describe'
+
+# Old code
 require 'pact_broker/client/pacts'
 
 module PactBroker

data/lib/pact_broker/client/versions/describe.rb

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/pact_broker_client'
 require 'pact_broker/client/versions/formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Describe
 
         class Result

data/lib/pact_broker/client/versions/formatter.rb

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/versions/json_formatter'
 require 'pact_broker/client/versions/text_formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Formatter
         def self.call(matrix_lines, format)
           formatter = case format

data/lib/pact_broker/client/versions/json_formatter.rb

@@ -1,11 +1,13 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class JsonFormatter
-        def self.call(matrix)
-          JSON.pretty_generate(matrix)
+        def self.call(version)
+          JSON.pretty_generate(version)
         end
       end
     end

data/lib/pact_broker/client/versions/text_formatter.rb

@@ -1,8 +1,10 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class TextFormatter
 
         Line = Struct.new(:number, :tags)