ahoy_matey 0.3.2 → 1.0.0

data/ahoy_matey.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "referer-parser"
   spec.add_dependency "user_agent_parser"
   spec.add_dependency "request_store"
+  spec.add_dependency "uuidtools"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/app/controllers/ahoy/base_controller.rb

@@ -2,5 +2,10 @@ module Ahoy
   class BaseController < ApplicationController
     # skip all filters
     skip_filter *_process_action_callbacks.map(&:filter)
+
+    def ahoy
+      @ahoy ||= Ahoy::Tracker.new(controller: self, api: true)
+    end
+
   end
 end

data/app/controllers/ahoy/events_controller.rb

@@ -4,13 +4,15 @@ module Ahoy
     def create
       events = params[:name] ? [params] : ActiveSupport::JSON.decode(request.body.read)
       events.each do |event|
-        options = {}
-        if event["time"] and (time = Time.at(event["time"].to_f) rescue nil) and (1.minute.ago..Time.now).cover?(time)
-          options[:time] = time
-        end
-        if event["id"]
-          options[:id] = event["id"]
-        end
+        time = Time.zone.parse(event["time"]) rescue nil
+
+        # timestamp is deprecated
+        time ||= Time.zone.at(event["time"].to_f) rescue nil
+
+        options = {
+          id: event["id"],
+          time: time
+        }
         ahoy.track event["name"], event["properties"], options
       end
       render json: {}

data/app/controllers/ahoy/visits_controller.rb

@@ -2,7 +2,8 @@ module Ahoy
   class VisitsController < BaseController
 
     def create
-      render json: ahoy.track_visit
+      ahoy.track_visit
+      render json: {visit_id: ahoy.visit_id, visitor_id: ahoy.visitor_id}
     end
 
   end

data/lib/ahoy.rb

@@ -4,47 +4,61 @@ require "geocoder"
 require "referer-parser"
 require "user_agent_parser"
 require "request_store"
+require "uuidtools"
+
 require "ahoy/version"
 require "ahoy/tracker"
 require "ahoy/controller"
 require "ahoy/model"
-require "ahoy/subscribers/active_record"
+require "ahoy/visit_properties"
+require "ahoy/deckhands/location_deckhand"
+require "ahoy/deckhands/request_deckhand"
+require "ahoy/deckhands/technology_deckhand"
+require "ahoy/deckhands/traffic_source_deckhand"
+require "ahoy/deckhands/utm_parameter_deckhand"
+require "ahoy/stores/base_store"
+require "ahoy/stores/active_record_store"
+require "ahoy/stores/active_record_token_store"
+require "ahoy/stores/log_store"
+require "ahoy/stores/mongoid_store"
 require "ahoy/engine"
 require "ahoy/warden" if defined?(Warden)
 
+# deprecated
+require "ahoy/subscribers/active_record"
+
 module Ahoy
+  UUID_NAMESPACE = UUIDTools::UUID.parse("a82ae811-5011-45ab-a728-569df7499c5f")
 
-  def self.generate_id
-    SecureRandom.uuid
-  end
+  mattr_accessor :visit_duration
+  self.visit_duration = 4.hours
 
-  def self.visit_model
-    @visit_model || ::Visit
-  end
+  mattr_accessor :visitor_duration
+  self.visitor_duration = 2.years
 
-  def self.visit_model=(visit_model)
-    @visit_model = visit_model
-  end
+  mattr_accessor :cookie_domain
 
-  # TODO private
-  # performance hack for referer-parser
-  def self.referrer_parser
-    @referrer_parser ||= RefererParser::Referer.new("https://github.com/ankane/ahoy")
-  end
+  mattr_accessor :track_visits_immediately
+  self.track_visits_immediately = false
 
-  # performance
-  def self.user_agent_parser
-    @user_agent_parser ||= UserAgentParser::Parser.new
-  end
+  mattr_accessor :quiet
+  self.quiet = true
 
-  def self.fetch_user(controller)
-    if user_method.respond_to?(:call)
-      user_method.call(controller)
+  def self.ensure_uuid(id)
+    valid = UUIDTools::UUID.parse(id) rescue nil
+    if valid
+      id
     else
-      controller.send(user_method)
+      UUIDTools::UUID.sha1_create(UUID_NAMESPACE, id).to_s
     end
   end
 
+  # deprecated
+
+  mattr_accessor :domain
+
+  mattr_accessor :visit_model
+
   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
@@ -57,11 +71,6 @@ module Ahoy
 
   mattr_accessor :track_bots
   self.track_bots = false
-
-  mattr_accessor :quiet
-  self.quiet = true
-
-  mattr_accessor :domain
 end
 
 ActionController::Base.send :include, Ahoy::Controller

