pact_broker-client 1.43.0 → 1.47.0

data/lib/pact_broker/client/deployments/record_support_ended.rb

@@ -0,0 +1,103 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordSupportEnded < PactBroker::Client::BaseCommand
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @environment_name = params.fetch(:environment_name)
+          @version_number = params.fetch(:version_number)
+        end
+
+        private
+
+        def do_call
+          if unsupported_versions_resources.empty?
+            PactBroker::Client::CommandResult.new(false, error_result_message)
+          else
+            PactBroker::Client::CommandResult.new(unsupported_versions_resources.all?(&:success?), result_message)
+          end
+        end
+
+        attr_reader :pacticipant_name, :environment_name, :version_number
+
+        def currently_supported_versions_link
+          environment_resource._link("pb:currently-supported-released-versions", "pb:currently-supported-versions") or raise PactBroker::Client::Error.new(not_supported_message)
+        end
+
+        def currently_supported_version_entities_for_pacticipant_version
+          @deployed_version_links ||= currently_supported_versions_link.get!(pacticipant: pacticipant_name, version: version_number).embedded_entities!("releasedVersions")
+        end
+
+        def unsupported_versions_resources
+          @unsupported_versions_resources ||= currently_supported_version_entities_for_pacticipant_version.collect do | entity |
+            entity._link!("self").patch(currentlySupported: false)
+          end
+        end
+
+        def action
+          "undeployment"
+        end
+
+        def environment_resource
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+            .get!
+        end
+
+        def result_message
+          if json_output?
+            unsupported_versions_resources.collect{ | resource | resource.response.body }.to_a.to_json
+          else
+            unsupported_versions_resources.collect do | undeployed_versions_resource |
+              if undeployed_versions_resource.success?
+                green("#{success_result_text_message(undeployed_versions_resource)} in #{pact_broker_name}.")
+              else
+                red(undeployed_versions_resource.error_message)
+              end
+            end.join("\n")
+          end
+        end
+
+        def success_result_text_message(undeployed_versions_resource)
+          "Recorded support ended for #{pacticipant_name} version #{version_number} in #{environment_name} environment"
+        end
+
+        def error_result_message
+          if json_output?
+            error_message_as_json(error_text)
+          else
+            red(error_text)
+          end
+        end
+
+        def error_text
+          if pacticipant_does_not_exist?
+            "No pacticipant with name '#{pacticipant_name}' found."
+          else
+            "#{pacticipant_name} version #{version_number} is not currently released in #{environment_name} environment. Cannot record support ended."
+          end
+        end
+
+        def not_supported_message
+          "This version of the Pact Broker does not support recording end of support. Please upgrade to version 2.80.0 or later."
+        end
+
+        def pacticipant_does_not_exist?
+          index_resource._link("pb:pacticipant") && index_resource._link("pb:pacticipant").expand(pacticipant: pacticipant_name).get.does_not_exist?
+        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/deployments/record_undeployment.rb

