From: Maxious Date: Mon, 03 Dec 2012 08:41:38 +0000 Subject: codestyle X-Git-Url: https://maxious.lambdacomplex.org/git/?p=disclosr.git&a=commitdiff&h=871c02c98ffe59a60559ab0d78b8ef98bf60166f --- codestyle Former-commit-id: e85a6fcfab76f7ea0b140471a810430aa544e81d --- --- a/.gitmodules +++ b/.gitmodules @@ -1,9 +1,6 @@ [submodule "couchdb/couchdb-lucene"] path = couchdb/couchdb-lucene url = https://github.com/rnewson/couchdb-lucene.git -[submodule "couchdb/settee"] - path = couchdb/settee - url = https://github.com/inadarei/settee.git [submodule "lib/php-diff"] path = lib/php-diff url = https://github.com/chrisboulton/php-diff.git @@ -31,4 +28,7 @@ [submodule "documents/lib/parsedatetime"] path = documents/lib/parsedatetime url = git://github.com/bear/parsedatetime.git +[submodule "lib/FeedWriter"] + path = lib/FeedWriter + url = https://github.com/mibe/FeedWriter --- a/admin/exportEmployees.csv.php +++ b/admin/exportEmployees.csv.php @@ -4,7 +4,8 @@ $format = "csv"; //$format = "json"; -if (isset($_REQUEST['format'])) $format = $_REQUEST['format']; +if (isset($_REQUEST['format'])) + $format = $_REQUEST['format']; setlocale(LC_CTYPE, 'C'); if ($format == "csv") { $headers = Array("name"); @@ -21,7 +22,6 @@ if (isset($row->value->statistics->employees)) { $headers = array_unique(array_merge($headers, array_keys(object_to_array($row->value->statistics->employees)))); - } } } catch (SetteeRestClientException $e) { @@ -40,15 +40,14 @@ fputcsv($fp, $headers); } else if ($format == "json") { echo '{ - "labels" : ["' . implode('","', $headers) . '"],'.PHP_EOL; + "labels" : ["' . implode('","', $headers) . '"],' . PHP_EOL; } try { $agencies = $db->get_view("app", "all", null, true)->rows; //print_r($agencies); $first = true; if ($format == "json") { - echo '"data" : ['.PHP_EOL; - + echo '"data" : [' . PHP_EOL; } foreach ($agencies as $agency) { @@ -56,25 +55,35 @@ $row = Array(); $agencyEmployeesArray = object_to_array($agency->value->statistics->employees); foreach ($headers as $i => $fieldName) { + if ($format == "csv") { + if (isset($agencyEmployeesArray[$fieldName])) { + $row[] = $agencyEmployeesArray[$fieldName]["value"] ; + } else if ($i == 0) { + $row[] = $agency->value->name; + } else { + $row[] = 0; + } + } else if ($format == "json") { if (isset($agencyEmployeesArray[$fieldName])) { - $row[] = '['.$i.','.$agencyEmployeesArray[$fieldName]["value"].']'; + $row[] = '[' . $i . ',' . $agencyEmployeesArray[$fieldName]["value"] . ']'; } else { - $row[] = '['.$i.',0]'; + $row[] = '[' . $i . ',0]'; } + } } if ($format == "csv") { fputcsv($fp, array_values($row)); } else if ($format == "json") { - if (!$first) echo ","; - echo '{"data" : [' . implode(",", array_values($row)) . '], "label": "'.$agency->value->name.'", "lines" : { "show" : true }, "points" : { "show" : true }}'.PHP_EOL; + if (!$first) + echo ","; + echo '{"data" : [' . implode(",", array_values($row)) . '], "label": "' . $agency->value->name . '", "lines" : { "show" : true }, "points" : { "show" : true }}' . PHP_EOL; $first = false; } } } if ($format == "json") { - echo '] - }'.PHP_EOL; - + echo '] + }' . PHP_EOL; } } catch (SetteeRestClientException $e) { setteErrorHandler($e); --- a/admin/importAPSCEmployees.php +++ b/admin/importAPSCEmployees.php @@ -47,13 +47,17 @@ $changed = false; if (!isset($doc->statistics)) { $changed = true; - $doc->statistics = Array(); + $doc->statistics = new stdClass(); + } + if (!isset($doc->statistics->employees)) { + $changed = true; + $doc->statistics->employees = new stdClass(); } foreach ($sum as $timePeriod => $value) { if (!isset($doc->statistics->employees->$timePeriod->value) || $doc->statistics->employees->$timePeriod->value != $value) { $changed = true; - $doc->statistics["employees"][$timePeriod] = Array("value" => $value, "source" => "http://apsc.gov.au/stateoftheservice/"); + $doc->statistics->employees->$timePeriod = Array("value" => $value, "source" => "http://apsc.gov.au/stateoftheservice/"); } } if ($changed) { --- /dev/null +++ b/admin/importAPSCEmployees2012.php @@ -1,1 +1,86 @@ +get_db('disclosr-agencies'); +$rows = $db->get_view("app", "byName")->rows; +$nametoid = Array(); +$sums = Array(); +$functions = Array(); +foreach ($rows as $row) { + $nametoid[trim($row->key)] = $row->value; +} + + +$request = Requests::get("http://www.apsc.gov.au/publications-and-media/parliamentary/state-of-the-service/new-sosr/appendix-2-aps-agencies"); +$doc = phpQuery::newDocumentHTML($request->body); +phpQuery::selectDocument($doc); +foreach (pq('tr')->elements as $tr) { + //echo $tr->nodeValue.PHP_EOL; + $agency = ""; + $employees = ""; + $function = ""; + $i = 0; + foreach ($tr->childNodes as $td) { + //echo $td->nodeValue." $i
"; + if ($i == 0) + $agency = $td->nodeValue; + if ($i == 2) { + $employees = trim(str_replace(",", "", $td->nodeValue)); + } + if ($i == 4) { + $function = $td->nodeValue; + } + $i++; + } + if ($agency != "" && $employees != "" && $function != "") { + $name = trim(str_replace('2','',$agency)); + //echo "$name

" . PHP_EOL; + if (isset($nametoid[$name])) { + $id = $nametoid[$name]; + //echo $id . "
" . PHP_EOL; + @$sums[$id]["2011-2012"] += $employees; + $functions[$id] = $function; + } else if ($agency != "Agency"){ + echo "
ERROR NAME '$agency' MISSING FROM ID LIST

