skeleton

app.js

@@ -0,0 +1,26 @@
+var express = require('express');
+var bodyParser = require('body-parser');
+var methodOverride = require('method-override');
+var morgan = require('morgan');
+var cors = require('cors');
+
+var middleware = require('./source/middleware');
+var logger = require('./source/utils/logger');
+
+var app = express();
+var env = process.env.NODE_ENV || 'development';
+var port = process.env.PORT || 3010;
+
+morgan.format('custom', ':method :url :req[content-type] :req[content-length] HTTP/:http-version :status :res[content-length] - :response-time ms');
+app.use(morgan('custom', {stream: logger.stream()}));
+
+app.use(bodyParser.json());
+app.use(methodOverride());
+app.use(cors());
+
+require('./source/api')(app);
+app.use(middleware.errors());
+
+app.listen(port, function () {
+    logger.info('editor-api listening on port ' + port + ' ' + env);
+});

config/development.config.js

@@ -0,0 +1,7 @@
+var config = {
+    logentries: {
+        token: null
+    }
+};
+
+module.exports = config;

config/index.js

@@ -0,0 +1,6 @@
+var util = require('util');
+
+var env = process.env.NODE_ENV || 'development';
+var config = util.format('/%s.config.js', env);
+
+module.exports = require(__dirname + config);

config/production.config.js

@@ -0,0 +1,7 @@
+var config = {
+    logentries: {
+        token: null
+    }
+};
+
+module.exports = config;

config/staging.config.js

@@ -0,0 +1,7 @@
+var config = {
+    logentries: {
+        token: null
+    }
+};
+
+module.exports = config;

config/test.config.js

@@ -0,0 +1,7 @@
+var config = {
+    logentries: {
+        token: null
+    }
+};
+
+module.exports = config;

package.json

@@ -6,6 +6,18 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "author": "",
+  "dependencies": {
+    "async": "^0.9.0",
+    "body-parser": "^1.9.0",
+    "colors": "^1.0.2",
+    "cors": "^2.4.2",
+    "express": "^4.9.5",
+    "method-override": "^2.2.0",
+    "moment": "^2.8.3",
+    "morgan": "^1.3.2",
+    "node-logentries": "^0.1.4",
+    "respawn": "^1.0.1"
+  },
+  "author": "alexander.beletsky@gmail.com",
   "license": "ISC"
 }

source/api/index.js

@@ -0,0 +1,2 @@
+module.exports = function (app) {
+};

source/middleware/auth.js

@@ -0,0 +1,8 @@
+
+function auth() {
+    return function (req, res, next) {
+        next();
+    };
+}
+
+module.exports = auth;

source/middleware/checkId.js

@@ -0,0 +1,17 @@
+function checkId(param) {
+    return function (req, res, next) {
+        var id = +req.query[param];
+
+        if (!id) {
+            return next({message: 'missing ' + param, status: 412});
+        }
+
+        if (req.user.id !== id) {
+            return next({message: 'wrong ' + param, status: 401});
+        }
+
+        next();
+    };
+}
+
+module.exports = checkId;

source/middleware/errors.js

@@ -0,0 +1,20 @@
+var util = require('util');
+var logger = require('../utils/logger');
+
+function errors(err, req, res, next) {
+    function includeStack(stack) {
+        return process.env.NODE_ENV === 'production' ? [] : stack;
+    }
+
+    return function (err, req, res, next) {
+        err = util.isError(err) ? {message: err.message, stack: includeStack(err.stack)} : err;
+        if (!err.status) {
+            err.status = 500;
+        }
+
+        logger.error(err);
+        return !err.logOnly && res.status(err.status).json(err);
+    };
+}
+
+module.exports = errors;

source/middleware/guest.js

@@ -0,0 +1,8 @@
+function guest () {
+    return function _guest (req, res, next) {
+        req.guestAccess = true;
+        next ();
+    };
+}
+
+module.exports = guest;

source/middleware/index.js

@@ -0,0 +1,13 @@
+module.exports = {
+    validate: require('./validate'),
+    errors: require('./errors'),
+    access: {
+        auth: require('./auth'),
+        id: require('./checkId'),
+        guest: require('./guest')
+    },
+    db: {
+        // mysql: require('./mysql'),
+        // mongo: require('./mongo')
+    }
+};

source/middleware/mongo.js

@@ -0,0 +1,19 @@
+var mongo = require('mongojs');
+
+function createConnection(config) {
+    var connection, collections = ['shifts', 'demands', 'plannings', 'vacations'];
+
+    if (!connection) {
+        connection = mongo.connect(config.connection, collections);
+        if (!connection) {
+            throw new Error('could not connect to ' + config.connection);
+        }
+    }
+
+    return function (req, res, next) {
+        req.mongo = connection;
+        next();
+    };
+}
+
+module.exports = createConnection;

source/middleware/mysql.js

@@ -0,0 +1,15 @@
+function createConnection(config) {
+    return function (req, res, next) {
+        req.getConnection(function (err, mysql) {
+            if (err) {
+                return next(err);
+            }
+
+            req.mysql = mysql;
+
+            next();
+        });
+    };
+}
+
+module.exports = createConnection;

source/middleware/validate.js

