ahoy_matey 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 901b2af03cc91c3ad7ccef91dedfd1514e452357
-  data.tar.gz: 83494b26ea230cf54836b3d67eb6efc88cbac45f
+  metadata.gz: aae43abe84c855bce95234160c4e8e0a2496155c
+  data.tar.gz: 037987022eaaf1738e0187b86683823a632639a2
 SHA512:
-  metadata.gz: 1772c4ed5abe7395b6cf651f48ef05ec7454b3e30c80d9e54989407e8dd510fdba40f2ff827b5041dbe93fc22160eba8dc612fe780657bce4ba55bb5da6f50ce
-  data.tar.gz: a33c3b9ea6cb8e4ae7104085b392c7d0bd49ed1121eaef0eace1c9157f11098843236f66792c0138286e2e11c3ee41bb5d2ce97676428f1ef28f3b812e9cc269
+  metadata.gz: 7f2eae369753dc8710a6ba8c8989b2641923b741feaff09184a5d94a76432ea568b6eeea53f0351dac79a7fe4f95bc4392f264560e6a0e693b92a974b2676d20
+  data.tar.gz: 4e1ff064b585b73a1de6225f5b606855f7aa13a620f187b02578775f2bb0c49f3bb1c87c8e1e88a2bf3dde71da0e92fb19ca2ee0dd5c1bd36e929602197a6524

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.3.0
+
+- Added `current_visit_token` and `current_visitor_token` method
+- Switched to UUIDs
+- Quiet endpoint requests
+- Skip server-side bot events
+- Added `request` argument to `exclude_method`
+
 ## 0.2.2
 
 - Added `exclude_method` option

data/README.md

@@ -175,6 +175,8 @@ or track all views and clicks with:
 ahoy.trackAll();
 ```
 
+See [Ahoy.js](https://github.com/ankane/ahoy.js) for a complete list of features.
+
 #### Ruby
 
 ```ruby
@@ -254,6 +256,12 @@ Turn off logging
 ahoy.debug(false);
 ```
 
+Debug endpoint requests in Ruby [master]
+
+```ruby
+Ahoy.quiet = false
+```
+
 ### More
 
 - Excludes bots
@@ -370,8 +378,8 @@ Ahoy.subscribers << Ahoy::Subscribers::ActiveRecord.new(model: Event)
 Exclude visits and events
 
 ```ruby
-Ahoy.exclude_method = proc do |controller|
-  controller.request.ip == "192.168.1.1"
+Ahoy.exclude_method = proc do |controller, request|
+  request.ip == "192.168.1.1"
 end
 ```
 
@@ -383,6 +391,12 @@ Ahoy.track_bots = true
 
 ## Upgrading
 
+### 0.3.0
+
+Starting with `0.3.0`, visit and visitor tokens are now UUIDs.
+
+### 0.1.6
+
 In `0.1.6`, a big improvement was made to `browser` and `os`. Update existing visits with:
 
 ```ruby

data/app/controllers/ahoy/base_controller.rb

@@ -2,20 +2,5 @@ module Ahoy
   class BaseController < ApplicationController
     # skip all filters
     skip_filter *_process_action_callbacks.map(&:filter)
-
-    before_filter :halt_bots
-
-    protected
-
-    def browser
-      @browser ||= Browser.new(ua: request.user_agent)
-    end
-
-    def halt_bots
-      if !Ahoy.track_bots and browser.bot?
-        render json: {}
-      end
-    end
-
   end
 end

data/app/controllers/ahoy/visits_controller.rb

@@ -2,8 +2,8 @@ module Ahoy
   class VisitsController < BaseController
 
     def create
-      visit_token = params[:visit_token] || generate_token
-      visitor_token = params[:visitor_token] || generate_token
+      visit_token = params[:visit_token] || Ahoy.generate_id
+      visitor_token = params[:visitor_token] || Ahoy.generate_id
 
       visit =
         Ahoy.visit_model.new do |v|
