pact_broker-client 1.38.2 → 1.42.0

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

@@ -0,0 +1,27 @@
+require 'pact_broker/client/environments/environment_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class DeleteEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+        private
+
+        attr_reader :deletion_request_resource
+
+        def do_call
+          existing_environment_resource!
+          @deletion_request_resource = existing_environment_link.delete!
+          PactBroker::Client::CommandResult.new(deletion_request_resource.success?, result_message)
+        end
+
+        def result_message
+          if json_output?
+            deletion_request_resource.response.raw_body
+          else
+            ::Term::ANSIColor.green("Deleted environment #{existing_environment_resource.name} from #{pact_broker_name}")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'pact_broker/client/environments/environment_command'
+require 'pact_broker/client/generate_display_name'
+require 'yaml'
+
+module PactBroker
+  module Client
+    module Environments
+      class DescribeEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+        include PactBroker::Client::GenerateDisplayName
+        private
+
+        def do_call
+          existing_environment_resource!
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def result_message
+          if json_output?
+            existing_environment_resource.response.raw_body
+          else
+            YAML.dump(displayify_keys(existing_environment_resource.response.body.except("_links"))).gsub("---\n", "")
+          end
+        end
+
+        def displayify_keys(thing)
+          case thing
+          when Hash then thing.each_with_object({}) { | (key, value), new_hash | new_hash[generate_display_name(key)] = displayify_keys(value) }
+          when Array then thing.collect{ | value | displayify_keys(value) }
+          else
+            thing
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class EnvironmentCommand < PactBroker::Client::BaseCommand
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support environments. Please upgrade to version 2.80.0 or later."
+
+        private
+
+        def new_environment_body
+          {
+            "name" => params[:name],
+            "displayName" => params[:display_name],
+            "production" => params[:production],
+            "contacts" => contacts
+          }.compact
+        end
+
+        def environments_link
+          index_resource._link!("pb:environments")
+        end
+
+        def existing_environment_link
+          index_resource
+            ._link!("pb:environment")
+            .expand(uuid: params[:uuid])
+        end
+
+        def existing_environment_resource
+          @existing_environment_resource ||= existing_environment_link.get
+        end
+
+        def existing_environment_resource!
+          existing_environment_resource.assert_success!
+        end
+
+        def existing_environment_body
+          @existing_environment_params ||= existing_environment_resource!
+            .response
+            .body
+            .except("uuid", "_links", "createdAt", "updatedAt")
+        end
+
+        def contacts
+          if params[:contact_name] || params[:contact_email_address]
+            contact = {}
+            contact["name"] = params[:contact_name] || "unknown"
+            if params[:contact_email_address]
+              contact["details"] = { "emailAddress" => params[:contact_email_address] }
+            end
+            [contact]
+          else
+            nil
+          end
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:environments")
+            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'pact_broker/client/environments/environment_command'
+require 'pact_broker/client/environments/text_formatter'
+
+module PactBroker
+  module Client
+    module Environments
+      class ListEnvironments < PactBroker::Client::Environments::EnvironmentCommand
+        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 result_message
+          if json_output?
+            environments_resource.response.raw_body
+          else
+            PactBroker::Client::Environments::TextFormatter.call(environments_resource._embedded["environments"])
+          end
+        end
+      end
+    end
+  end
+end

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,14 @@ module PactBroker
   module Client
     module Hal
       class RelationNotFoundError < ::PactBroker::Client::Error; end
-      class ErrorResponseReturned < ::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)
@@ -23,18 +30,34 @@ module PactBroker
           _link(key).get(*args)
         end
 
+        def get!(key, *args)
+          get(key, *args).assert_success!
+        end
+
         def post(key, *args)
           _link(key).post(*args)
         end
 
+        def post!(key, *args)
+          post(key, *args).assert_success!
+        end
+
         def put(key, *args)
           _link(key).put(*args)
         end
 
+        def put!(key, *args)
+          put(key, *args).assert_success!
+        end
+
         def patch(key, *args)
           _link(key).patch(*args)
         end
 
+        def patch!(key, *args)
+          patch(key, *args).assert_success!
+        end
+
         def can?(key)
           @links.key? key.to_s
         end
@@ -143,13 +166,13 @@ module PactBroker
         end
 
         def assert_success!(messages = {})
-          default_message = "Error retrieving #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
+          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)
+          raise ErrorResponseReturned.new(message, self)
         end
       end
     end

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

@@ -39,6 +39,11 @@ 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)
@@ -54,7 +59,7 @@ module PactBroker
         end
 
         def perform_request request, uri
-          response = until_truthy_or_max_times(times: 5, sleep: 5, condition: ->(resp) { resp.code.to_i < 500 }) do
+          response = until_truthy_or_max_times(condition: ->(resp) { resp.code.to_i < 500 }) do
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
             http.set_debug_output(output_stream) if verbose
             http.use_ssl = (uri.scheme == 'https')
@@ -71,7 +76,7 @@ module PactBroker
         end
 
         def until_truthy_or_max_times options = {}
-          max_tries = options.fetch(:times, 3)
+          max_tries = options.fetch(:times, default_max_tries)
           tries = 0
           sleep_interval = options.fetch(:sleep, 5)
           sleep(sleep_interval) if options[:sleep_first]
@@ -97,6 +102,10 @@ module PactBroker
           end
         end
 
+        def default_max_tries
+          5
+        end
+
         def sleep seconds
           Kernel.sleep seconds
         end

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

@@ -49,14 +49,34 @@ module PactBroker
           wrap_response(href, @http_client.put(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def put!(*args)
+          put(*args).assert_success!
+        end
+
         def post(payload = nil, headers = {})
           wrap_response(href, @http_client.post(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def post!(*args)
+          post(*args).assert_success!
+        end
+
         def patch(payload = nil, headers = {})
           wrap_response(href, @http_client.patch(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def patch!(*args)
+          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/links.rb

@@ -30,6 +30,21 @@ module PactBroker
           links.find{ | link | link.name == name }
         end
 
+        def select!(name, not_found_message = nil)
+          selected_links = select(name)
+          if selected_links.any?
+            selected_links
+          else
+            message = not_found_message || "Could not find relation '#{key}' with name '#{name}' in resource at #{href}."
+            available_options = names.any? ? names.join(", ") : "<none found>"
+            raise RelationNotFoundError.new(message.chomp(".") + ". Available options: #{available_options}")
+          end
+        end
+
+        def select(name)
+          links.select{ | link | link.name == name }
+        end
+
         private
 
         attr_reader :links, :key, :href

data/lib/pact_broker/client/hal_client_methods.rb

@@ -17,9 +17,15 @@ 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?
+        index_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+      end
+
+      def pact_broker_name
+        is_pactflow? ? "Pactflow" : "the Pact Broker"
       end
     end
   end

data/lib/pact_broker/client/matrix.rb

@@ -60,6 +60,9 @@ module PactBroker
         elsif selectors.size == 1 && !options[:to_environment]
           opts[:latest] = 'true'
         end
+        if options[:ignore_selectors] && options[:ignore_selectors].any?
+          opts[:ignore] = convert_selector_hashes_to_params(options[:ignore_selectors])
+        end
         opts
       end
 
@@ -69,6 +72,7 @@ module PactBroker
             hash[:version] = selector[:version] if selector[:version]
             hash[:latest] = 'true' if selector[:latest]
             hash[:tag] = selector[:tag] if selector[:tag]
+            hash[:branch] = selector[:branch] if selector[:branch]
           end
         end
       end