initial working acceptance test

Author: BryanDonovan

.jshintrc

@@ -0,0 +1,77 @@
+{
+    // Settings
+    "passfail"      : false,  // Stop on first error.
+    "maxerr"        : 500,    // Maximum errors before stopping.
+    "multistr"      : true,
+
+
+    // Predefined globals whom JSHint will ignore.
+    "node"          : false,
+
+    "predef"        : [  // Extra globals.
+        "__dirname",
+        "Buffer",
+        "event",
+        "exports",
+        "global",
+        "main",
+        "module",
+        "process",
+        "require",
+
+        "after",
+        "afterEach",
+        "before",
+        "beforeEach",
+        "context",
+        "describe",
+        "it"
+    ],
+
+    // Development.
+    "debug"         : false,  // Allow debugger statements e.g. browser breakpoints.
+    "devel"         : true,   // Allow development statements e.g. `console.log();`.
+
+
+    // EcmaScript 5.
+    "es5"           : true,   // Allow EcmaScript 5 syntax.
+    "strict"        : false,  // Require `use strict` pragma in every file.
+    "globalstrict"  : false,  // Allow global "use strict" (also enables 'strict').
+
+
+    "asi"           : false,  // Tolerate Automatic Semicolon Insertion (no semicolons).
+    "laxbreak"      : false,  // Tolerate unsafe line breaks e.g. `return [\n] x` without semicolons.
+    "bitwise"       : true,   // Prohibit bitwise operators (&, |, ^, etc.).
+    "boss"          : false,  // Tolerate assignments inside if, for & while. Usually conditions & loops are for comparison, not assignments.
+    "curly"         : true,   // Require {} for every new block or scope.
+    "eqeqeq"        : false,  // Require triple equals i.e. `===`.
+    "eqnull"        : false,  // Tolerate use of `== null`.
+    "evil"          : false,  // Tolerate use of `eval`.
+    "expr"          : false,  // Tolerate `ExpressionStatement` as Programs.
+    "forin"         : false,  // Tolerate `for in` loops without `hasOwnProperty`.
+    "immed"         : true,   // Require immediate invocations to be wrapped in parens e.g. `( function(){}() );`
+    "latedef"       : true,   // Prohibit variable use before definition.
+    "loopfunc"      : true,   // Allow functions to be defined within loops.
+    //"maxparams"   : 4,
+    //"maxdepth"      : 5,
+    //"maxcomplexity" : 10,
+    "noarg"         : true,   // Prohibit use of `arguments.caller` and `arguments.callee`.
+    "regexp"        : false,  // Prohibit `.` and `[^...]` in regular expressions.
+    "regexdash"     : false,  // Tolerate unescaped last dash i.e. `[-...]`.
+    "scripturl"     : true,   // Tolerate script-targeted URLs.
+    "shadow"        : false,  // Allows re-define variables later in code e.g. `var x=1; x=2;`.
+    "supernew"      : false,  // Tolerate `new function () { ... };` and `new Object;`.
+    "undef"         : true,   // Require all non-global variables be declared before they are used.
+
+
+    "newcap"        : false,  // Require capitalization of all constructor functions e.g. `new F()`.
+    "noempty"       : true,   // Prohibit use of empty blocks.
+    "nonew"         : false,  // Prohibit use of constructors for side-effects.
+    "nomen"         : false,  // Prohibit use of initial or trailing underbars in names.
+    "onevar"        : false,  // Allow only one `var` statement per function.
+    "plusplus"      : false,  // Prohibit use of `++` & `--`.
+    "sub"           : true,  // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`.
+    "trailing"      : true,  // Prohibit trailing whitespaces. (only works if white is 'true')
+    "white"         : true,  // Check against strict whitespace and indentation rules.
+    "indent"        : 4       // ignored because "white" is false.
+}

bin/launch

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+/**
+ * Spawns one or more apps on multiple ports listed in apps' settings files.
+ * TODO: Allow overriding settings.
+ * TODO: This file probably needs review and refactoring.
+ * TODO: Accept a 'copies' arg to specify how many instance of each app to launch.
+ *       (see sonos-js/app.js for example).
+ */
+var clc = require('cli-color');
+var path = require('path');
+var fs = require('fs');
+var spawn = require('child_process').spawn;
+
+var help = 'Usage: launch [app_name1 [app_name2]](required))';
+var argv = require('optimist')
+    .string('env')
+    .describe('env', 'node.js env')
+    .alias('env', 'e')
+    .usage(help)
+    .argv;
+
+if (argv._.length === 0) {
+    console.log(clc.red.bold(help));
+    process.exit();
+}
+
+process.env.NODE_ENV = process.env.NODE_ENV || argv.e || 'dev';
+var ENV = process.env.NODE_ENV;
+
+require('../src/index.js');
+
+// TODO: what path and file name for this combined log?
+// Or should it not be combined?
+function start_detached(module_name, app_port) {
+    var out = fs.openSync(__dirname + '/../logs/multi.log', 'a');
+    var err = fs.openSync(__dirname + '/../logs/multi.log', 'a');
+    var start_opts = [module_name, '--port', app_port, '-e', ENV];
+    var spawn_opts = {
+        detached: true,
+        stdio: ['ignore', out, err]
+    };
+
+    var child = spawn(__dirname + '/start', start_opts, spawn_opts); 
+    child.unref();
+    
+    console.log(clc.green.bold('Registered: ' + module_name + ':' + app_port));
+}
+
+function get_app_ports(app_settings) {
+    var ports = [];
+
+    if (app_settings && app_settings[ENV] && app_settings[ENV].server && app_settings[ENV].server.port) {
+        var starting_port = app_settings[ENV].server.port;
+        var nbr_of_proxies = app_settings[ENV].server.proxies;
+        for (var i = 0; i < nbr_of_proxies; i++) {
+            ports.push(starting_port + i);
+        }
+    }
+
+    return ports;
+}
+
+argv._.forEach(function(module) {
+    var app_settings = require('../settings/' + module).settings;
+    var ports = get_app_ports(app_settings);
+
+    if (ports.length === 0) {
+        throw new Error("Failed to get port from settings for module: " + module);
+    }
+
+    ports.forEach(function(app_port) {
+        start_detached(module, app_port);
+    });
+});