data/lib/ahoy/controller.rb

@@ -1,12 +1,15 @@
+require "request_store"
+
 module Ahoy
   module Controller
 
     def self.included(base)
       base.helper_method :current_visit
       base.helper_method :ahoy
-      base.before_filter :set_ahoy_visitor_cookie
+      base.before_filter :set_ahoy_cookies
+      base.before_filter :track_ahoy_visit
       base.before_filter do
-        RequestStore.store[:ahoy_controller] ||= self
+        RequestStore.store[:ahoy] ||= ahoy
       end
     end
 
@@ -15,28 +18,17 @@ module Ahoy
     end
 
     def current_visit
-      visit_token = current_visit_token
-      if visit_token
-        @current_visit ||= Ahoy.visit_model.where(visit_token: visit_token).first
-      end
-    end
-
-    def current_visit_token
-      @current_visit_token ||= request.headers["Ahoy-Visit"] || cookies[:ahoy_visit]
+      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
+    def set_ahoy_cookies
+      ahoy.set_visitor_cookie
+      ahoy.set_visit_cookie
     end
 
-    def set_ahoy_visitor_cookie
-      if !request.headers["Ahoy-Visitor"] && !cookies[:ahoy_visitor]
-        cookie = {
-          value: current_visitor_token,
-          expires: 2.years.from_now
-        }
-        cookie[:domain] = Ahoy.domain if Ahoy.domain
-        cookies[:ahoy_visitor] = cookie
+    def track_ahoy_visit
+      if ahoy.new_visit?
+        ahoy.track_visit(defer: !Ahoy.track_visits_immediately)
       end
     end
 

data/lib/ahoy/deckhands/location_deckhand.rb

@@ -0,0 +1,39 @@
+module Ahoy
+  module Deckhands
+    class LocationDeckhand
+
+      def initialize(ip)
+        @ip = ip
+      end
+
+      def country
+        location.try(:country).presence
+      end
+
+      def region
+        location.try(:state).presence
+      end
+
+      def city
+        location.try(:city).presence
+      end
+
+      protected
+
+      def location
+        if !@checked
+          @location =
+            begin
+              Geocoder.search(@ip).first
+            rescue => e
+              $stderr.puts e.message
+              nil
+            end
+          @checked = true
+        end
+        @location
+      end
+
+    end
+  end
+end

data/lib/ahoy/deckhands/request_deckhand.rb

@@ -0,0 +1,41 @@
+module Ahoy
+  module Deckhands
+    class RequestDeckhand
+      attr_reader :request
+
+      def initialize(request, options = {})
+        @request = request
+        @options = options
+      end
+
+      def ip
+        request.remote_ip
+      end
+
+      def user_agent
+        request.user_agent
+      end
+
+      def referrer
+        @options[:api] ? request.params["referrer"] : request.referer
+      end
+
+      def landing_page
+        @options[:api] ? request.params["landing_page"] : request.original_url
+      end
+
+      def platform
+        request.params["platform"]
+      end
+
+      def app_version
+        request.params["app_version"]
+      end
+
+      def os_version
+        request.params["os_version"]
+      end
+
+    end
+  end
+end

data/lib/ahoy/deckhands/technology_deckhand.rb

@@ -0,0 +1,49 @@
+module Ahoy
+  module Deckhands
+    class TechnologyDeckhand
+
+      def initialize(user_agent)
+        @user_agent = user_agent
+      end
+
+      def browser
+        agent.name
+      end
+
+      def os
+        agent.os.name
+      end
+
+      def device_type
+        @device_type ||= begin
+          browser = Browser.new(ua: @user_agent)
+          if browser.bot?
+            "Bot"
+          elsif browser.tv?
+            "TV"
+          elsif browser.console?
+            "Console"
+          elsif browser.tablet?
+            "Tablet"
+          elsif browser.mobile?
+            "Mobile"
+          else
+            "Desktop"
+          end
+        end
+      end
+
+      protected
+
+      def agent
+        @agent ||= self.class.user_agent_parser.parse(@user_agent)
+      end
+
+      # performance
+      def self.user_agent_parser
+        @user_agent_parser ||= UserAgentParser::Parser.new
+      end
+
+    end
+  end
+end

data/lib/ahoy/deckhands/traffic_source_deckhand.rb

@@ -0,0 +1,24 @@
+module Ahoy
+  module Deckhands
+    class TrafficSourceDeckhand
+
+      def initialize(referrer)
+        @referrer = referrer
+      end
+
+      def referring_domain
+        @referring_domain ||= Addressable::URI.parse(@referrer).host.first(255) rescue nil
+      end
+
+      def search_keyword
+        @search_keyword ||= (self.class.referrer_parser.parse(@referrer)[1].first(255) rescue nil).presence
+      end
+
+      # performance hack for referer-parser
+      def self.referrer_parser
+        @referrer_parser ||= RefererParser::Referer.new("https://github.com/ankane/ahoy")
+      end
+
+    end
+  end
+end

