ahoy_matey 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e6b98a3bbcd3ab67886e562a6a285344a1d0b53
-  data.tar.gz: 97975b14612ca24bf380584f1020c39407a88894
+  metadata.gz: 7973efa4435f37d54dfa0bd84b7441473a4e3ddf
+  data.tar.gz: 3ceb16b3595ae8b258e63102ae996667652802af
 SHA512:
-  metadata.gz: 3808dc8508cdbf29d1b018224179141d2588be09b76752035ddbb9f697ec22df873a0272de63e536575a6d887fcfee3997e9a9d3eddd7cfee02eafdbc68e8e9a
-  data.tar.gz: d8c2b3764a85b9f66d0b06da755260e501c089fe3cab7d8a584cf4e167803714b103f1cf6b692eea242e3571ceabda097acb8285da9f88cb79f3213a4b8a3e79
+  metadata.gz: a16bd0b6d30f134a901d2574bc944d411e049e1a7fcaae46707245a98287013b2e4c26c69eca8fd77cf00394e34bd6576843b62d85fc7d93e92344565e7e58a1
+  data.tar.gz: 6c228da084f4949c9fbd8618b1fdc2a04f83a75402d3f2eadbba954f6f02988b040b223181f4b7a34e5ec6d5e375c218a367ceb3457239966bff877b8b564503

data/README.md

@@ -4,16 +4,17 @@
 
 In under a minute, start learning more about your visitors.
 
-- traffic source - referrer, referring domain, campaign, landing page
+- traffic source - referrer, referring domain, landing page, search keyword
 - location - country, region, and city
 - technology - browser, OS, and device type
+- utm parameters - source, medium, term, content, campaign
 
 It’s all stored in **your database** so you can easily combine it with other data.
 
 See which campaigns generate the most revenue effortlessly.
 
 ```ruby
-Order.joins(:visit).group("campaign").sum(:revenue)
+Order.joins(:visit).group("utm_campaign").sum(:revenue)
 ```
 
 ## Ready, Set, Go
@@ -66,8 +67,8 @@ Order.joins(:visit).group("city").count
 
 ## Features
 
-- Excludes search engines
-- Gracefully degrades when cookies are disabled
+- Excludes bots
+- Degrades gracefully when cookies are disabled
 - Gets campaign from utm_campaign parameter
 
 ## TODO
@@ -75,8 +76,10 @@ Order.joins(:visit).group("city").count
 - better readme
 - model integration
 - update visit when user logs in
-- better browser / OS detection
 - set visit_id automatically on `visitable` models
+- simple dashboard
+- hook to store additional fields
+- turn off modules
 
 ## Contributing
 

data/ahoy_matey.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "addressable"
   spec.add_dependency "browser", ">= 0.4.0"
   spec.add_dependency "geocoder"
+  spec.add_dependency "referer-parser"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/app/controllers/ahoy/visits_controller.rb

@@ -14,58 +14,10 @@ module Ahoy
           v.user = current_user if respond_to?(:current_user)
         end
 
-      referring_uri = Addressable::URI.parse(params[:referrer]) rescue nil
-      if referring_uri
-        visit.referring_domain = referring_uri.host
-      end
-
-      landing_uri = Addressable::URI.parse(params[:landing_page]) rescue nil
-      if landing_uri
-        visit.campaign = (landing_uri.query_values || {})["utm_campaign"]
-      end
-
-      visit.browser = browser.name
-
-      # TODO add more
-      visit.os =
-        if browser.android?
-          "Android"
-        elsif browser.ios?
-          "iOS"
-        elsif browser.windows_phone?
-          "Windows Phone"
-        elsif browser.blackberry?
-          "Blackberry"
-        elsif browser.chrome_os?
-          "Chrome OS"
-        elsif browser.mac?
-          "Mac"
-        elsif browser.windows?
-          "Windows"
-        elsif browser.linux?
-          "Linux"
-        end
-
-      visit.device_type =
-        if browser.tv?
-          "TV"
-        elsif browser.console?
-          "Console"
-        elsif browser.tablet?
-          "Tablet"
-        elsif browser.mobile?
-          "Mobile"
-        else
-          "Desktop"
-        end
-
-      # location
-      location = Geocoder.search(request.remote_ip).first rescue nil
-      if location
-        visit.country = location.country.presence
-        visit.region = location.state.presence
-        visit.city = location.city.presence
-      end
+      visit.set_traffic_source
+      visit.set_technology
+      visit.set_location
+      visit.set_utm_parameters
 
       visit.save!
       render json: {id: visit.id}

