Add integration klaviyo

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

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

integrations/klaviyo/HISTORY.md

@@ -0,0 +1,84 @@
+
+2.2.1 / 2017-04-13
+==================
+
+  * Remove traits.id as well if email enforced
+
+2.2.0 / 2017-04-05
+==================
+
+  * Add new option to only send $email
+
+2.1.2 / 2016-10-18
+==================
+
+  * Ensure unique $event_id for auto-generated  ordered product events
+
+2.1.1 / 2016-09-07
+==================
+
+  * update history.md
+
+2.1.0 / 2016-09-07
+==================
+  * support ecom spec v2
+
+2.0.0 / 2016-06-21
+==================
+
+  * Remove Duo compatibility
+  * Add CI setup (coverage, linting, cross-browser compatibility, etc.)
+  * Update eslint configuration
+
+
+1.0.9 / 2016-05-23
+==================
+
+  * Merge pull request #6 from segment-integrations/add-sku
+  * Added SKU to "Ordered Product" event.
+
+1.0.8 / 2016-05-17
+==================
+
+  * send ordered product event per product
+
+1.0.7 / 2016-05-16
+==================
+
+  * add support back for looking up urls
+
+1.0.6 / 2016-05-13
+==================
+
+  * remove lookup for product and image urls
+  * let custom props pass
+
+1.0.5 / 2016-05-07
+==================
+
+  * Bump Analytics.js core, tester, integration to use Facade 2.x
+
+1.0.4 / 2016-04-01
+==================
+
+  * enhance completed order events
+
+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/klaviyo/README.md

@@ -0,0 +1,12 @@
+# analytics.js-integration-klaviyo [![Build Status][ci-badge]][ci-link]
+
+Klaviyo 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-klaviyo
+[ci-badge]: https://circleci.com/gh/segment-integrations/analytics.js-integration-klaviyo.svg?style=svg

integrations/klaviyo/lib/index.js