bin/start

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+/**
+ * Starts one or more apps on a single port.
+ */
+var clc = require('cli-color');
+var path = require('path');
+var fs = require('fs');
+var util = require('util');
+
+var log_red = function(msg) {
+    console.log(clc.red.bold(msg));
+};
+
+var help = 'Usage: $0 [app_name1, [app_name2]] -e dev';
+var optimist = require('optimist');
+argv = optimist
+    .boolean(['port'])
+    .alias('port', 'p')
+    .describe('port', 'port to run server(s) on')
+    .string('env')
+    .describe('env', 'NodeJS env')
+    .alias('env', 'e')
+    .usage(help)
+    .argv;
+
+process.env.NODE_ENV = process.env.NODE_ENV || argv.e || 'dev';
+var ENV = process.env.NODE_ENV;
+
+var port = argv.port;
+
+require('../lib');
+
+var app = require('../lib/app')();
+
+if (port) {
+    if (isNaN(parseInt(port, 10))) {
+        throw "Invalid port number";
+    }
+} else {
+    port = 8080;
+}
+
+if (argv._.length === 0) {
+    optimist.showHelp(log_red);
+    process.exit();
+}
+
+function start(module_name, app_port) {
+    app.register(module_name, {port: app_port});
+    console.log(clc.green.bold('Registered: ' + module_name));
+}
+
+function start_apps(app_names) {
+    app_names.forEach(function(app_name) {
+        if (app_name) {
+            console.log("app_name: " + app_name);
+            start(app_name, port);
+        }
+    });
+}
+
+function get_all_app_names() {
+    var app_dir = path.resolve(path.join(__dirname, "../lib/apps"));
+    var app_dirnames = fs.readdirSync(app_dir);
+    var route_path;
+    var app_names = [];
+
+    app_dirnames.forEach(function(app_dirname) {
+        route_path = path.join(app_dir, app_dirname, 'routes.js');
+        if (fs.existsSync(route_path)) {
+            app_names.push(app_dirname);
+        } else {
+            console.error("Error: routes not found at : " + route_path);
+        }
+    });
+
+    return app_names;
+}
+
+var app_names = argv._;
+
+if (app_names[0] === 'all') {
+    app_names = get_all_app_names();
+}
+
+start_apps(app_names);

config.js

@@ -0,0 +1,11 @@
+module.exports = {
+    common: {
+        server: {
+            port: 8080
+        }
+    },
+
+    dev: {},
+
+    test: {}
+};

lib/app.js

@@ -0,0 +1,31 @@
+var restify = require('restify');
+var Settings = require('settings');
+var config = new Settings(require('../config'));
+var AppServer = require('./server/app_server');
+var AppRegistrar = require('./server/app_registrar');
+
+var app = function () {
+    var self = {};
+
+    self.app_server = new AppServer(config);
+
+    self.register = function (app_name, options) {
+        if (!self.app_server.started) {
+            self.app_server.start(options);
+        }
+
+        var registrar = new AppRegistrar(self.app_server.server, app_name, options);
+        registrar.register();
+    };
+
+    self.close_server = function () {
+        if (self.app_server.started) {
+            self.app_server.close();
+            self.app_server.started = false;
+        }
+    };
+
+    return self;
+};
+
+module.exports = app;

lib/apps/users/controller.js

@@ -0,0 +1,12 @@
+var User = main.models.User;
+var responder = main.server.responder;
+
+var methods = {
+    create: function (req, res, next) {
+        User.create(req.parsed_params, function (err, user) {
+            responder.respond(res, err, {data: user}, next);
+        });
+    }
+};
+
+module.exports = methods;

lib/apps/users/routes.js

@@ -0,0 +1,12 @@
+var controller = require('./controller');
+
+var routes = [
+    {
+        method     : "post",
+        url        : "/users",
+        func       : controller.create,
+        middleware : []
+    }
+];
+
+module.exports = routes;

lib/index.js

@@ -0,0 +1,6 @@
+if (!global.main) {
+    global.main = {};
+}
+
+main.models = require('./models');
+main.server = require('./server');

lib/models/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+    User: require('./user')
+};

lib/models/user.js

@@ -0,0 +1,8 @@
+function User() {
+}
+
+User.create = function (args, cb) {
+    cb(null, {id: 123});
+};
+
+module.exports = User;