ahoy_matey 1.5.5 → 4.2.1

data/vendor/assets/javascripts/ahoy.js

@@ -1,32 +1,72 @@
-/*
- * Ahoy.js
+/*!
+ * Ahoy.js v0.4.2
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.2.1
  * MIT License
  */
 
-/*jslint browser: true, indent: 2, plusplus: true, vars: true */
-
-(function (window) {
-  "use strict";
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+  typeof define === 'function' && define.amd ? define(factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.ahoy = factory());
+})(this, (function () { 'use strict';
+
+  // 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=/; samesite=lax";
+    },
+    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,
+    visitDuration: 4 * 60, // default 4 hours
+    visitorDuration: 2 * 365 * 24 * 60 // default 2 years
   };
 
   var ahoy = window.ahoy || window.Ahoy || {};
 
   ahoy.configure = function (options) {
     for (var key in options) {
-      if (options.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(options, key)) {
         config[key] = options[key];
       }
     }
@@ -37,8 +77,6 @@
 
   var $ = window.jQuery || window.Zepto || window.$;
   var visitId, visitorId, track;
-  var visitTtl = 4 * 60; // 4 hours
-  var visitorTtl = 2 * 365 * 24 * 60; // 2 years
   var isReady = false;
   var queue = [];
   var canStringify = typeof(JSON) !== "undefined" && typeof(JSON.stringify) !== "undefined";
@@ -52,46 +90,36 @@
     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;
+  }
+
+  function serialize(object) {
+    var data = new FormData();
+    for (var key in object) {
+      if (Object.prototype.hasOwnProperty.call(object, key)) {
+        data.append(key, object[key]);
+      }
+    }
+    return data;
   }
 
   // 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,81 +130,150 @@
 
   function setReady() {
     var callback;
-    while (callback = queue.shift()) {
+    while ((callback = queue.shift())) {
       callback();
     }
     isReady = true;
   }
 
-  function ready(callback) {
+  ahoy.ready = function (callback) {
     if (isReady) {
       callback();
     } else {
       queue.push(callback);
     }
+  };
+
+  function matchesSelector(element, selector) {
+    var matches = element.matches ||
+      element.matchesSelector ||
+      element.mozMatchesSelector ||
+      element.msMatchesSelector ||
+      element.oMatchesSelector ||
+      element.webkitMatchesSelector;
+
+    if (matches) {
+      if (matches.apply(element, [selector])) {
+        return element;
+      } else if (element.parentElement) {
+        return matchesSelector(element.parentElement, selector);
+      }
+      return null;
+    } else {
+      log("Unable to match");
+      return null;
+    }
+  }
+
+  function onEvent(eventName, selector, callback) {
+    document.addEventListener(eventName, function (e) {
+      var matchedElement = matchesSelector(e.target, selector);
+      if (matchedElement) {
+        var skip = getClosest(matchedElement, "data-ahoy-skip");
+        if (skip !== null && skip !== "false") { return; }
+
+        callback.call(matchedElement, e);
+      }
+    });
   }
 
-  // http://stackoverflow.com/a/2117523/1177228
+  // http://beeker.io/jquery-document-ready-equivalent-vanilla-javascript
+  function documentReady(callback) {
+    if (document.readyState === "interactive" || document.readyState === "complete") {
+      setTimeout(callback, 0);
+    } else {
+      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);
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      var r = Math.random() * 16 | 0;
+      var v = c === 'x' ? r : (r & 0x3 | 0x8);
       return v.toString(16);
     });
   }
 
   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) {
+        $.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 (Object.prototype.hasOwnProperty.call(config.headers, 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;
   }
 
   function trackEvent(event) {
-    ready( function () {
-      sendRequest(eventsUrl(), eventData(event), function() {
+    ahoy.ready(function () {
+      sendRequest(eventsUrl(), eventData(event), function () {
         // remove from queue
         for (var i = 0; i < eventQueue.length; i++) {
-          if (eventQueue[i].id == event.id) {
+          if (eventQueue[i].id === event.id) {
             eventQueue.splice(i, 1);
             break;
           }
@@ -187,13 +284,15 @@
   }
 
   function trackEventNow(event) {
-    ready( function () {
+    ahoy.ready(function () {
       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(), serialize(data));
     });
   }
 
@@ -201,15 +300,39 @@
     return config.page || window.location.pathname;
   }
 
-  function eventProperties(e) {
-    var $target = $(e.currentTarget);
-    return {
-      tag: $target.get(0).tagName.toLowerCase(),
-      id: $target.attr("id"),
-      "class": $target.attr("class"),
+  function presence(str) {
+    return (str && str.length > 0) ? str : null;
+  }
+
+  function cleanObject(obj) {
+    for (var key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        if (obj[key] === null) {
+          delete obj[key];
+        }
+      }
+    }
+    return obj;
+  }
+
+  function eventProperties() {
+    return cleanObject({
+      tag: this.tagName.toLowerCase(),
+      id: presence(this.id),
+      "class": presence(this.className),
       page: page(),
-      section: $target.closest("*[data-section]").data("section")
-    };
+      section: getClosest(this, "data-section")
+    });
+  }
+
+  function getClosest(element, attribute) {
+    for (; element && element !== document; element = element.parentNode) {
+      if (element.hasAttribute(attribute)) {
+        return element.getAttribute(attribute);
+      }
+    }
+
+    return null;
   }
 
   function createVisit() {
@@ -219,18 +342,17 @@
     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);
+        setCookie("ahoy_visit", visitId, config.visitDuration);
       }
 
       // make sure cookies are enabled
@@ -239,7 +361,7 @@
 
         if (!visitorId) {
           visitorId = generateId();
-          setCookie("ahoy_visitor", visitorId, visitorTtl);
+          setCookie("ahoy_visitor", visitorId, config.visitorDuration);
         }
 
         var data = {
@@ -248,7 +370,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 +379,19 @@
           data.referrer = document.referrer;
         }
 
+        for (var key in config.visitParams) {
+          if (Object.prototype.hasOwnProperty.call(config.visitParams, 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,37 +427,39 @@
   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()) {
+    ahoy.ready(function () {
+      if (config.cookies && !ahoy.getVisitId()) {
         createVisit();
       }
 
-      event.visit_token = ahoy.getVisitId();
-      event.visitor_token = ahoy.getVisitorId();
+      ahoy.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 (additionalProperties) {
@@ -335,8 +470,8 @@
     };
 
     if (additionalProperties) {
-      for(var propName in additionalProperties) {
-        if (additionalProperties.hasOwnProperty(propName)) {
+      for (var propName in additionalProperties) {
+        if (Object.prototype.hasOwnProperty.call(additionalProperties, propName)) {
           properties[propName] = additionalProperties[propName];
         }
       }
@@ -344,37 +479,39 @@
     ahoy.track("$view", properties);
   };
 
-  ahoy.trackClicks = function () {
-    $(document).on("click", "a, button, input[type=submit]", function (e) {
-      var $target = $(e.currentTarget);
-      var properties = eventProperties(e);
-      properties.text = properties.tag == "input" ? $target.val() : $.trim($target.text().replace(/[\s\r\n]+/g, " "));
-      properties.href = $target.attr("href");
+  ahoy.trackClicks = function (selector) {
+    if (selector === undefined) {
+      throw new Error("Missing selector");
+    }
+    onEvent("click", selector, function (e) {
+      var properties = eventProperties.call(this, e);
+      properties.text = properties.tag === "input" ? this.value : (this.textContent || this.innerText || this.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
+      properties.href = this.href;
       ahoy.track("$click", properties);
     });
   };
 
-  ahoy.trackSubmits = function () {
-    $(document).on("submit", "form", function (e) {
-      var properties = eventProperties(e);
+  ahoy.trackSubmits = function (selector) {
+    if (selector === undefined) {
+      throw new Error("Missing selector");
+    }
+    onEvent("submit", selector, function (e) {
+      var properties = eventProperties.call(this, e);
       ahoy.track("$submit", properties);
     });
   };
 
-  ahoy.trackChanges = function () {
-    $(document).on("change", "input, textarea, select", function (e) {
-      var properties = eventProperties(e);
+  ahoy.trackChanges = function (selector) {
+    log("trackChanges is deprecated and will be removed in 0.5.0");
+    if (selector === undefined) {
+      throw new Error("Missing selector");
+    }
+    onEvent("change", selector, function (e) {
+      var properties = eventProperties.call(this, e);
       ahoy.track("$change", properties);
     });
   };
 
-  ahoy.trackAll = function() {
-    ahoy.trackView();
-    ahoy.trackClicks();
-    ahoy.trackSubmits();
-    ahoy.trackChanges();
-  };
-
   // push events from queue
   try {
     eventQueue = JSON.parse(getCookie("ahoy_events") || "[]");
@@ -392,11 +529,12 @@
     ahoy.start = function () {};
   };
 
-  $( function () {
+  documentReady(function () {
     if (config.startOnReady) {
       ahoy.start();
     }
   });
 
-  window.ahoy = ahoy;
-}(window));
+  return ahoy;
+
+}));