Add Scratch-it Analytics integration [wip]

Author: cthorner

integrations.js

@@ -73,6 +73,7 @@ module.exports = [
   require('./lib/route'),
   require('./lib/saasquatch'),
   require('./lib/satismeter'),
+  require('./lib/scratch-it'),
   require('./lib/segmentio'),
   require('./lib/sentry'),
   require('./lib/snapengage'),

lib/scratch-it/index.js

@@ -0,0 +1,57 @@
+
+/**
+ * Module dependencies.
+ */
+
+var integration = require('analytics.js-integration');
+var is = require('is');
+var del = require('obj-case').del;
+
+/**
+ * Expose `ScratchIt` integration.
+ */
+
+var ScratchIt = module.exports = integration('Scratch-it Analytics')
+  .global('ScratchIt')
+  .option('trkId', '')
+  .tag('<script src="//static.scratch-it.com/public/scratch-it-analytics.min.js">');
+
+/**
+ * Initialize.
+ */
+
+ScratchIt.prototype.initialize = function() {
+  // Shim out the Scratchit library.
+  window.ScratchIt = {
+    track: function(event_type, event_name, parameters) {
+      // no-op
+      console.log(event_type);
+      console.log(event_name);
+      console.log(parameters);
+    }
+  }; // TODO: real object
+  this.load(this.ready);
+};
+
+/**
+ * Loaded?
+ *
+ * @return {boolean}
+ */
+
+ScratchIt.prototype.loaded = function() {
+  return is.fn(window.ScratchIt);
+};
+
+/**
+ * Track.
+ *
+ * @param {Track} track
+ */
+
+ScratchIt.prototype.track = function(track) {
+  var parameters = track.properties();
+  var event_type = parameters.event_type || 'track';
+  del(parameters, 'event_type');
+  window.ScratchIt.track(event_type, track.event(), parameters);
+};

lib/scratch-it/test.js

@@ -0,0 +1,81 @@
+var Analytics = require('analytics.js').constructor;
+var integration = require('analytics.js-integration');
+var sandbox = require('clear-env');
+var tester = require('analytics.js-integration-tester');
+var ScratchIt = require('./');
+
+describe('ScratchIt', function() {
+  var analytics;
+  var scratchIt;
+  var options = {
+    trkId: 'foo'
+  };
+
+  beforeEach(function() {
+    analytics = new Analytics();
+    scratchIt = new ScratchIt(options);
+    analytics.use(ScratchIt);
+    analytics.use(tester);
+    analytics.add(scratchIt);
+  });
+
+  afterEach(function() {
+    analytics.restore();
+    analytics.reset();
+    scratchIt.reset();
+    sandbox();
+  });
+
+  it('should have the right settings', function() {
+    analytics.compare(ScratchIt, integration('Scratch-it Analytics')
+        .global('ScratchIt')
+        .option('trkId', ''));
+  });
+
+  describe('before loading', function() {
+    beforeEach(function() {
+      analytics.stub(scratchIt, 'load');
+    });
+
+    describe('#initialize', function() {
+      it('should create the window.ScratchIt object', function() {
+        analytics.assert(window.ScratchIt === undefined);
+        analytics.initialize();
+        analytics.assert(window.ScratchIt);
+      });
+
+      it('should call #load', function() {
+        analytics.initialize();
+        analytics.called(scratchIt.load);
+      });
+    });
+  });
+
+  describe('after loading', function() {
+    beforeEach(function(done) {
+      analytics.once('ready', done);
+      analytics.initialize();
+    });
+
+    describe('#track', function() {
+      beforeEach(function() {
+        analytics.stub(window.ScratchIt, 'track');
+      });
+
+      it('should send an event with default type', function() {
+        analytics.track('Goal Reached');
+        analytics.called(window.ScratchIt.track, 'track', 'Goal Reached', {});
+      });
+
+      it('should send an event', function() {
+        analytics.track('Started Scratching', { event_type: 'scratching_page' });
+        analytics.called(window.ScratchIt.track, 'scratching_page', 'Started Scratching', {});
+      });
+
+      it('should send an event with properties', function() {
+        analytics.track('Started Scratching', { event_type: 'scratching_page', foo: 'bar' });
+        analytics.called(window.ScratchIt.track, 'scratching_page', 'Started Scratching', { foo: 'bar' });
+      });
+    });
+  });
+});

test/index.js

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