pact_broker-client 1.39.0 → 1.44.0

data/lib/pact_broker/client/environments.rb

@@ -0,0 +1,6 @@
+require 'pact_broker/client/environments/create_environment'
+require 'pact_broker/client/environments/delete_environment'
+require 'pact_broker/client/environments/describe_environment'
+require 'pact_broker/client/environments/list_environments'
+require 'pact_broker/client/environments/update_environment'
+

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

@@ -0,0 +1,31 @@
+require 'pact_broker/client/environments/environment_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class CreateEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+
+        private
+
+        attr_reader :created_environment_resource
+
+        def do_call
+          @created_environment_resource = environments_link.post!(new_environment_body)
+          PactBroker::Client::CommandResult.new(created_environment_resource.success?, result_message)
+        end
+
+        def result_message
+          if json_output?
+            created_environment_resource.response.raw_body
+          else
+            ::Term::ANSIColor.green("Created #{params[:name]} environment in #{pact_broker_name} with UUID #{uuid}")
+          end
+        end
+
+        def uuid
+          created_environment_resource.uuid
+        end
+      end
+    end
+  end
+end

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,26 @@
+require 'pact_broker/client/environments/environment_command'
+require 'pact_broker/client/describe_text_formatter'
+
+module PactBroker
+  module Client
+    module Environments
+      class DescribeEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+        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
+            properties = existing_environment_resource.response.body.except("_links", "_embedded")
+            PactBroker::Client::DescribeTextFormatter.call(properties)
+          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)
@@ -158,14 +165,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.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

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

@@ -0,0 +1,15 @@
+module PactBroker
+  module Client
+    class Matrix
+      class AbbreviateVersionNumber
+        def self.call version_number
+          if version_number
+            version_number.gsub(/[A-Za-z0-9]{40}/) do | val |
+              val[0...7] + "..."
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,9 +2,22 @@ require 'pact_broker/client/base_client'
 
 module PactBroker
   module Client
+    class Notice < Hash
+      def initialize(hash)
+        self.merge!(hash)
+      end
+
+      def text
+        self[:text]
+      end
+
+      def type
+        self[:type]
+      end
+    end
     class Matrix < BaseClient
-      class Resource < Hash
 
+      class Resource < Hash
         def initialize hash
           self.merge!(hash)
         end
@@ -21,6 +34,10 @@ module PactBroker
           !!(self[:summary] && Integer === self[:summary][:unknown] )
         end
 
+        def supports_ignore?
+          !!(self[:summary] && Integer === self[:summary][:ignored] )
+        end
+
         def unknown_count
           supports_unknown_count? ? self[:summary][:unknown] : nil
         end
@@ -32,6 +49,14 @@ module PactBroker
         def deployable?
           self[:summary][:deployable]
         end
+
+        def notices
+          if self[:notices].is_a?(Array)
+            self[:notices].collect { | notice_hash | Notice.new(notice_hash) }
+          else
+            nil
+          end
+        end
       end
     end
   end