ahoy_matey 0.3.2 → 1.0.0

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.3.2"
+  VERSION = "1.0.0"
 end

data/lib/ahoy/visit_properties.rb

@@ -0,0 +1,58 @@
+module Ahoy
+  class VisitProperties
+
+    REQUEST_KEYS = [:ip, :user_agent, :referrer, :landing_page, :platform, :app_version, :os_version]
+    TRAFFIC_SOURCE_KEYS = [:referring_domain, :search_keyword]
+    UTM_PARAMETER_KEYS = [:utm_source, :utm_medium, :utm_term, :utm_content, :utm_campaign]
+    TECHNOLOGY_KEYS = [:browser, :os, :device_type]
+    LOCATION_KEYS = [:country, :region, :city]
+
+    KEYS = REQUEST_KEYS + TRAFFIC_SOURCE_KEYS + UTM_PARAMETER_KEYS + TECHNOLOGY_KEYS + LOCATION_KEYS
+
+    delegate *REQUEST_KEYS, to: :request_deckhand
+    delegate *TRAFFIC_SOURCE_KEYS, to: :traffic_source_deckhand
+    delegate *(UTM_PARAMETER_KEYS + [:landing_params]), to: :utm_parameter_deckhand
+    delegate *TECHNOLOGY_KEYS, to: :technology_deckhand
+    delegate *LOCATION_KEYS, to: :location_deckhand
+
+    def initialize(request, options = {})
+      @request = request
+      @options = options
+    end
+
+    def [](key)
+      send(key)
+    end
+
+    def keys
+      KEYS
+    end
+
+    def to_hash
+      keys.inject({}){|memo, key| memo[key] = send(key); memo }
+    end
+
+    protected
+
+    def request_deckhand
+      @request_deckhand ||= Deckhands::RequestDeckhand.new(@request, @options)
+    end
+
+    def traffic_source_deckhand
+      @traffic_source_deckhand ||= Deckhands::TrafficSourceDeckhand.new(request_deckhand.referrer)
+    end
+
+    def utm_parameter_deckhand
+      @utm_parameter_deckhand ||= Deckhands::UtmParameterDeckhand.new(request_deckhand.landing_page)
+    end
+
+    def technology_deckhand
+      @technology_deckhand ||= Deckhands::TechnologyDeckhand.new(request_deckhand.user_agent)
+    end
+
+    def location_deckhand
+      @location_deckhand ||= Deckhands::LocationDeckhand.new(request_deckhand.ip)
+    end
+
+  end
+end

data/lib/ahoy/warden.rb

@@ -1,14 +1,5 @@
 Warden::Manager.after_set_user except: :fetch do |user, auth, opts|
   request = ActionDispatch::Request.new(auth.env)
-  visit_token = request.cookies["ahoy_visit"] || request.headers["Ahoy-Visit"]
-  visit = nil
-  if visit_token
-    visit = Ahoy.visit_model.where(visit_token: visit_token).first
-    if visit and !visit.user
-      visit.user = user
-      visit.save!
-    end
-  end
   ahoy = Ahoy::Tracker.new(request: request)
-  ahoy.track "$authenticate", {}, user: user, visit: visit
+  ahoy.authenticate(user)
 end

data/lib/generators/ahoy/stores/active_record_events_generator.rb

