landmark-serve/lib/middleware/initAPI.js

Web Application Framework and Admin GUI / Content Management System built on Express.js and Mongoose

/**
 * Middleware to initialise a standard API response.
 *
 * Adds `res.apiResonse` and `res.apiError` methods.
 *
 * ####Example:
 *
 *     app.all('/api*', initAPI);
 *
 * @param {app.request} req
 * @param {app.response} res
 * @param {function} next
 * @api public
 */

// The exported function returns a closure that retains
// a reference to the landmark instance, so it can be
// passed as middeware to the express app.

exports = module.exports = function(landmark) {
	return function initAPI(req, res, next) {
		
		res.apiResponse = function(status) {
			if (req.query.callback)
				res.jsonp(status);
			else
				res.json(status);
		};

		res.apiError = function(key, err, msg) {
			msg = msg || 'Error';
			key = key || 'unknown error';
			msg += ' (' + key + ')';
			if (landmark.get('logger')) {
				console.log(msg + (err ? ':' : ''));
				if (err) {
					console.log(err);
				}
			}
			res.status(500);
			res.apiResponse({ error: key || 'error', detail: err });
		};

		next();
	};
};