Added more functionality and tests

Author: fblundun

core/Gruntfile.js

@@ -45,7 +45,7 @@ module.exports = function(grunt) {
           suites: [
             'tests/base64.js',
             'tests/payload.js',
-            'tests/integration.js'
+            'tests/core.js'
             ]
         }
       }

core/lib/core.js

@@ -34,28 +34,28 @@
 
 var payload = require('./payload.js');
 
-function trackerCore(base64) {
+module.exports = function trackerCore(base64) {
 
 	// Dictionary of key-value pairs which get added to every payload, e.g. tracker version
-	var state = {};
+	var environment = {};
 
 	/**
 	 * Set a persistent key-value pair to be added to every payload
 	 *
 	 * @param string key Field name
 	 * @param string value Field value
 	 */
-	 function setState(key, value) {
-	 	state[key] = value;
+	 function setEnvironment(key, value) {
+	 	environment[key] = value;
 	 }
 
 	/**
-	 * Replace state with a new dictionary
+	 * Replace environment with a new dictionary
 	 *
-	 * @param object newState New dictionary
+	 * @param object newenvironment New dictionary
 	 */
-	function resetState(newState) {
-		state = payload.isJson(newState) ? newState : {};
+	function resetEnvironment(newenvironment) {
+		environment = payload.isJson(newenvironment) ? newenvironment : {};
 	}
 
 	function completeContexts(contexts) {
@@ -81,10 +81,11 @@ function trackerCore(base64) {
 			data: properties
 		};
 
+		sb.add('e', 'ue');
 		sb.addJson('ue_px', 'ue_pr', ueJson);
-		sb.addDict(state);
+		sb.addDict(environment);
 
-		return sb;
+		return sb.build();
 	}
 
 	/**
@@ -101,14 +102,14 @@ function trackerCore(base64) {
 		var sb = payload.payloadBuilder(base64);
 		sb.add('e', 'se'); // 'se' for Structured Event
 		sb.add('se_ca', category);
-		sb.add('se_ac', action)
+		sb.add('se_ac', action);
 		sb.add('se_la', label);
 		sb.add('se_pr', property);
 		sb.add('se_va', value);
 
-		sb.addDict(state);
+		sb.addDict(environment);
 
-		return sb;
+		return sb.build();
 	}
 
 	/**
@@ -144,10 +145,10 @@ function trackerCore(base64) {
 		sb.add('url', pageUrl);
 		sb.add('page', pageTitle);
 		sb.add('refr', referrer);
-		sb.addDict(state);
+		sb.addDict(environment);
 		sb.addJson('cx', 'co', completeContexts(context));
 
-		return sb;
+		return sb.build();
 	}
 
 	/**
@@ -163,9 +164,9 @@ function trackerCore(base64) {
 		sb.add('url', pageUrl);
 		sb.add('page', pageTitle);
 		sb.add('refr', referrer);
-		sb.addDict(state);
+		sb.addDict(environment);
 
-		return sb;
+		return sb.build();
 	}
 
 	/**
@@ -185,18 +186,18 @@ function trackerCore(base64) {
 	function trackEcommerceTransaction(orderId, totalValue, affiliation, taxValue, shipping, city, state, country, currency, items, context) {
 		var sb = payload.payloadBuilder(base64);
 		sb.add('e', 'tr'); // 'tr' for Transaction
-		sb.add("tr_id", orderId)
-		sb.add("tr_tt", totalValue)
-		sb.add("tr_af", affiliation)
-		sb.add("tr_tx", taxValue)
-		sb.add("tr_sh", shipping)
-		sb.add("tr_ci", city)
-		sb.add("tr_st", state)
-		sb.add("tr_co", country)
-		sb.add("tr_cu", currency)
-		sb.addDict(state);
-
-		return sb;
+		sb.add("tr_id", orderId);
+		sb.add("tr_tt", totalValue);
+		sb.add("tr_af", affiliation);
+		sb.add("tr_tx", taxValue);
+		sb.add("tr_sh", shipping);
+		sb.add("tr_ci", city);
+		sb.add("tr_st", state);
+		sb.add("tr_co", country);
+		sb.add("tr_cu", currency);
+		sb.addDict(environment);
+
+		return sb.build();
 	}
 
 	/**
@@ -213,16 +214,16 @@ function trackerCore(base64) {
 	 */
 	function trackEcommerceTransactionItem(orderId, sku, price, quantity, name, category, currency, context) {
 		var sb = payload.payloadBuilder(base64)
-		sb.add("e", "ti") // 'tr' for Transaction Item
-		sb.add("ti_id", orderId)
-		sb.add("ti_sk", sku)
-		sb.add("ti_nm", name)
-		sb.add("ti_ca", category)
-		sb.add("ti_pr", price)
-		sb.add("ti_qu", quantity)
-		sb.add("ti_cu", currency)
-
-		return sb;
+		sb.add("e", "ti"); // 'tr' for Transaction Item
+		sb.add("ti_id", orderId);
+		sb.add("ti_sk", sku);
+		sb.add("ti_nm", name);
+		sb.add("ti_ca", category);
+		sb.add("ti_pr", price);
+		sb.add("ti_qu", quantity);
+		sb.add("ti_cu", currency);
+
+		return sb.build();
 	}
 
 
@@ -309,7 +310,7 @@ function trackerCore(base64) {
 			}
 		};
 
-		trackUnstructEvent(eventJson, context);
+		return trackUnstructEvent(eventJson, context);
 	}
 
 	/**
@@ -342,12 +343,12 @@ function trackerCore(base64) {
 			}
 		};
 
-		trackUnstructEvent(eventJson, context);
+		return trackUnstructEvent(eventJson, context);
 	}
 
 	return {
-		setState: setState,
-		resetState: resetState,
+		setEnvironment: setEnvironment,
+		resetEnvironment: resetEnvironment,
 		trackUnstructEvent: trackUnstructEvent,
 		trackStructEvent: trackStructEvent,
 		trackPageView: trackPageView,

core/tests/base64.js

@@ -39,7 +39,7 @@ define([
 ], function(registerSuite, assert, base64) {
 
 	registerSuite({
-		name: "base64 encoding test",
+		name: "Base 64 encoding test",
 		"Encode a string": function() {
 			assert.strictEqual(base64.base64encode('my_string'), 'bXlfc3RyaW5n', 'Base64-encode a string');
 		},

core/tests/core.js

@@ -0,0 +1,125 @@
+/*
+ * JavaScript tracker core for Snowplow: tests/integration.js
+ * 
+ * Significant portions copyright 2010 Anthon Pang. Remainder copyright 
+ * 2012-2014 Snowplow Analytics Ltd. All rights reserved. 
+ * 
+ * Redistribution and use in source and binary forms, with or without 
+ * modification, are permitted provided that the following conditions are 
+ * met: 
+ *
+ * * Redistributions of source code must retain the above copyright 
+ *   notice, this list of conditions and the following disclaimer. 
+ *
+ * * Redistributions in binary form must reproduce the above copyright 
+ *   notice, this list of conditions and the following disclaimer in the 
+ *   documentation and/or other materials provided with the distribution. 
+ *
+ * * Neither the name of Anthon Pang nor Snowplow Analytics Ltd nor the
+ *   names of their contributors may be used to endorse or promote products
+ *   derived from this software without specific prior written permission. 
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+define([
+	"intern!object",
+	"intern/chai!assert",
+	"intern/dojo/node!../lib/core.js",
+	"intern/dojo/node!JSON"
+], function(registerSuite, assert, core, JSON) {
+
+	var tracker = core(false);
+
+	registerSuite({
+		name: "Tracking events",
+		"Track a page view": function() {
+			var url = 'http://www.example.com';
+			var page = 'title page';
+			var expected = {
+				e: 'pv',
+				url: url,
+				page: page
+			};
+			assert.deepEqual(tracker.trackPageView(url, page), expected, 'A page view should be tracked correctly');
+		},
+
+		"Track a page ping": function() {
+			var url = 'http://www.example.com';
+			var referer = 'http://www.google.com';
+			var expected = {
+				e: 'pp',
+				url: url,
+				refr: referer
+			};
+
+			assert.deepEqual(tracker.trackPagePing(url, null, referer), expected, 'A page ping should be tracked correctly');
+		},
+
+		"Track a structured event": function() {
+			var expected = {
+				e: 'se',
+				se_ca: 'cat',
+				se_ac: 'act',
+				se_la: 'lab',
+				se_pr: 'prop',
+				se_va: 'val'
+			};
+
+			assert.deepEqual(tracker.trackStructEvent('cat', 'act', 'lab', 'prop', 'val'), expected, 'A structured event should be tracked correctly');
+		},
+
+		"Track an ecommerce transaction event": function() {
+			var orderId = 'ak0008';
+			var totalValue = 50;
+			var taxValue = 6;
+			var shipping = 0;
+			var city = 'Phoenix';
+			var state = 'Arizona';
+			var country = 'USA';
+			var currency = 'USD';
+			var expected = {
+				e: 'tr',
+				tr_tt: totalValue,
+				tr_tx: taxValue,
+				tr_id: orderId,
+				tr_sh: shipping,
+				tr_ci: city,
+				tr_st: state,
+				tr_co: country,
+				tr_cu: currency
+			};
+
+			assert.deepEqual(tracker.trackEcommerceTransaction(orderId, totalValue, null, taxValue, shipping, city, state, country, currency), expected, 'A transaction event should be tracked correctly');
+		},
+
+		"Track an unstructured event": function() {
+			var inputJson = {
+				schema: 'iglu:com.acme/user/jsonschema/1-0-1',
+				data: {
+					name: 'Eric'
+				}
+			}
+			var expected = {
+				e: 'ue',
+				ue_pr: JSON.stringify({
+					schema: 'iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0',
+					data: inputJson
+				})
+			};
+
+			assert.deepEqual(tracker.trackUnstructEvent(inputJson), expected, 'An unstructured event should be tracked correctly');
+		},		
+	});
+	
+});

core/tests/intern.js

@@ -1,5 +1,5 @@
 /*
- * JavaScript tracker for Snowplow: tests/intern.js
+ * JavaScript tracker core for Snowplow: tests/intern.js
  * 
  * Significant portions copyright 2010 Anthon Pang. Remainder copyright 
  * 2012-2014 Snowplow Analytics Ltd. All rights reserved. 
@@ -66,7 +66,7 @@ define({
 	loader: {},
 
 	// Functional test suite(s) to run in each browser once non-functional tests are completed
-	functionalSuites: ['tests/functional/helpers','tests/functional/detectors'],
+	functionalSuites: [],
 
 	// A regular expression matching URLs to files that should not be included in code coverage analysis
 	excludeInstrumentation: /^tests\//

core/tests/payload.js

@@ -84,16 +84,29 @@ define([
 		'Identify an empty JSON': function() {
 			var emptyJson = {};
 
-			assert.strictEqual(payload.isNonEmptyJson(emptyJson), false, 'Identify {} as empty')
+			assert.strictEqual(payload.isNonEmptyJson(emptyJson), false, '{} should be identified as empty')
 		},
 
 		'Build a payload': function () {
-
 			var sb = payload.payloadBuilder(false);
 			sb.add('e', 'pv');
 			sb.add('tv', 'js-2.0.0');
 
-			assert.deepEqual(sb.build(), {e: 'pv', tv: 'js-2.0.0'});
+			assert.deepEqual(sb.build(), {e: 'pv', tv: 'js-2.0.0'}, 'Individual name-value pairs should be added to the payload');
+		},
+
+		'Do not add undefined values to a payload': function () {
+			var sb = payload.payloadBuilder(false);
+			sb.add('e', undefined);
+
+			assert.deepEqual(sb.build(), {}, 'Undefined values should not be added to the payload');
+		},
+
+		'Do not add null values to a payload': function () {
+			var sb = payload.payloadBuilder(false);
+			sb.add('e', null);
+
+			assert.deepEqual(sb.build(), {}, 'Null values should not be added to the payload');
 		},
 
 		'Add a dictionary of name-value pairs to the payload': function () {
@@ -103,7 +116,7 @@ define([
 				'tv': 'js-2.0.0'
 			})
 
-			assert.deepEqual(sb.build(), {e: 'pv', tv: 'js-2.0.0'});
+			assert.deepEqual(sb.build(), {e: 'pv', tv: 'js-2.0.0'}, 'A dictionary of name-value pairs should be added to the payload');
 		},
 
 		'Add a JSON to the payload': function() {