Added page scroll parameters to trackPagePing (fixes snowplow#257)

Author: fblundun

core/CHANGELOG

@@ -1,7 +1,7 @@
 Version 0.3.0 (2014-xx-xx)
 --------------------------
 Apply callback to the Payload for an event rather than the event dictionary (#259)
-Added page scroll parameters to trackPagePing (#257) (TODO)
+Added page scroll parameters to trackPagePing (#257)
 Added social tracking (#258) (TODO)
 
 Version 0.2.0 (2014-08-07)

core/lib/core.js

@@ -280,16 +280,24 @@ function trackerCore(base64, callback) {
 		 * by sending a page ping.
 		 *
 		 * @param string pageTitle The page title to attach to this page ping
+		 * @param minxoffset Minimum page x offset seen in the last ping period
+		 * @param maxXOffset Maximum page x offset seen in the last ping period
+		 * @param minYOffset Minimum page y offset seen in the last ping period
+		 * @param maxYOffset Maximum page y offset seen in the last ping period
 		 * @param array context Custom contexts relating to the event
 		 * @param number tstamp Timestamp of the event
 		 * @return object Payload
 		 */
-		trackPagePing: function (pageUrl, pageTitle, referrer, context, tstamp) {
+		trackPagePing: function (pageUrl, pageTitle, referrer, minXOffset, maxXOffset, minYOffset, maxYOffset, context, tstamp) {
 			var sb = payload.payloadBuilder(base64);
 			sb.add('e', 'pp'); // 'pv' for Page View
 			sb.add('url', pageUrl);
 			sb.add('page', pageTitle);
 			sb.add('refr', referrer);
+			sb.add('pp_mix', minXOffset);
+			sb.add('pp_max', maxXOffset);
+			sb.add('pp_miy', minYOffset);
+			sb.add('pp_may', maxYOffset);
 
 			return track(sb, context, tstamp);
 		},

core/tests/core.js

@@ -51,10 +51,14 @@ define([
 			var expected = {
 				e: 'pp',
 				url: url,
-				refr: referer
+				refr: referer,
+				pp_mix: 1,
+				pp_max: 2,
+				pp_miy: 3,
+				pp_may: 4
 			};
 
-			compare(tracker.trackPagePing(url, null, referer), expected, 'A page ping should be tracked correctly');
+			compare(tracker.trackPagePing(url, null, referer, 1, 2, 3, 4), expected, 'A page ping should be tracked correctly');
 		},
 
 		"Track a structured event": function () {