@@ -0,0 +1,44 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Ahoy
+  module Stores
+    module Generators
+      class ActiveRecordEventsGenerator < Rails::Generators::Base
+        include Rails::Generators::Migration
+        source_root File.expand_path("../templates", __FILE__)
+
+        class_option :database, type: :string, aliases: "-d"
+
+        # Implement the required interface for Rails::Generators::Migration.
+        def self.next_migration_number(dirname) #:nodoc:
+          next_migration_number = current_migration_number(dirname) + 1
+          if ::ActiveRecord::Base.timestamped_migrations
+            [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+          else
+            "%.3d" % next_migration_number
+          end
+        end
+
+        def copy_migration
+          unless options["database"].in?([nil, "postgresql"])
+            raise Thor::Error, "Unknown database option"
+          end
+          migration_template "active_record_events_migration.rb", "db/migrate/create_ahoy_events.rb"
+        end
+
+        def generate_model
+          template "active_record_event_model.rb", "app/models/ahoy/event.rb"
+        end
+
+        def create_initializer
+          template "active_record_initializer.rb", "config/initializers/ahoy.rb"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/ahoy/stores/active_record_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+
+module Ahoy
+  module Stores
+    module Generators
+      class ActiveRecordGenerator < Rails::Generators::Base
+        class_option :database, type: :string, aliases: "-d"
+
+        def boom
+          invoke "ahoy:stores:active_record_visits", nil, options
+          invoke "ahoy:stores:active_record_events", nil, options
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/ahoy/{events/active_record_generator.rb → stores/active_record_visits_generator.rb}

@@ -5,17 +5,18 @@ require "active_record"
 require "rails/generators/active_record"
 
 module Ahoy
-  module Events
+  module Stores
     module Generators
-      class ActiveRecordGenerator < Rails::Generators::Base
+      class ActiveRecordVisitsGenerator < Rails::Generators::Base
         include Rails::Generators::Migration
-
         source_root File.expand_path("../templates", __FILE__)
 
+        class_option :database, type: :string, aliases: "-d"
+
         # Implement the required interface for Rails::Generators::Migration.
         def self.next_migration_number(dirname) #:nodoc:
           next_migration_number = current_migration_number(dirname) + 1
-          if ActiveRecord::Base.timestamped_migrations
+          if ::ActiveRecord::Base.timestamped_migrations
             [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
           else
             "%.3d" % next_migration_number
@@ -23,11 +24,18 @@ module Ahoy
         end
 
         def copy_migration
-          migration_template "create_events.rb", "db/migrate/create_ahoy_events.rb"
+          unless options["database"].in?([nil, "postgresql"])
+            raise Thor::Error, "Unknown database option"
+          end
+          migration_template "active_record_visits_migration.rb", "db/migrate/create_visits.rb"
+        end
+
+        def generate_model
+          template "active_record_visit_model.rb", "app/models/visit.rb"
         end
 
         def create_initializer
-          template "initializer.rb", "config/initializers/ahoy.rb"
+          template "active_record_initializer.rb", "config/initializers/ahoy.rb"
         end
 
       end

data/lib/generators/ahoy/stores/custom_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Ahoy
+  module Stores
+    module Generators
+      class CustomGenerator < Rails::Generators::Base
+        source_root File.expand_path("../templates", __FILE__)
+
+        def create_initializer
+          template "custom_initializer.rb", "config/initializers/ahoy.rb"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/ahoy/stores/log_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Ahoy
+  module Stores
+    module Generators
+      class LogGenerator < Rails::Generators::Base
+        source_root File.expand_path("../templates", __FILE__)
+
+        def create_initializer
+          template "log_initializer.rb", "config/initializers/ahoy.rb"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/ahoy/stores/mongoid_events_generator.rb

@@ -0,0 +1,20 @@
+require "rails/generators"
+
+module Ahoy
+  module Stores
+    module Generators
+      class MongoidEventsGenerator < Rails::Generators::Base
+        source_root File.expand_path("../templates", __FILE__)
+
+        def generate_model
+          template "mongoid_event_model.rb", "app/models/ahoy/event.rb"
+        end
+
+        def create_initializer
+          template "mongoid_initializer.rb", "config/initializers/ahoy.rb"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/ahoy/stores/mongoid_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Ahoy
+  module Stores
+    module Generators
+      class MongoidGenerator < Rails::Generators::Base
+
+        def boom
+          invoke "ahoy:stores:mongoid_visits"
+          invoke "ahoy:stores:mongoid_events"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/ahoy/stores/mongoid_visits_generator.rb

@@ -0,0 +1,20 @@
+require "rails/generators"
+
+module Ahoy
+  module Stores
+    module Generators
+      class MongoidVisitsGenerator < Rails::Generators::Base
+        source_root File.expand_path("../templates", __FILE__)
+
+        def generate_model
+          template "mongoid_visit_model.rb", "app/models/visit.rb"
+        end
+
+        def create_initializer
+          template "mongoid_initializer.rb", "config/initializers/ahoy.rb"
+        end
+
+      end
+    end
+  end
+end

data/{app/models/ahoy/event.rb → lib/generators/ahoy/stores/templates/active_record_event_model.rb}

@@ -3,8 +3,8 @@ module Ahoy
     self.table_name = "ahoy_events"
 
     belongs_to :visit
-    belongs_to :user, polymorphic: true
+    belongs_to :user
 
-    serialize :properties, JSON
+    <% if options["database"] != "postgresql" %>serialize :properties, JSON<% end %>
   end
 end

data/lib/generators/ahoy/stores/templates/active_record_events_migration.rb

@@ -0,0 +1,20 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :ahoy_events, id: false do |t|
+      t.uuid :id, primary_key: true
+      t.uuid :visit_id
+
+      # user
+      t.integer :user_id
+      # add t.string :user_type if polymorphic
+
+      t.string :name
+      t.<% if options["database"] == "postgresql" %>json<% else %>text<% end %> :properties
+      t.timestamp :time
+    end
+
+    add_index :ahoy_events, [:visit_id]
+    add_index :ahoy_events, [:user_id]
+    add_index :ahoy_events, [:time]
+  end
+end

data/lib/generators/ahoy/stores/templates/active_record_initializer.rb

@@ -0,0 +1,3 @@
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+  # customize here
+end

data/lib/generators/ahoy/stores/templates/active_record_visit_model.rb

@@ -0,0 +1,4 @@
+class Visit < ActiveRecord::Base
+  has_many :ahoy_events, class_name: "Ahoy::Event"
+  belongs_to :user
+end

data/lib/generators/ahoy/{templates/install.rb → stores/templates/active_record_visits_migration.rb}

@@ -1,9 +1,8 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
-    create_table :visits do |t|
-      # cookies
-      t.string :visit_token
-      t.string :visitor_token
+    create_table :visits, id: false do |t|
+      t.uuid :id, primary_key: true
+      t.uuid :visitor_id
 
       # the rest are recommended but optional
       # simply remove the columns you don't want
@@ -16,7 +15,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
 
       # user
       t.integer :user_id
-      t.string :user_type
+      # add t.string :user_type if polymorphic
 
       # traffic source
       t.string :referring_domain
@@ -44,10 +43,9 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       # t.string :app_version
       # t.string :os_version
 
-      t.timestamp :created_at
+      t.timestamp :started_at
     end
 
-    add_index :visits, [:visit_token], unique: true
-    add_index :visits, [:user_id, :user_type]
+    add_index :visits, [:user_id]
   end
 end

data/lib/generators/ahoy/stores/templates/custom_initializer.rb

@@ -0,0 +1,12 @@
+class Ahoy::Store < Ahoy::Stores::BaseStore
+
+  def track_visit(options)
+  end
+
+  def track_event(name, properties, options)
+  end
+
+  def current_visit
+  end
+
+end

data/lib/generators/ahoy/stores/templates/log_initializer.rb

@@ -0,0 +1,3 @@
+class Ahoy::Store < Ahoy::Stores::LogStore
+  # customize here
+end

data/lib/generators/ahoy/stores/templates/mongoid_event_model.rb

@@ -0,0 +1,12 @@
+class Ahoy::Event
+  include Mongoid::Document
+
+  # associations
+  belongs_to :visit
+  belongs_to :user
+
+  # fields
+  field :name, type: String
+  field :properties, type: Hash
+  field :time, type: Time
+end

data/lib/generators/ahoy/stores/templates/mongoid_initializer.rb

@@ -0,0 +1,3 @@
+class Ahoy::Store < Ahoy::Stores::MongoidStore
+  # customize here
+end

data/lib/generators/ahoy/stores/templates/mongoid_visit_model.rb

@@ -0,0 +1,41 @@
+class Visit
+  include Mongoid::Document
+
+  # associations
+  belongs_to :user
+
+  # required
+  field :visitor_id, type: BSON::Binary
+
+  # the rest are recommended but optional
+  # simply remove the columns you don't want
+
+  # standard
+  field :ip, type: String
+  field :user_agent, type: String
+  field :referrer, type: String
+  field :landing_page, type: String
+
+  # traffic source
+  field :referring_domain, type: String
+  field :search_keyword, type: String
+
+  # technology
+  field :browser, type: String
+  field :os, type: String
+  field :device_type, type: String
+
+  # location
+  field :country, type: String
+  field :region, type: String
+  field :city, type: String
+
+  # utm parameters
+  field :utm_source, type: String
+  field :utm_medium, type: String
+  field :utm_term, type: String
+  field :utm_content, type: String
+  field :utm_campaign, type: String
+
+  field :started_at, type: Time
+end

data/vendor/assets/javascripts/ahoy.js

@@ -13,7 +13,7 @@
 
   var ahoy = window.ahoy || window.Ahoy || {};
   var $ = window.jQuery || window.Zepto || window.$;
-  var visitId, visitorId;
+  var visitId, visitorId, track;
   var visitTtl = 4 * 60; // 4 hours
   var visitorTtl = 2 * 365 * 24 * 60; // 2 years
   var isReady = false;
@@ -21,6 +21,8 @@
   var canStringify = typeof(JSON) !== "undefined" && typeof(JSON.stringify) !== "undefined";
   var eventQueue = [];
   var page = ahoy.page || window.location.pathname;
+  var visitsUrl = ahoy.visitsUrl || "/ahoy/visits"
+  var eventsUrl = ahoy.eventsUrl || "/ahoy/events"
 
   // cookies
 
@@ -102,7 +104,7 @@
       if (canStringify) {
         $.ajax({
           type: "POST",
-          url: "/ahoy/events",
+          url: eventsUrl,
           data: JSON.stringify([event]),
           contentType: "application/json; charset=utf-8",
           dataType: "json",
@@ -136,14 +138,21 @@
 
   visitId = getCookie("ahoy_visit");
   visitorId = getCookie("ahoy_visitor");
+  track = getCookie("ahoy_track");
 
-  if (visitId && visitorId) {
+  if (visitId && visitorId && !track) {
     // TODO keep visit alive?
     log("Active visit");
     setReady();
   } else {
-    visitId = generateId();
-    setCookie("ahoy_visit", visitId, visitTtl);
+    if (track) {
+      destroyCookie("ahoy_track");
+    }
+
+    if (!visitId) {
+      visitId = generateId();
+      setCookie("ahoy_visit", visitId, visitTtl);
+    }
 
     // make sure cookies are enabled
     if (getCookie("ahoy_visit")) {
@@ -170,24 +179,26 @@
 
       log(data);
 
-      $.post("/ahoy/visits", data, setReady, "json");
+      $.post(visitsUrl, data, setReady, "json");
     } else {
       log("Cookies disabled");
       setReady();
     }
   }
 
-  ahoy.getVisitToken = function () {
+  ahoy.getVisitId = ahoy.getVisitToken = function () {
     return visitId;
   };
 
-  ahoy.getVisitorToken = function () {
+  ahoy.getVisitorId = ahoy.getVisitorToken = function () {
     return visitorId;
   };
 
   ahoy.reset = function () {
     destroyCookie("ahoy_visit");
     destroyCookie("ahoy_visitor");
+    destroyCookie("ahoy_events");
+    destroyCookie("ahoy_track");
     return true;
   };