customer-io

index.js

/**
 * Module dependencies.
 */

var integration = require('../../../createIntegration')
var Identify = require('segmentio-facade').Identify
var mapper = require('./mapper')
var time = require('unix-time')

/**
 * Expose `CustomerIO`
 */

var CustomerIO = module.exports = integration('Customer.io')
  .endpoint('https://app.customer.io/api/v1/customers/')
  .channels(['server'])
  .ensure('settings.siteId')
  .ensure('settings.apiKey')
  .ensure('message.userId')
  .retries(2)

/**
 * Identify.
 *
 * http://customer.io/docs/api/rest.html#section-Creating_or_updating_customers
 *
 * @param {Identify} identify
 * @param {Function} fn
 * @api public
 */

CustomerIO.prototype.identify = function (identify, fn) {
  this
  .put(encodeURIComponent(identify.userId()))
  .auth(this.settings.siteId, this.settings.apiKey)
  .type('json')
  .send(mapper.identify(identify))
  .end(fn)
}

/**
 * Group.
 *
 * http://customer.io/docs/api/rest.html#section-Creating_or_updating_customers
 *
 * @param {Group} group
 * @param {Function} fn
 * @api public
 */

CustomerIO.prototype.group = function (group, fn) {
  var json = mapper.group(group)
  var identify = new Identify(json)
  this.identify(identify, fn)
}

/**
 * Track.
 *
 * http://customer.io/docs/api/rest.html#section-Track_a_custom_event
 *
 * @param {Track} track
 * @param {Function} fn
 * @api public
 */

CustomerIO.prototype.track = function (track, fn) {
  this
  .post(encodeURIComponent(track.userId()) + '/events')
  .auth(this.settings.siteId, this.settings.apiKey)
  .send(mapper.track(track))
  .type('json')
  .end(fn)
}

/**
 * Visit.
 *
 * @param {Facade} message
 * @param {Function} fn
 * @api private
 */

CustomerIO.prototype.visit = function (message, fn) {
  if (!message.active()) return setImmediate(fn)
  this
  .put(message.userId())
  .auth(this.settings.siteId, this.settings.apiKey)
  .send({ _last_visit: time(message.timestamp()) })
  .type('json')
  .end(fn)
}

/**
 * Page.
 *
 * Pages are custom events with type "page" and name set to the URL.
 *
 * @param {Page} page
 * @param {Function} fn
 * @api public
 */

CustomerIO.prototype.page = function (page, fn) {
  var self = this
  this.visit(page, function (err) {
    if (err) return fn(err)
    self
    .post(encodeURIComponent(page.userId()) + '/events')
    .auth(self.settings.siteId, self.settings.apiKey)
    .send(mapper.page(page))
    .type('json')
    .end(fn)
  })
}

/**
 * Screen.
 *
 * Screens are custom events with the naming 'Viewed %s Screen'
 *
 * @param {Screen} screen
 * @param {Function} fn
 * @api public
 */

CustomerIO.prototype.screen = function (screen, fn) {
  var self = this
  this.visit(screen, function (err) {
    if (err) return fn(err)
    self
    .post(encodeURIComponent(screen.userId()) + '/events')
    .auth(self.settings.siteId, self.settings.apiKey)
    .send(mapper.screen(screen))
    .type('json')
    .end(fn)
  })
}