node-couch.js

/*
Copyright (c) 2009 Hagen Overdick

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.
*/

var clients = {};

function cache_client(port, host) {
	var key = [port, host];
	var client = clients[key];
	if (client) {
		return client;
	} else {
		return clients[key] = node.http.createClient(port, host);
	}
}

function _interact(verb, path, successStatus, options, port, host) {
	verb = verb.toLowerCase();
	options = options || {};
	var request;
	
	var client = cache_client(port, host);
	var requestPath = path + encodeOptions(options);
	if (CouchDB.debug) {
		node.debug("COUCHING " + requestPath + " -> " + verb);
	}
	
	if (options.body) {
		if (verb === "get") {
			verb = "post";
		}
		var requestBody = toJSON(options.body);
		request = client[verb](requestPath, [["Content-Length", requestBody.length]]);
		request.sendBody(requestBody, "utf8");
	} else {
		request = client[verb](requestPath);
	}
	request.finish(function(response) {
		var responseBody = "";
		response.setBodyEncoding("utf8");
		
		response.addListener("body", function(chunk) {
			responseBody += chunk;
		});
		
		response.addListener("complete", function() {
			responseBody = JSON.parse(responseBody);
			if (response.statusCode === successStatus) {
				if (options.success) {
					options.success(responseBody);
				}
			} else if (options.error) {
				options.error(responseBody);
			}
		});
	});
}

function encodeOptions(options) {
  	var result = [];
  	if (typeof(options) === "object" && options !== null) {
    	for (var name in options) {
			if (options.hasOwnProperty(name)) {
				if (name === "request" || name === "error" || name === "success" || name === "body") {
					continue;
				}
				
				var value = options[name];
	      		
				if (name == "key" || name == "startkey" || name == "endkey") {
	      			value = toJSON(value);
				}
				
		      	result.push(encodeURIComponent(name) + "=" + encodeURIComponent(value));
			}
		}
  	}
  	return result.length ? ("?" + result.join("&")) : "";
}

function toJSON(obj) {
    return obj !== null ? JSON.stringify(obj) : null;
}

var CouchDB = {
	defaultPort : 5984,
	defaultHost : "127.0.0.1",
	debug : true,
	
	activeTasks: function(options) {
		_interact("get", "/_active_tasks", 200, options, CouchDB.defaultPort, CouchDB.defaultHost);
	},
	
	allDbs : function(options) {
		_interact("get", "/_all_dbs", 200, options, CouchDB.defaultPort, CouchDB.defaultHost);	
	},
	
	generateUUIDs : function(options) {
		options = options || {};
		if (!options.count) {
			options.count = 100;
		}
		var callback = options.success;
		options.success = function(result) {
			callback(result.uuids);
		};
		_interact("get", "/_uuids", 200, options, CouchDB.defaultPort, CouchDB.defaultHost);
	},
	
	db : function(name, port, host) {
		return {
			name : name,
			uri  : "/" + encodeURIComponent(name) + "/",
			port : port || CouchDB.defaultPort,
			host : host || CouchDB.defaultHost,

			interact : function(verb, path, successStatus, options, suppressPrefix) {
				if (!suppressPrefix) {
					path = this.uri + path;
				}
				_interact(verb, path, successStatus, options, this.port, this.host);
			},
			
			compact : function(options) {
				this.interact("post", "_compact", 202, options);
			},
			
			create : function(options) {
				this.interact("put", "", 201, options);
			},
			
			drop : function(options) {
				this.interact("del", "", 200, options);
			},
			
			info : function(options) {
				this.interact("get", "", 200, options);				
			},

			allDocs : function(options) {
				this.interact("get", "_all_docs", 200, options);
			},

			openDoc : function(docId, options) {
				var path;
				if (typeof docId === "string") {
					path = docId;				
				} else {
					path = "_all_docs";
					options.body = {
						keys : docId
					};				
				}
				this.interact("get", path, 200, options); // interact will override get to post when needed
			},

			saveDoc : function(doc, options) {
				options = options || {};
				doc = doc || {};
				var success = options.success;
				options.success = function(result) {
					if (!result.ok) {
						options.error(result);
					} else {
						doc._id = result.id;
						doc._rev = result.rev;
					}
					if (success) { success(doc); }
				};

				options.body = doc;

				if (doc._id === undefined) {
					this.interact("post", "", 201, options);
				} else {
					this.interact("put", doc._id, 201, options);
				}
			},

			removeDoc : function(doc, options) {
				options = options || {};
				options.rev = doc._rev;

				var success = options.success;
				options.success = function(result) {
					if (!result.ok) {
						options.error(result);
					}
					delete doc._rev;
					if (success) {
						success(doc);						 
					}
				};

				this.interact("del", doc._id, 200, options);
			},

			view : function(name, options) {
				name = name.split('/');
				this.interact("get", "_design/" + name[0] + "/_view/" + name[1], 200, options);
			}
		}	
	}
};

exports.CouchDB = CouchDB;