Plato - lib/eggtart.js

var fs = require('fs'),
  p = require('path'),
  req = require('bagofrequest'),
  xml2js = require('xml2js'),
  url = require('url'),
  util = require('util'),
  validator = require('./validator');

/**
 * class Eggtart
 *
 * @param {String} username: Delicious account username
 * @param {String} password: Delicious account password
 * @param {Object} opts: optional
 *   - version: API version, default: v1
 */
function Eggtart(username, password, opts) {
  opts = opts || {};

this.version = opts.version || 'v1';
  this.wait = opts.wait || 1000; // mandatory wait to avoid forced throttling
  this.url = util.format('https://%s:%s@api.delicious.com/%s/',
    username,
    password,
    this.version);

this._init();
}

// initialises methods and sub methods based on API configuration
Eggtart.prototype._init = function () {  
  var file = p.join(__dirname, '..', 'conf', this.version + '.json'),
    config = JSON.parse(fs.readFileSync(file)),
    self = this;

Object.keys(config).forEach(function (method) {
    var subMethods = {};

Object.keys(config[method]).forEach(function (subMethod) {
      subMethods[subMethod] = function (args, cb) {
        if (!cb) {
          cb = args;
          args = {};
        }
        
        var endpoint = config[method][subMethod].endpoint,
          rules = config[method][subMethod].args;

validator.validate(rules, args, function (err) {
          if (err) {
            cb(err);
          } else {
            self._request(endpoint, args, cb);
          }
        });
      };
    });

Eggtart.prototype[method] = function () {
      return subMethods;
    };
  });
};

// send request to Delicious
Eggtart.prototype._request = function (endpoint, params, cb) {

var parser = new xml2js.Parser(),
    self = this;

function _success(result, cb) {
    parser.parseString(result.body, cb);
  }

function _error(result, cb) {
    parser.parseString(result.body, function (err, result) {
      cb(new Error(result.result.$.code));
    });
  }

var opts = {
    queryStrings: params,
    handlers: {
      200: _success,
      401: _error, // access denied
      500: _error, // throttled
      999: _error  // throttled
    }
  };

// mandatory wait to avoid forced throttling
  setTimeout(function () {
    req.request('get', self.url + endpoint, opts, cb);
  }, this.wait);
};

module.exports = Eggtart;

lib/eggtart.js

Maintainability

Lines of code

Difficulty

Estimated Errors

Function weight

By Complexity

By SLOC