Merge pull request #1 from stowns/develop

Develop

Author: stowns

.nvmrc

@@ -0,0 +1 @@
+0.10.26

Gruntfile.js

@@ -0,0 +1,40 @@
+module.exports = function(grunt) {
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+
+    jshint: {
+      dev: {
+        options: {
+          jshintrc: true
+        },
+        src: ['*.js', 'app/**/*.js', 'lib/**/*.js', 'test/**/*.js', 'models/**/*.js'],
+      },
+    },
+    watch: {
+      grunt: { files: ['Gruntfile.js'] },
+      options: {
+        livereload: true
+      },
+      files: ['*.js', 'app/**/*.js', 'lib/**/*.js', 'test/**/*.js', 'models/**/*.js'],
+      tasks: ['jshint:dev']
+    },
+    apidoc: {
+      apiStarter: {
+        src: "app/",
+        dest: "docs/",
+        options : {
+          includeFilters: [ ".*\\.js$" ],
+          excludeFilters: [ "node_modules/" ]
+        }
+      }
+    }
+
+  });
+
+
+ grunt.loadNpmTasks('grunt-contrib-jshint');
+ grunt.loadNpmTasks('grunt-contrib-watch');
+ grunt.loadNpmTasks('grunt-apidoc');
+
+ grunt.registerTask('default', ['apidoc', 'jshint:dev']);
+};

README.md

