@balderdash/sails-edge/lib/hooks/request/validate.js

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

/**
 * Module dependencies
 */
var _ = require('lodash');
var anchor = require('anchor');

/**
 * Mixes in `req.validate`.
 *
 * @param  {Request} req
 * @param  {Response} res
 * @return {Request}
 */
module.exports = function (req, res) {
  req.validate = _validate;

  /**
   * req.validate()
   *
   * @param  {Object} usage
   *         (supports either `{type: {}}` or `{}`)
   *
   * @param  {String} redirectTo
   *         (optional)
   *
   * @throws {Error}
   * @api public
   */

  function _validate (usage, redirectTo) {
    usage = usage || {};

    // Wrap `usage` in a `type` key, since req.params.all()
    // always returns an object anyways.
    var invalidParams = anchor(req.params.all()).to({type: usage});
    if (invalidParams) {

      var e = new E_INVALID_PARAMS({
        invalidParams: invalidParams,
        route: req.url,
        method: req.method,
        usage: usage
      });

      if (redirectTo) {
        if (req.session && req.flash) {
          req.flash('error', e);
        }
        res.redirect(redirectTo);
      }
      else {
        throw e;
      }
    }
  }

  return req;
};






/**
 * Constructs an E_INVALID_PARAMS error.
 * @constructor
 */
function E_INVALID_PARAMS (opts) {
  this.invalidParams = opts.invalidParams;
  this.route = opts.route;
  this.method = opts.method;
  this.usage = opts.usage;

  // Generate stack trace
  var e = new Error();
  this.stack = e.stack;
}
E_INVALID_PARAMS.prototype.code = 'E_INVALID_PARAMS';
E_INVALID_PARAMS.prototype.status = 400;

/**
 * How this error is serialized when sent w/ `res.json()`
 * @return {Object}
 */
E_INVALID_PARAMS.prototype.toJSON = function () {
  return _.map(this.invalidParams, function (invalidParam) {
    return {
      parameter: invalidParam.property,
      error: invalidParam.message,
      expectedType: invalidParam.rule,
      actualType: invalidParam.actualType,
      data: invalidParam.data
    };
  });
};

/**
 * How this error appears when logged
 * (or whenever util.inspect is called on it)
 * @return {String}
 */
E_INVALID_PARAMS.prototype.inspect = function () {
  var output = 'Invalid parameters sent to route: "'+this.method + ' ' + this.route+'"';
  output += '\n';
  output += _.map(this.invalidParams, function (invalidParam) {
    return '  -> ' + invalidParam.message;
  });
  return output;
};