@@ -23,11 +23,5 @@ module Ahoy
       render json: {visit_token: visit.visit_token, visitor_token: visit.visitor_token}
     end
 
-    protected
-
-    def generate_token
-      SecureRandom.urlsafe_base64(32).gsub(/[\-_]/, "").first(32)
-    end
-
   end
 end

data/lib/ahoy/controller.rb

@@ -4,20 +4,33 @@ module Ahoy
     def self.included(base)
       base.helper_method :current_visit
       base.helper_method :ahoy
+      base.before_filter :set_ahoy_visitor_cookie
       base.before_filter do
         RequestStore.store[:ahoy_controller] ||= self
       end
     end
 
+    def ahoy
+      @ahoy ||= Ahoy::Tracker.new(controller: self)
+    end
+
     def current_visit
-      visit_token = cookies[:ahoy_visit] || request.headers["Ahoy-Visit"]
+      visit_token = current_visit_token
       if visit_token
         @current_visit ||= Ahoy.visit_model.where(visit_token: visit_token).first
       end
     end
 
-    def ahoy
-      @ahoy ||= Ahoy::Tracker.new(controller: self)
+    def current_visit_token
+      @current_visit_token ||= request.headers["Ahoy-Visit"] || cookies[:ahoy_visit]
+    end
+
+    def current_visitor_token
+      @current_visitor_token ||= request.headers["Ahoy-Visitor"] || cookies[:ahoy_visitor] || current_visit.try(:visitor_token) || Ahoy.generate_id
+    end
+
+    def set_ahoy_visitor_cookie
+      cookies[:ahoy_visitor] = current_visitor_token if !request.headers["Ahoy-Visitor"] && !cookies[:ahoy_visitor]
     end
 
   end

data/lib/ahoy/engine.rb

@@ -1,4 +1,28 @@
 module Ahoy
   class Engine < ::Rails::Engine
+    # from https://github.com/evrone/quiet_assets/blob/master/lib/quiet_assets.rb
+    initializer "ahoy", after: "sprockets.environment" do |app|
+      next unless Ahoy.quiet
+
+      # Parse PATH_INFO by assets prefix
+      AHOY_PREFIX = "/ahoy/"
+      KEY = "ahoy.old_level"
+
+      # Just create an alias for call in middleware
+      Rails::Rack::Logger.class_eval do
+        def call_with_quiet_ahoy(env)
+          begin
+            if env["PATH_INFO"].start_with?(AHOY_PREFIX)
+              env[KEY] = Rails.logger.level
+              Rails.logger.level = Logger::ERROR
+            end
+            call_without_quiet_ahoy(env)
+          ensure
+            Rails.logger.level = env[KEY] if env[KEY]
+          end
+        end
+        alias_method_chain :call, :quiet_ahoy
+      end
+    end
   end
 end

data/lib/ahoy/tracker.rb

@@ -3,10 +3,11 @@ module Ahoy
 
     def initialize(options = {})
       @controller = options[:controller]
+      @request = options[:request] || @controller.try(:request)
     end
 
     def track(name, properties = {}, options = {})
-      if !(@controller and Ahoy.exclude_method and Ahoy.exclude_method.call(@controller))
+      if (Ahoy.track_bots or !bot?) and !exclude?
         # publish to each subscriber
         options = options.dup
         if @controller
@@ -15,8 +16,15 @@ module Ahoy
           if @controller.respond_to?(:current_visit)
             options[:visit] ||= @controller.current_visit
           end
+          if @controller.respond_to?(:current_visit_token)
+            options[:visit_token] = @controller.current_visit_token
+          end
+          if @controller.respond_to?(:current_visitor_token)
+            options[:visitor_token] = @controller.current_visitor_token
+          end
         end
         options[:time] ||= Time.zone.now
+        options[:id] ||= Ahoy.generate_id
 
         subscribers = Ahoy.subscribers
         if subscribers.any?