" . PHP_EOL; + + die(); + } + } else { + echo "skipped $agency"; + } +} +//print_r($sums); +foreach ($sums as $id => $sum) { + echo $id . "
" . PHP_EOL; + $doc = $db->get($id); + echo $doc->name . "
" . PHP_EOL; + // print_r($doc); + $changed = false; + if (!isset($doc->statistics)) { + $changed = true; + $doc->statistics = new stdClass(); + } + if (!isset($doc->statistics->employees)) { + $changed = true; + $doc->statistics->employees = new stdClass(); + } + foreach ($sum as $timePeriod => $value) { + if (!isset($doc->statistics->employees->$timePeriod->value) + || $doc->statistics->employees->$timePeriod->value != $value) { + $changed = true; + $doc->statistics->employees->$timePeriod = Array("value" => $value, "source" => "http://apsc.gov.au/stateoftheservice/"); + $doc->employees = $value; + $doc->functionClassification = $functions[$id]; + } + } + + if ($changed) { + $db->save($doc); + } else { + echo "not changed" . "
" . PHP_EOL; + } +} +// employees: timeperiod, source = apsc state of service, value +?> + --- a/admin/refreshDesignDoc.php +++ b/admin/refreshDesignDoc.php @@ -4,74 +4,61 @@ //function createFOIDocumentsDesignDoc() { $foidb = $server->get_db('disclosr-foidocuments'); - $obj = new stdClass(); - $obj->_id = "_design/" . urlencode("app"); - $obj->language = "javascript"; - $obj->views->all->map = "function(doc) { emit(doc._id, doc); };"; - $obj->views->byDate->map = "function(doc) { emit(doc.date, doc); };"; - $obj->views->byDate->reduce = "_count"; - $obj->views->byAgencyID->map = "function(doc) { emit(doc.agencyID, doc); };"; - $obj->views->byAgencyID->reduce = "_count"; +$obj = new stdClass(); +$obj->_id = "_design/" . urlencode("app"); +$obj->language = "javascript"; +$obj->views->all->map = "function(doc) { emit(doc._id, doc); };"; +$obj->views->byDate->map = "function(doc) { emit(doc.date, doc); };"; +$obj->views->byDateMonthYear->map = "function(doc) { emit(doc.date, doc); };"; +$obj->views->byDateMonthYear->reduce = "_count"; +$obj->views->byAgencyID->map = "function(doc) { emit(doc.agencyID, doc); };"; +$obj->views->byAgencyID->reduce = "_count"; - // allow safe updates (even if slightly slower due to extra: rev-detection check). - $foidb->save($obj, true); +// allow safe updates (even if slightly slower due to extra: rev-detection check). +$foidb->save($obj, true); -function createDocumentsDesignDoc() { - /* - global $db; - $obj = new stdClass(); - $obj->_id = "_design/" . urlencode("app"); - $obj->language = "javascript"; - $obj->views->all->map = "function(doc) { emit(doc._id, doc); };"; - $obj->views->byABN->map = "function(doc) { emit(doc.abn, doc); };"; - "views": { - "web_server": { - "map": "function(doc) {\n emit(doc.web_server, 1);\n}", - "reduce": "function (key, values, rereduce) {\n return sum(values);\n}" - }, - "byAgency": { - "map": "function(doc) {\n emit(doc.agencyID, 1);\n}", - "reduce": "function (key, values, rereduce) {\n return sum(values);\n}" - }, - "byURL": { - "map": "function(doc) {\n emit(doc.url, doc);\n}" - }, - "agency": { - "map": "function(doc) {\n emit(doc.agencyID, doc);\n}" - }, - "byWebServer": { - "map": "function(doc) {\n emit(doc.web_server, doc);\n}" - }, - "getValidationRequired": { - "map": "function(doc) {\nif (doc.mime_type == \"text/html\" \n&& typeof(doc.validation) == \"undefined\") {\n emit(doc._id, doc._attachments);\n}\n}" - } - } */ -} +//function createDocumentsDesignDoc() { +$docdb = $server->get_db('disclosr-documents'); + +$obj = new stdClass(); +$obj->_id = "_design/" . urlencode("app"); +$obj->language = "javascript"; +$obj->views->web_server->map = "function(doc) {\n emit(doc.web_server, 1);\n}"; +$obj->views->web_server->reduce = "function (key, values, rereduce) {\n return sum(values);\n}"; +$obj->views->byAgency->map = "function(doc) {\n emit(doc.agencyID, 1);\n}"; +$obj->views->byAgency->reduce = "function (key, values, rereduce) {\n return sum(values);\n}"; +$obj->views->byURL->map = "function(doc) {\n emit(doc.url, doc);\n}"; +$obj->views->agency->map = "function(doc) {\n emit(doc.agencyID, doc);\n}"; +$obj->views->byWebServer->map = "function(doc) {\n emit(doc.web_server, doc);\n}"; +$obj->views->getValidationRequired = "function(doc) {\nif (doc.mime_type == \"text/html\" \n&& typeof(doc.validation) == \"undefined\") {\n emit(doc._id, doc._attachments);\n}\n}"; + + + //function createAgencyDesignDoc() { $db = $server->get_db('disclosr-agencies'); - $obj = new stdClass(); - $obj->_id = "_design/" . urlencode("app"); - $obj->language = "javascript"; - $obj->views->all->map = "function(doc) { emit(doc._id, doc); };"; - $obj->views->byABN->map = "function(doc) { emit(doc.abn, doc); };"; - $obj->views->byCanonicalName->map = "function(doc) { +$obj = new stdClass(); +$obj->_id = "_design/" . urlencode("app"); +$obj->language = "javascript"; +$obj->views->all->map = "function(doc) { emit(doc._id, doc); };"; +$obj->views->byABN->map = "function(doc) { emit(doc.abn, doc); };"; +$obj->views->byCanonicalName->map = "function(doc) { if (doc.parentOrg || doc.orgType == 'FMA-DepartmentOfState') { emit(doc.name, doc); } };"; - $obj->views->byDeptStateName->map = "function(doc) { +$obj->views->byDeptStateName->map = "function(doc) { if (doc.orgType == 'FMA-DepartmentOfState') { emit(doc.name, doc._id); } };"; - $obj->views->parentOrgs->map = "function(doc) { +$obj->views->parentOrgs->map = "function(doc) { if (doc.parentOrg) { emit(doc._id, doc.parentOrg); } };"; - $obj->views->byName->map = 'function(doc) { +$obj->views->byName->map = 'function(doc) { if (typeof(doc["status"]) == "undefined" || doc["status"] != "suspended") { emit(doc.name, doc._id); if (typeof(doc.shortName) != "undefined" && doc.shortName != doc.name) { @@ -95,14 +82,14 @@ } };'; - $obj->views->foiEmails->map = "function(doc) { +$obj->views->foiEmails->map = "function(doc) { emit(doc._id, doc.foiEmail); };"; - $obj->views->byLastModified->map = "function(doc) { emit(doc.metadata.lastModified, doc); }"; - $obj->views->getActive->map = 'function(doc) { if (doc.status == "active") { emit(doc._id, doc); } };'; - $obj->views->getSuspended->map = 'function(doc) { if (doc.status == "suspended") { emit(doc._id, doc); } };'; - $obj->views->getScrapeRequired->map = "function(doc) { +$obj->views->byLastModified->map = "function(doc) { emit(doc.metadata.lastModified, doc); }"; +$obj->views->getActive->map = 'function(doc) { if (doc.status == "active") { emit(doc._id, doc); } };'; +$obj->views->getSuspended->map = 'function(doc) { if (doc.status == "suspended") { emit(doc._id, doc); } };'; +$obj->views->getScrapeRequired->map = "function(doc) { var lastScrape = Date.parse(doc.metadata.lastScraped); @@ -113,14 +100,14 @@ } };"; - $obj->views->showNamesABNs->map = "function(doc) { emit(doc._id, {name: doc.name, abn: doc.abn}); };"; - $obj->views->getConflicts->map = "function(doc) { +$obj->views->showNamesABNs->map = "function(doc) { emit(doc._id, {name: doc.name, abn: doc.abn}); };"; +$obj->views->getConflicts->map = "function(doc) { if (doc._conflicts) { emit(null, [doc._rev].concat(doc._conflicts)); } }"; - // http://stackoverflow.com/questions/646628/javascript-startswith - $obj->views->score->map = 'if(!String.prototype.startsWith){ +// http://stackoverflow.com/questions/646628/javascript-startswith +$obj->views->score->map = 'if(!String.prototype.startsWith){ String.prototype.startsWith = function (str) { return !this.indexOf(str); } @@ -144,7 +131,7 @@ emit(count+doc._id, {id:doc._id, name: doc.name, score:count, orgType: doc.orgType, portfolio:portfolio}); } }'; - $obj->views->scoreHas->map = 'if(!String.prototype.startsWith){ +$obj->views->scoreHas->map = 'if(!String.prototype.startsWith){ String.prototype.startsWith = function (str) { return !this.indexOf(str); } @@ -164,22 +151,20 @@ emit("total", 1); } }'; - $obj->views->scoreHas->reduce = 'function (key, values, rereduce) { +$obj->views->scoreHas->reduce = 'function (key, values, rereduce) { return sum(values); }'; - $obj->views->fieldNames->map = ' +$obj->views->fieldNames->map = ' function(doc) { for(var propName in doc) { emit(propName, doc._id); } }'; - $obj->views->fieldNames->reduce = 'function (key, values, rereduce) { +$obj->views->fieldNames->reduce = 'function (key, values, rereduce) { return values.length; }'; - // allow safe updates (even if slightly slower due to extra: rev-detection check). - $db->save($obj, true); - - +// allow safe updates (even if slightly slower due to extra: rev-detection check). +$db->save($obj, true); ?> --- a/couchdb/SetteeDatabase.class.php +++ /dev/null @@ -1,306 +1,1 @@ -conn_url = $conn_url; - $this->dbname = $dbname; - $this->rest_client = SetteeRestClient::get_instance($this->conn_url); - } - - - /** - * Get UUID from CouchDB - * - * @return - * CouchDB-generated UUID string - * - */ - function gen_uuid() { - $ret = $this->rest_client->http_get('_uuids'); - return $ret['decoded']->uuids[0]; // should never be empty at this point, so no checking - } - - /** - * Create or update a document database - * - * @param $document - * PHP object, a PHP associative array, or a JSON String representing the document to be saved. PHP Objects and arrays are JSON-encoded automatically. - * - *

