ahoy_matey 1.5.3 → 3.0.1

data/vendor/assets/javascripts/ahoy.js

@@ -2,24 +2,160 @@
  * Ahoy.js
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.1.0
+ * v0.3.4
  * MIT License
  */
 
-/*jslint browser: true, indent: 2, plusplus: true, vars: true */
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+  typeof define === 'function' && define.amd ? define(factory) :
+  (global.ahoy = factory());
+}(this, (function () { 'use strict';
 
-(function (window) {
-  "use strict";
+  function isUndefined(value) {
+    return value === undefined;
+  }
+
+  function isNull(value) {
+    return value === null;
+  }
+
+  function isObject(value) {
+    return value === Object(value);
+  }
+
+  function isArray(value) {
+    return Array.isArray(value);
+  }
+
+  function isDate(value) {
+    return value instanceof Date;
+  }
+
+  function isBlob(value) {
+    return (
+      value &&
+      typeof value.size === 'number' &&
+      typeof value.type === 'string' &&
+      typeof value.slice === 'function'
+    );
+  }
+
+  function isFile(value) {
+    return (
+      isBlob(value) &&
+      (typeof value.lastModifiedDate === 'object' ||
+        typeof value.lastModified === 'number') &&
+      typeof value.name === 'string'
+    );
+  }
+
+  function isFormData(value) {
+    return value instanceof FormData;
+  }
+
+  function objectToFormData(obj, cfg, fd, pre) {
+    if (isFormData(cfg)) {
+      pre = fd;
+      fd = cfg;
+      cfg = null;
+    }
+
+    cfg = cfg || {};
+    cfg.indices = isUndefined(cfg.indices) ? false : cfg.indices;
+    cfg.nulls = isUndefined(cfg.nulls) ? true : cfg.nulls;
+    fd = fd || new FormData();
+
+    if (isUndefined(obj)) {
+      return fd;
+    } else if (isNull(obj)) {
+      if (cfg.nulls) {
+        fd.append(pre, '');
+      }
+    } else if (isArray(obj)) {
+      if (!obj.length) {
+        var key = pre + '[]';
+
+        fd.append(key, '');
+      } else {
+        obj.forEach(function(value, index) {
+          var key = pre + '[' + (cfg.indices ? index : '') + ']';
+
+          objectToFormData(value, cfg, fd, key);
+        });
+      }
+    } else if (isDate(obj)) {
+      fd.append(pre, obj.toISOString());
+    } else if (isObject(obj) && !isFile(obj) && !isBlob(obj)) {
+      Object.keys(obj).forEach(function(prop) {
+        var value = obj[prop];
+
+        if (isArray(value)) {
+          while (prop.length > 2 && prop.lastIndexOf('[]') === prop.length - 2) {
+            prop = prop.substring(0, prop.length - 2);
+          }
+        }
+
+        var key = pre ? pre + '[' + prop + ']' : prop;
+
+        objectToFormData(value, cfg, fd, key);
+      });
+    } else {
+      fd.append(pre, obj);
+    }
+
+    return fd;
+  }
+
+  var objectToFormdata = objectToFormData;
+
+  // https://www.quirksmode.org/js/cookies.html
+
+  var Cookies = {
+    set: function (name, value, ttl, domain) {
+      var expires = "";
+      var cookieDomain = "";
+      if (ttl) {
+        var date = new Date();
+        date.setTime(date.getTime() + (ttl * 60 * 1000));
+        expires = "; expires=" + date.toGMTString();
+      }
+      if (domain) {
+        cookieDomain = "; domain=" + domain;
+      }
+      document.cookie = name + "=" + escape(value) + expires + cookieDomain + "; path=/";
+    },
+    get: function (name) {
+      var i, c;
+      var nameEQ = name + "=";
+      var ca = document.cookie.split(';');
+      for (i = 0; i < ca.length; i++) {
+        c = ca[i];
+        while (c.charAt(0) === ' ') {
+          c = c.substring(1, c.length);
+        }
+        if (c.indexOf(nameEQ) === 0) {
+          return unescape(c.substring(nameEQ.length, c.length));
+        }
+      }
+      return null;
+    }
+  };
 
   var config = {
     urlPrefix: "",
     visitsUrl: "/ahoy/visits",
     eventsUrl: "/ahoy/events",
-    cookieDomain: null,
     page: null,
     platform: "Web",
-    useBeacon: false,
-    startOnReady: true
+    useBeacon: true,
+    startOnReady: true,
+    trackVisits: true,
+    cookies: true,
+    cookieDomain: null,
+    headers: {},
+    visitParams: {},
+    withCredentials: false
   };
 
   var ahoy = window.ahoy || window.Ahoy || {};
@@ -52,46 +188,26 @@
     return config.urlPrefix + config.eventsUrl;
   }
 
+  function isEmpty(obj) {
+    return Object.keys(obj).length === 0;
+  }
+
   function canTrackNow() {
-    return (config.useBeacon || config.trackNow) && canStringify && typeof(window.navigator.sendBeacon) !== "undefined";
+    return (config.useBeacon || config.trackNow) && isEmpty(config.headers) && canStringify && typeof(window.navigator.sendBeacon) !== "undefined" && !config.withCredentials;
   }
 
   // cookies
 
-  // http://www.quirksmode.org/js/cookies.html
   function setCookie(name, value, ttl) {
-    var expires = "";
-    var cookieDomain = "";
-    if (ttl) {
-      var date = new Date();
-      date.setTime(date.getTime() + (ttl * 60 * 1000));
-      expires = "; expires=" + date.toGMTString();
-    }
-    var domain = config.cookieDomain || config.domain;
-    if (domain) {
-      cookieDomain = "; domain=" + domain;
-    }
-    document.cookie = name + "=" + escape(value) + expires + cookieDomain + "; path=/";
+    Cookies.set(name, value, ttl, config.cookieDomain || config.domain);
   }
 
   function getCookie(name) {
-    var i, c;
-    var nameEQ = name + "=";
-    var ca = document.cookie.split(';');
-    for (i = 0; i < ca.length; i++) {
-      c = ca[i];
-      while (c.charAt(0) === ' ') {
-        c = c.substring(1, c.length);
-      }
-      if (c.indexOf(nameEQ) === 0) {
-        return unescape(c.substring(nameEQ.length, c.length));
-      }
-    }
-    return null;
+    return Cookies.get(name);
   }
 
   function destroyCookie(name) {
-    setCookie(name, "", -1);
+    Cookies.set(name, "", -1);
   }
 
   function log(message) {
@@ -102,7 +218,7 @@
 
   function setReady() {
     var callback;
-    while (callback = queue.shift()) {
+    while ((callback = queue.shift())) {
       callback();
     }
     isReady = true;
@@ -116,7 +232,36 @@
     }
   }
 
-  // http://stackoverflow.com/a/2117523/1177228
+  function matchesSelector(element, selector) {
+    var matches = element.matches ||
+      element.matchesSelector ||
+      element.mozMatchesSelector ||
+      element.msMatchesSelector ||
+      element.oMatchesSelector ||
+      element.webkitMatchesSelector;
+
+    if (matches) {
+      return matches.apply(element, [selector]);
+    } else {
+      log("Unable to match");
+      return false;
+    }
+  }
+
+  function onEvent(eventName, selector, callback) {
+    document.addEventListener(eventName, function (e) {
+      if (matchesSelector(e.target, selector)) {
+        callback(e);
+      }
+    });
+  }
+
+  // http://beeker.io/jquery-document-ready-equivalent-vanilla-javascript
+  function documentReady(callback) {
+    document.readyState === "interactive" || document.readyState === "complete" ? callback() : document.addEventListener("DOMContentLoaded", callback);
+  }
+
+  // https://stackoverflow.com/a/2117523/1177228
   function generateId() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
       var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
@@ -125,47 +270,73 @@
   }
 
   function saveEventQueue() {
-    // TODO add stringify method for IE 7 and under
-    if (canStringify) {
+    if (config.cookies && canStringify) {
       setCookie("ahoy_events", JSON.stringify(eventQueue), 1);
     }
   }
 
-  // from jquery-ujs
+  // from rails-ujs
 
   function csrfToken() {
-    return $("meta[name=csrf-token]").attr("content");
+    var meta = document.querySelector("meta[name=csrf-token]");
+    return meta && meta.content;
   }
 
   function csrfParam() {
-    return $("meta[name=csrf-param]").attr("content");
+    var meta = document.querySelector("meta[name=csrf-param]");
+    return meta && meta.content;
   }
 
   function CSRFProtection(xhr) {
     var token = csrfToken();
-    if (token) xhr.setRequestHeader("X-CSRF-Token", token);
+    if (token) { xhr.setRequestHeader("X-CSRF-Token", token); }
   }
 
   function sendRequest(url, data, success) {
     if (canStringify) {
-      $.ajax({
-        type: "POST",
-        url: url,
-        data: JSON.stringify(data),
-        contentType: "application/json; charset=utf-8",
-        dataType: "json",
-        beforeSend: CSRFProtection,
-        success: success
-      });
+      if ($) {
+        $.ajax({
+          type: "POST",
+          url: url,
+          data: JSON.stringify(data),
+          contentType: "application/json; charset=utf-8",
+          dataType: "json",
+          beforeSend: CSRFProtection,
+          success: success,
+          headers: config.headers,
+          xhrFields: {
+            withCredentials: config.withCredentials
+          }
+        });
+      } else {
+        var xhr = new XMLHttpRequest();
+        xhr.open("POST", url, true);
+        xhr.withCredentials = config.withCredentials;
+        xhr.setRequestHeader("Content-Type", "application/json");
+        for (var header in config.headers) {
+          if (config.headers.hasOwnProperty(header)) {
+            xhr.setRequestHeader(header, config.headers[header]);
+          }
+        }
+        xhr.onload = function() {
+          if (xhr.status === 200) {
+            success();
+          }
+        };
+        CSRFProtection(xhr);
+        xhr.send(JSON.stringify(data));
+      }
     }
   }
 
   function eventData(event) {
     var data = {
-      events: [event],
-      visit_token: event.visit_token,
-      visitor_token: event.visitor_token
+      events: [event]
     };
+    if (config.cookies) {
+      data.visit_token = event.visit_token;
+      data.visitor_token = event.visitor_token;
+    }
     delete event.visit_token;
     delete event.visitor_token;
     return data;
@@ -191,9 +362,11 @@
       var data = eventData(event);
       var param = csrfParam();
       var token = csrfToken();
-      if (param && token) data[param] = token;
-      var payload = new Blob([JSON.stringify(data)], {type : "application/json; charset=utf-8"});
-      navigator.sendBeacon(eventsUrl(), payload);
+      if (param && token) { data[param] = token; }
+      // stringify so we keep the type
+      data.events_json = JSON.stringify(data.events);
+      delete data.events;
+      window.navigator.sendBeacon(eventsUrl(), objectToFormdata(data));
     });
   }
 
@@ -201,15 +374,40 @@
     return config.page || window.location.pathname;
   }
 
+  function presence(str) {
+    return (str && str.length > 0) ? str : null;
+  }
+
+  function cleanObject(obj) {
+    for (var key in obj) {
+      if (obj.hasOwnProperty(key)) {
+        if (obj[key] === null) {
+          delete obj[key];
+        }
+      }
+    }
+    return obj;
+  }
+
   function eventProperties(e) {
-    var $target = $(e.currentTarget);
-    return {
-      tag: $target.get(0).tagName.toLowerCase(),
-      id: $target.attr("id"),
-      "class": $target.attr("class"),
+    var target = e.target;
+    return cleanObject({
+      tag: target.tagName.toLowerCase(),
+      id: presence(target.id),
+      "class": presence(target.className),
       page: page(),
-      section: $target.closest("*[data-section]").data("section")
-    };
+      section: getClosestSection(target)
+    });
+  }
+
+  function getClosestSection(element) {
+    for ( ; element && element !== document; element = element.parentNode) {
+      if (element.hasAttribute('data-section')) {
+        return element.getAttribute('data-section');
+      }
+    }
+
+    return null;
   }
 
   function createVisit() {
@@ -219,15 +417,14 @@
     visitorId = ahoy.getVisitorId();
     track = getCookie("ahoy_track");
 
-    if (visitId && visitorId && !track) {
+    if (config.cookies === false || config.trackVisits === false) {
+      log("Visit tracking disabled");
+      setReady();
+    } else if (visitId && visitorId && !track) {
       // TODO keep visit alive?
       log("Active visit");
       setReady();
     } else {
-      if (track) {
-        destroyCookie("ahoy_track");
-      }
-
       if (!visitId) {
         visitId = generateId();
         setCookie("ahoy_visit", visitId, visitTtl);
@@ -248,7 +445,8 @@
           platform: config.platform,
           landing_page: window.location.href,
           screen_width: window.screen.width,
-          screen_height: window.screen.height
+          screen_height: window.screen.height,
+          js: true
         };
 
         // referrer
@@ -256,9 +454,19 @@
           data.referrer = document.referrer;
         }
 
+        for (var key in config.visitParams) {
+          if (config.visitParams.hasOwnProperty(key)) {
+            data[key] = config.visitParams[key];
+          }
+        }
+
         log(data);
 
-        sendRequest(visitsUrl(), data, setReady);
+        sendRequest(visitsUrl(), data, function () {
+          // wait until successful to destroy
+          destroyCookie("ahoy_track");
+          setReady();
+        });
       } else {
         log("Cookies disabled");
         setReady();
@@ -294,67 +502,77 @@
   ahoy.track = function (name, properties) {
     // generate unique id
     var event = {
-      id: generateId(),
       name: name,
       properties: properties || {},
-      time: (new Date()).getTime() / 1000.0
+      time: (new Date()).getTime() / 1000.0,
+      id: generateId(),
+      js: true
     };
 
-    // wait for createVisit to log
-    $( function () {
-      log(event);
-    });
-
     ready( function () {
-      if (!ahoy.getVisitId()) {
+      if (config.cookies && !ahoy.getVisitId()) {
         createVisit();
       }
 
-      event.visit_token = ahoy.getVisitId();
-      event.visitor_token = ahoy.getVisitorId();
+      ready( function () {
+        log(event);
 
-      if (canTrackNow()) {
-        trackEventNow(event);
-      } else {
-        eventQueue.push(event);
-        saveEventQueue();
+        event.visit_token = ahoy.getVisitId();
+        event.visitor_token = ahoy.getVisitorId();
 
-        // wait in case navigating to reduce duplicate events
-        setTimeout( function () {
-          trackEvent(event);
-        }, 1000);
-      }
+        if (canTrackNow()) {
+          trackEventNow(event);
+        } else {
+          eventQueue.push(event);
+          saveEventQueue();
+
+          // wait in case navigating to reduce duplicate events
+          setTimeout( function () {
+            trackEvent(event);
+          }, 1000);
+        }
+      });
     });
+
+    return true;
   };
 
-  ahoy.trackView = function () {
+  ahoy.trackView = function (additionalProperties) {
     var properties = {
       url: window.location.href,
       title: document.title,
       page: page()
     };
+
+    if (additionalProperties) {
+      for(var propName in additionalProperties) {
+        if (additionalProperties.hasOwnProperty(propName)) {
+          properties[propName] = additionalProperties[propName];
+        }
+      }
+    }
     ahoy.track("$view", properties);
   };
 
   ahoy.trackClicks = function () {
-    $(document).on("click", "a, button, input[type=submit]", function (e) {
-      var $target = $(e.currentTarget);
+    onEvent("click", "a, button, input[type=submit]", function (e) {
+      var target = e.target;
       var properties = eventProperties(e);
-      properties.text = properties.tag == "input" ? $target.val() : $.trim($target.text().replace(/[\s\r\n]+/g, " "));
-      properties.href = $target.attr("href");
+      properties.text = properties.tag == "input" ? target.value : (target.textContent || target.innerText || target.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
+      properties.href = target.href;
       ahoy.track("$click", properties);
     });
   };
 
   ahoy.trackSubmits = function () {
-    $(document).on("submit", "form", function (e) {
+    onEvent("submit", "form", function (e) {
       var properties = eventProperties(e);
       ahoy.track("$submit", properties);
     });
   };
 
   ahoy.trackChanges = function () {
-    $(document).on("change", "input, textarea, select", function (e) {
+    onEvent("change", "input, textarea, select", function (e) {
       var properties = eventProperties(e);
       ahoy.track("$change", properties);
     });
@@ -367,24 +585,29 @@
     ahoy.trackChanges();
   };
 
-  ahoy.start = function () {
-    createVisit();
+  // push events from queue
+  try {
+    eventQueue = JSON.parse(getCookie("ahoy_events") || "[]");
+  } catch (e) {
+    // do nothing
+  }
 
-    // push events from queue
-    try {
-      eventQueue = JSON.parse(getCookie("ahoy_events") || "[]");
-    } catch (e) {
-      // do nothing
-    }
+  for (var i = 0; i < eventQueue.length; i++) {
+    trackEvent(eventQueue[i]);
+  }
 
-    for (var i = 0; i < eventQueue.length; i++) {
-      trackEvent(eventQueue[i]);
-    }
+  ahoy.start = function () {
+    createVisit();
 
     ahoy.start = function () {};
   };
 
-  if (config.startOnReady) { $(ahoy.start); }
+  documentReady(function() {
+    if (config.startOnReady) {
+      ahoy.start();
+    }
+  });
+
+  return ahoy;
 
-  window.ahoy = ahoy;
-}(window));
+})));