Add Unlock Method

lib/obs_github_deployments/deployment.rb

@@ -37,6 +37,17 @@ def lock(reason:)
       true if create_and_set_state(state: "queued", payload: payload_reason(reason: reason))
     end
 
+    def unlock
+      deployment_status = latest_status
+
+      if deployment_status.blank? || deployment_status.state != "queued"
+        raise ObsGithubDeployments::Deployment::NothingToUnlockError
+      end
+
+      add_state(deployment: latest, state: "inactive")
+      true
+    end
+
     private
 
     def all
@@ -59,7 +70,10 @@ def create(payload:)
     end
 
     def add_state(deployment:, state:)
-      @client.create_deployment_status(deployment.url, state, { accept: "application/vnd.github.flash-preview+json" })
+      options = { accept: "application/vnd.github.flash-preview+json" }
+      options[:accept] = "application/vnd.github.ant-man-preview+json" if state == "inactive"
+
+      @client.create_deployment_status(deployment.url, state, options)
     end
 
     def create_and_set_state(state:, payload:)

lib/obs_github_deployments/deployment/nothing_to_unlock_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ObsGithubDeployments
+  class Deployment
+    class NothingToUnlockError < StandardError
+      def message
+        "Current deployment is not locked, nothing to do here"
+      end
+    end
+  end
+end

spec/obs_github_deployments/deployment_spec.rb

@@ -65,4 +65,41 @@
       end
     end
   end
+
+  describe "unlock" do
+    context "with an deployment not in the locked state" do
+      before do
+        subject.send :create_and_set_state, state: "success", payload: nil
+      end
+
+      it "throws an exception" do
+        expect { subject.unlock }.to raise_error(
+          ObsGithubDeployments::Deployment::NothingToUnlockError
+        )
+      end
+    end
+
+    context "with an deployment without any state set" do
+      before do
+        subject.send :create, payload: nil
+      end
+
+      it "throws an exception" do
+        expect { subject.unlock }.to raise_error(
+          ObsGithubDeployments::Deployment::NothingToUnlockError
+        )
+      end
+    end
+
+    context "with a locked deployment in place" do
+      before do
+        subject.send :create_and_set_state, state: "queued", payload: nil
+      end
+
+      it "unlocks the deployment and returns true" do
+        expect(subject.unlock).to eq(true)
+        expect(subject.send(:latest_status).state).to eq("inactive")
+      end
+    end
+  end
 end