@@ -31,5 +39,23 @@ module Ahoy
       true
     end
 
+    protected
+
+    def bot?
+      @bot ||= Browser.new(ua: @request.user_agent).bot?
+    end
+
+    def exclude?
+      if Ahoy.exclude_method
+        if Ahoy.exclude_method.arity == 1
+          Ahoy.exclude_method.call(@controller)
+        else
+          Ahoy.exclude_method.call(@controller, @request)
+        end
+      else
+        false
+      end
+    end
+
   end
 end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/ahoy/warden.rb

@@ -9,6 +9,6 @@ Warden::Manager.after_set_user except: :fetch do |user, auth, opts|
       visit.save!
     end
   end
-  ahoy = Ahoy::Tracker.new
+  ahoy = Ahoy::Tracker.new(request: request)
   ahoy.track "$authenticate", {}, user: user, visit: visit
 end

data/lib/ahoy.rb

@@ -0,0 +1,66 @@
+require "addressable/uri"
+require "browser"
+require "geocoder"
+require "referer-parser"
+require "user_agent_parser"
+require "request_store"
+require "ahoy/version"
+require "ahoy/tracker"
+require "ahoy/controller"
+require "ahoy/model"
+require "ahoy/subscribers/active_record"
+require "ahoy/engine"
+require "ahoy/warden" if defined?(Warden)
+
+module Ahoy
+
+  def self.generate_id
+    SecureRandom.uuid
+  end
+
+  def self.visit_model
+    @visit_model || ::Visit
+  end
+
+  def self.visit_model=(visit_model)
+    @visit_model = visit_model
+  end
+
+  # TODO private
+  # performance hack for referer-parser
+  def self.referrer_parser
+    @referrer_parser ||= RefererParser::Referer.new("https://github.com/ankane/ahoy")
+  end
+
+  # performance
+  def self.user_agent_parser
+    @user_agent_parser ||= UserAgentParser::Parser.new
+  end
+
+  def self.fetch_user(controller)
+    if user_method.respond_to?(:call)
+      user_method.call(controller)
+    else
+      controller.send(user_method)
+    end
+  end
+
+  mattr_accessor :user_method
+  self.user_method = proc do |controller|
+    (controller.respond_to?(:current_user) && controller.current_user) || (controller.respond_to?(:current_resource_owner, true) && controller.send(:current_resource_owner)) || nil
+  end
+
+  mattr_accessor :exclude_method
+
+  mattr_accessor :subscribers
+  self.subscribers = []
+
+  mattr_accessor :track_bots
+  self.track_bots = false
+
+  mattr_accessor :quiet
+  self.quiet = true
+end
+
+ActionController::Base.send :include, Ahoy::Controller
+ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)

data/lib/ahoy_matey.rb

@@ -1,59 +1 @@
-require "addressable/uri"
-require "browser"
-require "geocoder"
-require "referer-parser"
-require "user_agent_parser"
-require "request_store"
-require "ahoy/version"
-require "ahoy/tracker"
-require "ahoy/controller"
-require "ahoy/model"
-require "ahoy/subscribers/active_record"
-require "ahoy/engine"
-require "ahoy/warden" if defined?(Warden)
-
-module Ahoy
-
-  def self.visit_model
-    @visit_model || ::Visit
-  end
-
-  def self.visit_model=(visit_model)
-    @visit_model = visit_model
-  end
-
-  # TODO private
-  # performance hack for referer-parser
-  def self.referrer_parser
-    @referrer_parser ||= RefererParser::Referer.new("https://github.com/ankane/ahoy")
-  end
-
-  # performance
-  def self.user_agent_parser
-    @user_agent_parser ||= UserAgentParser::Parser.new
-  end
-
-  def self.fetch_user(controller)
-    if user_method.respond_to?(:call)
-      user_method.call(controller)
-    else
-      controller.send(user_method)
-    end
-  end
-
-  mattr_accessor :user_method
-  self.user_method = proc do |controller|
-    (controller.respond_to?(:current_user) && controller.current_user) || (controller.respond_to?(:current_resource_owner, true) && controller.send(:current_resource_owner)) || nil
-  end
-
-  mattr_accessor :exclude_method
-
-  mattr_accessor :subscribers
-  self.subscribers = []
-
-  mattr_accessor :track_bots
-  self.track_bots = false
-end
-
-ActionController::Base.send :include, Ahoy::Controller
-ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)
+require "ahoy"

