pact_broker-client 1.41.0 → 1.46.0

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

@@ -0,0 +1,30 @@
+require 'table_print'
+require 'ostruct'
+
+module PactBroker
+  module Client
+    module Environments
+      class TextFormatter
+
+        def self.call(environments)
+          return "" if environments.size == 0
+
+          data = environments.collect do | environment |
+            OpenStruct.new(environment)
+          end.sort_by{ | environment | environment.name.downcase }
+
+          uuid_width = data.collect(&:uuid).collect(&:size).max
+
+          tp_options = [
+            { uuid: { width: uuid_width } },
+            { name: {} },
+            { displayName: { display_name: "Display name" } },
+            { production: {} }
+          ]
+
+          TablePrint::Printer.new(data, tp_options).table_print
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/environments/update_environment.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/environments/environment_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class UpdateEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+
+        private
+
+        attr_reader :updated_environment_resource
+
+        def do_call
+          @updated_environment_resource = existing_environment_link.put!(request_body)
+          PactBroker::Client::CommandResult.new(updated_environment_resource.success?, result_message)
+        end
+
+        def request_body
+          @request_body ||= existing_environment_body.merge(new_environment_body)
+        end
+
+        def result_message
+          if json_output?
+            updated_environment_resource.response.raw_body
+          else
+            ::Term::ANSIColor.green("Updated #{request_body["name"]} environment in #{pact_broker_name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/generate_display_name.rb

@@ -0,0 +1,27 @@
+require 'pact_broker/client/string_refinements'
+
+module PactBroker
+  module Client
+    module GenerateDisplayName
+      using PactBroker::Client::StringRefinements
+
+      def self.call(name)
+        return nil if name.nil?
+        name
+          .to_s
+          .gsub(/([A-Z])([A-Z])([a-z])/,'\1 \2\3')
+          .gsub(/([a-z\d])([A-Z])(\S)/,'\1 \2\3')
+          .gsub(/(\S)([\-_\s\.])(\S)/, '\1 \3')
+          .gsub(/\s+/, " ")
+          .strip
+          .split(" ")
+          .collect{ |word| word.camelcase(true) }
+          .join(" ")
+      end
+
+      def generate_display_name(name)
+        GenerateDisplayName.call(name)
+      end
+    end
+  end
+end

data/lib/pact_broker/client/hal/entity.rb

@@ -8,7 +8,15 @@ module PactBroker
   module Client
     module Hal
       class RelationNotFoundError < ::PactBroker::Client::Error; end
-      class ErrorResponseReturned < ::PactBroker::Client::Error; end
+      class EmbeddedEntityNotFoundError < ::PactBroker::Client::Error; end
+      class ErrorResponseReturned < ::PactBroker::Client::Error
+        attr_reader :entity
+
+        def initialize(message, entity)
+          super(message)
+          @entity = entity
+        end
+      end
 
       class Entity
         def initialize(href, data, http_client, response = nil)
@@ -92,7 +100,17 @@ module PactBroker
 
         def embedded_entity
           embedded_ent = yield @data["_embedded"]
-          Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+          if embedded_ent
+            Entity.new(self_href(embedded_ent), embedded_ent, @client, response)
+          end
+        end
+
+        def embedded_entities!(key)
+          embedded_ents = (@data["_embedded"] && @data["_embedded"][key])
+          raise EmbeddedEntityNotFoundError.new("Could not find embedded entity with key '#{key}' in resource at #{@href}") unless embedded_ents
+          embedded_ents.collect do | embedded_ent |
+            Entity.new(self_href(embedded_ent), embedded_ent, @client, response)
+          end
         end
 
         def embedded_entities(key = nil)
@@ -102,7 +120,7 @@ module PactBroker
             yield @data["_embedded"]
           end
           embedded_ents.collect do | embedded_ent |
-            Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+            Entity.new(self_href(embedded_ent), embedded_ent, @client, response)
           end
         end
 
@@ -139,6 +157,10 @@ module PactBroker
         def assert_success!(_ignored = nil)
           self
         end
+
+        def self_href(entity_hash)
+          entity_hash["_links"] && entity_hash["_links"]["self"] && entity_hash["_links"]["self"]["href"]
+        end
       end
 
       class ErrorEntity < Entity
@@ -158,14 +180,17 @@ module PactBroker
           false
         end
 
-        def assert_success!(messages = {})
-          default_message = "Error retrieving #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
+        def error_message(messages = {})
+          default_message = "Error making request to #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
           message = if response && messages[response.status]
             (messages[response.status] || "") + " (#{default_message})"
           else
             default_message
           end
-          raise ErrorResponseReturned.new(message)
+        end
+
+        def assert_success!(messages = {})
+          raise ErrorResponseReturned.new(error_message(messages), self)
         end
       end
     end

data/lib/pact_broker/client/hal/http_client.rb

@@ -18,7 +18,7 @@ module PactBroker
         end
 
         def get href, params = {}, headers = {}
-          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value)}" }.join("&")
+          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}" }.join("&")
           uri = URI(href)
           uri.query = query
           perform_request(create_request(uri, 'Get', nil, headers), uri)
@@ -39,9 +39,15 @@ module PactBroker
           perform_request(create_request(uri, 'Patch', body, headers), uri)
         end
 
+        def delete href, body = nil, headers = {}
+          uri = URI(href)
+          perform_request(create_request(uri, 'Delete', body, headers), uri)
+        end
+
         def create_request uri, http_method, body = nil, headers = {}
           request = Net::HTTP.const_get(http_method).new(uri.request_uri)
-          request['Content-Type'] = "application/json" if ['Post', 'Put', 'Patch'].include?(http_method)
+          request['Content-Type'] ||= "application/json" if ['Post', 'Put'].include?(http_method)
+          request['Content-Type'] ||= "application/merge-patch+json" if ['Patch'].include?(http_method)
           request['Accept'] = "application/hal+json"
           headers.each do | key, value |
             request[key] = value

data/lib/pact_broker/client/hal/link.rb

@@ -69,6 +69,14 @@ module PactBroker
           patch(*args).assert_success!
         end
 
+        def delete(payload = nil, headers = {})
+          wrap_response(href, @http_client.delete(href, payload ? JSON.dump(payload) : nil, headers))
+        end
+
+        def delete!(*args)
+          delete(*args).assert_success!
+        end
+
         def expand(params)
           expanded_url = expand_url(params, href)
           new_attrs = @attrs.merge('href' => expanded_url)

data/lib/pact_broker/client/hal_client_methods.rb

@@ -17,9 +17,7 @@ module PactBroker
       end
 
       def index_resource
-        @index_resource ||= Retry.while_error do
-          index_entry_point.get!
-        end
+        @index_resource ||= index_entry_point.get!
       end
 
       def is_pactflow?

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

@@ -11,21 +11,17 @@ module PactBroker
 
         Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref, :ignored)
 
-        TP_OPTIONS = [
-          { consumer: {} },
-          { consumer_version: {display_name: 'C.VERSION'} },
-          { provider: {} },
-          { provider_version: {display_name: 'P.VERSION'} },
-          { success: {display_name: 'SUCCESS?'} },
-          { ref: { display_name: 'RESULT#' } }
-        ]
-
         def self.call(matrix)
-          tp_options = TP_OPTIONS.dup
           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
@@ -40,9 +36,17 @@ module PactBroker
               lookup(line, nil, :ignored)
             )
           end
+        end
 
-          printer = TablePrint::Printer.new(data, tp_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
@@ -75,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} in #{pact_broker_name}")
+          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