stackato-assist

<!DOCTYPE html><html><head><title>index.js</title><meta http-equiv="Content-Type" content="text/html" charset="UTF-8"><link rel="stylesheet" media="all" href="./docco.css"></head><body><div id="container"><div id="background"></div><div id="jump_to">Jump To …<div id="jump_wrapper"><div id="jump_page"><a href="./index.html" class="source">README</a><a href="././index.js.html" class="source selected">. / index.js</a></div></div></div><table cellpadding="0" cellspacing="0"><thead><tr><th class="docs"><h1>index.js</h1><div class="filepath">./</div></th><th class="code"></th></tr></thead><tbody><tr id="section-1"><td class="docs"><div class="pilwrap"><a href="#section-1" class="pilcrow">¶</a></div> </td><td class="code"><div class="highlight"><pre>var mongodb = require('mongodb'); var mysql = require('mysql'); var redis = require("redis"); var pg = require('pg');</pre></div></td></tr><tr id="section-2"><td class="docs"><div class="pilwrap"><a href="#section-2" class="pilcrow">¶</a></div><div class="dox"><div class="summary">Utility functions</div><div class="body"></div></div> </td><td class="code"><div class="highlight"><pre>function has (obj, key) { return Object.prototype.hasOwnProperty.call(obj, key); } var Stackato = function(opts){ this.isStackato = (process.env.STACKATO_APP_NAME) ? true : false;</pre></div></td></tr><tr id="section-3"><td class="docs"><div class="pilwrap"><a href="#section-3" class="pilcrow">¶</a></div>Application environment helpers </td><td class="code"><div class="highlight"><pre> this.port = (process.env.PORT) ? parseInt(process.env.PORT,10) : null; this.host = (process.env.VCAP_APP_HOST) ? process.env.VCAP_APP_HOST : null; if (process.env.VCAP_APPLICATION){ this.app = JSON.parse(process.env.VCAP_APPLICATION); this.instance = JSON.parse(process.env.VMC_APP_INSTANCE); this.services = JSON.parse(process.env.VCAP_SERVICES); } if (this.instance){ this.sudo = this.instance.sudo; this.instanceID = this.instance.instance_id; this.uris = this.instance.uris; }</pre></div></td></tr><tr id="section-4"><td class="docs"><div class="pilwrap"><a href="#section-4" class="pilcrow">¶</a></div>Helpers for database services </td><td class="code"><div class="highlight"><pre> this.hasMongoDB = (process.env.MONGODB_URL) ? true : false; this.hasRedis = (process.env.REDIS_URL) ? true : false; this.hasMySQL = (process.env.MYSQL_URL) ? true : false; this.hasPostgreSQL = (process.env.POSTGRESQL_URL) ? true : false; this.hasHarbor = (process.env.STACKATO_HARBOR) ? true : false; if(this.hasHarbor) this.harborPort = parseInt(process.env.STACKATO_HARBOR, 10); if(process.env.STACKATO_FILESYSTEM) { this.hasFileSystem = true; this.fileSystemPath = process.env.STACKATO_FILESYSTEM; } if (process.env.STACKATO_SERVICES){ this.services = JSON.parse(process.env.STACKATO_SERVICES); if(this.services){ for(service in this.services){</pre></div></td></tr><tr id="section-5"><td class="docs"><div class="pilwrap"><a href="#section-5" class="pilcrow">¶</a></div>If more than one of any database type <db*>_URL env is unset </td><td class="code"><div class="highlight"><pre> if(service == 'mongodb') this.hasMongoDB = true; if(service == 'redis') this.hasRedis = true; if(service == 'mysql') this.hasMySQL = true; if(service == 'postgresql') this.hasPostgreSQL = true; if(service == 'filesystem') this.hasFileSystem = true; if(service == 'harbor') this.hasHarbor = true; } } } };</pre></div></td></tr><tr id="section-6"><td class="docs"><div class="pilwrap"><a href="#section-6" class="pilcrow">¶</a></div><div class="dox"><div class="summary">getService: Get a service by name</div><div class="body"><pre><code>Returns the service object in JSON if it exists, otherwise returns null @servicename = the user derived service name @cb = the callback function (err, service) </code></pre></div></div> </td><td class="code"><div class="highlight"><pre>Stackato.prototype.getService = function(serviceName, cb){ if(has(this.services, serviceName)){ return cb(null, this.services[serviceName]); }else{ return cb(null, null); } }</pre></div></td></tr><tr id="section-7"><td class="docs"><div class="pilwrap"><a href="#section-7" class="pilcrow">¶</a></div><div class="dox"><div class="summary">MongoDB connection helper</div><div class="body"><h2>Uses the native mongodb driver</h2> <a href='https://github.com/mongodb/node-mongodb-native'>https://github.com/mongodb/node-mongodb-native</a> @servicename = the user derived service name specified in the stackato.yml @opts = mongodb connection parameters (optional) @cb = the callback function when a connection has been attempted (err, client)</div></div> </td><td class="code"><div class="highlight"><pre>Stackato.prototype.connectMongoDB = function(serviceName, opts, cb) { var self = this; if(opts instanceof Function) { cb = opts; opts = {safe:false}; } if(!cb){ return new Error('Last argument must be callback function') } if(!serviceName){ return cb(new Error('Service name not specified')); } if (has(this.services, serviceName)){ var service = self.services[serviceName]; var server = new mongodb.Server(service.host, service.port, opts); new mongodb.Db(service.db, server, opts).open(function (err, client) { if(err) return cb(err, null); client.authenticate(service.username, service.password, function(err, status) { cb(err, client); }); }); }else{ cb(new Error('Cannot find a service named: ' + serviceName)); } };</pre></div></td></tr><tr id="section-8"><td class="docs"><div class="pilwrap"><a href="#section-8" class="pilcrow">¶</a></div><div class="dox"><div class="summary">Redis connection helper</div><div class="body">Uses the ubiquitous node_redis driver: <a href='https://github.com/mranney/node_redis'>https://github.com/mranney/node_redis</a> @servicename = the user derived servicename specified in the stackato.yml @opts = node_redis createConnection() parameters (optional) @cb = the callback function when a connection has been attempted (err, client)</div></div> </td><td class="code"><div class="highlight"><pre>Stackato.prototype.connectRedis = function(serviceName, opts, cb) { if(opts instanceof Function) { cb = opts; opts = {}; } if(!cb){ return new Error('Last argument must be callback function') } if(!serviceName){ return cb(new Error('Service name not specified')); } if (has(this.services, serviceName)){ var client = redis.createClient(this.services[serviceName].port, this.services[serviceName].host, opts); client.on('error', function(err){ cb(err); }); client.auth(this.services[serviceName].password, function(){ return cb(null, client); }); }else{ cb(new Error('Cannot find a service named: ' + serviceName)); } };</pre></div></td></tr><tr id="section-9"><td class="docs"><div class="pilwrap"><a href="#section-9" class="pilcrow">¶</a></div><div class="dox"><div class="summary">PostgreSQL connection helper</div><div class="body">Uses the de facto node-postgres driver: <a href='https://github.com/brianc/node-postgres'>https://github.com/brianc/node-postgres</a> @servicename = the user derived servicename specified in the stackato.yml @opts = pg defaults parameters (optional) @cb = the callback function when a connection has been attempted (err, client, node-postgres [object])</div></div> </td><td class="code"><div class="highlight"><pre>Stackato.prototype.connectPostgreSQL = function(serviceName, opts, cb) { if(opts instanceof Function) { cb = opts; opts = {}; } if(!cb){ return new Error('Last argument must be callback function') } if(!serviceName){ return cb(new Error('Service name not specified')); } if (has(this.services, serviceName)){</pre></div></td></tr><tr id="section-10"><td class="docs"><div class="pilwrap"><a href="#section-10" class="pilcrow">¶</a></div>make the pg object re-usable in the callback by specifying the default connection params </td><td class="code"><div class="highlight"><pre> pg.defaults.host = this.services[serviceName].host; pg.defaults.port = this.services[serviceName].port; pg.defaults.user = this.services[serviceName].user; pg.defaults.password = this.services[serviceName].password; pg.defaults.database = this.services[serviceName].name; pg.connect(function(err, client){ cb(err, client, pg); }); }else{ cb(new Error('Cannot find a service named: ' + serviceName)); } };</pre></div></td></tr><tr id="section-11"><td class="docs"><div class="pilwrap"><a href="#section-11" class="pilcrow">¶</a></div><div class="dox"><div class="summary">MySQL connection helper</div><div class="body">Uses the currently active mysql driver: <a href='https://github.com/felixge/node-mysql'>https://github.com/felixge/node-mysql</a> @servicename = the user derived servicename specified in the stackato.yml @opts = <code>mysql</code> default parameters (optional) @cb = the callback function when a connection has been attempted (err, connection [object])</div></div> </td><td class="code"><div class="highlight"><pre>Stackato.prototype.connectMySQL = function(serviceName, opts, cb) { if(opts instanceof Function) { cb = opts; opts = {}; } if(!cb){ return new Error('Last argument must be callback function') } if(!serviceName){ return cb(new Error('Service name not specified')); } if (has(this.services, serviceName)){ var connection = mysql.createConnection({ host : this.services[serviceName].host, port : this.services[serviceName].port, user : this.services[serviceName].user, password : this.services[serviceName].password, database : this.services[serviceName].name }); connection.connect(); cb(null, connection); }else{ cb(new Error('Cannot find a service named: ' + serviceName)); } }; module.exports = new Stackato() </pre></div></td></tr></tbody></table><div id="generated">generated Mon May 20 2013 22:52:33 GMT-0700 (PDT) </div><div id="projectname"><a href="./index.html">Stackato-Assist</a></div></div></body></html>