Merge pull request #1259 from ttaylorr/force-unlock-param

api: add Force option to unlock requests

api/lock_api.go

@@ -80,21 +80,19 @@ func (s *LockService) Search(req *LockSearchRequest) (*RequestSchema, *LockList)
 }
 
 // Unlock generates a *RequestSchema that is used to preform the "unlock" API
-// method.
-//
-// It generates a bodyless request that simply directs to POST
-// /locks/:id/unlock.
+// method, against a particular lock potentially with --force.
 //
 // This method's corresponding response type will either contain a reference to
 // the lock that was unlocked, or an error that was experienced by the server in
 // unlocking it.
-func (s *LockService) Unlock(l *Lock) (*RequestSchema, *UnlockResponse) {
+func (s *LockService) Unlock(id string, force bool) (*RequestSchema, *UnlockResponse) {
 	var resp UnlockResponse
 
 	return &RequestSchema{
 		Method:    "POST",
-		Path:      fmt.Sprintf("/locks/%s/unlock", l.Id),
+		Path:      fmt.Sprintf("/locks/%s/unlock", id),
 		Operation: UploadOperation,
+		Body:      &UnlockRequest{id, force},
 		Into:      &resp,
 	}, &resp
 }
@@ -181,6 +179,16 @@ type LockResponse struct {
 	Err string `json:"error,omitempty"`
 }
 
+// UnlockRequest encapsulates the data sent in an API request to remove a lock.
+type UnlockRequest struct {
+	// Id is the Id of the lock that the user wishes to unlock.
+	Id string `json:"id"`
+	// Force determines whether or not the lock should be "forcibly"
+	// unlocked; that is to say whether or not a given individual should be
+	// able to break a different individual's lock.
+	Force bool `json:"force"`
+}
+
 // UnlockResponse is the result sent back from the API when asked to remove a
 // lock.
 type UnlockResponse struct {

api/lock_api_test.go

@@ -74,6 +74,21 @@ func TestLockSearchWithLimit(t *testing.T) {
 	}, got)
 }
 
+func TestUnlockingALock(t *testing.T) {
+	got, body := LockService.Unlock("some-lock-id", true)
+
+	AssertRequestSchema(t, &api.RequestSchema{
+		Method:    "POST",
+		Path:      "/locks/some-lock-id/unlock",
+		Operation: api.UploadOperation,
+		Body: &api.UnlockRequest{
+			Id:    "some-lock-id",
+			Force: true,
+		},
+		Into: body,
+	}, got)
+}
+
 func TestLockRequest(t *testing.T) {
 	schema.Validate(t, schema.LockRequestSchema, &api.LockRequest{
 		Path:               "/path/to/lock",
@@ -133,6 +148,13 @@ func TestLockResponseInvalidWithCommitAndError(t *testing.T) {
 	})
 }
 
+func TestUnlockRequest(t *testing.T) {
+	schema.Validate(t, schema.UnlockRequestSchema, &api.UnlockRequest{
+		Id:    "some-lock-id",
+		Force: false,
+	})
+}
+
 func TestUnlockResponseWithLock(t *testing.T) {
 	schema.Validate(t, schema.UnlockResponseSchema, &api.UnlockResponse{
 		Lock: &api.Lock{

api/schema/schemas.go

@@ -19,5 +19,6 @@ const (
 	LockListSchema       = "lock_list_schema.json"
 	LockRequestSchema    = "lock_request_schema.json"
 	LockResponseSchema   = "lock_response_schema.json"
+	UnlockRequestSchema  = "unlock_request_schema.json"
 	UnlockResponseSchema = "unlock_response_schema.json"
 )

api/schema/unlock_request_schema.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string"
+        },
+        "force": {
+            "type": "boolean"
+        }
+    },
+    "required": ["id", "force"],
+    "additionalItems": false
+}