oauth20-provider/lib/model/user.js

OAuth 2.0 provider toolkit for nodeJS

var
    error = require('./../error');

/**
 * User schema is defined by server side logic
 */

/**
 * Gets primary key of the user
 *
 * @param user {Object} User object
 */
module.exports.getId = function(user) {
    throw new error.serverError('User model method "getId" is not implemented');
};

/**
 * Fetches user object by primary key
 * Should be implemented with server logic
 *
 * @param userId {String} Unique identifier
 * @param cb {Function} Function callback ->(error, object)
 */
module.exports.fetchById = function(userId, cb) {
    throw new error.serverError('User model method "fetchById" is not implemented');
};

/**
 * Fetches user object by primary key
 * Should be implemented with server logic
 *
 * @param username {String} Unique username/login
 * @param cb {Function} Function callback ->(error, object)
 */
module.exports.fetchByUsername = function(username, cb) {
    throw new error.serverError('User model method "fetchByUsername" is not implemented');
};

/**
 * Checks password for the user
 * Function arguments MAY be different
 *
 * @param user {Object} User object
 * @param password {String} Password to be checked
 * @param cb {Function} Function callback -> (error, boolean) If input is correct
 */
module.exports.checkPassword = function(user, password, cb) {
    /**
     * In case of sync check function use:
     * (user.password == superHashFunction(password)) ? cb(null, true) : cb(null, false);
     */
    throw new error.serverError('User model method "checkPassword" is not implemented');
};

/**
 * Fetch user object from session (fetch logged user only)
 *
 * @param req
 */
module.exports.fetchFromRequest = function(req) {
    throw new error.serverError('User model method "fetchFromRequest" is not implemented');
};