ahoy_matey 0.3.2 → 1.0.0

data/lib/ahoy/stores/active_record_store.rb

@@ -0,0 +1,63 @@
+module Ahoy
+  module Stores
+    class ActiveRecordStore < BaseStore
+
+      def track_visit(options, &block)
+        visit =
+          visit_model.new do |v|
+            v.id = ahoy.visit_id
+            v.visitor_id = ahoy.visitor_id
+            v.user = user if v.respond_to?(:user=)
+            v.started_at = options[:started_at]
+          end
+
+        visit_properties.keys.each do |key|
+          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=")
+        end
+
+        yield(visit) if block_given?
+
+        begin
+          visit.save!
+        rescue ActiveRecord::RecordNotUnique
+          # do nothing
+        end
+      end
+
+      def track_event(name, properties, options, &block)
+        event =
+          event_model.new do |e|
+            e.id = options[:id]
+            e.visit_id = ahoy.visit_id
+            e.user = user
+            e.name = name
+            e.properties = properties
+            e.time = options[:time]
+          end
+
+        yield(event) if block_given?
+
+        begin
+          event.save!
+        rescue ActiveRecord::RecordNotUnique
+          # do nothing
+        end
+      end
+
+      def visit
+        @visit ||= visit_model.where(id: ahoy.visit_id).first if ahoy.visit_id
+      end
+
+      protected
+
+      def visit_model
+        ::Visit
+      end
+
+      def event_model
+        ::Ahoy::Event
+      end
+
+    end
+  end
+end

data/lib/ahoy/stores/active_record_token_store.rb

@@ -0,0 +1,113 @@
+module Ahoy
+  module Stores
+    class ActiveRecordTokenStore < BaseStore
+
+      def track_visit(options, &block)
+        visit =
+          visit_model.new do |v|
+            v.visit_token = ahoy.visit_token
+            v.visitor_token = ahoy.visitor_token
+            v.user = user if v.respond_to?(:user=)
+            v.created_at = options[:started_at]
+          end
+
+        visit_properties.keys.each do |key|
+          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=")
+        end
+
+        yield(visit) if block_given?
+
+        begin
+          visit.save!
+        rescue ActiveRecord::RecordNotUnique
+          # do nothing
+        end
+      end
+
+      def track_event(name, properties, options, &block)
+        if self.class.uses_deprecated_subscribers?
+          options[:controller] ||= controller
+          options[:user] ||= user
+          options[:visit] ||= visit
+          options[:visit_token] ||= ahoy.visit_token
+          options[:visitor_token] ||= ahoy.visitor_token
+
+          subscribers = Ahoy.subscribers
+          if subscribers.any?
+            subscribers.each do |subscriber|
+              subscriber.track(name, properties, options.dup)
+            end
+          else
+            $stderr.puts "No subscribers"
+          end
+        else
+          event =
+            event_model.new do |e|
+              e.visit_id = visit.try(:id)
+              e.user = user
+              e.name = name
+              e.properties = properties
+              e.time = options[:time]
+            end
+
+          yield(event) if block_given?
+
+          event.save!
+        end
+      end
+
+      def visit
+        @visit ||= visit_model.where(visit_token: ahoy.visit_token).first if ahoy.visit_token
+      end
+
+      def exclude?
+        (!Ahoy.track_bots && bot?) ||
+        (
+          if Ahoy.exclude_method
+            warn "[DEPRECATION] Ahoy.exclude_method is deprecated - use exclude? instead"
+            if Ahoy.exclude_method.arity == 1
+              Ahoy.exclude_method.call(controller)
+            else
+              Ahoy.exclude_method.call(controller, request)
+            end
+          else
+            false
+          end
+        )
+      end
+
+      def user
+        user_method = Ahoy.user_method
+        if user_method.respond_to?(:call)
+          user_method.call(controller)
+        else
+          controller.send(user_method)
+        end
+      end
+
+      class << self
+
+        def uses_deprecated_subscribers
+          warn "[DEPRECATION] Ahoy subscribers are deprecated"
+          @uses_deprecated_subscribers = true
+        end
+
+        def uses_deprecated_subscribers?
+          @uses_deprecated_subscribers || false
+        end
+
+      end
+
+      protected
+
+      def visit_model
+        Ahoy.visit_model || ::Visit
+      end
+
+      def event_model
+        ::Ahoy::Event
+      end
+
+    end
+  end
+end

data/lib/ahoy/stores/base_store.rb

