slack-client/lib/clients/helpers.js

A library for creating a Slack client

/**
 * Helpers for working with Slack API clients.
 */

var assign = require('lodash').assign;
var isFunction = require('lodash').isFunction;
var isUndefined = require('lodash').isUndefined;
var isString = require('lodash').isString;
var forEach = require('lodash').forEach;
var noop = require('lodash').noop;


/**
 *
 * @param {object} data
 * @returns {object}
 */
var getData = function getData(data, token) {
  var newData = assign({}, data ? data.opts || {} : {});

  forEach(data || {}, function getValidData(val, key) {
    if (!isUndefined(val) && val !== null && key !== 'opts') {
      // For the web API, this should always be a JSON-encoded array, see:
      //   https://api.slack.com/docs/attachments
      if (key === 'attachments') {
        if (isString(val)) {
          newData[key] = val;
        } else {
          newData[key] = JSON.stringify(val);
        }
      } else {
        newData[key] = val;
      }
    }
  });

  // There are a couple of API calls that don't require tokens, so check before passing it through
  if (token) {
    newData.token = token;
  }

  return newData;
};


var getAPICallArgs = function getAPICallArgs(token, optData, optCb) {
  var data;
  var cb;

  if (arguments.length === 1) {
    // Pass in a no-op function here to avoid adding more conditionals in the _callTransport fn
    cb = noop;
    data = getData({}, token);
  } else if (arguments.length === 2) {
    if (isFunction(arguments[1])) {
      cb = arguments[1];
      data = getData({}, token);
    } else {
      cb = noop;
      data = getData(optData, token);
    }
  } else if (arguments.length === 3) {
    cb = optCb || noop;
    data = getData(optData, token);
  }

  return {
    cb: cb,
    data: data,
  };
};


module.exports.getData = getData;
module.exports.getAPICallArgs = getAPICallArgs;