alisms/lib/topClient.js

taobao api

'use strict';

var urllib = require('urllib');
var util = require('./topUtil');

/**
 * TOP API Client.
 *
 * @param {Object} options, must set `appkey` and `appsecret`.
 * @constructor
 */

function TopClient(options) {
    if (!(this instanceof TopClient)) {
        return new TopClient(options);
    }
    options = options || {};
    if (!options.appkey || !options.appsecret) {
        throw new Error('appkey or appsecret need!');
    }
    this.REST_URL = options.REST_URL || 'http://gw.api.taobao.com/router/rest';
    this.appkey = options.appkey;
    this.appsecret = options.appsecret;
}

/**
 * Invoke an api by method name.
 *
 * @param {String} method, method name
 * @param {Object} params
 * @param {Array} reponseNames, e.g. ['tmall_selected_items_search_response', 'tem_list', 'selected_item']
 * @param {Object} defaultResponse
 * @param {String} type
 * @param {Function(err, response)} callback
 */
TopClient.prototype.invoke = function(method, params, reponseNames, defaultResponse, type, callback) {
    params.method = method;
    this.request(params, type, function(err, result) {
        if (err) {
            return callback(err);
        }
        var response = result;
        if (reponseNames && reponseNames.length > 0) {
            for (var i = 0; i < reponseNames.length; i++) {
                var name = reponseNames[i];
                response = response[name];
                if (response === undefined) {
                    break;
                }
            }
        }
        if (response === undefined) {
            response = defaultResponse;
        }
        callback(null, response);
    });
};

TopClient.prototype._wrapJSON = function(s) {
    var matchs = s.match(/\"id\"\:\s?\d{16,}/g);
    if (matchs) {
        for (var i = 0; i < matchs.length; i++) {
            var m = matchs[i];
            s = s.replace(m, '"id":"' + m.split(':')[1].trim() + '"');
        }
    }
    return s;
};

var IGNORE_ERROR_CODES = {
    'isv.user-not-exist:invalid-nick': 1
};

/**
 * Request API.
 *
 * @param {Object} params
 * @param {String} [type='GET']
 * @param {Function(err, result)} callback
 * @public
 */
TopClient.prototype.request = function(params, type, callback) {
    if (typeof type === 'function') {
        callback = type;
        type = null;
    }
    var err = util.checkRequired(params, 'method');
    if (err) {
        return callback(err);
    }
    var args = {
        timestamp: this.timestamp(),
        format: 'json',
        app_key: this.appkey,
        v: '2.0',
        sign_method: 'md5'
    };
    for (var k in params) {
        if (typeof params[k] == "object") {
            args[k] = JSON.stringify(params[k]);
        } else {
            args[k] = params[k];
        }
    }
    args.sign = this.sign(args);
    type = type || 'GET';
    var options = { type: type, data: args, agent: this.agent };
    var that = this;
    urllib.request(that.REST_URL, options, function(err, buffer) {
        var data;
        if (buffer) {
            buffer = that._wrapJSON(buffer.toString());
            try {
                data = JSON.parse(buffer);
            } catch (e) {
                err = e;
                e.data = buffer.toString();
                data = null;
            }
        }
        var errRes = data && data.error_response;
        if (errRes) {
            if (!errRes.sub_msg || !IGNORE_ERROR_CODES[errRes.sub_code]) {
                // no sub_msg error, let caller handle it.
                var msg = errRes.msg + ', code ' + errRes.code;
                if (errRes.sub_msg) {
                    msg += '; ' + errRes.sub_code + ': ' + errRes.sub_msg;
                }
                err = new Error(msg);
                err.name = 'TOPClientError';
                err.code = errRes.code;
                err.sub_code = errRes.sub_code;
                err.data = buffer.toString();
                data = null;
            }
        }

        callback(err, data);
    });
};

/**
 * Get now timestamp with 'yyyy-MM-dd HH:mm:ss' format.
 * @return {String}
 */
TopClient.prototype.timestamp = function() {
    return util.YYYYMMDDHHmmss();
};

/**
 * Sign API request.
 * see http://open.taobao.com/doc/detail.htm?id=111#s6
 *
 * @param  {Object} params
 * @return {String} sign string
 */
TopClient.prototype.sign = function(params) {
    var sorted = Object.keys(params).sort();
    var basestring = this.appsecret;
    for (var i = 0, l = sorted.length; i < l; i++) {
        var k = sorted[i];
        basestring += k + params[k];
    }
    basestring += this.appsecret;
    var sign = util.md5(basestring).toUpperCase();
    return sign;
};

/**
 * execute top api
 */
TopClient.prototype.execute = function(apiname, params, callback) {
    this.invoke(apiname, params, [util.getApiResponseName(apiname)], null, 'POST', callback);
};

exports.TopClient = TopClient;