Merge pull request #638 from segmentio/VentureCraft-master

Initial Elevio integration added

Author: Nathan Houle

integrations.js

@@ -26,6 +26,7 @@ module.exports = [
   require('./lib/curebit'),
   require('./lib/customerio'),
   require('./lib/drip'),
+  require('./lib/elevio'),
   require('./lib/errorception'),
   require('./lib/evergage'),
   require('./lib/extole'),

lib/elevio/index.js

@@ -0,0 +1,56 @@
+var integration = require('analytics.js-integration');
+var tick = require('next-tick');
+
+/**
+ * Expose `Elevio` integration.
+ */
+
+var Elevio = module.exports = integration('Elevio')
+  .assumesPageview()
+  .option('accountId', '')
+  .global('_elev')
+  .tag('<script src="//static.elev.io/js/v3.js">');
+
+/**
+ * Initialize elevio.
+ */
+
+Elevio.prototype.initialize = function(){
+  var self = this;
+  window._elev = window._elev || {};
+  window._elev.account_id = this.options.accountId;
+  window._elev.segment = true;
+  this.load(function(){
+    tick(self.ready);
+  });
+};
+
+/**
+ * Has the elevio library been loaded yet?
+ *
+ * @return {Boolean}
+ */
+
+Elevio.prototype.loaded = function(){
+  return !!window._elev;
+};
+
+/**
+ * Identify a user.
+ *
+ * @param {Facade} identify
+ */
+
+Elevio.prototype.identify = function(identify){
+  var name = identify.name();
+  var email = identify.email();
+  var plan = identify.proxy('traits.plan');
+
+  var user = {};
+  user.via = 'segment';
+  if (email) user.email = email;
+  if (name) user.name = name;
+  if (plan) user.plan = [plan];
+
+  window._elev.user = user;
+};

lib/elevio/test.js

@@ -0,0 +1,109 @@
+var Analytics = require('analytics.js').constructor;
+var integration = require('analytics.js-integration');
+var tester = require('analytics.js-integration-tester');
+var sandbox = require('clear-env');
+var Elevio = require('./');
+
+
+describe('Elevio', function(){
+  var analytics;
+  var elevio;
+  var options = {
+    accountId: 'konami'
+  };
+
+  beforeEach(function(){
+    analytics = new Analytics();
+    elevio = new Elevio(options);
+    analytics.use(Elevio);
+    analytics.use(tester);
+    analytics.add(elevio);
+  });
+
+  afterEach(function(){
+    analytics.restore();
+    analytics.reset();
+    elevio.reset();
+    sandbox();
+  });
+
+  it('should have the right settings', function(){
+    analytics.compare(Elevio, integration('Elevio')
+      .assumesPageview()
+      .global('_elev')
+      .option('accountId', ''));
+  });
+
+  describe('before loading', function(){
+    beforeEach(function(){
+      analytics.stub(window, '_elev');
+      analytics.stub(elevio, 'load');
+    });
+    describe('#initialize', function(){
+      it('should create window._elev', function(){
+        analytics.initialize();
+        analytics.page();
+        analytics.assert(window._elev instanceof Object);
+      });
+      it('should call #load', function(){
+        analytics.initialize();
+        analytics.page();
+        analytics.called(elevio.load);
+      });
+    });
+  });
+
+  describe('loading', function(){
+    it('should load', function(done){
+      analytics.load(elevio, done);
+    });
+  });
+
+  describe('after loading', function(){
+    beforeEach(function(done){
+      analytics.once('ready', done);
+      analytics.initialize();
+      analytics.page();
+    });
+
+    describe('#identify', function(){
+      beforeEach(function(){
+        // TODO: stub the integration global api.
+        // For example:
+        // analytics.stub(window.api, 'identify');
+      });
+
+      it('should send an email', function(){
+        analytics.identify('id', { email: '[email protected]' });
+        analytics.assert(window._elev.user.email === '[email protected]');
+      });
+
+      it('should send a full name', function(){
+        analytics.identify('id', { name: 'Test Person' });
+        analytics.assert(window._elev.user.name === 'Test Person');
+      });
+
+      it('should not send name', function(){
+        analytics.identify('id');
+        analytics.assert(window._elev.user.name === undefined);
+      });
+
+      // TODO seems Identify.prototype.name returns nothing when no last name is sent
+      // it('should send a first name', function(){
+        // analytics.identify(undefined, { firstName: 'Test' });
+        // analytics.assert(window._elev.user.name === 'Test');
+      // });
+
+      it('should send a combined name', function(){
+        analytics.identify('id', { firstName: 'Test', lastName: 'Person' });
+        analytics.assert(window._elev.user.name === 'Test Person');
+      });
+
+      it('should send their plan', function(){
+        analytics.identify('id', { plan: 'gold' });
+        analytics.assert(window._elev.user.plan instanceof Array);
+        analytics.assert(window._elev.user.plan[0] === 'gold');
+      });
+    });
+  });
+});

test/index.js

@@ -20,7 +20,7 @@ mocha.setup({
 
 describe('integrations', function(){
   it('should export our integrations', function(){
-    assert.equal(85, object.length(Integrations));
+    assert.equal(86, object.length(Integrations));
   });
 });