@@ -0,0 +1,26 @@
+var schemas = require('../models/schemas');
+
+module.exports = {
+    body: function (schema) {
+        return function (req, res, next) {
+            var result = schemas.validate(req.body, schema);
+
+            if (!result.valid) {
+                return res.status(412).json(result.errors);
+            }
+
+            next();
+        };
+    },
+    id: function (param) {
+        return function (req, res, next) {
+            var result = schemas.validateId(req.params[param]);
+
+            if (!result.valid) {
+                return res.status(412).json(result.errors);
+            }
+
+            next();
+        };
+    }
+};

source/utils/auth.js

@@ -0,0 +1,11 @@
+var middleware = require('../middleware');
+
+function applyAuthentication(app, routesToSecure) {
+    routesToSecure.forEach(function (route) {
+        app.all(route + '/*', middleware.access.auth());
+    });
+
+    return app;
+}
+
+module.exports = applyAuthentication;

source/utils/keys.js

@@ -0,0 +1,13 @@
+function createKeyDrivers(region) {
+	return region + ':drivers';
+}
+
+function createKeyFromAddress(region, address) {
+	address = address.replace(/[, \.]+/g, ':').toLowerCase();
+	return region + ':addresses:' + address;
+}
+
+module.exports = {
+	address: createKeyFromAddress,
+	drivers: createKeyDrivers
+};

source/utils/logger.js

@@ -0,0 +1,88 @@
+require('colors');
+
+var util = require('util');
+var moment = require('moment');
+var logentries = require('node-logentries');
+var config = require('../../config');
+var stub = require('./stub');
+
+var log = logentries.logger({
+    token: config.logentries.token,
+    printerror: false
+});
+
+log.level('debug');
+
+var logger = {
+    success: function (message) {
+        message = typeof message === 'string' ? message : JSON.stringify(message);
+        console.log(this.timestamptMessage(util.format('SUCCESS: %s', message)).green);
+        log.log('info', message);
+    },
+
+    warning: function (message) {
+        message = typeof message === 'string' ? message : JSON.stringify(message);
+        console.log(this.timestamptMessage(util.format('WARNING: %s', message)).yellow);
+        log.log('warning', message);
+    },
+
+    error: function (message) {
+        message = typeof message === 'string' ? message : JSON.stringify(message);
+        console.log(this.timestamptMessage(util.format('ERROR: %s', message)).red);
+        log.log('err', message);
+    },
+
+    fatal: function (message) {
+        message = typeof message === 'string' ? message : JSON.stringify(message);
+        console.log(this.timestamptMessage(util.format('ERROR: %s', message)).red);
+        log.log('emerg', message);
+    },
+
+    info: function (message) {
+        message = typeof message === 'string' ? message : JSON.stringify(message);
+        console.log(this.timestamptMessage(message));
+        log.log('info', message);
+    },
+
+    connector: function (name) {
+        var me = this;
+
+        return {
+            info: function (message) {
+                me.info('connector ' + name + ': ' + message);
+            },
+            warning: function (message) {
+                me.warning('connector ' + name + ': ' + message);
+            },
+            error: function (message) {
+                me.error('connector ' + name + ': ' + message);
+            },
+            success: function (message) {
+                me.success('connector ' + name + ': ' + message);
+            }
+        };
+    },
+
+    timestamptMessage: function (message) {
+        return util.format('[%s] %s', moment(), message);
+    },
+
+    stream: function () {
+        var me = this;
+
+        return {
+            write: function (message) {
+                me.info(message.replace('\n', ''));
+            }
+        };
+    }
+};
+
+module.exports = (function () {
+    var env = process.env.NODE_ENV || 'development';
+    if (env === 'test') {
+        return stub(logger, ['stream']);
+    }
+
+    return logger;
+})();

source/utils/stub.js

@@ -0,0 +1,11 @@
+function stub(obj, skip) {
+    Object.keys(obj).forEach(function (key) {
+        if (typeof obj[key] === 'function' && skip.indexOf(key) < 0) {
+            obj[key] = function () {};
+        }
+    });
+
+    return obj;
+}
+
+module.exports = stub;

source/utils/tenancy.js

@@ -0,0 +1,44 @@
+var util = require('util');
+var _ = require('underscore');
+
+var tenantFields = [
+	'id',
+	'firstname',
+	'lastname',
+	'email',
+	'countryCode',
+	'city',
+	'salesforceAccountID',
+	'workCapacity',
+	'isFulltimeEmployed'
+];
+
+function removeTenant(result) {
+	return _.omit(result, 'user');
+}
+
+function wrapCallback(callback) {
+	return function (err, results) {
+		if (err) {
+			return callback(err);
+		}
+
+		return util.isArray(results) ? callback(null, results.map(removeTenant)) : callback(null, removeTenant(results));
+	};
+}
+
+function tenancy(user, data) {
+	if (typeof user === 'function') {
+		return wrapCallback(user);
+	}
+
+	return _.extend(data, {user: _.pick(user, tenantFields)});
+}
+
+tenancy.query = function (user, query) {
+	return _.extend(query, {'user.id': user.id});
+};
+
+tenancy.fields = tenantFields;
+
+module.exports = tenancy;