Merge branch 'develop'

* develop:
  update labels for search
  bump npm version and update README
  update help text for in node
  add query by document id to in node
  cleanning code
  sending query result via payload

Author: lgfa29

77-cloudant-cf.html

@@ -157,7 +157,15 @@
     </div>
 
     <div class="form-row">
-        <label for="node-input-design-doc"><i class="fa fa-search"></i> Search Idx.</label>
+        <label for="node-input-search"><i class="fa fa-search"></i> Search by</label>
+        <select id="node-input-search">
+            <option value="_id_">_id</option>
+            <option value="_idx_">search index</option>
+        </select>
+    </div>
+
+    <div id="node-search-index-form" class="form-row">
+        <label>&nbsp;</label>
         <input type="text" id="node-input-design" style="width: 30%" placeholder="design document">
         /
         <input type="text" id="node-input-index" style="width: 30%" placeholder="index name">
@@ -169,10 +177,10 @@
     </div>
 
     <script>
-        $("#node-input-operation").change(function() {
-            var id = $("#node-input-operation option:selected").val();
-            if (id == "delete") $(".node-input-payonly").hide();
-            else $(".node-input-payonly").show();
+        $("#node-input-search").change(function() {
+            var searchType = $("#node-input-search option:selected").val();
+            if (searchType == "_id_") $("#node-search-index-form").hide();
+            else $("#node-search-index-form").show();
         });
     </script>
 </script>
@@ -208,6 +216,7 @@
             cloudant: { type: "cloudant", validate: validateServer },
             name    : { value: "" },
             database: { value: "", required: true },
+            search  : { value: "_id_", required: true },
             design  : { value: "", required: true },
             index   : { value: "", required: true }
         },
@@ -292,11 +301,22 @@
 
 <script type="text/x-red" data-help-name="cloudant in">
    <p>
-        A node for searching a Cloudant database using a Search Index.
+        A node for searching documents in a Cloudant database.
+    </p>
+    <p>
+        Searching for a document can be done in two modes: directly by using the
+        document <b>_id</b> or by using an existing <a
+        href="https://cloudant.com/for-developers/search/" target="_blank">Search
+        Index</a>.
+    </p>
+    <p>
+        When querying using the <b>_id</b> option, the <code>_id</code> should be
+        passed in the <code>msg.payload</code> as a string.
     </p>
     <p>
-        Query is performed on existing <b>Search Indexes</b> stored on the desired
-        database. The query argument should be passed on the <code>msg.payload</code>
-        following the <code>indexName:value</code> pattern.
+        To use an existing <b>Search Index</b> stored on the desired database, the
+        query argument should be passed on the <code>msg.payload</code> following
+        the <code>indexName:value</code> pattern. The index must be created beforehand
+        on the database.
     </p>
 </script>

77-cloudant-cf.js

@@ -212,11 +212,12 @@ module.exports = function(RED) {
     function CloudantInNode(n) {
         RED.nodes.createNode(this,n);
 
-        this.design   = n.design;
-        this.index    = n.index;
-        this.database = n.database;
         this.cloudant = n.cloudant;
         this.url      = _getUrl(this, n);
+        this.database = n.database;
+        this.search   = n.search;
+        this.design   = n.design;
+        this.index    = n.index;
 
         if (this.url) {
             var node = this;
@@ -225,17 +226,24 @@ module.exports = function(RED) {
             var db   = nano.use(node.database);
 
             node.on("input", function(msg) {
-                var query = { q: msg.payload };
-
-                db.search(node.design, node.index, query, function(err, doc) {
-                    if (!err) {
-                        node.send(doc);
-                    } else {
-                        node.error(err);
-                    }
-                });
+                if (node.search === "_id_") {
+                    var id = msg.payload;
+                    db.get(id, sendDocumentOnPayload);
+                }
+                else if (node.search === "_idx_") {
+                    var query = { q: msg.payload };
+                    db.search(node.design, node.index, query, sendDocumentOnPayload);
+                }
             });
         }
+
+        function sendDocumentOnPayload(err, body) {
+            if (!err) {
+                node.send({ payload: body });
+            } else {
+                node.error(err);
+            }
+        }
     }
     RED.nodes.registerType("cloudant in", CloudantInNode);
 

README.md

@@ -1,6 +1,6 @@
 node-red-node-cf-cloudant
 =========================
-A [Node-RED](http://nodered.org) node to `insert`, `update` and `delete` documents
+A pair of [Node-RED](http://nodered.org) nodes to work with documents
 in a [Cloudant](http://cloudant.com) database that is integrated with
 [IBM Bluemix](http://bluemix.net).
 
@@ -13,13 +13,20 @@ npm install node-red-node-cf-cloudant
 
 Usage
 -----
-Allows basic access to a [Cloudant](http://cloudant.com) database. Currently
-it only have one node that supports `insert`, `update` and `delete`
-operations.
+Allows basic access to a [Cloudant](http://cloudant.com) database to
+`insert`, `update`, `delete` and `search` for documents.
 
 To **insert** a new document into the database you have the option to store
 the entire `msg` object or just the `msg.payload`. If the input value is not
 in JSON format, it will be transformed before being stored.
 
 For **update** and **delete**, you must pass the `_id` and the `_rev`as part
 of the input `msg` object.
+
+To **search** for a document you have two options: get a document directly by
+its `_id` or use an existing [search index](https://cloudant.com/for-developers/search/)
+from the database. For both cases, the query should be passed in the
+`msg.payload` input object as a string.
+
+When getting documents by id, the `payload` will be the desired `_id` value.
+For `search indexes`, the query should follow the format `indexName:value`.

package.json

@@ -1,6 +1,6 @@
 {
     "name"         : "node-red-node-cf-cloudant",
-    "version"      : "0.2.0",
+    "version"      : "0.2.1",
     "description"  : "A Node-RED node to write to a Cloudant database on Bluemix",
     "dependencies" : {
         "nano" : "5.10.0"