If $document has a an "_id" property set, it will be used as document's unique id (even for "create" operation). - * If "_id" is missing, CouchDB will be used to generate a UUID. - * - *

If $document has a "_rev" property (revision), document will be updated, rather than creating a new document. - * You have to provide "_rev" if you want to update an existing document, otherwise operation will be assumed to be - * one of creation and you will get a duplicate document exception from CouchDB. Also, you may not provide "_rev" but - * not provide "_id" since that is an invalid input. - * - * @param $allowRevAutoDetection - * Default: false. When true and _rev is missing from the document, save() function will auto-detect latest revision - * for a document and use it. This option is "false" by default because it involves an extra http HEAD request and - * therefore can make save() operation slightly slower if such auto-detection is not required. - * - * @return - * document object with the database id (uuid) and revision attached; - * - * @throws SetteeCreateDatabaseException - */ - function save($document, $allowRevAutoDetection = false) { - if (is_string($document)) { - $document = json_decode($document); - } - - // Allow passing of $document as an array (for syntactic simplicity and also because in JSON world it does not matter) - if(is_array($document)) { - $document = (object) $document; - } - - if (empty($document->_id) && empty($document->_rev)) { - $id = $this->gen_uuid(); - } - elseif (empty($document->_id) && !empty($document->_rev)) { - throw new SetteeWrongInputException("Error: You can not save a document with a revision provided, but missing id"); - } - else { - $id = $document->_id; - - if ($allowRevAutoDetection) { - try { - $rev = $this->get_rev($id); - } catch (SetteeRestClientException $e) { - // auto-detection may fail legitimately, if a document has never been saved before (new doc), so skipping error - } - if (!empty($rev)) { - $document->_rev = $rev; - } - } - } - - $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); - $document_json = json_encode($document, JSON_NUMERIC_CHECK); - - $ret = $this->rest_client->http_put($full_uri, $document_json); - - $document->_id = $ret['decoded']->id; - $document->_rev = $ret['decoded']->rev; - - return $document; - } - - /** - * @param $doc - * @param $name - * @param $content - * Content of the attachment in a string-buffer format. This function will automatically base64-encode content for - * you, so you don't have to do it. - * @param $mime_type - * Optional. Will be auto-detected if not provided - * @return void - */ - public function add_attachment($doc, $name, $content, $mime_type = null) { - if (empty($doc->_attachments) || !is_object($doc->_attachments)) { - $doc->_attachments = new stdClass(); - } - - if (empty($mime_type)) { - $mime_type = $this->rest_client->content_mime_type($content); - } - - $doc->_attachments->$name = new stdClass(); - $doc->_attachments->$name->content_type = $mime_type; - $doc->_attachments->$name->data = base64_encode($content); - } - - /** - * @param $doc - * @param $name - * @param $file - * Full path to a file (e.g. as returned by PHP's realpath function). - * @param $mime_type - * Optional. Will be auto-detected if not provided - * @return void - */ - public function add_attachment_file($doc, $name, $file, $mime_type = null) { - $content = file_get_contents($file); - $this->add_attachment($doc, $name, $content, $mime_type); - } - - /** - * - * Retrieve a document from CouchDB - * - * @throws SetteeWrongInputException - * - * @param $id - * Unique ID (usually: UUID) of the document to be retrieved. - * @return - * database document in PHP object format. - */ - function get($id) { - if (empty($id)) { - throw new SetteeWrongInputException("Error: Can't retrieve a document without a uuid."); - } - - $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); -$full_uri = str_replace("%3Frev%3D","?rev=",$full_uri); - $ret = $this->rest_client->http_get($full_uri); - return $ret['decoded']; - } - - /** - * - * Get the latest revision of a document with document id: $id in CouchDB. - * - * @throws SetteeWrongInputException - * - * @param $id - * Unique ID (usually: UUID) of the document to be retrieved. - * @return - * database document in PHP object format. - */ - function get_rev($id) { - if (empty($id)) { - throw new SetteeWrongInputException("Error: Can't query a document without a uuid."); - } - - $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); - $headers = $this->rest_client->http_head($full_uri); - if (empty($headers['Etag'])) { - throw new SetteeRestClientException("Error: could not retrieve revision. Server unexpectedly returned empty Etag"); - } - $etag = str_replace('"', '', $headers['Etag']); - return $etag; - } - - /** - * Delete a document - * - * @param $document - * a PHP object or JSON representation of the document that has _id and _rev fields. - * - * @return void - */ - function delete($document) { - if (!is_object($document)) { - $document = json_decode($document); - } - - $full_uri = $this->dbname . "/" . $this->safe_urlencode($document->_id) . "?rev=" . $document->_rev; - $this->rest_client->http_delete($full_uri); - } - - - /*----------------- View-related functions --------------*/ - - /** - * Create a new view or update an existing one. - * - * @param $design_doc - * @param $view_name - * @param $map_src - * Source code of the map function in Javascript - * @param $reduce_src - * Source code of the reduce function in Javascript (optional) - * @return void - */ - function save_view($design_doc, $view_name, $map_src, $reduce_src = null) { - $obj = new stdClass(); - $obj->_id = "_design/" . urlencode($design_doc); - $view_name = urlencode($view_name); - $obj->views->$view_name->map = $map_src; - if (!empty($reduce_src)) { - $obj->views->$view_name->reduce = $reduce_src; - } - - // allow safe updates (even if slightly slower due to extra: rev-detection check). - return $this->save($obj, true); - } - - /** - * Create a new view or update an existing one. - * - * @param $design_doc - * @param $view_name - * @param $key - * key parameter to a view. Can be a single value or an array (for a range). If passed an array, function assumes - * that first element is startkey, second: endkey. - * @param $descending - * return results in descending order. Please don't forget that if you are using a startkey/endkey, when you change - * order you also need to swap startkey and endkey values! - * - * @return void - */ - function get_view($design_doc, $view_name, $key = null, $descending = false) { - $id = "_design/" . urlencode($design_doc); - $view_name = urlencode($view_name); - $id .= "/_view/$view_name"; - - $data = array(); - if (!empty($key)) { - if (is_string($key)) { - $data = "key=" . '"' . $key . '"'; - } - elseif (is_array($key)) { - list($startkey, $endkey) = $key; - $data = "startkey=" . '"' . $startkey . '"&' . "endkey=" . '"' . $endkey . '"'; - } - - if ($descending) { - $data .= "&descending=true"; - } - } - - - - if (empty($id)) { - throw new SetteeWrongInputException("Error: Can't retrieve a document without a uuid."); - } - - $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); -$full_uri = str_replace("%253Fgroup%253Dtrue","?group=true",$full_uri); - $ret = $this->rest_client->http_get($full_uri, $data); - return $ret['decoded']; - - } - - /** - * @param $id - * @return - * return a properly url-encoded id. - */ - private function safe_urlencode($id) { - //-- System views like _design can have "/" in their URLs. - $id = rawurlencode($id); - if (substr($id, 0, 1) == '_') { - $id = str_replace('%2F', '/', $id); - } - return $id; - } - - /** Getter for a database name */ - function get_name() { - return $this->dbname; - } - -} --- a/couchdb/settee +++ /dev/null --- /dev/null +++ b/couchdb/settee/.travis.yml @@ -1,1 +1,6 @@ +language: php +phps: + - 5.3 + - 5.4 +before_script: cd tests/ --- /dev/null +++ b/couchdb/settee/LICENSE.txt @@ -1,1 +1,9 @@ +(The MIT License) +Copyright (c) 2011 Irakli Nadareishvili + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --- /dev/null +++ b/couchdb/settee/README.textile @@ -1,1 +1,60 @@ +Inspired by: "CouchRest library for Ruby":http://jchrisa.net/drl/_design/sofa/_list/post/post-page?startkey=%5B%22couchrest__restful_ruby_client_%22%5D and the "couchdb-python":http://packages.python.org/CouchDB/client.html#document library. +h3. Server Functions + +# Specify a server: +@$server = new SetteeServer('http://127.0.0.1:5984');@ +# Database API +## Create a database: +@$ret = $server->create_db('irakli_test');@ +## Drop a database: +@$ret = $server->drop_db('irakli_test');@ +## List all databases: +@$ret = $server->list_dbs();@ +## Get a database object +@$db = $server->get_db('irakli_test');@ +# Document API +## Create/Update a document: +@$ret = $db->save($doc);@ +## Retrieve a document: +@$db_doc = $db->get($id);@ +## Determine the latest revision_id for a document: +@$rev = $db->get_rev($id);@ +## Delete a document: +@$db_doc = $db->delete($doc);@ +# Attachments API +## Add content as attachment: +@$db->add_attachment($doc, "foo.txt", "Some text that will be base64 encoded", "text/plain");@ +## Add a file path to be attached: +@$db->add_attachment_file($doc, "foo.pdf", $file_path, "application/pdf");@ +## Add a file path to be attached (mime-type is auto-detected): +@$db->add_attachment_file($doc, "foo.pdf", $file_path);@ +## Full attachment saving example: + $doc = new stdClass(); + $doc->_id = "attachment_doc"; + $file_path = dirname(__FILE__) . "/resources/couch-logo.pdf"; + $this->db->add_attachment_file($doc, "foo.pdf", $file_path, "application/pdf"); + $db_doc = $this->db->save($doc); +## ATTENTION: there is no "load_attachments" method, because when you load a document, all its attachments get loaded with it, as well. +# Views API +## Create a new view or save a view: +@$view = $db->save_view("some_design_document_id", "a_view_name", $map_src);@ +@$view = $db->save_view("some_design_document_id", "a_view_name", $map_src, $reduce_src);@ +## Get a view (run query and get results): +@$view = $db->get_view("some_design_document_id", "a_view_name");@ +## Parametrized view: +@$view = $db->get_view("some_design_document_id", "a_view_name", "2009/02/17 21:13:39");@ +## Parametrized view with key range: +@$view = $db->get_view("some_design_document_id", "a_view_name", array("2009/01/30 18:04:11", "2009/02/17 21:13:39"));@ +## Parametrized view with key range, ordered descending: +@$view = $db->get_view("some_design_document_id", "a_view_name", array("2009/01/30 18:04:11", "2009/02/17 21:13:39"), true);@ + + +h3. Requirements +# PHP 5.2 or newer + +h3. Recommended +# PHP 5.3 or newer. With PHP 5.2 following functionality will not work: +## Some unit-tests +## Mime type auto-detection. +# pecl_http --- /dev/null +++ b/couchdb/settee/examples/db.ops.php @@ -1,1 +1,50 @@ +#!/usr/bin/env php + "settee_test_perf_01", + 2 => "settee_test_perf_02", + 3 => "settee_test_perf_03", +); + +print ("creating databases: \n"); + +foreach ($dbs as $db) { + $start = microtime(true); + try { + $ret = $server->create_db($db); + } catch (Exception $e) { + //-- re-throw. this is just for demo + throw $e; + } + $elapsed = microtime(true) - $start; + print("Time elapsed: $elapsed \n"); +} + +$ret = $server->list_dbs(); +print_r($ret); +print ("\n"); + +print ("dropping databases: \n"); + +foreach ($dbs as $db) { + $start = microtime(true); + try { + $ret = $server->drop_db($db); + } catch (Exception $e) { + //-- re-throw. this is just for demo + throw $e; + } + $elapsed = microtime(true) - $start; + print("Time elapsed: $elapsed \n"); +} + +$ret = $server->list_dbs(); +print_r($ret); + --- /dev/null +++ b/couchdb/settee/examples/doc.ops.php @@ -1,1 +1,40 @@ +#!/usr/bin/env php +get_db('irakli'); + +try { + $server->create_db($db); +} catch (Exception $e) { + print_r("database irakli already exists! \n"); +} + +$doc = new StdClass(); +$doc->firstName = "Irakli"; +$doc->lastName = "Nadareishvili"; +$doc->IQ = 200; +$doc->hobbies = array("skiing", "swimming"); +$doc->pets = array ("whitey" => "labrador", "mikey" => "pug"); + +// Should work with json string as well: +//$doc = '{"firstName":"irakli","lastName":"Nadareishvili","IQ":200,"hobbies":["skiing","swimming"],"pets":{"whitey":"labrador","mikey":"pug"}}'; + +$doc = $db->save($doc); +print_r($doc); + +$doc = $db->get($doc->_id); +print_r($doc); + +$doc->firstName = "Ika"; +$doc = $db->save($doc); +print_r($doc); + +$db->delete($doc); + + + --- /dev/null +++ b/couchdb/settee/src/classes/SetteeDatabase.class.php @@ -1,1 +1,310 @@ - +conn_url = $conn_url; + $this->dbname = $dbname; + $this->rest_client = SetteeRestClient::get_instance($this->conn_url); + } + + + /** + * Get UUID from CouchDB + * + * @return + * CouchDB-generated UUID string + * + */ + function gen_uuid() { + $ret = $this->rest_client->http_get('_uuids'); + return $ret['decoded']->uuids[0]; // should never be empty at this point, so no checking + } + + /** + * Create or update a document database + * + * @param $document + * PHP object, a PHP associative array, or a JSON String representing the document to be saved. PHP Objects and arrays are JSON-encoded automatically. + * + *

If $document has a an "_id" property set, it will be used as document's unique id (even for "create" operation). + * If "_id" is missing, CouchDB will be used to generate a UUID. + * + *

If $document has a "_rev" property (revision), document will be updated, rather than creating a new document. + * You have to provide "_rev" if you want to update an existing document, otherwise operation will be assumed to be + * one of creation and you will get a duplicate document exception from CouchDB. Also, you may not provide "_rev" but + * not provide "_id" since that is an invalid input. + * + * @param $allowRevAutoDetection + * Default: false. When true and _rev is missing from the document, save() function will auto-detect latest revision + * for a document and use it. This option is "false" by default because it involves an extra http HEAD request and + * therefore can make save() operation slightly slower if such auto-detection is not required. + * + * @return + * document object with the database id (uuid) and revision attached; + * + * @throws SetteeCreateDatabaseException + */ + function save($document, $allowRevAutoDetection = false) { + if (is_string($document)) { + $document = json_decode($document); + } + + // Allow passing of $document as an array (for syntactic simplicity and also because in JSON world it does not matter) + if(is_array($document)) { + $document = (object) $document; + } + + if (empty($document->_id) && empty($document->_rev)) { + $id = $this->gen_uuid(); + } + elseif (empty($document->_id) && !empty($document->_rev)) { + throw new SetteeWrongInputException("Error: You can not save a document with a revision provided, but missing id"); + } + else { + $id = $document->_id; + + if ($allowRevAutoDetection) { + try { + $rev = $this->get_rev($id); + } catch (SetteeRestClientException $e) { + // auto-detection may fail legitimately, if a document has never been saved before (new doc), so skipping error + } + if (!empty($rev)) { + $document->_rev = $rev; + } + } + } + + $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); + $document_json = json_encode($document, JSON_NUMERIC_CHECK); + + $ret = $this->rest_client->http_put($full_uri, $document_json); + + $document->_id = $ret['decoded']->id; + $document->_rev = $ret['decoded']->rev; + + return $document; + } + + /** + * @param $doc + * @param $name + * @param $content + * Content of the attachment in a string-buffer format. This function will automatically base64-encode content for + * you, so you don't have to do it. + * @param $mime_type + * Optional. Will be auto-detected if not provided + * @return void + */ + public function add_attachment($doc, $name, $content, $mime_type = null) { + if (empty($doc->_attachments) || !is_object($doc->_attachments)) { + $doc->_attachments = new stdClass(); + } + + if (empty($mime_type)) { + $mime_type = $this->rest_client->content_mime_type($content); + } + + $doc->_attachments->$name = new stdClass(); + $doc->_attachments->$name->content_type = $mime_type; + $doc->_attachments->$name->data = base64_encode($content); + } + + /** + * @param $doc + * @param $name + * @param $file + * Full path to a file (e.g. as returned by PHP's realpath function). + * @param $mime_type + * Optional. Will be auto-detected if not provided + * @return void + */ + public function add_attachment_file($doc, $name, $file, $mime_type = null) { + $content = file_get_contents($file); + $this->add_attachment($doc, $name, $content, $mime_type); + } + + /** + * + * Retrieve a document from CouchDB + * + * @throws SetteeWrongInputException + * + * @param $id + * Unique ID (usually: UUID) of the document to be retrieved. + * @return + * database document in PHP object format. + */ + function get($id) { + if (empty($id)) { + throw new SetteeWrongInputException("Error: Can't retrieve a document without a uuid."); + } + + $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); +$full_uri = str_replace("%3Frev%3D","?rev=",$full_uri); + $ret = $this->rest_client->http_get($full_uri); + return $ret['decoded']; + } + + /** + * + * Get the latest revision of a document with document id: $id in CouchDB. + * + * @throws SetteeWrongInputException + * + * @param $id + * Unique ID (usually: UUID) of the document to be retrieved. + * @return + * database document in PHP object format. + */ + function get_rev($id) { + if (empty($id)) { + throw new SetteeWrongInputException("Error: Can't query a document without a uuid."); + } + + $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); + $headers = $this->rest_client->http_head($full_uri); + if (empty($headers['Etag'])) { + throw new SetteeRestClientException("Error: could not retrieve revision. Server unexpectedly returned empty Etag"); + } + $etag = str_replace('"', '', $headers['Etag']); + return $etag; + } + + /** + * Delete a document + * + * @param $document + * a PHP object or JSON representation of the document that has _id and _rev fields. + * + * @return void + */ + function delete($document) { + if (!is_object($document)) { + $document = json_decode($document); + } + + $full_uri = $this->dbname . "/" . $this->safe_urlencode($document->_id) . "?rev=" . $document->_rev; + $this->rest_client->http_delete($full_uri); + } + + + /*----------------- View-related functions --------------*/ + + /** + * Create a new view or update an existing one. + * + * @param $design_doc + * @param $view_name + * @param $map_src + * Source code of the map function in Javascript + * @param $reduce_src + * Source code of the reduce function in Javascript (optional) + * @return void + */ + function save_view($design_doc, $view_name, $map_src, $reduce_src = null) { + $obj = new stdClass(); + $obj->_id = "_design/" . urlencode($design_doc); + $view_name = urlencode($view_name); + $obj->views->$view_name->map = $map_src; + if (!empty($reduce_src)) { + $obj->views->$view_name->reduce = $reduce_src; + } + + // allow safe updates (even if slightly slower due to extra: rev-detection check). + return $this->save($obj, true); + } + + /** + * Create a new view or update an existing one. + * + * @param $design_doc + * @param $view_name + * @param $key + * key parameter to a view. Can be a single value or an array (for a range). If passed an array, function assumes + * that first element is startkey, second: endkey. + * @param $descending + * return results in descending order. Please don't forget that if you are using a startkey/endkey, when you change + * order you also need to swap startkey and endkey values! + * + * @return void + */ + function get_view($design_doc, $view_name, $key = null, $descending = false, $limit = false) { + $id = "_design/" . urlencode($design_doc); + $view_name = urlencode($view_name); + $id .= "/_view/$view_name"; + + $data = array(); + if (!empty($key)) { + if (is_string($key)) { + $data = "key=" . '"' . $key . '"'; + } + elseif (is_array($key)) { + list($startkey, $endkey) = $key; + $data = "startkey=" . '"' . $startkey . '"&' . "endkey=" . '"' . $endkey . '"'; + } + + if ($descending) { + $data .= "&descending=true"; + } + if ($limit) { + $data .= "&limit=".$limit; + } + } + + + + if (empty($id)) { + throw new SetteeWrongInputException("Error: Can't retrieve a document without a uuid."); + } + + $full_uri = $this->dbname . "/" . $this->safe_urlencode($id); +$full_uri = str_replace("%253Fgroup%253D","?group=",$full_uri); +$full_uri = str_replace("%253Flimit%253D","?limit=",$full_uri); + $ret = $this->rest_client->http_get($full_uri, $data); + return $ret['decoded']; + + } + + /** + * @param $id + * @return + * return a properly url-encoded id. + */ + private function safe_urlencode($id) { + //-- System views like _design can have "/" in their URLs. + $id = rawurlencode($id); + if (substr($id, 0, 1) == '_') { + $id = str_replace('%2F', '/', $id); + } + return $id; + } + + /** Getter for a database name */ + function get_name() { + return $this->dbname; + } + +} --- /dev/null +++ b/couchdb/settee/src/classes/SetteeRestClient.class.php @@ -1,1 +1,246 @@ - +base_url = $base_url; + + $curl = curl_init(); + curl_setopt($curl, CURLOPT_USERAGENT, "Settee CouchDB Client/1.0"); + curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json')); + curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($curl, CURLOPT_HEADER, 0); + curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1); + curl_setopt($curl, CURLOPT_TIMEOUT_MS, self::HTTP_TIMEOUT); + curl_setopt($curl, CURLOPT_FORBID_REUSE, false); // Connection-pool for CURL + + $this->curl = $curl; + + } + + /** + * Class destructor cleans up any resources + */ + function __destruct() { + curl_close($this->curl); + } + + /** + * HTTP HEAD + * + * @return + * Raw HTTP Headers of the response. + * + * @see: http://www.php.net/manual/en/context.params.php + * + */ + function http_head($uri) { + curl_setopt($this->curl, CURLOPT_HEADER, 1); + + $full_url = $this->get_full_url($uri); + curl_setopt($this->curl, CURLOPT_URL, $full_url); + curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'HEAD'); + curl_setopt($this->curl, CURLOPT_NOBODY, true); + + + $response = curl_exec($this->curl); + // Restore default values + curl_setopt($this->curl, CURLOPT_NOBODY, false); + curl_setopt($this->curl, CURLOPT_HEADER, false); + + $resp_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE); + if ($resp_code == 404 ) { + throw new SetteeRestClientException("Couch document not found at: '$full_url'"); + } + + if (function_exists('http_parse_headers')) { + $headers = http_parse_headers($response); + } + else { + $headers = $this->_http_parse_headers($response); + } + + return $headers; + } + + /** + * Backup PHP impl. for when PECL http_parse_headers() function is not available + * + * @param $header + * @return array + * @source http://www.php.net/manual/en/function.http-parse-headers.php#77241 + */ + private function _http_parse_headers( $header ) { + $retVal = array(); + $fields = explode("\r\n", preg_replace('/\x0D\x0A[\x09\x20]+/', ' ', $header)); + foreach( $fields as $field ) { + if( preg_match('/([^:]+): (.+)/m', $field, $match) ) { + $match[1] = preg_replace('/(?<=^|[\x09\x20\x2D])./e', 'strtoupper("\0")', strtolower(trim($match[1]))); + if( isset($retVal[$match[1]]) ) { + $retVal[$match[1]] = array($retVal[$match[1]], $match[2]); + } else { + $retVal[$match[1]] = trim($match[2]); + } + } + } + return $retVal; + } + + /** + * HTTP GET + */ + function http_get($uri, $data = array()) { + $data = (is_array($data)) ? http_build_query($data) : $data; + if (!empty($data)) { + $uri .= "?$data"; + } + return $this->http_request('GET', $uri); + } + + /** + * HTTP PUT + */ + function http_put($uri, $data = array()) { + return $this->http_request('PUT', $uri, $data); + } + + /** + * HTTP DELETE + */ + function http_delete($uri, $data = array()) { + return $this->http_request('DELETE', $uri, $data); + } + + /** + * Generic implementation of a HTTP Request. + * + * @param $http_method + * @param $uri + * @param array $data + * @return + * an array containing json and decoded versions of the response. + */ + private function http_request($http_method, $uri, $data = array()) { + $data = (is_array($data)) ? http_build_query($data) : $data; + + if (!empty($data)) { + curl_setopt($this->curl, CURLOPT_HTTPHEADER, array('Content-Length: ' . strlen($data))); + curl_setopt($this->curl, CURLOPT_POSTFIELDS, $data); + } + + curl_setopt($this->curl, CURLOPT_URL, $this->get_full_url($uri)); + curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, $http_method); + + $response = curl_exec($this->curl); + $response_decoded = $this->decode_response($response); + $response = array('json' => $response, 'decoded'=>$response_decoded); + + $this->check_status($response,$uri); + + return $response; + } + + /** + * Check http status for safe return codes + * + * @throws SetteeRestClientException + */ + private function check_status($response,$uri) { + $resp_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE); + + if ($resp_code < 199 || $resp_code > 399 || !empty($response['decoded']->error)) { + $msg = "CouchDB returned: \"HTTP 1.1. $resp_code\". ERROR: " . $response['json'] . $uri; + throw new SetteeRestClientException($msg); + } + } + + /** + * @param $path + * Full path to a file (e.g. as returned by PHP's realpath function). + * @return void + */ + public function file_mime_type ($path) { + $ftype = 'application/octet-stream'; + + if (function_exists("finfo_file")) { + $finfo = new finfo(FILEINFO_MIME_TYPE | FILEINFO_SYMLINK); + $fres = $finfo->file($path); + if (is_string($fres) && !empty($fres)) { + $ftype = $fres; + } + } + + return $ftype; + } + + /** + * @param $content + * content of a file in a string buffer format. + * @return void + */ + public function content_mime_type ($content) { + $ftype = 'application/octet-stream'; + + if (function_exists("finfo_file")) { + $finfo = new finfo(FILEINFO_MIME_TYPE | FILEINFO_SYMLINK); + $fres = $finfo->buffer($content); + if (is_string($fres) && !empty($fres)) { + $ftype = $fres; + } + } + + return $ftype; + } + + + /** + * + * @param $json + * json-encoded response from CouchDB + * + * @return + * decoded PHP object + */ + private function decode_response($json) { + return json_decode($json); + } + + /** + * Get full URL from a partial one + */ + private function get_full_url($uri) { + // We do not want "/", "?", "&" and "=" separators to be encoded!!! + $uri = str_replace(array('%2F', '%3F', '%3D', '%26'), array('/', '?', '=', '&'), urlencode($uri)); + return $this->base_url . '/' . $uri; + } +} + +class SetteeRestClientException extends Exception {} --- /dev/null +++ b/couchdb/settee/src/classes/SetteeServer.class.php @@ -1,1 +1,106 @@ +conn_url = rtrim($conn_url, ' /'); + $this->rest_client = SetteeRestClient::get_instance($this->conn_url); + } + + /** + * Create database + * + * @param $db + * Either a database object or a String name of the database. + * + * @return + * json string from the server. + * + * @throws SetteeCreateDatabaseException + */ + function create_db($db) { + if ($db instanceof SetteeDatabase) { + $db = $db->get_name(); + } + $ret = $this->rest_client->http_put($db); + if (!empty($ret['decoded']->error)) { + throw new SetteeDatabaseException("Could not create database: " . $ret["json"]); + } + return $ret['decoded']; + } + + /** + * Drop database + * + * @param $db + * Either a database object or a String name of the database. + * + * @return + * json string from the server. + * + * @throws SetteeDropDatabaseException + */ + function drop_db($db) { + if ($db instanceof SetteeDatabase) { + $db = $db->get_name(); + } + $ret = $this->rest_client->http_delete($db); + if (!empty($ret['decoded']->error)) { + throw new SetteeDatabaseException("Could not create database: " . $ret["json"]); + } + return $ret['decoded']; + } + + /** + * Instantiate a database object + * + * @param $dbname + * name of the newly created database + * + * @return SetteeDatabase + * new SetteeDatabase instance. + */ + function get_db($dbname) { + return new SetteeDatabase($this->conn_url, $dbname); + } + + + /** + * Return an array containing all databases + * + * @return Array + * an array of database names in the CouchDB instance + */ + function list_dbs() { + $ret = $this->rest_client->http_get('_all_dbs'); + if (!empty($ret['decoded']["error"])) { + throw new SetteeDatabaseException("Could not get list of databases: " . $ret["json"]); + } + return $ret['decoded']; + } + +} + +class SetteeServerErrorException extends Exception {} +class SetteeDatabaseException extends Exception {} +class SetteeWrongInputException extends Exception {} --- /dev/null +++ b/couchdb/settee/src/settee.php @@ -1,1 +1,6 @@ + sudo upgrade pear + > sudo pear channel-discover pear.phpunit.de + > sudo pear install phpunit/PHPUnit +2. You need PHP 5.3.2 or later to run some tests that deal with private or protected methods. If you use an earlier + version of PHP, these tests will be skipped. + +3. Run all tests with: + > phpunit . --- /dev/null +++ b/couchdb/settee/tests/SetteeDatabaseTest.php @@ -1,1 +1,281 @@ - +db = $this->server->get_db($dbname); + $this->server->create_db($this->db); + } + + public function test_document_lifecycle_objectbased() { + $doc = new StdClass(); + $doc->firstName = "Irakli"; + $doc->lastName = "Nadareishvili"; + $doc->IQ = 200; + $doc->hobbies = array("skiing", "swimming"); + $doc->pets = array ("whitey" => "labrador", "mikey" => "pug"); + + $doc = $this->db->save($doc); + $this->assertTrue(!empty($doc->_id) && !empty($doc->_rev), "Document creation success [object-based]"); + + $_rev = $doc->_rev; + $doc = $this->db->get($doc->_id); + $this->assertEquals($_rev, $doc->_rev, "Document retrieval success [object-based] test"); + + $doc->firstName = "Ika"; + $db_doc = $this->db->save($doc); + $this->assertEquals($doc->firstName, $db_doc->firstName, "Document update success [object-based]"); + + $this->db->delete($doc); + + + try { + $doc = $this->db->get($doc->_id); + } catch (SetteeRestClientException $e) { + // we expect exception to fire, so this is good. + return; + } + + $this->fail('Document still available for retrieval after being deleted. [object-based]'); + } + + // Should work with json string as well: + // + + + public function test_document_lifecycle_jsonbased() { + $doc = '{"firstName":"Irakli","lastName":"Nadareishvili","IQ":200,"hobbies":["skiing","swimming"],"pets":{"whitey":"labrador","mikey":"pug"}}'; + + $doc = $this->db->save($doc); + $this->assertTrue(!empty($doc->_id) && !empty($doc->_rev), "Document creation success [json-based]"); + + $_rev = $doc->_rev; + + $db_doc = $this->db->get($doc->_id); + $this->assertEquals($_rev, $db_doc->_rev, "Document retrieval success [json-based] test"); + + $doc = '{'; + $doc .= '"_id":"' . $db_doc->_id . '",'; + $doc .= '"_rev":"' . $db_doc->_rev . '",'; + $doc .= '"firstName":"Ika","lastName":"Nadareishvili","IQ":200,"hobbies":["skiing","swimming"],"pets":{"whitey":"labrador","mikey":"pug"}}'; + + $orig_doc = json_decode($doc); + $db_doc = $this->db->save($doc); + $this->assertEquals($orig_doc->firstName, $db_doc->firstName, "Document update success [json-based]"); + + $doc = '{'; + $doc .= '"_id":"' . $db_doc->_id . '",'; + $doc .= '"_rev":"' . $db_doc->_rev . '",'; + $doc .= '"firstName":"Ika","lastName":"Nadareishvili","IQ":200,"hobbies":["skiing","swimming"],"pets":{"whitey":"labrador","mikey":"pug"}}'; + + $this->db->delete($doc); + + try { + $doc = $this->db->get($db_doc->_id); + } catch (SetteeRestClientException $e) { + // we expect exception to fire, so this is good. + return; + } + + $this->fail('Document still available for retrieval after being deleted. [object-based]'); + } + + public function test_invalid_document() { + $doc = 12345; + try { + $doc = $this->db->save($doc); + } catch (SetteeRestClientException $e) { + // we expect exception to fire, so this is good. + return; + } + + $this->fail('Document saved with invalid format'); + } + + public function test_get_rev() { + $doc = new stdClass(); + $doc->_id = "some_fixed_id"; + $doc = $this->db->save($doc); + + $_rev = $doc->_rev; + + $db_rev = $this->db->get_rev($doc->_id); + $this->assertEquals($_rev, $db_rev, "Document Revision retrieval success"); + + // _rev is now attached to this object due to last ->save() call + $doc->_id = "some_fixed_id"; + $doc->title = "Some Fixed ID"; + $doc = $this->db->save($doc); + + $_rev = $doc->_rev; + + $db_rev = $this->db->get_rev($doc->_id); + $this->assertEquals($_rev, $db_rev, "Document Revision retrieval success after re-save"); + + } + + public function test_save_auto_revision_detection() { + $doc = new stdClass(); + $doc->_id = "some_fixed_id"; + $this->db->save($doc); + + $doc = new stdClass(); + $doc->_id = "some_fixed_id"; + $doc->extra_field = "some other value"; + + $new_doc = $this->db->save($doc, true); + $this->assertEquals ($new_doc->extra_field, "some other value", "Testing auto-rev detection by save method"); + } + + public function test_inline_attachment_json() { + $doc = '{ + "_id":"attachment_doc", + "_attachments": + { + "foo.txt": + { + "content_type":"text\/plain", + "data": "VGhpcyBpcyBhIGJhc2U2NCBlbmNvZGVkIHRleHQ=" + } + } + }'; + $db_doc = $this->db->save($doc); + $this->assertTrue(is_object($db_doc->_attachments), "Inline attachment save successful [json-based]"); + } + + public function test_inline_attachment_obj_content() { + $doc = new stdClass(); + $doc->_id = "attachment_doc"; + $this->db->add_attachment($doc, "foo.txt", "This is some text to be encoded", "text/plain"); + $db_doc = $this->db->save($doc); + $this->assertTrue(is_object($db_doc->_attachments), "Inline attachment save successful [object-based]"); + + $doc = new stdClass(); + $doc->_id = "attachment_doc_autodetect"; + $this->db->add_attachment($doc, "foo.txt", "This is some other text to be encoded"); + $db_doc = $this->db->save($doc); + $this->assertTrue(is_object($db_doc->_attachments), "Inline attachment save successful [object-based, mime auto-detection]"); + } + + public function test_inline_attachment_obj_file() { + $doc = new stdClass(); + $doc->_id = "attachment_doc"; + $file_path = dirname(__FILE__) . "/resources/couch-logo.pdf"; + $this->db->add_attachment_file($doc, "foo.pdf", $file_path, "application/pdf"); + $db_doc = $this->db->save($doc); + $this->assertTrue(is_object($db_doc->_attachments), "Inline attachment of file successful"); + + $doc = new stdClass(); + $doc->_id = "attachment_doc_autodetect"; + $file_path = dirname(__FILE__) . "/resources/couch-logo.pdf"; + $this->db->add_attachment_file($doc, "foo.pdf", $file_path); + $db_doc = $this->db->save($doc); + $this->assertTrue(is_object($db_doc->_attachments), "Inline attachment of file successful w/ mime type auto-detection"); + } + + public function test_view_lifecycle() { + $this->_create_some_sample_docs(); + + $map_src = <<db->save_view("foo_views", "bar_view", $map_src); + $this->assertEquals("_design/foo_views", $view->_id, "View Creation Success"); + + $view = $this->db->get_view("foo_views", "bar_view"); + $this->assertEquals(3, $view->total_rows, "Running a View Success"); + + $map_src = <<db->save_view("foo_views", "bar_view", $map_src); + $this->assertEquals("_design/foo_views", $view->_id, "View Update Success"); + + $view = $this->db->get_view("foo_views", "bar_view"); + $this->assertEquals("Well hello and welcome to my new blog...", $view->rows[0]->value->body, "Running a View Success (after update)"); + + $view = $this->db->get_view("foo_views", "bar_view", "2009/02/17 21:13:39"); + $this->assertEquals("Bought a Cat", $view->rows[0]->value->title, "Running a Parametrized View"); + + $view = $this->db->get_view("foo_views", "bar_view", array("2009/01/30 18:04:11", "2009/02/17 21:13:39")); + $this->assertEquals("Biking", $view->rows[0]->value->title, "Running a Parametrized View with range"); + + $view = $this->db->get_view("foo_views", "bar_view", array("2009/02/17 21:13:39", "2009/01/30 18:04:11"), true); + $this->assertEquals("Bought a Cat", $view->rows[0]->value->title, "Running a Parametrized View with range, descending"); + $this->assertEquals(2, count($view->rows), "Running a Parametrized View with range, descending [count]"); + +} + + function test_two_views_in_a_design_doc() { + + $map_src = <<db->save_view("a_settee_design_doc", "foo_view", $map_src); + $this->assertTrue(isset($view->views->foo_view), "View1 Creation Success"); + + $view = $this->db->save_view("a_settee_design_doc", "bar_view", $map_src); + $this->assertTrue(isset($view->views->bar_view), "View2 Creation Success"); + } + + /** + * Create some sample docs for running tests on them. + * + *

This sample was taken from a wonderful book: + * CouchDB: The Definitive Guide (Animal Guide) by J. Chris Anderson, Jan Lehnardt and Noah Slater + * http://www.amazon.com/CouchDB-Definitive-Guide-Relax-Animal/dp/0596155891/ref=sr_1_1?ie=UTF8&qid=1311533443&sr=8-1 + * + * @return void + */ + private function _create_some_sample_docs() { + $doc = new stdClass(); + $doc->_id = "biking"; + $doc->title = "Biking"; + $doc->body = "My biggest hobby is mountainbiking"; + $doc->date = "2009/01/30 18:04:11"; + $this->db->save($doc); + + $doc = new stdClass(); + $doc->_id = "bought-a-cat"; + $doc->title = "Bought a Cat"; + $doc->body = "I went to the the pet store earlier and brought home a little kitty..."; + $doc->date = "2009/02/17 21:13:39"; + $this->db->save($doc); + + $doc = new stdClass(); + $doc->_id = "hello-world"; + $doc->title = "Hello World"; + $doc->body = "Well hello and welcome to my new blog..."; + $doc->date = "2009/01/15 15:52:20"; + $this->db->save($doc); + } + + public function tearDown() { + $ret = $this->server->drop_db($this->db); + } + +} + + --- /dev/null +++ b/couchdb/settee/tests/SetteeRestClientTest.php @@ -1,1 +1,90 @@ +rest_client = SetteeRestClient::get_instance($this->db_url); + } + + public function test_get_full_url() { + + //-- Can't run this test in PHP versions earlier than 5.3.2, which do not support ReflectionMethod class. + if (!class_exists('ReflectionMethod')) { + return; + } + + //-- Prepare for testing the private full_url_method method. + $get_full_url_method = new ReflectionMethod('SetteeRestClient', 'get_full_url'); + $get_full_url_method->setAccessible(TRUE); + + $uri = 'irakli/26cede9ab9cd8fcd67895eb05200d1ea'; + //-- Equivalent to: $calc = $this->rest_client->get_full_url($uri); but for a private method. + $calc = $get_full_url_method->invokeArgs($this->rest_client, array($uri)); + //-- + $expected = $this->db_url . '/irakli/26cede9ab9cd8fcd67895eb05200d1ea'; + $this->assertEquals($expected, $calc, "Full URL Generation with DB and ID"); + + $uri = 'irakli/26cede9ab9cd8fcd67895eb05200d1ea?rev=2-21587f7dffc43b4100f40168f309a267'; + $calc = $get_full_url_method->invokeArgs($this->rest_client, array($uri)); + $expected = $this->db_url . '/irakli/26cede9ab9cd8fcd67895eb05200d1ea?rev=2-21587f7dffc43b4100f40168f309a267'; + $this->assertEquals($expected, $calc, "Full URL Generation with DB, ID and Single Query Parameter"); + + $uri = 'irakli/26cede9ab9cd8fcd67895eb05200d1ea?rev=2-21587f7dffc43b4100f40168f309a267&second=foo'; + $calc = $get_full_url_method->invokeArgs($this->rest_client, array($uri)); + $expected = $this->db_url . '/irakli/26cede9ab9cd8fcd67895eb05200d1ea?rev=2-21587f7dffc43b4100f40168f309a267&second=foo'; + $this->assertEquals($expected, $calc, "Full URL Generation with DB, ID and Two Query Parameters"); + + } + + public function test_file_mime_type() { + + $type = $this->rest_client->file_mime_type(dirname(__FILE__) . "/resources/couch-logo.jpg"); + $this->assertEquals("image/jpeg", $type, "Jpeg Mime Type Detection"); + + $type = $this->rest_client->file_mime_type(dirname(__FILE__) . "/resources/couch-logo.pdf"); + $this->assertEquals("application/pdf", $type, "PDF Mime Type Detection"); + + + $type = $this->rest_client->file_mime_type(dirname(__FILE__) . "/resources/couch-logo.png"); + $this->assertEquals("image/png", $type, "PNG Mime Type Detection"); + + $type = $this->rest_client->file_mime_type(dirname(__FILE__) . "/resources/couch-tag.ini"); + $this->assertEquals("text/plain", $type, "Text Mime Type Detection"); + + $type = $this->rest_client->file_mime_type(dirname(__FILE__) . "/resources/couch-tag.xml"); + $this->assertEquals("application/xml", $type, "XML Mime Type Detection"); + } + + public function test_content_mime_type() { + $content = file_get_contents(dirname(__FILE__) . "/resources/couch-logo.jpg"); + $type = $this->rest_client->content_mime_type($content); + $this->assertEquals("image/jpeg", $type, "Jpeg Mime Type Detection"); + + $content = file_get_contents(dirname(__FILE__) . "/resources/couch-logo.pdf"); + $type = $this->rest_client->content_mime_type($content); + $this->assertEquals("application/pdf", $type, "PDF Mime Type Detection"); + + $content = file_get_contents(dirname(__FILE__) . "/resources/couch-logo.png"); + $type = $this->rest_client->content_mime_type($content); + $this->assertEquals("image/png", $type, "PNG Mime Type Detection"); + + $content = file_get_contents(dirname(__FILE__) . "/res