feat: support marking a released version as unsupported

lib/pact_broker/api/decorators/released_version_decorator.rb

@@ -6,8 +6,8 @@ module Decorators
       class ReleasedVersionDecorator < BaseDecorator
         property :uuid
         property :currently_supported, camelize: true
-
         include Timestamps
+        property :supportEndedAt, getter: lambda { |_|  support_ended_at ? FormatDateTime.call(support_ended_at) : nil }, writeable: false
       end
     end
   end

lib/pact_broker/api/resources/released_version.rb

@@ -1,16 +1,30 @@
 require "pact_broker/api/resources/base_resource"
 require "pact_broker/api/decorators/released_version_decorator"
+require "pact_broker/messages"
 
 module PactBroker
   module Api
     module Resources
       class ReleasedVersion < BaseResource
+        include PactBroker::Messages
+
+        def initialize
+          super
+          @currently_supported_param = params(default: {})[:currentlySupported]
+        end
+
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
 
+        def content_types_accepted
+          [
+            ["application/merge-patch+json", :from_merge_patch_json]
+          ]
+        end
+
         def allowed_methods
-          ["GET", "OPTIONS"]
+          ["GET", "PATCH", "OPTIONS"]
         end
 
         def resource_exists?
@@ -21,6 +35,18 @@ def to_json
           decorator_class(:released_version_decorator).new(released_version).to_json(decorator_options)
         end
 
+        def from_merge_patch_json
+          if request.patch?
+            if resource_exists?
+              process_currently_supported_param
+            else
+              404
+            end
+          else
+            415
+          end
+        end
+
         def policy_name
           :'versions::version'
         end
@@ -31,6 +57,20 @@ def policy_record
 
         private
 
+        attr_reader :currently_supported_param
+
+        def process_currently_supported_param
+          if currently_supported_param == false
+            @released_version = released_version_service.record_version_support_ended(released_version)
+            response.body = to_json
+          elsif currently_supported_param == true
+            set_json_validation_error_messages(currentlySupported: [message("errors.validation.cannot_set_currently_supported_true")])
+            422
+          else
+            response.body = to_json
+          end
+        end
+
         def released_version
           @released_version ||= released_version_service.find_by_uuid(uuid)
         end

lib/pact_broker/deployments/released_version.rb

@@ -39,10 +39,15 @@ def order_by_date_desc
         end
 
         def record_support_ended
-          update(support_ended_at: Sequel.datetime_class.now)
+          where(support_ended_at: nil).update(support_ended_at: Sequel.datetime_class.now)
         end
       end
 
+      def record_support_ended
+        self.class.where(id: id).record_support_ended
+        refresh
+      end
+
       def currently_supported
         support_ended_at == nil
       end

lib/pact_broker/locale/en.yml

@@ -83,6 +83,7 @@ en:
         cannot_modify_version_branch: "The branch for a pacticipant version cannot be changed once set (currently '%{old_branch}', proposed value '%{new_branch}'). Your pact publication/verification publication configurations may be in conflict with each other if you are seeing this error. If the current branch value is incorrect, you must delete the pacticipant version resource at %{version_url} and publish the pacts/verification results again with a consistent branch name."
         invalid_content_for_content_type: "The content could not be parsed as %{content_type}"
         cannot_set_currently_deployed_true: The currentlyDeployed property cannot be set back to true. Please record a new deployment.
+        cannot_set_currently_supported_true: The currentlySupported property cannot be set back to true. Please record a new deployment.
       duplicate_pacticipant: |
         This is the first time a pact has been published for "%{new_name}".
         The name "%{new_name}" is very similar to the following existing consumers/providers:

lib/pact_broker/test/test_data_builder.rb

@@ -545,6 +545,7 @@ def create_released_version(uuid: , currently_supported: true, version:, environ
         env = find_environment(environment_name)
         @released_version = PactBroker::Deployments::ReleasedVersionService.create(uuid, version, env)
         PactBroker::Deployments::ReleasedVersionService.record_version_support_ended(released_version) unless currently_supported
+        released_version.refresh
         set_created_at_if_set(created_at, :released_versions, id: released_version.id)
       end
 

spec/features/record_undeployment_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe "Get currently deployed versions for environment" do
+RSpec.describe "Record undeployment" do
   let!(:version) { td.create_consumer("Foo").create_consumer_version("1").and_return(:consumer_version) }
   let!(:test_environment) { td.create_environment("test").and_return(:environment) }
   let!(:deployed_version) do