@@ -0,0 +1,127 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordUndeployment < PactBroker::Client::BaseCommand
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @environment_name = params.fetch(:environment_name)
+          @target = params.fetch(:target)
+        end
+
+        private
+
+        def do_call
+          if undeployed_versions_resources.empty?
+            PactBroker::Client::CommandResult.new(false, error_result_message)
+          else
+            PactBroker::Client::CommandResult.new(undeployed_versions_resources.all?(&:success?), result_message)
+          end
+        end
+
+        attr_reader :pacticipant_name, :environment_name, :target
+
+        def currently_deployed_versions_link
+          environment_resource._link("pb:currently-deployed-deployed-versions", "pb:currently-deployed-versions") or raise PactBroker::Client::Error.new(not_supported_message)
+        end
+
+        def currently_deployed_version_entities_for_pacticipant
+          @deployed_version_links ||= currently_deployed_versions_link.get!(pacticipant: pacticipant_name).embedded_entities!("deployedVersions")
+        end
+
+        def currently_deployed_version_entities_for_pacticipant_and_target
+          currently_deployed_version_entities_for_pacticipant.select do | entity |
+            entity.target == target
+          end
+        end
+
+        def undeployed_versions_resources
+          @undeployed_versions_resources ||= currently_deployed_version_entities_for_pacticipant_and_target.collect do | entity |
+            entity._link!("self").patch(currentlyDeployed: false)
+          end
+        end
+
+        def action
+          "undeployment"
+        end
+
+        def environment_resource
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+            .get!
+        end
+
+        def result_message
+          if json_output?
+            undeployed_versions_resources.collect{ | resource | resource.response.body }.to_a.to_json
+          else
+            undeployed_versions_resources.collect do | undeployed_versions_resource |
+              if undeployed_versions_resource.success?
+                green("#{success_result_text_message(undeployed_versions_resource)} in #{pact_broker_name}.")
+              else
+                red(undeployed_versions_resource.error_message)
+              end
+            end.join("\n")
+          end
+        end
+
+        def success_result_text_message(undeployed_versions_resource)
+          version = undeployed_versions_resource.embedded_entity{ | embedded_entity| embedded_entity && embedded_entity['version'] }
+          message = "Recorded #{action} of #{pacticipant_name}"
+          message = "#{message} version #{version.number}" if (version && version.number)
+          message = "#{message} from #{environment_name} environment"
+          message = "#{message} (target #{target})" if target
+          message
+        end
+
+        def error_result_message
+          if json_output?
+            error_message_as_json(error_text)
+          else
+            red(error_text)
+          end
+        end
+
+        def error_text
+          if pacticipant_does_not_exist?
+            "No pacticipant with name '#{pacticipant_name}' found."
+          else
+            if currently_deployed_version_entities_for_pacticipant.any?
+              target_does_not_match_message
+            else
+              "#{pacticipant_name} is not currently deployed to #{environment_name} environment. Cannot record undeployment."
+            end
+          end
+        end
+
+        def target_does_not_match_message
+          potential_targets = currently_deployed_version_entities_for_pacticipant.collect(&:target).collect { |target| target || "<no target>"}
+          if target
+            "#{pacticipant_name} is not currently deployed to target '#{target}' in #{environment_name} environment. Please specify one of the following targets to record the undeployment from: #{potential_targets.join(", ")}"
+          else
+            "Please specify one of the following targets to record the undeployment from: #{potential_targets.join(", ")}"
+          end
+        end
+
+        def not_supported_message
+          "This version of the Pact Broker does not support recording undeployments. Please upgrade to version 2.80.0 or later."
+        end
+
+        def pacticipant_does_not_exist?
+          index_resource._link("pb:pacticipant") && index_resource._link("pb:pacticipant").expand(pacticipant: pacticipant_name).get.does_not_exist?
+        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/describe_text_formatter.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+require 'pact_broker/client/generate_display_name'
+
+module PactBroker
+  module Client
+    class DescribeTextFormatter
+      extend GenerateDisplayName
+
+      def self.call(properties)
+        YAML.dump(displayify_keys(properties)).gsub("---\n", "")
+      end
+
+      def self.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

data/lib/pact_broker/client/environments.rb

@@ -1,3 +1,6 @@
-Dir.glob(File.join(__FILE__.gsub(".rb", "/**/*.rb"))).sort.each do | path |
-  require path
-end
+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/describe_environment.rb

@@ -1,12 +1,10 @@
 require 'pact_broker/client/environments/environment_command'
-require 'pact_broker/client/generate_display_name'
-require 'yaml'
+require 'pact_broker/client/describe_text_formatter'
 
 module PactBroker
   module Client
     module Environments
       class DescribeEnvironment < PactBroker::Client::Environments::EnvironmentCommand
-        include PactBroker::Client::GenerateDisplayName
         private
 
         def do_call
@@ -18,16 +16,8 @@ module PactBroker
           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
+            properties = existing_environment_resource.response.body.except("_links", "_embedded")
+            PactBroker::Client::DescribeTextFormatter.call(properties)
           end
         end
       end

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

@@ -8,6 +8,7 @@ module PactBroker
   module Client
     module Hal
       class RelationNotFoundError < ::PactBroker::Client::Error; end
+      class EmbeddedEntityNotFoundError < ::PactBroker::Client::Error; end
       class ErrorResponseReturned < ::PactBroker::Client::Error
         attr_reader :entity
 
@@ -99,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)
@@ -109,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
 
@@ -146,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
@@ -165,14 +180,17 @@ module PactBroker
           false
         end
 
-        def assert_success!(messages = {})
+        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, self)
+        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)
@@ -46,7 +46,8 @@ module PactBroker
 
         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/pacticipants.rb

@@ -1,7 +1,7 @@
 # New code
-Dir.glob(File.join(__FILE__.gsub(".rb", "/**/*.rb"))).sort.each do | path |
-  require path
-end
+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'

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

@@ -17,7 +17,7 @@ module PactBroker
             index_resource._link!('pb:pacticipants').post!(pacticipant_resource_params)
           elsif pacticipant_entity.success?
             @action = "updated"
-            pacticipant_entity._link!('self').patch!(pacticipant_resource_params)
+            pacticipant_entity._link!('self').patch!(pacticipant_resource_params, { "Content-Type" => "application/json" })
           else
             pacticipant_entity.assert_success!
           end
@@ -30,7 +30,7 @@ module PactBroker
           if json_output?
             response_entity.response.raw_body
           else
-            green(message = "Pacticipant \"#{params[:name]}\" #{action}")
+            green(message = "Pacticipant \"#{params[:name]}\" #{action} in #{pact_broker_name}")
           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