Merge branch 'develop'

lgfa29 · lgfa29 · commit 5e7cd923afa1 · 2015-05-20T04:05:00.000-03:00
* develop:
  improve error handling and allow use of api key/password
  clean database name and fix fields that start with _ in the document
diff --git a/77-cloudant-cf.html b/77-cloudant-cf.html
@@ -16,9 +16,9 @@
 
 <script type="text/x-red" data-template-name="cloudant">
     <div class="form-row">
-        <label for="node-config-input-hostname"><i class="fa fa-bookmark"></i> Host</label>
-        <input class="input-append-left" type="text" id="node-config-input-hostname"
-               placeholder="https://[username].cloudant.com">
+        <label for="node-config-input-host"><i class="fa fa-bookmark"></i> Host</label>
+        <input class="input-append-left" type="text" id="node-config-input-host"
+               placeholder="[username].cloudant.com">
     </div>
 
     <div class="form-row">
@@ -42,13 +42,13 @@
         category: "config",
         color: "rgb(114, 199, 231)",
         defaults: {
-            hostname: { value: "", required: true },
+            host: { value: "", required: true },
             name: { value: "" },
             //user -> credentials
             //pass -> credentials
         },
         label: function() {
-            return this.name || this.hostname;
+            return this.name || this.host;
         },
         oneditprepare: function() {
             $.getJSON("cloudant/"+this.id, function(data) {
@@ -186,7 +186,7 @@
             service: { value: "", required: true },
             cloudant: { type: "cloudant", validate: validateServer},
             name: { value: "" },
-            database: { value: "", required: true },
+            database: { value: "", required: true, validate: validateDatabase },
             payonly: { value: false },
             operation: { value: "insert" }
         },
@@ -208,7 +208,7 @@
             service : { value: "", required: true },
             cloudant: { type: "cloudant", validate: validateServer },
             name    : { value: "" },
-            database: { value: "", required: true },
+            database: { value: "", required: true, validate: validateDatabase },
             search  : { value: "_id_", required: true },
             design  : { value: "" },
             index   : { value: "" }
@@ -286,6 +286,12 @@
     function validateServer(v) {
         return this.service != "_ext_" || v != "_ADD_";
     }
+
+    // https://wiki.apache.org/couchdb/HTTP_database_API#Naming_and_Addressing
+    function validateDatabase(v) {
+        return (v.indexOf('_') !== 0) &&
+               (v.search(/[A-Z\s\\/]/g) < 0)
+    }
 </script>
 
 <script type="text/x-red" data-help-name="cloudant out">
@@ -307,11 +313,25 @@
     </p>
     <p>
         It is also possible to <b>delete</b> documents from the database by
-        providing values for <code>_id</b> and <code>_rev</code> and selecting
+        providing values for <code>_id</code> and <code>_rev</code> and selecting
         the <b>remove</b> option for the node. You can pass these values in the
         <code>msg</code> object itself or as an object in the
         <code>msg.payload</code>.
     </p>
+    <p>
+        The <b>database name</b> must follow these rules:
+        <ul>
+            <li>No spaces</li>
+            <li>All letters in small caps</li>
+            <li>The first character can't be <code>_</code></li>
+        </ul>
+    </p>
+    <p>
+        Your document should avoid having top-level fields that start with
+        <code>_</code>, with exceptions for <code>_id</code>, <code>_rev</code>
+        and other <a href="https://wiki.apache.org/couchdb/HTTP_Document_API#Special_Fields">
+        CouchDB reserved words</a>.
+    </p>
 </script>
 
 <script type="text/x-red" data-help-name="cloudant in">
@@ -338,15 +358,29 @@
     </p>
     <p>
         When querying using a <b>Search Index</b> you can pass the search
-        parameters as an object in <code>msg.payload</code>. For example, you
-        can pass an object like this: <code>{ query: "abc*", limit: 100 }</code>
+        parameters as an object in <code>msg.payload</code>.
+    </p>
+    <p>
+        For example, you can pass an object like this:
+    <p>
+        <code>{ query: "abc*", limit: 100 }</code>
+    </p>
+    <p>
         to change the value of <code>limit</code>. You can find more information
-        on the accepted parameters in the <a
+        about <b>Search Index</b> parameters in the <a
         href="https://docs.cloudant.com/api.html?http#queries" target="_blank">
         official Cloudant documentation</a>.
     </p>
     <p>
         The last method to retrieve documents is to simply get all of them by
         selecting the option <b>all documents</b>.
     </p>
+    <p>
+        The <b>database name</b> must follow these rules:
+        <ul>
+            <li>No spaces</li>
+            <li>All letters in small caps</li>
+            <li>The first character can't be <code>_</code></li>
+        </ul>
+    </p>
 </script>
diff --git a/77-cloudant-cf.js b/77-cloudant-cf.js
@@ -90,24 +90,23 @@ module.exports = function(RED) {
     function CloudantNode(n) {
         RED.nodes.createNode(this, n);
 
-        this.name     = n.name;
-        this.hostname = n.hostname;
+        this.name = n.name;
+        this.host = n.host;
+
+        // remove unnecessary parts from host value
+        var parsedUrl = url.parse(this.host);
+        if (parsedUrl.host) {
+            this.host = parsedUrl.host;
+        }
+
+        // extract only the account name
+        this.account = this.host.substring(0, this.host.indexOf('.'));
 
         var credentials = RED.nodes.getCredentials(n.id);
         if (credentials) {
             this.username = credentials.username;
             this.password = credentials.password;
         }
-
-        var parsedUrl = url.parse(this.hostname);
-        var authUrl   = parsedUrl.protocol+'//';
-
-        if (this.username && this.password) {
-            authUrl += this.username + ":" + encodeURIComponent(this.password) + "@";
-        }
-        authUrl += parsedUrl.hostname;
-
-        this.url = authUrl;
     }
     RED.nodes.registerType("cloudant", CloudantNode);
 
@@ -116,17 +115,18 @@ module.exports = function(RED) {
 
         this.operation      = n.operation;
         this.payonly        = n.payonly || false;
-        this.database       = n.database;
+        this.database       = _cleanDatabaseName(n.database, this);
         this.cloudantConfig = _getCloudantConfig(n);
 
         var node = this;
         var credentials = {
-            account:  node.cloudantConfig.credentials.username,
-            password: node.cloudantConfig.credentials.password
+            account:  node.cloudantConfig.account,
+            key:      node.cloudantConfig.username,
+            password: node.cloudantConfig.password
         };
 
         Cloudant(credentials, function(err, cloudant) {
-            if (err) { node.error(err); }
+            if (err) { node.error(err.description, err); }
             else {
                 // check if the database exists and create it if it doesn't
                 createDatabase(cloudant, node);
@@ -139,10 +139,24 @@ module.exports = function(RED) {
 
         function createDatabase(cloudant, node) {
             cloudant.db.list(function(err, all_dbs) {
-                if (err) { node.error(err); }
+                if (err) {
+                    if (err.error !== 'forbidden') {
+                        // if err.error is 'forbidden' then we are using an api
+                        // key, so we can assume the database already exists
+                        return;
+                    }
+                    node.error("Failed to list databases: " + err.description, err);
+                }
                 else {
                     if (all_dbs && all_dbs.indexOf(node.database) < 0) {
-                        cloudant.db.create(node.database);
+                        cloudant.db.create(node.database, function(err, body) {
+                            if (err) {
+                                node.error(
+                                    "Failed to create database: " + err.description,
+                                    err
+                                );
+                            }
+                        });
                     }
                 }
             });
@@ -155,7 +169,12 @@ module.exports = function(RED) {
                 var doc  = parseMessage(msg, root);
 
                 insertDocument(cloudant, node, doc, MAX_ATTEMPTS, function(err, body) {
-                    if (err) { node.error(err); }
+                    if (err) {
+                        node.error(
+                            "Failed to insert document: " + err.description,
+                            err
+                        );
+                    }
                 });
             }
             else if (node.operation === "delete") {
@@ -164,10 +183,16 @@ module.exports = function(RED) {
                 if ("_rev" in doc && "_id" in doc) {
                     var db = cloudant.use(node.database);
                     db.destroy(doc._id, doc._rev, function(err, body) {
-                        if (err) { node.error(err); }
+                        if (err) {
+                            node.error(
+                                "Failed to delete document: " + err.description,
+                                err
+                            );
+                        }
                     });
                 } else {
-                    node.error("_rev and _id are required to delete a document");
+                    var err = new Error("_id and _rev are required to delete a document");
+                    node.error(err.message, err);
                 }
             }
         }
@@ -187,9 +212,36 @@ module.exports = function(RED) {
                     msg = JSON.parse('{"' + root + '":"' + msg + '"}');
                 }
             }
+            return cleanMessage(msg);
+        }
+
+        // fix field values that start with _
+        // https://wiki.apache.org/couchdb/HTTP_Document_API#Special_Fields
+        function cleanMessage(msg) {
+            for (var key in msg) {
+                if (msg.hasOwnProperty(key) && !isFieldNameValid(key)) {
+                    // remove _ from the start of the field name
+                    var newKey = key.substring(1, msg.length);
+
+                    msg[newKey] = msg[key];
+                    delete msg[key];
+
+                    node.warn("Property '" + key + "' renamed to '" + newKey + "'.");
+                }
+            }
+
             return msg;
         }
 
+        function isFieldNameValid(key) {
+            var allowedWords = [
+                '_id', '_rev', '_attachments', '_deleted', '_revisions',
+                '_revs_info', '_conflicts', '_deleted_conflicts', '_local_seq'
+            ];
+
+            return key[0] !== '_' || allowedWords.indexOf(key) >= 0;
+        }
+
         // Inserts a document +doc+ in a database +db+ that migh not exist
         // beforehand. If the database doesn't exist, it will create one
         // with the name specified in +db+. To prevent loops, it only tries
@@ -214,20 +266,21 @@ module.exports = function(RED) {
         RED.nodes.createNode(this,n);
 
         this.cloudantConfig = _getCloudantConfig(n);
-        this.database       = n.database;
+        this.database       = _cleanDatabaseName(n.database, this);
         this.search         = n.search;
         this.design         = n.design;
         this.index          = n.index;
         this.inputId        = "";
 
         var node = this;
         var credentials = {
-            account:  node.cloudantConfig.credentials.username,
-            password: node.cloudantConfig.credentials.password
+            account:  node.cloudantConfig.account,
+            key:      node.cloudantConfig.username,
+            password: node.cloudantConfig.password
         };
 
         Cloudant(credentials, function(err, cloudant) {
-            if (err) { node.error(err); }
+            if (err) { node.error(err.description, err); }
             else {
                 node.on("input", function(msg) {
                     var db = cloudant.use(node.database);
@@ -245,7 +298,7 @@ module.exports = function(RED) {
                         options.query = options.query || options.q || formatSearchQuery(msg.payload);
                         options.include_docs = options.include_docs || true;
                         options.limit = options.limit || 200;
-                        
+
                         if (options.sort) {
                             options.sort = JSON.stringify(options.sort);
                         }
@@ -312,10 +365,13 @@ module.exports = function(RED) {
                 msg.payload = null;
 
                 if (err.description === "missing") {
-                    node.warn("Document '" + node.inputId + "' not found in database '" +
-                                node.database + "'.");
+                    node.warn(
+                        "Document '" + node.inputId +
+                        "' not found in database '" + node.database + "'.",
+                        err
+                    );
                 } else {
-                    node.error(err.reason);
+                    node.error(err.description, err);
                 }
             }
 
@@ -324,11 +380,42 @@ module.exports = function(RED) {
     }
     RED.nodes.registerType("cloudant in", CloudantInNode);
 
+    // must return an object with, at least, values for account, username and
+    // password for the Cloudant service at the top-level of the object
     function _getCloudantConfig(n) {
         if (n.service === "_ext_") {
             return RED.nodes.getNode(n.cloudant);
+
         } else if (n.service !== "") {
-            return appEnv.getService(n.service);
+            var service        = appEnv.getService(n.service);
+            var cloudantConfig = { };
+
+            var host = service.credentials.host;
+
+            cloudantConfig.username = service.credentials.username;
+            cloudantConfig.password = service.credentials.password;
+            cloudantConfig.account  = host.substring(0, host.indexOf('.'));
+
+            return cloudantConfig;
+        }
+    }
+
+    // remove invalid characters from the database name
+    // https://wiki.apache.org/couchdb/HTTP_database_API#Naming_and_Addressing
+    function _cleanDatabaseName(database, node) {
+        var newDatabase = database;
+
+        // caps are not allowed
+        newDatabase = newDatabase.toLowerCase();
+        // remove trailing underscore
+        newDatabase = newDatabase.replace(/^_/, '');
+        // remove spaces and slashed
+        newDatabase = newDatabase.replace(/[\s\\/]+/g, '-');
+
+        if (newDatabase !== database) {
+            node.warn("Database renamed  as '" + newDatabase + "'.");
         }
+
+        return newDatabase;
     }
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name"         : "node-red-node-cf-cloudant",
-    "version"      : "0.2.12",
+    "version"      : "0.2.13",
     "description"  : "A Node-RED node to access a Cloudant database on Bluemix",
     "dependencies" : {
         "cfenv"   : "1.0.0",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name" : "node-red-node-cf-cloudant",`
`3`		`- "version" : "0.2.12",`
	`3`	`+ "version" : "0.2.13",`
`4`	`4`	`"description" : "A Node-RED node to access a Cloudant database on Bluemix",`
`5`	`5`	`"dependencies" : {`
`6`	`6`	`"cfenv" : "1.0.0",`