@@ -0,0 +1,65 @@
+module Ahoy
+  module Stores
+    class BaseStore
+
+      def initialize(options)
+        @options = options
+      end
+
+      def track_visit(options)
+      end
+
+      def track_event(name, properties, options)
+      end
+
+      def visit
+      end
+
+      def authenticate(user)
+        @user = user
+        if visit and visit.respond_to?(:user) and !visit.user
+          visit.user = user
+          visit.save!
+        end
+      end
+
+      def report_exception(e)
+      end
+
+      def user
+        @user ||= controller.current_user
+      end
+
+      def exclude?
+        bot?
+      end
+
+      def generate_id
+        SecureRandom.uuid
+      end
+
+      protected
+
+      def bot?
+        @bot ||= Browser.new(ua: request.user_agent).bot?
+      end
+
+      def request
+        @request ||= @options[:request] || controller.try(:request)
+      end
+
+      def controller
+        @controller ||= @options[:controller]
+      end
+
+      def ahoy
+        @ahoy ||= @options[:ahoy]
+      end
+
+      def visit_properties
+        ahoy.visit_properties
+      end
+
+    end
+  end
+end

data/lib/ahoy/stores/log_store.rb

@@ -0,0 +1,47 @@
+module Ahoy
+  module Stores
+    class LogStore < BaseStore
+
+      def track_visit(options, &block)
+        data = {
+          id: ahoy.visit_id,
+          visitor_id: ahoy.visitor_id,
+        }.merge(visit_properties.to_hash)
+        data[:user_id] = user.id if user
+        data[:started_at] = options[:started_at]
+
+        yield(data) if block_given?
+
+        visit_logger.info data.to_json
+      end
+
+      def track_event(name, properties, options, &block)
+        data = {
+          id: options[:id],
+          name: name,
+          properties: properties,
+          visit_id: ahoy.visit_id,
+          visitor_id: ahoy.visitor_id
+        }
+        data[:user_id] = user.id if user
+        data[:time] = options[:time]
+
+        yield(data) if block_given?
+
+        event_logger.info data.to_json
+      end
+
+      protected
+
+      # TODO disable header
+      def visit_logger
+        @visit_logger ||= ActiveSupport::Logger.new(Rails.root.join("log/visits.log"))
+      end
+
+      def event_logger
+        @event_logger ||= ActiveSupport::Logger.new(Rails.root.join("log/events.log"))
+      end
+
+    end
+  end
+end

data/lib/ahoy/stores/mongoid_store.rb

@@ -0,0 +1,59 @@
+module Ahoy
+  module Stores
+    class MongoidStore < BaseStore
+
+      def track_visit(options, &block)
+        visit =
+          visit_model.new do |v|
+            v.id = binary(ahoy.visit_id)
+            v.visitor_id = binary(ahoy.visitor_id)
+            v.user = user if v.respond_to?(:user=) && user
+            v.started_at = options[:started_at]
+          end
+
+        visit_properties.keys.each do |key|
+          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=") && visit_properties[key]
+        end
+
+        yield(visit) if block_given?
+
+        visit.upsert
+      end
+
+      def track_event(name, properties, options, &block)
+        event =
+          event_model.new do |e|
+            e.id = binary(options[:id])
+            e.visit_id = binary(ahoy.visit_id)
+            e.user = user if e.respond_to?(:user)
+            e.name = name
+            e.properties = properties
+            e.time = options[:time]
+          end
+
+        yield(event) if block_given?
+
+        event.upsert
+      end
+
+      def visit
+        @visit ||= visit_model.where(_id: binary(ahoy.visit_id)).first if ahoy.visit_id
+      end
+
+      protected
+
+      def visit_model
+        ::Visit
+      end
+
+      def event_model
+        ::Ahoy::Event
+      end
+
+      def binary(token)
+        ::BSON::Binary.new(token.delete("-"), :uuid)
+      end
+
+    end
+  end
+end

data/lib/ahoy/tracker.rb

@@ -1,103 +1,144 @@
 module Ahoy
   class Tracker
+    attr_reader :request, :controller
 
     def initialize(options = {})
+      @store = Ahoy::Store.new(options.merge(ahoy: self))
       @controller = options[:controller]
       @request = options[:request] || @controller.try(:request)
+      @options = options
     end
 
     def track(name, properties = {}, options = {})
-      if track?
-        # publish to each subscriber
+      unless exclude?
         options = options.dup
-        if @controller
-          options[:controller] ||= @controller
-          options[:user] ||= Ahoy.fetch_user(@controller)
-          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?
-          subscribers.each do |subscriber|
-            subscriber.track(name, properties, options)
-          end
+
+        options[:time] = trusted_time(options[:time])
+        options[:id] = ensure_uuid(options[:id] || generate_id)
+
+        @store.track_event(name, properties, options)
+      end
+      true
+    rescue => e
+      report_exception(e)
+    end
+
+    def track_visit(options = {})
+      unless exclude?
+        if options[:defer]
+          set_cookie("ahoy_track", true)
         else
