ahoy_events 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 624b3a10b7a0ec8f941e0218bf2ccf5c15b406fb
-  data.tar.gz: d95a3036411a9175742275ed066eac7026e936e9
+  metadata.gz: 7bb576fde4349935bb02f99ac5499240ac9f313c
+  data.tar.gz: e247bef1ae291d918d91a3c1ccee8a24bce382ee
 SHA512:
-  metadata.gz: 10d94a157012825266783ba7a3e12da348dc0049edb6773014f2e1a6fdd8ca0b42e0185323e842bae78e7a7177530f07920af0ac952d9ac8083a41136b9b63c5
-  data.tar.gz: 50f2ebb1422c12902ea6d69b41d9068f483889771ae52a1a0fc3369b02dcb28e102953dbaf2b6e53f19905717c620e9b5e7788ec4901e28900b3bd0ba06ad06a
+  metadata.gz: ee83bfdf2cef88ab0318ec03a182f3297427c956fb50722562697d2019f9f55cbd54d7906504ef53a8f892b8f809c65bc026280779316dab0122729b26c5ffeb
+  data.tar.gz: d94ecaa8c17294b78aad164494c2e1fffd6db44f2d9a811c6225ba40957f50517c4f65c7bf1db5c246ac5f61c39adeb7a96823e33c60ba372f8918a05e71b16b

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- Added `trackAll` method

data/README.md

@@ -39,6 +39,12 @@ There are three ways to track events.
 ahoy.track("Viewed book", {title: "The World is Flat"});
 ```
 
+or track all views and clicks with:
+
+```javascript
+ahoy.trackAll();
+```
+
 #### Ruby
 
 ```ruby
@@ -98,6 +104,18 @@ Add as many subscribers as you’d like.
 
 ## Reference
 
+Track view
+
+```javascript
+ahoy.trackView();
+```
+
+Track clicks
+
+```javascript
+ahoy.trackClicks();
+```
+
 Track all Rails actions
 
 ```ruby
@@ -112,15 +130,15 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Use a different model [master]
+Use a different model
 
 ```ruby
 Ahoy.subscribers << Ahoy::Subscribers::ActiveRecord.new(model: Event)
 ```
 
-## TODO
+## History
 
-- Ability to track JavaScript events automatically (button clicks, etc)
+View the [changelog](https://github.com/ankane/ahoy_events/blob/master/CHANGELOG.md)
 
 ## Contributing
 

data/app/controllers/ahoy/events_controller.rb

@@ -2,7 +2,11 @@ module Ahoy
   class EventsController < Ahoy::BaseController
 
     def create
-      ahoy.track params[:name], params[:properties]
+      options = {}
+      if params[:time] and (time = Time.at(params[:time].to_f) rescue nil) and (1.minute.ago..Time.now).cover?(time)
+        options[:time] = time
+      end
+      ahoy.track params[:name], params[:properties], options
       render json: {}
     end
 

data/lib/ahoy_events/version.rb

@@ -1,3 +1,3 @@
 module AhoyEvents
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/vendor/assets/javascripts/ahoy_events.js

@@ -4,22 +4,111 @@
   "use strict";
 
   var ahoy = window.ahoy;
+  var canStringify = typeof(JSON) !== "undefined" && typeof(JSON.stringify) !== "undefined";
+  var eventQueue = [];
 
-  ahoy.track = function (name, properties) {
-    ahoy.ready( function () {
-      var data = {name: name, properties: properties};
-      ahoy.log(data);
+  // https://github.com/klughammer/node-randomstring
+  function generateId() {
+    var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghiklmnopqrstuvwxyz';
+    var length = 32;
+    var string = '';
+
+    for (var i = 0; i < length; i++) {
+      var randomNumber = Math.floor(Math.random() * chars.length);
+      string += chars.substring(randomNumber, randomNumber + 1);
+    }
+
+    return string;
+  }
+
+  function saveEventQueue() {
+    // TODO add stringify method for IE 7 and under
+    if (canStringify) {
+      ahoy.setCookie("ahoy_events", JSON.stringify(eventQueue), 1);
+    }
+  }
 
+  function trackEvent(event) {
+    ahoy.ready( function () {
       // ensure JSON is defined
-      if (typeof(JSON) !== "undefined") {
+      if (canStringify) {
         $.ajax({
           type: "POST",
           url: "/ahoy/events",
-          data: JSON.stringify(data),
+          data: JSON.stringify(event),
           contentType: "application/json; charset=utf-8",
-          dataType: "json"
+          dataType: "json",
+          success: function() {
+            // remove from queue
+            for (var i = 0; i < eventQueue.length; i++) {
+              if (eventQueue[i].id == event.id) {
+                eventQueue.splice(i, 1);
+                break;
+              }
+            }
+            saveEventQueue();
+          }
         });
       }
     });
+  }
+
+  ahoy.track = function (name, properties) {
+    // generate unique id
+    var event = {
+      id: generateId(),
+      name: name,
+      properties: properties,
+      time: (new Date()).getTime() / 1000.0
+    };
+    ahoy.log(event);
+
+    eventQueue.push(event);
+    saveEventQueue();
+
+    // wait in case navigating to reduce duplicate events
+    setTimeout( function() {
+      trackEvent(event);
+    }, 1000);
   };
+
+  ahoy.trackView = function() {
+    var properties = {
+      url: window.location.href,
+      title: document.title
+    };
+    ahoy.track("$view", properties);
+  };
+
+  ahoy.trackClicks = function() {
+    $(document).on("click", "a, button, input[type=submit]", function(e) {
+      var $target = $(e.currentTarget);
+      var tag = $target.get(0).tagName.toLowerCase();
+      var text = tag == "input" ? $target.val() : $.trim($target.text());
+      var properties = {
+        tag: tag,
+        id: $target.attr("id"),
+        class: $target.attr("class"),
+        text: text,
+        href: $target.attr("href")
+      };
+      ahoy.track("$click", properties);
+    });
+  };
+
+  ahoy.trackAll = function() {
+    ahoy.trackView();
+    ahoy.trackClicks();
+  };
+
+  // push events from queue
+  try {
+    eventQueue = JSON.parse(ahoy.getCookie("ahoy_events") || "[]");
+  } catch (e) {
+    // do nothing
+  }
+
+  for (var i = 0; i < eventQueue.length; i++) {
+    trackEvent(eventQueue[i]);
+  }
 }(window));

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_events
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ahoy_matey
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md