Added setUserIdFromReferrer and setUserIdFromLocation (snowplow#57)

Author: fblundun

CHANGELOG

@@ -6,8 +6,8 @@ Renamed requestStringBuilder to payloadBuilder and moved it into its own file, p
 Introduced gzipped sp.js library (#48)
 Updated grunt and intern dependencies (#54)
 Replaced snowpak.sh with Grunt and grunt-yui-compressor (#53)
-Added setUserIdFromReferer('oaid') (#57) (TODO)
-Added ability to pass a referer to Snowplow from an IFRAME (#1) (TODO)
+Added setUserIdFromReferrer and setUserIdFromLocation (#57)
+Added ability to pass a referrer to Snowplow from an IFRAME (#1) (TODO)
 Added user fingerprinting on/off switch and configurable hash seed (#7) (TODO)
 
 Version 0.13.1 (2014-01-28)

examples/web/async.html

@@ -23,8 +23,8 @@
 
         _snaq.push(['setCollectorCf', 'd3rkrsqld9gmqf']); // Update to your CloudFront distribution subdomain
         _snaq.push(['setAppId', 'CFe23a']); // Site ID can be anything you want. Set it if you're tracking more than one site in this account
-        _snaq.push(['setUserId', 'alex 123']); // Business-defined user ID
-        // Deprecated _snaq.push(['attachUserId', false]); // Don't attach &uid=xxx to the querystring
+        //_snaq.push(['setUserId', 'alex 123']); // Business-defined user ID
+        //_snaq.push(['setUserIdFromLocation', 'id']); // To test this, reload the page with ?id=xxx
         _snaq.push(['setCustomUrl', '/overridden-url/']); // Override the page URL
         _snaq.push(['enableActivityTracking', 10, 10]); // Ping every 10 seconds after 10 seconds
         _snaq.push(['enableLinkTracking']);
@@ -45,7 +45,7 @@
         (function() {
             var sp = document.createElement('script'); sp.type = 'text/javascript'; sp.async = true; sp.defer = true;
             //sp.src = ('https:' == document.location.protocol ? 'https' : 'http') + '://d1fc8wv8zag5ca.cloudfront.net/0.13.0/sp.js';
-             sp.src = '../../dist/sp.js'; // For testing
+             sp.src = '../../dist/sp.nogz.js'; // For testing
             var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(sp, s);
             })();
     </script>

examples/web/sync.html

@@ -20,7 +20,7 @@
     <!-- Snowplow starts plowing -->
     <script type="text/javascript">
     //var spSrc = ('https:' == document.location.protocol ? 'https' : 'http') + '://d1fc8wv8zag5ca.cloudfront.net/0.13.0/sp.js';
-     var spSrc = '../../dist/sp.js'; // For testing
+     var spSrc = '../../dist/sp.nogz.js'; // For testing
     document.write(unescape("%3Cscript src='" + spSrc + "' type='text/javascript'%3E%3C/script%3E"));
     </script>
     <script type="text/javascript">

src/js/helpers.js

@@ -324,3 +324,10 @@ SnowPlow.executePluginMethod = function (methodName, callback) {
 	return result;
 }
 
+SnowPlow.fromQuerystring = function (field, url) {
+	var match = RegExp('[?&]' + field + '=([^&]*)').exec(url);
+	if (!match) {
+		return null;
+	}
+	return SnowPlow.decodeWrapper(match[1].replace(/\+/g, ' '));
+}

src/js/tracker.js

@@ -52,8 +52,11 @@ SnowPlow.Tracker = function Tracker(argmap) {
 	 ************************************************************/
 
 	var
+		// Get the referrer URL
+		referrer =  SnowPlow.getReferrer(),
+
 		// Current URL and Referrer URL
-		locationArray = SnowPlow.fixupUrl(SnowPlow.documentAlias.domain, SnowPlow.windowAlias.location.href, SnowPlow.getReferrer()),
+		locationArray = SnowPlow.fixupUrl(SnowPlow.documentAlias.domain, SnowPlow.windowAlias.location.href, referrer),
 		domainAlias = SnowPlow.fixupDomain(locationArray[0]),
 		locationHrefAlias = locationArray[1],
 		configReferrerUrl = locationArray[2],
@@ -1545,6 +1548,29 @@ SnowPlow.Tracker = function Tracker(argmap) {
 			businessUserId = userId;
 		},
 
+		/**
+		 * Set the business-defined user ID for this user using the location querystring.
+		 * 
+		 * @param string queryName Name of a querystring name-value pair
+		 */
+
+		 setUserIdFromLocation: function(queryName) {
+		 	
+		 	var location = document.URL;
+		 	businessUserId = SnowPlow.fromQuerystring(queryName, location);
+		 },
+
+		/**
+		 * Set the business-defined user ID for this user using the referrer querystring.
+		 * 
+		 * @param string queryName Name of a querystring name-value pair
+		 */
+
+		 setUserIdFromReferrer: function(queryName) {
+
+		 	businessUserId = SnowPlow.fromQuerystring(queryName, referrer);
+		 },
+
 		/**
 		 * Toggle whether to attach User ID to the querystring or not
 		 *
@@ -1553,7 +1579,7 @@ SnowPlow.Tracker = function Tracker(argmap) {
 		 * cookie). So there's no need to enable or disable specific user IDs.
 		 *
 		 * @param bool attach Whether to attach User ID or not
-		 */
+		 */ 
 		attachUserId: function (attach) {
 
 			if (typeof console !== 'undefined') {