@@ -7,17 +7,19 @@ A seed project for building out a new api.  Supports resource-based routing, Seq
   * [Dependencies](#dependencies)
   * [Signals](#signals)
   * [Migrations](#migrations)
+  * [Docs](#docs)
 
 
 ## Getting Started
-  - nvm install 0.10.22
-  - npm install -g mocha
+  - nvm install 0.10.26
+  - npm install -g mocha grunt-cli
   - npm install
   - edit /conf/development.js && /conf/test.js database information appropriately
   - createdb api_dev ; createdb api_test
   - nvm use
   - npm test
   - npm start
+  - optionally, run 'grunt watch' for [JSHint][jshint] results on saves
 
 ### Dependencies
 - [Node.js ≥ 0.10.22][node]
@@ -46,9 +48,13 @@ Api Starter uses [Sequelize's][sequelize] built in migration support.  [Docs her
 
 **IMPORTANT** do *NOT* use the global sequelize binary ie) `sequelize -m`.  Use the binary installed locally to the node_modules folder.
 
+### Docs
+The default grunt task generates documentation using [APIDoc][apidoc].
 
 [node]: http://nodejs.org/ "Node.js"
 [cluster]: http://nodejs.org/docs/v0.10.22/api/cluster.html "Cluster - Node v0.10.22"
 [redis]: http://redis.io/download "Redis"
 [postgres]: http://www.postgresql.org/ "Postgres"
-[sequelize]: http://http://sequelizejs.com/ "Sequelize"
+[sequelize]: http://http://sequelizejs.com/ "Sequelize"
+[jshint]: http://www.jshint.com/docs/ "JSHint"
+[apidoc]: http://apidocjs.com/ "APIDocJS"

app/v1/controllers/users/index.js

@@ -11,19 +11,27 @@ var ResourceController = require(app.locals.appPath + '/lib/sequelizeResourceCon
 /* beforeAction definitions */
 var before = {
   logParams : function(req, res, next) {
-    log.info('PARAMS:');
-    log.info(req.params);
+    if (process.env.NODE_ENV !== 'test') {
+      log.info('PARAMS:');
+      log.info(req.params);
+    }
+
+    next();
+  }, 
+  exampleMiddleware : function(req, res, next) {
+    if (process.env.NODE_ENV !== 'test') {
+      log.info('example middleware!');
+    }
 
     next();
   }
 };
 
 opts = {
   before: { // Middleware support
-    //all: before.logParams,
-    index: [middleware.authRole('admin')],
-    destroy: [middleware.authRole('admin')],
-    query: [middleware.authRole('admin')]
+    all: before.logParams,
+    index: [before.exampleMiddleware],
+    destroy: [before.exampleMiddleware]
   }
 };
 

app/v2/routes.js

@@ -7,4 +7,4 @@ module.exports.init = function(rootRoute) {
   app.get(rootRoute + '/', function(req, res) {
     res.send('hello from v2');
   });
-}
+};

conf/test.js

@@ -20,8 +20,8 @@ conf.redis = {
 conf.postgres = {
   database : 'api_test',
   port     : 5432,
-  uname    : 'uname',
-  pass     : 'pass',
+  uname    : 'pagelever',
+  pass     : 'pagelever',
   logging  : true
 };
 

lib/cluster.js

@@ -13,13 +13,13 @@ var _          = require('lodash'),
 function Cluster() {
   _.bindAll(this);
   log = bunyan.createLogger({name: "cluster"});
-  this.workerRestartArray = []
+  this.workerRestartArray = [];
 
   process.nextTick(this.start);
 
   return this;
 
-};
+}
 
 /** @alias {Cluster.prototype.sysCluster} onto Cluster constructor for static ref */
 Cluster.prototype.sysCluster = Cluster.sysCluster = require('cluster');
@@ -43,8 +43,8 @@ Cluster.prototype.start = _.once(function () {
     // explicitly set worker number
     cluster.workers(numWorkers);
 
-    log.info('cluster: Spawning ' + numWorkers
-              + ' workers for ' + cpus + ' CPUs');
+    log.info('cluster: Spawning ' + numWorkers +
+               ' workers for ' + cpus + ' CPUs');
 
     // Restart workers when they die
     cluster.sysCluster.on('exit', cluster.restartWorker);
@@ -107,9 +107,9 @@ Cluster.prototype.restartWorker = function (worker, code, signal) {
     // delayed to prevent CPU explosions if crashes happen to quickly
     _.delay(function () {
       if (worker) {
-        log.info('cluster: Worker ' + worker.id + ' (pid '
-         + worker.process.pid + ') ' + 'died ('
-         + worker.process.exitCode + '). Respawning..');
+        log.info('cluster: Worker ' + worker.id + ' (pid ' +
+          worker.process.pid + ') ' + 'died (' +
+          worker.process.exitCode + '). Respawning..');
       }
 
       cluster.sysCluster.fork();
@@ -118,7 +118,7 @@ Cluster.prototype.restartWorker = function (worker, code, signal) {
 
   // workerRestartArray used for rolling restarts (SIGUSR2)
   if (cluster.workerRestartArray.length > 0) {
-    var worker = cluster.workerRestartArray.shift();
+    worker = cluster.workerRestartArray.shift();
     log.info("Sending 'stop' signal to worker " + worker.process.pid);
     // killing a worker will in-turn call restartWorker and restart itself.
     worker.send("stop");
@@ -187,6 +187,6 @@ Cluster.prototype.shutdown = function () {
   }
   process.exit();
   log.info('exiting ' +  process.pid.toString());
-}
+};
 
 exports = module.exports = Cluster;

lib/logger.js

@@ -1,6 +1,6 @@
 var bunyan = require('bunyan'),
     _ = require('lodash'),
-    url = require('url')
+    url = require('url'),
     mongo = require('mongodb'),
     path = require('path'),
     MongoClient = mongo.MongoClient;
@@ -39,27 +39,27 @@ function Logger(conf) {
  */
 Logger.prototype.createLogger = function () {
   this.log = bunyan.createLogger({ name: this.conf.app.name });
-}
+};
 
 Logger.prototype.trace = function (message) {
   this.write('trace', message);
-}
+};
 
 Logger.prototype.info = function (message) {
   this.write('info', message);
-}
+};
 
 Logger.prototype.warn = function (message) {
   this.write('warn', message);
-}
+};
 
 Logger.prototype.error = function (message) {
   this.write('error', message);
-}
+};
 
 Logger.prototype.fatal = function (message) {
   this.write('fatal', message);
-}
+};
 
 /**
  * Writes to the designated log
@@ -73,8 +73,8 @@ Logger.prototype.write = function (level, message) {
 
   _.each(this.enabled, function(method) {
     _this[method](level, message);
-  })
-}
+  });
+};
 
 
 /**
@@ -89,7 +89,7 @@ Logger.prototype.index = function (level, message) {
 
   var indexMethod = 'index' + this.conf.logger.index.type;
   this[indexMethod](level, message);
-}
+};
 
 Logger.prototype.indexMongo = function (level, message) {
   var _this = this;
@@ -108,6 +108,6 @@ Logger.prototype.indexMongo = function (level, message) {
        db.close();
     });
   });
-}
+};
 
 exports = module.exports = Logger;

lib/middleware.js

@@ -21,4 +21,4 @@ middleware.mergeParams = function(req, res, next) {
 };
 
 
-exports = module.exports = middleware
+exports = module.exports = middleware;

lib/sequelizeResourceController.js

@@ -22,15 +22,15 @@ _.str = require('underscore.string');
 function ResourceController(modelName, opts) {
   var db = app.locals.db;
   this.db = db;
-  this.options = opts,
+  this.options = opts;
   this.modelName = modelName; // user
   this.modelNamePlural = inflection.pluralize(this.modelName); // users
   this.ModelClass = db[_.str.capitalize(this.modelName)]; // User
   this.modelGetter = 'get' + _.str.capitalize(this.modelName); // getUser
   this.modelGetterPlural = inflection.pluralize(this.modelGetter); // getUsers
   this.modelSetter = 'set' + _.str.capitalize(this.modelName);
   this.modelSetterPlural = inflection.pluralize(this.modelSetter);
-  this.log = new app.locals.Logger(app.locals.conf)
+  this.log = new app.locals.Logger(app.locals.conf);
   this.dialect = 'postgres';
 
   var scopeCheck = function(req, res, next) {
@@ -47,7 +47,7 @@ function ResourceController(modelName, opts) {
     if (this.options.before) {
       if (this.options.before && this.options.before.all) { // options.before.all exists
         if (_.isArray(this.options.before.all)) {           // options.before.all is an Array, prepend it
-          this.options.before.all.unshift(scopeCheck)
+          this.options.before.all.unshift(scopeCheck);
         } 
         else {                                            // options.before.all is an Object, convert to an Array and prepend.
           this.options.before.all = [scopeCheck, this.options.before.all];
@@ -64,7 +64,7 @@ function ResourceController(modelName, opts) {
 
   // maintains 'this' context throughout the class
   _.bindAll(this);
-};
+}
 
 ResourceController.prototype.index = function(req, res) {
   var _this = this,
@@ -101,7 +101,7 @@ ResourceController.prototype.index = function(req, res) {
       .error(function (err) { _this.sendErr(res, 'index', err); })
       .success(function (result, created) {
         if (result.length === 1)
-            return res.send(result[0])
+            return res.send(result[0]);
         res.send(result);
       });
     }
@@ -146,7 +146,7 @@ ResourceController.prototype.new = function(req, res) {
 ResourceController.prototype.create = function(req, res) {
   var action = 'create',
       params = req.body,
-      modelParam = params[this.modelName] // { theModelName : { attr : value }}
+      modelParam = params[this.modelName]; // { theModelName : { attr : value }}
       _this = this;
 
   if (_.isEmpty(modelParam)) return _this.sendErr(res, action, 'no ' + this.modelName + ' parameter supplied');
@@ -222,15 +222,15 @@ ResourceController.prototype.update = function(req, res) {
       var setKeys =  _.keys(params.update);  // ['key', 'key2', 'key3']
       var setString = '';
       var setArray  = _.map(setKeys, function(key) { // [ '"name"=\'Bob\'','"age=16"', '"desc"=\'A user\'' ]
-          var value = params.update[key]          
+          var value = params.update[key];
           value = _.isNumber(params.update[key]) ? value : SqlString.escape(value, null, null, _this.dialect);
           return "\"" + key + "\"=" + value;
         });
 
       if (setArray.length > 1) {
           // "name"='Bob',"age=16"
           setString += setArray.shift();
-          _.each(setArray, function(setter) { setString += (',' + setter) ;})
+          _.each(setArray, function(setter) { setString += (',' + setter); });
 
         } else {
           // "name"='Bob'
@@ -239,10 +239,10 @@ ResourceController.prototype.update = function(req, res) {
 
 
       // :/ this gets us the relational piece of the update query
-      var query = 'UPDATE ' + this.modelNamePlural + ' SET ' + setString 
-            + ' WHERE id IN (SELECT "' + this.modelName + 'Id"'
-            + ' FROM ' + this.modelNamePlural + inflection.pluralize(req.scope.daoFactory.name)
-            + ' WHERE "' + req.scope.daoFactory.name + 'Id" = ' + req.scope.id + ')';
+      var query = 'UPDATE ' + this.modelNamePlural + ' SET ' + setString +
+            ' WHERE id IN (SELECT "' + this.modelName + 'Id"' +
+            ' FROM ' + this.modelNamePlural + inflection.pluralize(req.scope.daoFactory.name) +
+            ' WHERE "' + req.scope.daoFactory.name + 'Id" = ' + req.scope.id + ')';
 
 
       if (_.isEmpty(params.where)) {
@@ -263,7 +263,7 @@ ResourceController.prototype.update = function(req, res) {
         query += whereQuery;
       }
       _this.db.sequelize.query(query)
-        .error(function (err) { _this.sendErr(res, action, err) })
+        .error(function (err) { _this.sendErr(res, action, err); })
         .success(function () {
           res.send({ status : 'success' });
         });
@@ -337,16 +337,17 @@ ResourceController.prototype.query = function(req, res) {
 ResourceController.prototype.describe = function(req, res) {
   var data = this.db.describe(this.ModelClass);
 
-  if (data == null)
+  if (data === null) {
     data = { error : 'This model does not exist' };
+  }
 
   res.setHeader('Sequelize-Admin', JSON.stringify(data));
   res.end();
 };
 
 ResourceController.prototype.getLogger = function () {
   return this.log;
-}
+};
 
 function isInt(arg) {
   var intRegex = /^\d+$/;
@@ -362,6 +363,6 @@ ResourceController.prototype.sendErr = function (res, action, msg) {
 
   this.log.error(err);
   res.send(err);
-}
+};
 
 exports = module.exports = ResourceController;

main.js

@@ -71,7 +71,7 @@ versions = {'Version 1': '/v1',
 // route to display versions
 app.get('/', function(req, res) {
     res.json(versions);
-})
+});
 
 // import and apply the routes
 for (var k in versions) { 
@@ -81,7 +81,7 @@ for (var k in versions) {
 
 app.locals.db.sequelize.sync().complete(function(err) {
   if (err) {
-    throw err
+    throw err;
   } else {
     if (isProduction()) {  // only run clustered in prod
       new Cluster()
@@ -113,7 +113,7 @@ function isTest() {
 /* Initialization */
 function startServer() {
   http.createServer(app).listen(conf.server.port.http, function(){
-    console.log('Express server listening on port ' + conf.server.port.http)
+    console.log('Express server listening on port ' + conf.server.port.http);
   });
 }
 

models/account.js

@@ -2,5 +2,5 @@ module.exports = function(sequelize, DataTypes) {
   return sequelize.define("account", {
     name: DataTypes.STRING,
     description: DataTypes.STRING
-  })
-}
+  });
+};

models/index.js

@@ -54,7 +54,7 @@ module.exports = function(conf) {
     var ScopeClass, scopeName, models, paramKeys;
 
     // build an array of all the model names available - the model name in question
-    possibleScopes = _.reject(db.modelNames, function(m) { return m === modelName});
+    possibleScopes = _.reject(db.modelNames, function(m) { return m === modelName; });
     // parse the passed param names (keys)
     paramKeys = _.keys(params);
     // find the scopeName ie) GET /users/:user/accounts : scopeName=user
@@ -105,4 +105,4 @@ module.exports = function(conf) {
   db.Account.hasMany(db.User);
 
   return db;
-}
+};

models/user.js

@@ -2,5 +2,5 @@ module.exports = function(sequelize, DataTypes) {
   return sequelize.define("user", {
     username: DataTypes.STRING,
     age     : DataTypes.INTEGER
-  })
-}
+  });
+};

