Feature/tracking module

.nycrc

@@ -1,4 +1,7 @@
 {
+  "exclude": [
+    "src/store/*"
+  ],
   "include": [
     "src/*"
   ],

README.md

@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-client-javascript)](https://www.npmjs.com/package/@constructor-io/constructorio-client-javascript)
 ![David (path)](https://img.shields.io/david/Constructor-io/constructorio-client-javascript)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-client-javascript/blob/master/LICENSE) 
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-client-javascript/blob/master/LICENSE)
 
 A JavaScript client for [Constructor.io](http://constructor.io/). [Constructor.io](http://constructor.io/) provides search as a service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for conversions, and user personalization).
 
@@ -26,7 +26,7 @@ var constructorio = new ConstructorIOClient({
 
 ## 4. Retrieve Results
 
-After instantiating an instance of the client, three modules will be exposed as properties to help retrieve data from Constructor.io: `search`, `autocomplete`, and `recommendations`.
+After instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: `search`, `autocomplete`, `recommendations` and `tracking`.
 
 ### Search
 
@@ -130,6 +130,93 @@ constructorio.recommendations.getUserFeaturedItems({ parameters }).then(function
 | --- | --- | --- |
 | `results` | number | Number of results to retrieve |
 
+### Tracker
+
+The tracker module can be used to send tracking events. Returns `true` when successful, or will throw an error if an issue is encountered.
+
+#### Send autocomplete select event
+```javascript
+constructorio.tracker.trackAutocompleteSelect('dogs', {
+    parameters
+});
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `original_query` | string | ? |
+| `result_id` | string | ? |
+| `section` | string | ? |
+| `tr` | string | ? |
+| `group_id` | string | ? |
+| `display_name` | string | ? |
+
+#### Send autocomplete search event
+```javascript
+constructorio.tracker.trackSearchSubmit('dogs', {
+    parameters
+});
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `original_query` | string | ? |
+| `result_id` | string | ? |
+| `group_id` | string | ? |
+| `display_name` | string | ? |
+
+#### Send search results event
+```javascript
+constructorio.tracker.trackSearchResultsLoaded('dogs', {
+    parameters
+});
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `num_results` | string | ? |
+| `customer_ids` | string | ? |
+
+#### Send search result click event
+```javascript
+constructorio.tracker.trackSearchResultClick('dogs', {
+    parameters
+});
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `name` | string | ? |
+| `customer_id` | string | ? |
+| `result_id` | string | ? |
+
+#### Send conversion event
+```javascript
+constructorio.tracker.trackConversion('dogs', {
+    parameters
+});
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `name` | string | ? |
+| `customer_id` | string | ? |
+| `result_id` | string | ? |
+| `revenue` | string | ? |
+| `section` | string | ? |
+
+#### Send purchase event
+```javascript
+constructorio.tracker.trackPurchase({
+    parameters
+});
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `customer_ids` | string | ? |
+| `revenue` | string | ? |
+| `section` | string | ? |
+
 ## Development / npm commands
 
 ```bash

package.json

@@ -38,6 +38,7 @@
     "eslint-plugin-import": "^2.18.2",
     "http-server": "^0.11.1",
     "jsdoc": "^3.6.3",
+    "jsdom": "^15.1.1",
     "minami": "^1.2.3",
     "mocha": "^6.2.0",
     "mocha-jsdom": "^2.0.0",
@@ -50,6 +51,7 @@
     "@constructor-io/constructorio-id": "^2.1.1",
     "es6-promise": "^4.2.8",
     "fetch-ponyfill": "^6.1.0",
-    "qs": "^6.8.0"
+    "qs": "^6.8.0",
+    "store2": "^2.9.0"
   }
 }

spec/mocha.helpers.js

@@ -1,4 +1,54 @@
 const qs = require('qs');
+const { JSDOM } = require('jsdom');
+const store = require('../src/store/store');
+
+// Setup mock DOM environment
+const setupDOM = () => {
+  const { window } = new JSDOM();
+
+  global.window = window;
+  global.document = window.document;
+};
+
+// Tear down mock DOM environment
+const teardownDOM = () => {
+  delete global.window;
+  delete global.document;
+};
+
+// Trigger browser resize event
+const triggerResize = () => {
+  const resizeEvent = document.createEvent('Event');
+
+  resizeEvent.initEvent('resize', true, true);
+
+  global.window.resizeTo = (width, height) => {
+    global.window.innerWidth = width || global.window.innerWidth;
+    global.window.innerHeight = height || global.window.innerHeight;
+    global.window.dispatchEvent(resizeEvent);
+  };
+
+  window.resizeTo(1024, 768);
+};
+
+// Trigger browser unload event
+const triggerUnload = () => {
+  const unloadEvent = document.createEvent('Event');
+
+  unloadEvent.initEvent('beforeunload', true, true);
+
+  global.window.unload = () => {
+    global.window.dispatchEvent(unloadEvent);
+  };
+
+  window.unload();
+};
+
+// Clear local and session storage
+const clearStorage = () => {
+  store.local.clearAll();
+  store.session.clearAll();
+};
 
 // Extract query parameters as object from url
 const extractUrlParamsFromFetch = (fetch) => {
@@ -14,5 +64,10 @@ const extractUrlParamsFromFetch = (fetch) => {
 };
 
 module.exports = {
+  setupDOM,
+  teardownDOM,
+  triggerResize,
+  triggerUnload,
+  clearStorage,
   extractUrlParamsFromFetch,
 };

spec/src/modules/tracker-humanity.js

@@ -0,0 +1,53 @@
+const dotenv = require('dotenv');
+const chai = require('chai');
+const chaiAsPromised = require('chai-as-promised');
+const store = require('../../../src/store/store');
+const trackerHumanity = require('../../../src/modules/tracker-humanity');
+const helpers = require('../../mocha.helpers');
+
+chai.use(chaiAsPromised);
+dotenv.config();
+
+describe('ConstructorIO - Tracker - Humanity', () => {
+  describe('isHuman', () => {
+    const storageKey = '_constructorio_is_human';
+
+    beforeEach(() => {
+      global.CLIENT_VERSION = 'cio-mocha';
+
+      helpers.setupDOM();
+    });
+
+    afterEach(() => {
+      delete global.CLIENT_VERSION;
+
+      helpers.teardownDOM();
+      helpers.clearStorage();
+    });
+
+    it('Should not have isHuman flag set on initial instantiation', () => {
+      const humanity = trackerHumanity();
+
+      expect(humanity.isHuman()).to.equal(false);
+      expect(store.session.get(storageKey)).to.equal(null);
+    });
+
+    it('Should have isHuman flag set if human-like actions are detected', () => {
+      const humanity = trackerHumanity();
+
+      expect(humanity.isHuman()).to.equal(false);
+      helpers.triggerResize();
+      expect(humanity.isHuman()).to.equal(true);
+      expect(store.session.get(storageKey)).to.equal(true);
+    });
+
+    it('Should have isHuman flag set if session variable is set', () => {
+      const humanity = trackerHumanity();
+
+      expect(humanity.isHuman()).to.equal(false);
+      store.session.set(storageKey, true);
+      expect(humanity.isHuman()).to.equal(true);
+      expect(store.session.get(storageKey)).to.equal(true);
+    });
+  });
+});