@@ -0,0 +1,288 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+var integration = require('@segment/analytics.js-integration');
+var push = require('global-queue')('_learnq');
+var tick = require('next-tick');
+var Track = require('segmentio-facade').Track;
+var foldl = require('@ndhoule/foldl');
+var remove = require('obj-case').del;
+var extend = require('@ndhoule/extend');
+
+
+/**
+ * Expose `Klaviyo` integration.
+ */
+
+var Klaviyo = module.exports = integration('Klaviyo')
+  .assumesPageview()
+  .global('_learnq')
+  .option('apiKey', '')
+  .option('enforceEmail', false)
+  .tag('<script src="//a.klaviyo.com/media/js/analytics/analytics.js">');
+
+/**
+ * Initialize.
+ *
+ * https://www.klaviyo.com/docs/getting-started
+ *
+ * @api public
+ */
+
+Klaviyo.prototype.initialize = function() {
+  var self = this;
+  push('account', this.options.apiKey);
+  this.load(function() {
+    tick(self.ready);
+  });
+};
+
+/**
+ * Loaded?
+ *
+ * @api public
+ * @return {Boolean}
+ */
+
+Klaviyo.prototype.loaded = function() {
+  return !!(window._learnq && window._learnq.push !== Array.prototype.push);
+};
+
+/**
+ * Identify.
+ *
+ * @api public
+ * @param {Identify} identify
+ */
+
+Klaviyo.prototype.identify = function(identify) {
+  // if you don't send either userId or email, noop
+  if (!identify.userId() && !identify.email()) return;
+  // TODO: should map/alias the rest of the reserved props
+  var traitAliases = {
+    email: '$email',
+    id: '$id',
+    firstName: '$first_name',
+    lastName: '$last_name',
+    phone: '$phone_number',
+    title: '$title'
+  };
+  // don't add $id or id if email only option is enforced to prevent some edge case dupe profile issues with Klaviyo API
+  var traits = identify.traits(traitAliases);
+  if (this.options.enforceEmail) {
+    remove(traits, 'id');
+    remove(traits, '$id');
+  }
+  // if you enforce email but you don't send email, noop
+  if (this.options.enforceEmail && !traits.$email) return;
+  push('identify', traits);
+};
+
+/**
+ * Group.
+ *
+ * @param {Group} group
+ */
+
+Klaviyo.prototype.group = function(group) {
+  var props = group.properties();
+  if (!props.name) return;
+  push('identify', { $organization: props.name });
+};
+
+/**
+ * Track.
+ *
+ * @param {Track} track
+ */
+
+Klaviyo.prototype.track = function(track) {
+  push('track', track.event(), track.properties({
+    revenue: '$value'
+  }));
+};
+
+/**
+ * Completed Order
+ *
+ * http://learn.klaviyo.com/12887-Ecommerce:-Other-Integrations/product-activity-integrating-a-custom-ecommerce-cart-or-platform
+ * @param {Track} track
+ */
+
+Klaviyo.prototype.orderCompleted = function(track) {
+  var products = formatProducts(track.products());
+  // Their docs for client side tells users to send these properties slightly
+  // different than server side, although they don't have to be.
+  var payload = {
+    $event_id: track.orderId(),
+    $value: track.revenue(),
+    Categories: products.categories,
+    ItemNames: products.names,
+    Items: products.items
+  };
+
+  var whitelist = [
+    '$event_id',
+    '$value',
+    'orderId',
+    'order_id',
+    'categories',
+    'itemNames',
+    'items',
+    'revenue',
+    'total',
+    'products'
+  ];
+  // strip standard props and leave custom props only
+  var topLevelCustomProps = filter(track, whitelist);
+
+  payload = extend(payload, topLevelCustomProps);
+
+  push('track', track.event(), payload);
+
+  // Formulate payload per product to send
+  var productProperties = formatItems(track);
+
+  // Send a separate event for each product
+  for (var x = 0; x < productProperties.length; x++) {
+    push('track', 'Ordered Product', productProperties[x]);
+  }
+};
+
+
+/**
+ * Return only custom properties
+ *
+ * @param {Object, Array} facade, list
+ * @return {Object}
+ * @api private
+ */
+
+function filter(facade, list) {
+  var ret = facade.properties();
+  for (var x = 0; x < list.length; x++) {
+    remove(ret, list[x]);
+  }
+  return ret;
+}
+
+/**
+ * Format payload for each product.
+ *
+ * @param {Track} track
+ * @return {Array}
+ * @api private
+ */
+
+function formatItems(track) {
+  return foldl(function(payloads, props) {
+    var product = new Track({ properties: props });
+    var itemWhitelist = [
+      '$event_id',
+      '$value',
+      'name',
+      'product categories',
+      'category',
+      'id',
+      'productId',
+      'product_id',
+      'sku',
+      'quantity',
+      'price',
+      'productUrl',
+      'imageUrl'
+    ];
+
+    // filter standard item props so we can merge custom props later
+    var itemCustomProps = filter(product, itemWhitelist);
+
+    var item = reject({
+      $value: product.price(),
+      Name: product.name(),
+      Quantity: product.quantity(),
+      ProductCategories: [product.category()],
+      ProductURL: product.proxy('properties.productUrl'),
+      ImageURL: product.proxy('properties.imageUrl'),
+      SKU: product.sku()
+    });
+
+    // ensure unique $event_id is associated with each Ordered Product event by combining Order Completed
+    //  order_id and product's productId or SKU
+    var identifier = product.productId() || product.id() || product.sku();
+    item.$event_id = track.orderId() + '_' + identifier;
+
+    item = extend(item, itemCustomProps);
+    payloads.push(item);
+
+    return payloads;
+  }, [], track.products());
+}
+
+/**
+ * Format products array.
+ *
+ * @param {Array} track
+ * @return {Array}
+ * @api private
+ */
+
+function formatProducts(products) {
+  return foldl(function(payloads, props) {
+    var product = new Track({ properties: props });
+    var whitelist = [
+      'id',
+      'product_id',
+      'productId',
+      'sku',
+      'name',
+      'quantity',
+      'itemPrice',
+      'price',
+      'rowTotal',
+      'categories',
+      'category',
+      'productUrl',
+      'imageUrl'
+    ];
+    // filter standard traits to merge custom props later
+    var customProps = filter(product, whitelist);
+
+    var item = reject({
+      id: product.productId() || product.id(),
+      SKU: product.sku(),
+      Name: product.name(),
+      Quantity: product.quantity(),
+      ItemPrice: product.price(),
+      RowTotal: product.price(),
+      Categories: [product.category()],
+      ProductURL: product.proxy('properties.productUrl'),
+      ImageURL: product.proxy('properties.imageUrl')
+    });
+    item = extend(item, customProps);
+    payloads.items.push(item);
+    payloads.categories.push(product.category());
+    payloads.names.push(product.name());
+
+    return payloads;
+  }, { categories: [], names: [], items: [] }, products);
+}
+
+/**
+ * Return a copy of an object, less an  `undefined` values.
+ *
+ * @param {Object} obj
+ * @return {Object}
+ * @api private
+ */
+
+function reject(obj) {
+  return foldl(function(result, val, key) {
+    if (val !== undefined) {
+      result[key] = val;
+    }
+    return result;
+  }, {}, obj);
+}