-          $stderr.puts "No subscribers"
+          options = options.dup
+
+          options[:started_at] ||= Time.zone.now
+
+          @store.track_visit(options)
         end
       end
+      true
+    rescue => e
+      report_exception(e)
+    end
 
+    def authenticate(user)
+      unless exclude?
+        @store.authenticate(user)
+      end
       true
+    rescue => e
+      report_exception(e)
     end
 
-    # not a public API - do not use
-    def track_visit
-      visit_token = params[:visit_token] || Ahoy.generate_id
-      visitor_token = params[:visitor_token] || Ahoy.generate_id
-
-      if track?
-        # TODO move to subscriber
-        visit =
-          Ahoy.visit_model.new do |v|
-            v.visit_token = visit_token
-            v.visitor_token = visitor_token
-            v.ip = request.remote_ip if v.respond_to?(:ip=)
-            v.user_agent = request.user_agent if v.respond_to?(:user_agent=)
-            v.referrer = params[:referrer] if v.respond_to?(:referrer=)
-            v.landing_page = params[:landing_page] if v.respond_to?(:landing_page=)
-            v.user = Ahoy.fetch_user(@controller) if v.respond_to?(:user=)
-            v.platform = params[:platform] if v.respond_to?(:platform=)
-            v.app_version = params[:app_version] if v.respond_to?(:app_version=)
-            v.os_version = params[:os_version] if v.respond_to?(:os_version=)
-          end
-
-        begin
-          visit.save!
-        rescue ActiveRecord::RecordNotUnique
-          # do nothing
-        end
+    def visit
+      @visit ||= @store.visit
+    end
+
+    def visit_id
+      @visit_id ||= ensure_uuid(existing_visit_id || visit_token)
+    end
+
+    def visitor_id
+      @visitor_id ||= ensure_uuid(existing_visitor_id || visitor_token)
+    end
+
+    def new_visit?
+      !existing_visit_id
+    end
+
+    def set_visit_cookie
+      set_cookie("ahoy_visit", visit_id, Ahoy.visit_duration)
+    end
+
+    def set_visitor_cookie
+      if !existing_visitor_id
+        set_cookie("ahoy_visitor", visitor_id, Ahoy.visitor_duration)
       end
+    end
+
+    def user
+      @user ||= @store.user
+    end
 
-      {visit_token: visit_token, visitor_token: visitor_token}
+    # TODO better name
+    def visit_properties
+      @visit_properties ||= Ahoy::VisitProperties.new(request, @options.slice(:api))
+    end
+
+    # for ActiveRecordTokenStore only - do not use
+    def visit_token
+      @visit_token ||= existing_visit_id || (@options[:api] && request.params["visit_token"]) || generate_id
+    end
+
+    # for ActiveRecordTokenStore only - do not use
+    def visitor_token
+      @visitor_token ||= existing_visitor_id || (@options[:api] && request.params["visitor_token"]) || generate_id
     end
 
     protected
 
-    def track?
-      (Ahoy.track_bots || !bot?) && !exclude?
+    def set_cookie(name, value, duration = nil)
+      cookie = {
+        value: value
+      }
+      cookie[:expires] = duration.from_now if duration
+      domain = Ahoy.cookie_domain || Ahoy.domain
+      cookie[:domain] = domain if domain
+      request.cookie_jar[name] = cookie
     end
 
-    def bot?
-      @bot ||= Browser.new(ua: @request.user_agent).bot?
+    def trusted_time(time)
+      if !time or (@options[:api] and !(1.minute.ago..Time.now).cover?(time))
+        Time.zone.now
+      else
+        time
+      end
     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
+      @store.exclude?
+    end
+
+    def report_exception(e)
+      @store.report_exception(e)
+      if Rails.env.development?
+        raise e
       end
     end
 
-    def params
-      @controller.params
+    def generate_id
+      @store.generate_id
+    end
+
+    def existing_visit_id
+      @existing_visit_id ||= request.headers["Ahoy-Visit"] || request.cookies["ahoy_visit"]
+    end
+
+    def existing_visitor_id
+      @existing_visitor_id ||= request.headers["Ahoy-Visitor"] || request.cookies["ahoy_visitor"]
     end
 
-    def request
-      @request
+    def ensure_uuid(id)
+      Ahoy.ensure_uuid(id)
     end
 
   end