Add integration intercom

This commit copies the content of the integration repo into
the "integrations" folder.

Original repo: https://github.com/segment-integrations/analytics.js-integration-intercom
Readme: https://github.com/segment-integrations/analytics.js-integration-intercom/blob/master/README.md

Author: SegmentDestinationsBot

integrations/intercom/HISTORY.md

@@ -0,0 +1,69 @@
+
+3.0.0 / 2017-08-21
+==================
+
+  * Drop support for stringifying/flattened arrays or objects as requested by Intercom
+
+2.2.3 / 2017-02-16
+==================
+
+  * Update modules to support IE browsers
+
+2.2.2 / 2017-02-16
+==================
+
+  * Add option to let customers decide how they would like their custom nested traits to be handled
+  * Fix unsubscribe bug
+  * Add special hanlding for Rich Link
+
+2.1.2 / 2017-02-02
+==================
+
+  * Properly map monthlySpend and revenue for parity with server-side integration
+
+2.1.1 / 2016-09-13
+==================
+
+  * Fix ie8 compat (#17)
+
+2.1.0 / 2016-08-24
+==================
+
+  * support hide default launcher
+
+2.0.0 / 2016-06-21
+==================
+
+  * Remove Duo compatibility
+  * Add CI setup (coverage, linting, cross-browser compatibility, etc.)
+  * Update eslint configuration
+
+1.0.5 / 2016-05-07
+==================
+
+  * Bump Analytics.js core, tester, integration to use Facade 2.x
+
+1.0.4 / 2015-12-23
+==================
+
+  * deprecate increments
+
+1.0.3 / 2015-06-30
+==================
+
+  * Replace analytics.js dependency with analytics.js-core
+
+1.0.2 / 2015-06-24
+==================
+
+  * Bump analytics.js-integration version
+
+1.0.1 / 2015-06-24
+==================
+
+  * Bump analytics.js-integration version
+
+1.0.0 / 2015-06-09
+==================
+
+  * Initial commit :sparkles:

integrations/intercom/README.md

@@ -0,0 +1,12 @@
+# analytics.js-integration-intercom [![Build Status][ci-badge]][ci-link]
+
+Intercom integration for [Analytics.js][].
+
+## License
+
+Released under the [MIT license](LICENSE).
+
+
+[Analytics.js]: https://segment.com/docs/libraries/analytics.js/
+[ci-link]: https://circleci.com/gh/segment-integrations/analytics.js-integration-intercom
+[ci-badge]: https://circleci.com/gh/segment-integrations/analytics.js-integration-intercom.svg?style=svg

integrations/intercom/lib/index.js

@@ -0,0 +1,307 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+var convertDates = require('@segment/convert-dates');
+var defaults = require('@ndhoule/defaults');
+var del = require('obj-case').del;
+var integration = require('@segment/analytics.js-integration');
+var is = require('is');
+var extend = require('@ndhoule/extend');
+var clone = require('@ndhoule/clone');
+var each = require('@ndhoule/each');
+var pick = require('@ndhoule/pick');
+
+/**
+ * Expose `Intercom` integration.
+ */
+
+var Intercom = module.exports = integration('Intercom')
+  .global('Intercom')
+  .option('activator', '#IntercomDefaultWidget')
+  .option('appId', '')
+  .option('richLinkProperties', [])
+  .tag('<script src="https://widget.intercom.io/widget/{{ appId }}">');
+
+/**
+ * Initialize.
+ *
+ * http://docs.intercom.io/
+ * http://docs.intercom.io/#IntercomJS
+ *
+ * @api public
+ */
+
+Intercom.prototype.initialize = function() {
+  // Shim out the Intercom library.
+  window.Intercom = function() {
+    window.Intercom.q.push(arguments);
+  };
+  window.Intercom.q = [];
+
+  this.load(this.ready);
+};
+
+/**
+ * Loaded?
+ *
+ * @api private
+ * @return {boolean}
+ */
+
+Intercom.prototype.loaded = function() {
+  return typeof window.Intercom === 'function';
+};
+
+/**
+ * Page.
+ *
+ * @api public
+ * @param {Page} page
+ */
+
+Intercom.prototype.page = function(page) {
+  var integrationSettings = page.options(this.name);
+  this.bootOrUpdate({}, integrationSettings);
+};
+
+/**
+ * Identify.
+ *
+ * http://docs.intercom.io/#IntercomJS
+ *
+ * @api public
+ * @param {Identify} identify
+ */
+
+Intercom.prototype.identify = function(identify) {
+  var traits = identify.traits({ userId: 'user_id' });
+  var integrationSettings = identify.options(this.name);
+  var companyCreated = identify.companyCreated();
+  var created = identify.created();
+  var name = identify.name();
+  var id = identify.userId();
+  var group = this.analytics.group();
+  var settings = this.options;
+
+  if (!id && !identify.email()) {
+    return;
+  }
+
+  // intercom requires `company` to be an object. default it with group traits
+  // so that we guarantee an `id` is there, since they require it
+  if (traits.company !== null && !is.object(traits.company)) {
+    delete traits.company;
+  }
+
+  if (traits.company) {
+    defaults(traits.company, group.traits());
+  }
+
+  // name
+  if (name) traits.name = name;
+
+  // handle dates
+  if (created) {
+    del(traits, 'created');
+    del(traits, 'createdAt');
+    traits.created_at = created;
+  }
+
+  if (companyCreated) {
+    del(traits.company, 'created');
+    del(traits.company, 'createdAt');
+    traits.company.created_at = companyCreated;
+  }
+
+  // convert dates
+  traits = convertDates(traits, formatDate);
+
+  // format nested custom traits
+  traits = formatNestedCustomTraits(traits, settings);
+
+  // handle options
+  if (integrationSettings.userHash) traits.user_hash = integrationSettings.userHash;
+  if (integrationSettings.user_hash) traits.user_hash = integrationSettings.user_hash;
+
+  this.bootOrUpdate(traits, integrationSettings);
+};
+
+/**
+ * Group.
+ *
+ * @api public
+ * @param {Group} group
+ */
+
+Intercom.prototype.group = function(group) {
+  var settings = this.options;
+  // using .traits here since group.properties() doesn't take alias object
+  var props = group.traits({
+    createdAt: 'created',
+    created: 'created_at',
+    monthlySpend: 'monthly_spend'
+  });
+  props = convertDates(props, formatDate);
+  var id = group.groupId();
+  if (id) props.id = id;
+  var integrationSettings = group.options(this.name);
+
+  // format nested custom traits
+  props = formatNestedCustomTraits(props, settings);
+
+  var traits = extend({ company: props }, hideDefaultLauncher(integrationSettings));
+
+  api('update', traits);
+};
+
+/**
+ * Track.
+ *
+ * @api public
+ * @param {Track} track
+ */
+
+Intercom.prototype.track = function(track) {
+  var settings = this.options;
+  var props = track.properties();
+  var revenue = track.revenue();
+  if (revenue) {
+    var revenueData = {
+      // Intercom requests value in cents
+      price: {
+        amount: revenue * 100,
+        currency: track.currency() // fallsback on 'USD'
+      }
+    };
+  }
+
+  // format Nested custom traits
+  props = formatNestedCustomTraits(props, settings);
+
+  props = extend(props, revenueData);
+  del(props, 'revenue');
+  del(props, 'currency');
+
+  api('trackEvent', track.event(), props);
+};
+
+/**
+ * Boots or updates, as appropriate.
+ *
+ * @api private
+ * @param {Object} options
+ */
+
+Intercom.prototype.bootOrUpdate = function(options, integrationSettings) {
+  options = options || {};
+  var method = this.booted === true ? 'update' : 'boot';
+  var activator = this.options.activator;
+  options.app_id = this.options.appId;
+
+  // Intercom, will force the widget to appear if the selector is
+  // #IntercomDefaultWidget so no need to check inbox, just need to check that
+  // the selector isn't #IntercomDefaultWidget.
+  if (activator !== '#IntercomDefaultWidget') {
+    options.widget = { activator: activator };
+  }
+  // Check for selective showing of messenger option
+  options = extend(options, hideDefaultLauncher(integrationSettings));
+
+  api(method, options);
+  this.booted = true;
+};
+
+/**
+ * Format a date to Intercom's liking.
+ *
+ * @api private
+ * @param {Date} date
+ * @return {number}
+ */
+
+function formatDate(date) {
+  return Math.floor(date / 1000);
+}
+
+/**
+ * Flatten selectively based on your settings. You can either stringify, flatten, or drop the properties.
+ * Intercom rejects nested objects so you must choose a method.
+ *
+ * @param {Object} obj
+ * @param {Object} settings
+ * @return {Object} ret
+ * @api private
+ */
+
+function formatNestedCustomTraits(obj, settings) {
+  var richLinkProperties = settings.richLinkProperties;
+  var basicIntercomTraits = [
+    'companies',
+    'company',
+    'created_at',
+    'created',
+    'custom_attributes',
+    'company_id',
+    'id',
+    'name',
+    'monthly_spend',
+    'plan',
+    'remote_created_at',
+    'remove',
+    'user_id',
+    'email'
+  ];
+
+  // add rich link object to semantic traits so that it's not altered by the default method and
+  // is passed to intercom as a nested object: https://developers.intercom.com/reference#event-metadata-types
+  var semanticTraits = basicIntercomTraits.concat(richLinkProperties);
+
+  // clone traits so we don't modify the original object
+  var customTraits = clone(obj);
+
+  // filter out semanticTraits so that we only format custom nested traits
+  each(function(trait) {
+    del(customTraits, trait);
+  }, semanticTraits);
+
+  // create object without custom traits to merge with formatted custom traits in the end
+  var standardTraits = pick(semanticTraits, obj);
+
+  // drop any arrays or objects
+  var supportedTraits = {};
+  each(function(value, key) {
+    if (!is.object(value) && !is.array(value)) supportedTraits[key] = value;
+  }, customTraits);
+
+  // combine all the traits
+  return extend(supportedTraits, standardTraits);
+}
+
+/**
+ * Push a call onto the Intercom queue.
+ *
+ * @api private
+ */
+
+function api() {
+  window.Intercom.apply(window.Intercom, arguments);
+}
+
+/**
+ * Selectively hide messenger
+ * https://docs.intercom.io/configure-intercom-for-your-product-or-site/customize-the-intercom-messenger/customize-the-intercom-messenger-technical#show-the-intercom-messenger-to-selected-users-for-web-
+ * @param {Object} options
+ * @return {Object} ret
+ * @api private
+ */
+
+function hideDefaultLauncher(options) {
+  var ret = {};
+  var setting = options.hideDefaultLauncher;
+  if (setting === undefined || typeof setting !== 'boolean') return ret;
+  ret.hide_default_launcher= setting;
+  return ret;
+}