data/vendor/assets/javascripts/ahoy.js

@@ -1,3 +1,11 @@
+/*
+ * Ahoy.js
+ * Simple, powerful JavaScript analytics
+ * https://github.com/ankane/ahoy.js
+ * v0.1.0
+ * MIT License
+ */
+
 /*jslint browser: true, indent: 2, plusplus: true, vars: true */
 
 (function (window) {
@@ -5,13 +13,14 @@
 
   var ahoy = window.ahoy || window.Ahoy || {};
   var $ = window.jQuery || window.Zepto || window.$;
-  var visitToken, visitorToken;
+  var visitId, visitorId;
   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";
   var eventQueue = [];
+  var page = ahoy.page || window.location.pathname;
 
   // cookies
 
@@ -72,18 +81,12 @@
     }
   }
 
-  // https://github.com/klughammer/node-randomstring
+  // http://stackoverflow.com/a/2117523/1177228
   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;
+    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 v.toString(16);
+    });
   }
 
   function saveEventQueue() {
@@ -123,35 +126,37 @@
     return {
       tag: $target.get(0).tagName.toLowerCase(),
       id: $target.attr("id"),
-      "class": $target.attr("class")
+      "class": $target.attr("class"),
+      page: page,
+      section: $target.closest("*[data-section]").data("section")
     };
   }
 
   // main
 
-  visitToken = getCookie("ahoy_visit");
-  visitorToken = getCookie("ahoy_visitor");
+  visitId = getCookie("ahoy_visit");
+  visitorId = getCookie("ahoy_visitor");
 
-  if (visitToken && visitorToken) {
+  if (visitId && visitorId) {
     // TODO keep visit alive?
     log("Active visit");
     setReady();
   } else {
-    visitToken = generateId();
-    setCookie("ahoy_visit", visitToken, visitTtl);
+    visitId = generateId();
+    setCookie("ahoy_visit", visitId, visitTtl);
 
     // make sure cookies are enabled
     if (getCookie("ahoy_visit")) {
       log("Visit started");
 
-      if (!visitorToken) {
-        visitorToken = generateId();
-        setCookie("ahoy_visitor", visitorToken, visitorTtl);
+      if (!visitorId) {
+        visitorId = generateId();
+        setCookie("ahoy_visitor", visitorId, visitorTtl);
       }
 
       var data = {
-        visit_token: visitToken,
-        visitor_token: visitorToken,
+        visit_token: visitId,
+        visitor_token: visitorId,
         platform: ahoy.platform || "Web",
         landing_page: window.location.href,
         screen_width: window.screen.width,
@@ -172,6 +177,14 @@
     }
   }
 
+  ahoy.getVisitToken = function () {
+    return visitId;
+  };
+
+  ahoy.getVisitorToken = function () {
+    return visitorId;
+  };
+
   ahoy.reset = function () {
     destroyCookie("ahoy_visit");
     destroyCookie("ahoy_visitor");
@@ -209,7 +222,8 @@
   ahoy.trackView = function () {
     var properties = {
       url: window.location.href,
-      title: document.title
+      title: document.title,
+      page: page
     };
     ahoy.track("$view", properties);
   };

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -141,6 +141,7 @@ files:
 - app/controllers/ahoy/visits_controller.rb
 - app/models/ahoy/event.rb
 - config/routes.rb
+- lib/ahoy.rb
 - lib/ahoy/controller.rb
 - lib/ahoy/engine.rb
 - lib/ahoy/model.rb