data/lib/ahoy/deckhands/utm_parameter_deckhand.rb

@@ -0,0 +1,24 @@
+module Ahoy
+  module Deckhands
+    class UtmParameterDeckhand
+
+      def initialize(landing_page)
+        @landing_page = landing_page
+      end
+
+      def landing_params
+        @landing_params ||= begin
+          landing_uri = Addressable::URI.parse(@landing_page) rescue nil
+          (landing_uri && landing_uri.query_values) || {}
+        end
+      end
+
+      %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
+        define_method name do
+          landing_params[name]
+        end
+      end
+
+    end
+  end
+end

data/lib/ahoy/engine.rb

@@ -1,7 +1,8 @@
 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|
+    initializer "ahoy.middleware", after: "sprockets.environment" do |app|
       next unless Ahoy.quiet
 
       # Parse PATH_INFO by assets prefix
@@ -24,5 +25,6 @@ module Ahoy
         alias_method_chain :call, :quiet_ahoy
       end
     end
+
   end
 end

data/lib/ahoy/model.rb

@@ -1,87 +1,6 @@
 module Ahoy
   module Model
 
-    def ahoy_visit
-      class_eval do
-
-        belongs_to :user, polymorphic: true
-
-        before_create :set_traffic_source
-        before_create :set_utm_parameters
-        before_create :set_technology
-        before_create :set_location
-
-        def set_traffic_source
-          referring_domain = Addressable::URI.parse(referrer).host.first(255) rescue nil
-          self.referring_domain = referring_domain if respond_to?(:referring_domain=)
-          # performance hack for referer-parser
-          search_keyword = Ahoy.referrer_parser.parse(referrer)[1].first(255) rescue nil
-          self.search_keyword = search_keyword.presence if respond_to?(:search_keyword=)
-          true
-        end
-
-        def set_utm_parameters
-          %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
-            self[name] = landing_params[name] if respond_to?(:"#{name}=")
-          end
-          true
-        end
-
-        def set_technology
-          if respond_to?(:user_agent)
-            agent = Ahoy.user_agent_parser.parse(user_agent)
-
-            self.browser = agent.name if respond_to?(:browser=)
-            self.os = agent.os.name if respond_to?(:os=)
-
-            browser = Browser.new(ua: user_agent)
-            self.device_type =
-              if browser.bot?
-                "Bot"
-              elsif browser.tv?
-                "TV"
-              elsif browser.console?
-                "Console"
-              elsif browser.tablet?
-                "Tablet"
-              elsif browser.mobile?
-                "Mobile"
-              else
-                "Desktop"
-              end if respond_to?(:device_type=)
-          end
-          true
-        end
-
-        def set_location
-          if respond_to?(:ip) and [:country=, :region=, :city=].any?{|method| respond_to?(method) }
-            location =
-              begin
-                Geocoder.search(ip).first
-              rescue => e
-                $stderr.puts e.message
-                nil
-              end
-
-            if location
-              self.country = location.country.presence if respond_to?(:country=)
-              self.region = location.state.presence if respond_to?(:region=)
-              self.city = location.city.presence if respond_to?(:city=)
-            end
-          end
-          true
-        end
-
-        def landing_params
-          @landing_params ||= begin
-            landing_uri = Addressable::URI.parse(landing_page) rescue nil
-            ActiveSupport::HashWithIndifferentAccess.new((landing_uri && landing_uri.query_values) || {})
-          end
-        end
-
-      end # end class_eval
-    end
-
     def visitable(name = nil, options = {})
       if name.is_a?(Hash)
         name = nil
@@ -94,10 +13,28 @@ module Ahoy
       end
       class_eval %Q{
         def set_visit
-          self.#{name} ||= RequestStore.store[:ahoy_controller].try(:send, :current_visit)
+          self.#{name} ||= RequestStore.store[:ahoy].visit
         end
       }
     end
 
+    # deprecated
+
+    def ahoy_visit
+      class_eval do
+        warn "[DEPRECATION] ahoy_visit is deprecated"
+
+        belongs_to :user, polymorphic: true
+
+        def landing_params
+          @landing_params ||= begin
+            warn "[DEPRECATION] landing_params is deprecated"
+            Deckhands::UtmParameterDeckhand.new(landing_page).landing_params
+          end
+        end
+
+      end
+    end
+
   end
 end