data/app/models/ahoy/visit.rb

@@ -1,5 +1,71 @@
 module Ahoy
   class Visit < ActiveRecord::Base
     belongs_to :user, polymorphic: true
+
+    def set_traffic_source
+      referring_uri = Addressable::URI.parse(referrer) rescue nil
+      self.referring_domain = referring_uri.try(:host)
+      search_keyword = RefererParser::Referer.new(referrer).search_term rescue nil
+      self.search_keyword = search_keyword.present? ? search_keyword : nil
+    end
+
+    def set_utm_parameters
+      landing_uri = Addressable::URI.parse(landing_page) rescue nil
+      if landing_uri
+        query_values = landing_uri.query_values || {}
+        %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
+          self[name] = query_values[name]
+        end
+      end
+    end
+
+    def set_technology
+      browser = Browser.new(ua: user_agent)
+
+      self.browser = browser.name
+
+      # TODO add more
+      self.os =
+        if browser.android?
+          "Android"
+        elsif browser.ios?
+          "iOS"
+        elsif browser.windows_phone?
+          "Windows Phone"
+        elsif browser.blackberry?
+          "Blackberry"
+        elsif browser.chrome_os?
+          "Chrome OS"
+        elsif browser.mac?
+          "Mac"
+        elsif browser.windows?
+          "Windows"
+        elsif browser.linux?
+          "Linux"
+        end
+
+      self.device_type =
+        if browser.tv?
+          "TV"
+        elsif browser.console?
+          "Console"
+        elsif browser.tablet?
+          "Tablet"
+        elsif browser.mobile?
+          "Mobile"
+        else
+          "Desktop"
+        end
+    end
+
+    def set_location
+      location = Geocoder.search(ip).first rescue nil
+      if location
+        self.country = location.country.presence
+        self.region = location.state.presence
+        self.city = location.city.presence
+      end
+    end
+
   end
 end

data/lib/ahoy/{controller_extensions.rb → controller.rb}

@@ -1,5 +1,5 @@
 module Ahoy
-  module ControllerExtensions
+  module Controller
 
     def self.included(base)
       base.helper_method :current_visit
@@ -10,13 +10,6 @@ module Ahoy
     def current_visit
       if cookies[:ahoy_visit]
         @current_visit ||= Ahoy::Visit.where(visit_token: cookies[:ahoy_visit]).first
-        if @current_visit
-          @current_visit
-        else
-          # clear cookie if visits are destroyed
-          cookies.delete(:ahoy_visit)
-          nil
-        end
       end
     end
 

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/ahoy_matey.rb

@@ -1,8 +1,9 @@
 require "ahoy/version"
-require "ahoy/controller_extensions"
+require "ahoy/controller"
 require "addressable/uri"
 require "browser"
 require "geocoder"
+require "referer-parser"
 
 module Ahoy
   class Engine < ::Rails::Engine
@@ -10,4 +11,18 @@ module Ahoy
   end
 end
 
-ActionController::Base.send :include, Ahoy::ControllerExtensions
+ActionController::Base.send :include, Ahoy::Controller
+
+if defined?(Warden)
+  Warden::Manager.after_authentication do |user, auth, opts|
+    p user
+    p auth.env
+    p opts
+    request = Rack::Request.new(auth.env)
+    if request.cookies["ahoy_visit"]
+      visit = Ahoy::Visit.where(visit_token: request.cookies["ahoy_visit"]).first
+      visit.user = user
+      visit.save!
+    end
+  end
+end

