Add the ability to delete documents

Author: lornajane

src/PHPCouchDB/Document.php

@@ -65,7 +65,7 @@ public function __debugInfo()
      * @throws \PHPCouchDB\Exception\DatabaseExecption if something else goes
      *  wrong, with the previous exception included
      */
-    public function update()
+    public function update() : Document
     {
         $endpoint = "/" . $this->database->getName() . "/" . $this->id;
 
@@ -91,4 +91,31 @@ public function update()
             }
         }
     }
+
+    public function delete() : bool
+    {
+        $endpoint = "/" . $this->database->getName() . "/" . $this->id;
+        $query = ["rev" => $this->rev];
+
+        try {
+            $response = $this->client->request('DELETE', $endpoint, ["query" => $query]);
+            // if successful, cool
+            return true;
+        } catch (\GuzzleHTTP\Exception\ClientException $e) {
+            // our reaction depends on the status code
+            $status = $e->getResponse()->getStatusCode();
+
+            if ($status == 404) {
+                // a 404 error is fine, means the record is already gone
+                return true;
+            } elseif ($status == 409) {
+                // conflict, we're deleting the wrong version of the doc
+                throw new Exception\DocumentConflictException(
+                    'Document conflict. Only the current document revision can be deleted'
+                );
+            } else {
+                throw new Exception\DatabaseException('The record could not be deleted', 0, $e);
+            }
+        }
+    }
 }

tests/PHPCouchDB/DocumentTest.php

@@ -27,7 +27,7 @@ public function setUp() {
         $this->fetch_response = new Response(200, [], $fetch);
     }
 
-    public function testUpdateConflict() {
+    public function testUpdate() {
         $update = '{"ok":true,"id":"abcde12345","rev":"2-74a0465bd6e3ea40a1a3752b93916762"}';
         $update_response = new Response(200, [], $update);
 
@@ -55,7 +55,7 @@ public function testUpdateConflict() {
     /**
      * @expectedException \PHPCouchDB\Exception\DocumentConflictException
      */
-    public function testUpdate() {
+    public function testUpdateConflict() {
         $update = '{"error":"conflict","reason":"Document update conflict."}';;
         $update_response = new Response(409, [], $update);
 
@@ -72,4 +72,47 @@ public function testUpdate() {
         $newdoc = $doc->update();
     }
 
+    public function testDelete() {
+        $delete = '{"ok":true,"id":"abcde12345","rev":"2-74a0465bd6e3ea40a1a3752b93916762"}';
+        $delete_response = new Response(200, [], $delete);
+
+        $fetch3 = '{"error":"not_found","reason":"deleted"}';
+        $fetch_response3 = new Response(404, [], $fetch3);
+
+		$mock = new MockHandler([ $this->db_response, $this->use_response, $this->create_response, $this->fetch_response, $delete_response, $fetch_response3 ]);
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
+
+		// userland code starts
+		$server = new \PHPCouchDB\Server(["client" => $client]);
+        $database = $server->useDB(["name" => "egdb"]);
+        $doc = $database->create(["noise" => "howl", "id" => "abcde12345"]);
+
+        $result = $doc->delete();
+        $this->assertEquals(true, $result);
+
+        // should be able to delete an already-deleted doc without errors
+
+        $result = $doc->delete();
+        $this->assertEquals(true, $result);
+    }
+
+    /**
+     * @expectedException \PHPCouchDB\Exception\DocumentConflictException
+     */
+    public function testDeleteConflict() {
+        $delete = '{"error":"conflict","reason":"Document update conflict."}';
+        $delete_response = new Response(409, [], $delete);
+
+		$mock = new MockHandler([ $this->db_response, $this->use_response, $this->create_response, $this->fetch_response, $delete_response ]);
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
+
+		// userland code starts
+		$server = new \PHPCouchDB\Server(["client" => $client]);
+        $database = $server->useDB(["name" => "egdb"]);
+        $doc = $database->create(["noise" => "howl", "id" => "abcde12345"]);
+
+        $result = $doc->delete();
+    }
 }