42-cent-model/lib/CreditCard.js

Models to ease creation of 42-cent parameter entities

var extend = require('util')._extend;
var setEventually = require('./func.js').setEventually;

/**
 * Model representing a credit card
 * @param  {Object} [data] - the instance will be extend with data
 * @constructor
 * @namespace
 * @property {String} this.creditCardNumber - the card number (no special character, no blank)
 * @property {String} this.expirationMonth - two string digit for the expiration month ('01'->'12')
 * @property {String} this.expirationYear - two string digit for the expiration year
 * @property {String} this.cvv2 - the cvv/cvv2/etc code
 */
function CreditCard(data) {
    var dataOrDefault = data || {};
    extend(this, dataOrDefault);
}

/**
 * setEventually the credit card number of the instance
 * @method
 * @param {String} number -a string for the card number (no blank, no special character)
 * @returns {CreditCard} returns the instance
 */
CreditCard.prototype.withCreditCardNumber = setEventually('creditCardNumber');

/**
 * setEventually the expiration month of the instance
 * @method
 * @param {string} month - a two digit string for the expiration month of the credit card
 * @returns {CreditCard} returns the instance
 */
CreditCard.prototype.withExpirationMonth = setEventually('expirationMonth');

/**
 * setEventually the expiration year of the instance
 * @method
 * @param {String} year - a two digit string for the expiration year of the credit card
 * @returns {CreditCard} returns the instance
 */
CreditCard.prototype.withExpirationYear = setEventually('expirationYear');

/**
 * setEventually the cvv/cvv2/etc code of the instance
 * @method
 * @param {String | Number} cvv2 - a string for the cvv/cvv2/etc code
 * @returns {CreditCard} returns the instance
 */
CreditCard.prototype.withCvv2 = setEventually('cvv2');

/**
 * setEventually the card holder name
 * @method
 * @param {String} cardHolder - a string for the card holder name of the card
 * @returns {CreditCard} returns the instance
 */
CreditCard.prototype.withCardHolder = setEventually('cardHolder');

module.exports = CreditCard;