Add the ability to get all documents from database

Author: lornajane

src/PHPCouchDB/Database.php

@@ -52,4 +52,31 @@ public function __construct($options)
             );
         }
     }
+
+    /**
+     * Fetch all the documents from the database
+     *
+     * @param array $options  Any modifiers needed for the query  These include:
+     *      - include_docs   Defaults to true
+     * @return array The array contains `PHPCouchDB\Document` objects
+     */
+    public function getAllDocs($options = []) : array
+    {
+        $endpoint = "/" . $this->db_name . "/_all_docs";
+        $query = ["include_docs" => "true"];
+        $response = $this->client->request("GET", $endpoint, ["query" => $query]);
+        if ($response->getStatusCode() == 200) {
+            // try to decode JSON
+            if ($json_data = json_decode($response->getBody(), true)) {
+                // we have some data - extract the docs to return
+                $docs = [];
+                foreach ($json_data["rows"] as $document) {
+                    $docs[] = new Document($document["doc"]);
+                }
+                return $docs;
+            } else {
+                throw new \PHPCouchDB\Exception\ServerException('JSON response not received or not understood');
+            }
+        }
+    }
 }

src/PHPCouchDB/Document.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * Objects to represent individual documents
+ */
+
+namespace PHPCouchDB;
+
+/**
+ * Documents are the "rows" in a document database.  The object has keys and
+ * values to represent the keys and values of the document.
+ */
+
+
+class Document
+{
+    /**
+     * Usually constructed by the Database object as it gets documents for us
+     *
+     * @param array $data Representation of the document
+     */
+    public function __construct($data)
+    {
+        // possibly overly simple!
+        // Add all array elements as properties on the new object
+        foreach ($data as $field => $value) {
+            if ($field == "_id") {
+                $this->id = $value;
+            } elseif ($field == "_rev") {
+                $this->rev = $value;
+            } else {
+                $this->{$field} = $value;
+            }
+        }
+    }
+}

src/PHPCouchDB/Server.php

@@ -158,5 +158,4 @@ public function getClient() : \GuzzleHttp\ClientInterface
     {
         return $this->client;
     }
-
 }

tests/PHPCouchDB/DatabaseTest.php

@@ -0,0 +1,65 @@
+<?php
+
+require __DIR__ . "/../../vendor/autoload.php";
+
+use GuzzleHttp\Client;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Psr7\Response;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Exception\RequestException;
+
+class DatabaseTest extends \PHPUnit\Framework\TestCase 
+{
+    public function setUp() {
+        // create the first request to check we can connect, can be added to
+        // the mocks for any test that wants it
+		$couchdb1 = '{"couchdb":"Welcome","uuid":"fce3d5aabfe189c988273c0ffa8d375b","version":"1.6.0","vendor":{"name":"Ubuntu","version":"15.10"}}';
+		$this->db_response = new Response(200, [], $couchdb1);
+    }
+
+    public function testGetAllDocs() {
+        $egdb1 = '{"db_name":"egdb","update_seq":"0-g1AAAABXeJzLYWBgYMpgTmEQTM4vTc5ISXLIyU9OzMnILy7JAUklMiTV____PyuRAY-iPBYgydAApP5D1GYBAJmvHGw","sizes":{"file":8488,"external":0,"active":0},"purge_seq":0,"other":{"data_size":0},"doc_del_count":0,"doc_count":0,"disk_size":8488,"disk_format_version":6,"data_size":0,"compact_running":false,"instance_start_time":"0"}';
+        $use_response = new Response(200, [], $egdb1);
+        $docs = '{"total_rows":2,"offset":0,"rows":[
+{"id":"95613816b3a7490727388ebb470001a6","key":"95613816b3a7490727388ebb470001a6","value":{"rev":"1-71e39cb1ac06a5974a16c72b26969009"},"doc":{"_id":"95613816b3a7490727388ebb470001a6","_rev":"1-71e39cb1ac06a5974a16c72b26969009","sound":"squeak"}},
+{"id":"95613816b3a7490727388ebb4700165a","key":"95613816b3a7490727388ebb4700165a","value":{"rev":"1-1ed93c4b346f531c5e7d4d69b755ee71"},"doc":{"_id":"95613816b3a7490727388ebb4700165a","_rev":"1-1ed93c4b346f531c5e7d4d69b755ee71","noise":"pop"}}
+]}';
+        $docs_response = new Response(200, [], $docs);
+
+		$mock = new MockHandler([ $this->db_response, $use_response, $docs_response ]);
+
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
+
+		// userland code starts
+		$server = new \PHPCouchDB\Server(["client" => $client]);
+        $database = $server->useDB(["name" => "egdb"]);
+        $docs = $database->getAllDocs();
+
+        $this->assertInternalType('array', $docs);
+        $this->assertInstanceOf('\PHPCouchDB\Document', $docs[0]);
+    }
+
+    public function testGetAllDocsWithNoDocs() {
+        $egdb1 = '{"db_name":"egdb","update_seq":"0-g1AAAABXeJzLYWBgYMpgTmEQTM4vTc5ISXLIyU9OzMnILy7JAUklMiTV____PyuRAY-iPBYgydAApP5D1GYBAJmvHGw","sizes":{"file":8488,"external":0,"active":0},"purge_seq":0,"other":{"data_size":0},"doc_del_count":0,"doc_count":0,"disk_size":8488,"disk_format_version":6,"data_size":0,"compact_running":false,"instance_start_time":"0"}';
+        $use_response = new Response(200, [], $egdb1);
+        $docs = '{"total_rows":0,"offset":0,"rows":[
+
+]}';
+        $docs_response = new Response(200, [], $docs);
+
+		$mock = new MockHandler([ $this->db_response, $use_response, $docs_response ]);
+
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
+
+		// userland code starts
+		$server = new \PHPCouchDB\Server(["client" => $client]);
+        $database = $server->useDB(["name" => "egdb"]);
+        $docs = $database->getAllDocs();
+
+        $this->assertInternalType('array', $docs);
+        $this->assertEmpty($docs);
+    }
+}