package.json

@@ -28,10 +28,14 @@
   "devDependencies": {
     "supertest": "~0.8.2",
     "chai": "~1.8.1",
-    "mocha": "~1.15.1"
+    "mocha": "~1.15.1",
+    "grunt-contrib-watch": "^0.6.1",
+    "grunt": "^0.4.5",
+    "grunt-apidoc": "^0.6.0",
+    "grunt-contrib-jshint": "^0.10.0"
   },
   "scripts": {
     "start": "axle node main.js",
-    "test": "mocha --timeout 5000 --reporter nyan"
+    "test": "NODE_ENV=test mocha --timeout 5000 --reporter spec --ui bdd"
   }
 }

test/accounts.js

@@ -1,5 +1,3 @@
-process.env.NODE_ENV = 'test'
-
 var should    = require('chai').should(),
     supertest = require('supertest'),
     app       = require('../main'),
@@ -14,16 +12,17 @@ var should    = require('chai').should(),
 var randomString = function () {
     var result = '',
       length = 5,
-      chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\'"!@#$%^&*()-_+=.,;:></?[]{}\\`~|'
+      chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\'"!@#$%^&*()-_+=.,;:></?[]{}\\`~|';
+
     for (var i = length; i > 0; --i) result += chars[Math.round(Math.random() * (chars.length - 1))];
     return result + chars;
-}
+};
 
 describe('The AccountsController works', function() {
   before(function (done) {
     db.sequelize.sync().complete(function(err) {
       if (err) {
-        throw err
+        throw err;
       } else {
         db.sequelize.query("DELETE FROM accounts")
           .error(function (err) {

test/users.js

@@ -1,5 +1,3 @@
-process.env.NODE_ENV = 'test'
-
 var should    = require('chai').should(),
     supertest = require('supertest'),
     app       = require('../main'),
@@ -145,7 +143,7 @@ describe('User Associations', function() {
   before(function (done) {
     db.sequelize.sync().complete(function(err) {
       if (err) { 
-        throw err 
+        throw err;
       }
       else {
         db.sequelize.query("DELETE FROM users")

test/utils/modelBuilder.js

@@ -15,12 +15,12 @@ ModelBuilder.prototype.build = function(modelName) {
       keys = ModelClass.rawAttributes,
       mock;
 
-  this.digitsRegex = /\((.*?)\)/
+  this.digitsRegex = /\((.*?)\)/;
   keys = _.omit(keys, ['createdAt', 'updatedAt', 'id']);
   mock = _.mapValues(keys, function(v) { return  _this.getType(v.toString()); });
 
   return mock;
-}
+};
 
 ModelBuilder.prototype.getType = function(type) {
   var types = {
@@ -38,21 +38,23 @@ ModelBuilder.prototype.getType = function(type) {
   };
 
   if (_.str.startsWith(type, 'TINYB')) {
-    return types['TINY'](type);
+    return types.TINY(type);
   } else {
     return types[type.substring(0,3)](type);
   }
 
-}
+};
+
 ModelBuilder.prototype.randomString = function (length) {
     var result = '',
-      chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\'"!@#$%^&*()-_+=.,;:></?[]{}\\`~|'
+      chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\'"!@#$%^&*()-_+=.,;:></?[]{}\\`~|';
+
     for (var i = length; i > 0; --i) result += chars[Math.round(Math.random() * (chars.length - 1))];
 
     console.log('RANDOM STRING GENERATED');
     console.log(result);
     return result;
-}
+};
 
 ModelBuilder.prototype.randomNumber = function (precision, scale) {
   var result;
@@ -63,7 +65,7 @@ ModelBuilder.prototype.randomNumber = function (precision, scale) {
   }
 
   return parseFloat(result);
-}
+};
 
 ModelBuilder.prototype.getVarChar = function(type) {
   var digits;
@@ -76,23 +78,21 @@ ModelBuilder.prototype.getVarChar = function(type) {
   }
 
   return this.randomString(digits);
-}
+};
 
 ModelBuilder.prototype.getText = function() {
-  
-}
+};
 
 ModelBuilder.prototype.getInt = function(type) {
   return Math.random() * 100|0;
-}
+};
 
 ModelBuilder.prototype.getBigInt = function() {
-  
-}
+};
 
 ModelBuilder.prototype.getFloat = function(type) {
   return Math.random() * 100;
-}
+};
 
 ModelBuilder.prototype.getDecimal = function(type) {
   var digits, result;
@@ -106,26 +106,21 @@ ModelBuilder.prototype.getDecimal = function(type) {
   }
 
   return result;
-}
+};
 
 ModelBuilder.prototype.getDateTime = function() {
-  
-}
+};
 
 ModelBuilder.prototype.getTinyInt = function() {
-  
-}
+};
 
 ModelBuilder.prototype.getEnum = function() {
-  
-}
+};
 
 ModelBuilder.prototype.getBlob = function() {
-  
-}
+};
 
 ModelBuilder.prototype.getTinyBlob = function() {
-  
-}
+};
 
 exports = module.exports = ModelBuilder;

test/utils/testUtil.js

@@ -9,7 +9,7 @@ TestUtil.prototype.clean = function(callback) {
   var _this = this;
   _this.db.sequelize.sync().complete(function(err) {
     if (err) {
-      throw err
+      throw err;
     } else {
       _this.db.sequelize.query("SELECT * FROM pg_catalog.pg_tables")
         .error(function (err) {
@@ -37,6 +37,6 @@ TestUtil.prototype.clean = function(callback) {
         });
     }
   });
-}
+};
 
 exports = module.exports = TestUtil;