data/lib/generators/ahoy/templates/install.rb

@@ -1,18 +1,23 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
     create_table :ahoy_visits do |t|
+      # cookies
       t.string :visit_token
       t.string :visitor_token
-      t.integer :user_id
-      t.string :user_type
+
+      # standard
       t.string :ip
       t.text :user_agent
+      t.text :referrer
+      t.text :landing_page
+
+      # user
+      t.integer :user_id
+      t.string :user_type
 
       # traffic source
-      t.text :referrer
       t.string :referring_domain
-      t.string :campaign
-      t.text :landing_page
+      t.string :search_keyword
 
       # technology
       t.string :browser
@@ -24,6 +29,13 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.string :region
       t.string :city
 
+      # utm parameters
+      t.string :utm_source
+      t.string :utm_medium
+      t.string :utm_term
+      t.string :utm_content
+      t.string :utm_campaign
+
       t.timestamp :created_at
     end
 

data/vendor/assets/javascripts/ahoy.js

@@ -1,10 +1,12 @@
 /*jslint browser: true, indent: 2, plusplus: true, vars: true */
 
-(function () {
+(function (window) {
   "use strict";
 
   var debugMode = false;
   var visitTtl, visitorTtl;
+  var $ = window.jQuery || window.Zepto || window.$;
+  var visitToken, visitorToken;
 
   if (debugMode) {
     visitTtl = 0.2;
@@ -18,22 +20,27 @@
 
   // http://www.quirksmode.org/js/cookies.html
   function setCookie(name, value, ttl) {
+    var expires = "";
     if (ttl) {
       var date = new Date();
-      date.setTime(date.getTime()+(ttl*60*1000));
-      var expires = "; expires="+date.toGMTString();
+      date.setTime(date.getTime() + (ttl * 60 * 1000));
+      expires = "; expires=" + date.toGMTString();
     }
-    else var expires = "";
-    document.cookie = name+"="+value+expires+"; path=/";
+    document.cookie = name + "=" + value + expires + "; path=/";
   }
 
   function getCookie(name) {
+    var i, c;
     var nameEQ = name + "=";
     var ca = document.cookie.split(';');
-    for(var i=0;i < ca.length;i++) {
-      var c = ca[i];
-      while (c.charAt(0)==' ') c = c.substring(1,c.length);
-      if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length);
+    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 c.substring(nameEQ.length, c.length);
+      }
     }
     return null;
   }
@@ -45,9 +52,10 @@
     var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghiklmnopqrstuvwxyz';
     var length = 32;
     var string = '';
+    var i, randomNumber;
 
-    for (var i = 0; i < length; i++) {
-      var randomNumber = Math.floor(Math.random() * chars.length);
+    for (i = 0; i < length; i++) {
+      randomNumber = Math.floor(Math.random() * chars.length);
       string += chars.substring(randomNumber, randomNumber + 1);
     }
 
@@ -55,13 +63,13 @@
   }
 
   function debug(message) {
-    console.log(message, visitToken, visitorToken);
+    window.console.log(message, visitToken, visitorToken);
   }
 
   // main
 
-  var visitToken = getCookie("ahoy_visit");
-  var visitorToken = getCookie("ahoy_visitor");
+  visitToken = getCookie("ahoy_visit");
+  visitorToken = getCookie("ahoy_visitor");
 
   if (visitToken && visitorToken) {
     // TODO keep visit alive?
@@ -99,4 +107,4 @@
     }
   }
 
-}());
+}(window));

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: referer-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +110,7 @@ files:
 - app/controllers/ahoy/visits_controller.rb
 - app/models/ahoy/visit.rb
 - config/routes.rb
-- lib/ahoy/controller_extensions.rb
+- lib/ahoy/controller.rb
 - lib/ahoy/version.rb
 - lib/ahoy_matey.rb
 - lib/generators/ahoy/install_generator.rb