ahoy_matey 1.5.3 → 3.0.1

data/app/controllers/ahoy/base_controller.rb

@@ -1,19 +1,12 @@
 module Ahoy
   class BaseController < ApplicationController
-    # skip all filters except for authlogic
-    filters = _process_action_callbacks.map(&:filter) - [:load_authlogic]
-    if Rails::VERSION::MAJOR >= 5
-      skip_before_action(*filters, raise: false)
-      skip_after_action(*filters, raise: false)
-      skip_around_action(*filters, raise: false)
-      before_action :verify_request_size
-    elsif respond_to?(:skip_action_callback)
-      skip_action_callback *filters
-      before_action :verify_request_size
-    else
-      skip_filter *filters
-      before_filter :verify_request_size
-    end
+    filters = _process_action_callbacks.map(&:filter) - Ahoy.preserve_callbacks
+    skip_before_action(*filters, raise: false)
+    skip_after_action(*filters, raise: false)
+    skip_around_action(*filters, raise: false)
+
+    before_action :verify_request_size
+    before_action :renew_cookies
 
     if respond_to?(:protect_from_forgery)
       protect_from_forgery with: :null_session, if: -> { Ahoy.protect_from_forgery }
@@ -25,10 +18,17 @@ module Ahoy
       @ahoy ||= Ahoy::Tracker.new(controller: self, api: true)
     end
 
+    # set proper ttl if cookie generated from JavaScript
+    # approach is not perfect, as user must reload the page
+    # for new cookie settings to take effect
+    def renew_cookies
+      set_ahoy_cookies if params[:js] && !Ahoy.api_only
+    end
+
     def verify_request_size
       if request.content_length > Ahoy.max_content_length
         logger.info "[ahoy] Payload too large"
-        render text: "Payload too large\n", status: 413
+        render plain: "Payload too large\n", status: 413
       end
     end
   end

data/app/controllers/ahoy/events_controller.rb

@@ -3,13 +3,19 @@ module Ahoy
     def create
       events =
         if params[:name]
-          # legacy API
+          # legacy API and AMP
           [request.params]
         elsif params[:events]
           request.params[:events]
         else
+          data =
+            if params[:events_json]
+              request.params[:events_json]
+            else
+              request.body.read
+            end
           begin
-            ActiveSupport::JSON.decode(request.body.read)
+            ActiveSupport::JSON.decode(data)
           rescue ActiveSupport::JSON.parse_error
             # do nothing
             []

data/app/controllers/ahoy/visits_controller.rb

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

data/app/jobs/ahoy/geocode_job.rb

@@ -0,0 +1,10 @@
+# for smooth update from Ahoy 1 -> 2
+module Ahoy
+  class GeocodeJob < ActiveJob::Base
+    queue_as { Ahoy.job_queue }
+
+    def perform(visit)
+      Ahoy::GeocodeV2Job.perform_now(visit.visit_token, visit.ip)
+    end
+  end
+end

data/app/jobs/ahoy/geocode_v2_job.rb

@@ -0,0 +1,28 @@
+module Ahoy
+  class GeocodeV2Job < ActiveJob::Base
+    queue_as { Ahoy.job_queue }
+
+    def perform(visit_token, ip)
+      location =
+        begin
+          Geocoder.search(ip).first
+        rescue => e
+          Ahoy.log "Geocode error: #{e.class.name}: #{e.message}"
+          nil
+        end
+
+      if location && location.country.present?
+        data = {
+          country: location.country,
+          region: location.try(:state).presence,
+          city: location.try(:city).presence,
+          postal_code: location.try(:postal_code).presence,
+          latitude: location.try(:latitude).presence,
+          longitude: location.try(:longitude).presence
+        }
+
+        Ahoy::Tracker.new(visit_token: visit_token).geocode(data)
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-  mount Ahoy::Engine => "/ahoy" if Ahoy.mount
+  mount Ahoy::Engine => "/ahoy" if Ahoy.api
 end
 
 Ahoy::Engine.routes.draw do

data/lib/ahoy.rb

@@ -1,61 +1,39 @@
+require "ipaddr"
+
+# dependencies
 require "active_support"
 require "active_support/core_ext"
-require "addressable/uri"
-require "browser"
 require "geocoder"
-require "referer-parser"
-require "user_agent_parser"
-require "request_store"
-require "uuidtools"
 require "safely/core"
 
-require "ahoy/version"
-require "ahoy/tracker"
+# modules
+require "ahoy/utils"
+require "ahoy/base_store"
 require "ahoy/controller"
+require "ahoy/database_store"
+require "ahoy/helper"
 require "ahoy/model"
+require "ahoy/query_methods"
+require "ahoy/tracker"
+require "ahoy/version"
 require "ahoy/visit_properties"
-require "ahoy/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/fluentd_store"
-require "ahoy/stores/mongoid_store"
-require "ahoy/stores/kafka_store"
-require "ahoy/stores/kinesis_firehose_store"
-require "ahoy/stores/bunny_store"
-require "ahoy/engine" if defined?(Rails)
-require "ahoy/warden" if defined?(Warden)
-
-# background jobs
-begin
-  require "active_job"
-rescue LoadError
-  # do nothing
-end
-require "ahoy/geocode_job" if defined?(ActiveJob)
 
-# deprecated
-require "ahoy/subscribers/active_record"
+require "ahoy/engine" if defined?(Rails)
 
 module Ahoy
-  UUID_NAMESPACE = UUIDTools::UUID.parse("a82ae811-5011-45ab-a728-569df7499c5f")
-
   mattr_accessor :visit_duration
   self.visit_duration = 4.hours
 
   mattr_accessor :visitor_duration
   self.visitor_duration = 2.years
 
+  mattr_accessor :cookies
+  self.cookies = true
+
   mattr_accessor :cookie_domain
 
-  mattr_accessor :track_visits_immediately
-  self.track_visits_immediately = false
+  mattr_accessor :server_side_visits
+  self.server_side_visits = true
 
   mattr_accessor :quiet
   self.quiet = true
@@ -69,70 +47,74 @@ module Ahoy
   mattr_accessor :max_events_per_request
   self.max_events_per_request = 10
 
-  mattr_accessor :mount
-  self.mount = true
-
-  mattr_accessor :throttle
-  self.throttle = true
-
-  mattr_accessor :throttle_limit
-  self.throttle_limit = 20
-
-  mattr_accessor :throttle_period
-  self.throttle_period = 1.minute
-
   mattr_accessor :job_queue
   self.job_queue = :ahoy
 
+  mattr_accessor :api
+  self.api = false
+
   mattr_accessor :api_only
   self.api_only = false
 
   mattr_accessor :protect_from_forgery
-  self.protect_from_forgery = false
-
-  def self.ensure_uuid(id)
-    valid = UUIDTools::UUID.parse(id) rescue nil
-    if valid
-      id
-    else
-      UUIDTools::UUID.sha1_create(UUID_NAMESPACE, id).to_s
-    end
-  end
+  self.protect_from_forgery = true
 
-  # deprecated
+  mattr_accessor :preserve_callbacks
+  self.preserve_callbacks = [:load_authlogic, :activate_authlogic]
 
-  mattr_accessor :domain
-  mattr_accessor :visit_model
   mattr_accessor :user_method
-  mattr_accessor :exclude_method
+  self.user_method = lambda do |controller|
+    (controller.respond_to?(:current_user, true) && controller.send(:current_user)) || (controller.respond_to?(:current_resource_owner, true) && controller.send(:current_resource_owner)) || nil
+  end
 
-  mattr_accessor :subscribers
-  self.subscribers = []
+  mattr_accessor :exclude_method
 
   mattr_accessor :track_bots
   self.track_bots = false
-end
 
-if defined?(Rails)
-  ActiveSupport.on_load(:action_controller) do
-    ActionController::Base.send :include, Ahoy::Controller
-  end
+  mattr_accessor :bot_detection_version
+  self.bot_detection_version = 2
 
-  ActiveSupport.on_load(:active_record) do
-    ActiveRecord::Base.send(:extend, Ahoy::Model)
+  mattr_accessor :token_generator
+  self.token_generator = -> { SecureRandom.uuid }
+
+  mattr_accessor :mask_ips
+  self.mask_ips = false
+
+  mattr_accessor :user_agent_parser
+  self.user_agent_parser = :device_detector
+
+  mattr_accessor :logger
+
+  def self.log(message)
+    logger.info { "[ahoy] #{message}" } if logger
   end
 
-  # ensure logger silence will not be added by activerecord-session_store
-  # otherwise, we get SystemStackError: stack level too deep
-  begin
-    require "active_record/session_store/extension/logger_silencer"
-  rescue LoadError
-    require "ahoy/logger_silencer"
-    Logger.send :include, Ahoy::LoggerSilencer
-
-    begin
-      require "syslog/logger"
-      Syslog::Logger.send :include, Ahoy::LoggerSilencer
-    rescue LoadError; end
+  def self.mask_ip(ip)
+    addr = IPAddr.new(ip)
+    if addr.ipv4?
+      # set last octet to 0
+      addr.mask(24).to_s
+    else
+      # set last 80 bits to zeros
+      addr.mask(48).to_s
+    end
   end
 end
+
+ActiveSupport.on_load(:action_controller) do
+  include Ahoy::Controller
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend Ahoy::Model
+end
+
+ActiveSupport.on_load(:action_view) do
+  include Ahoy::Helper
+end
+
+# Mongoid
+if defined?(ActiveModel)
+  ActiveModel::Callbacks.include(Ahoy::Model)
+end

data/lib/ahoy/base_store.rb

@@ -0,0 +1,97 @@
+module Ahoy
+  class BaseStore
+    attr_writer :user
+
+    def initialize(options)
+      @options = options
+    end
+
+    def track_visit(data)
+    end
+
+    def track_event(data)
+    end
+
+    def geocode(data)
+    end
+
+    def authenticate(data)
+    end
+
+    def visit
+    end
+
+    def user
+      @user ||= begin
+        if Ahoy.user_method.respond_to?(:call)
+          Ahoy.user_method.call(controller)
+        else
+          controller.send(Ahoy.user_method) if controller.respond_to?(Ahoy.user_method, true)
+        end
+      end
+    end
+
+    def exclude?
+      (!Ahoy.track_bots && bot?) || exclude_by_method?
+    end
+
+    def generate_id
+      Ahoy.token_generator.call
+    end
+
+    def visit_or_create
+      visit
+    end
+
+    protected
+
+    def bot?
+      unless defined?(@bot)
+        @bot = begin
+          if request
+            if Ahoy.user_agent_parser == :device_detector
+              detector = DeviceDetector.new(request.user_agent)
+              if Ahoy.bot_detection_version == 2
+                detector.bot? || (detector.device_type.nil? && detector.os_name.nil?)
+              else
+                detector.bot?
+              end
+            else
+              # no need to throw friendly error if browser isn't defined
+              # since will error in visit_properties
+              Browser.new(request.user_agent).bot?
+            end
+          else
+            false
+          end
+        end
+      end
+
+      @bot
+    end
+
+    def exclude_by_method?
+      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
+
+    def request
+      @request ||= @options[:request] || controller.try(:request)
+    end
+
+    def controller
+      @controller ||= @options[:controller]
+    end
+
+    def ahoy
+      @ahoy ||= @options[:ahoy]
+    end
+  end
+end

data/lib/ahoy/controller.rb

@@ -1,19 +1,13 @@
-require "request_store"
-
 module Ahoy
   module Controller
     def self.included(base)
-      base.helper_method :current_visit
-      base.helper_method :ahoy
-      if base.respond_to?(:before_action)
-        base.before_action :set_ahoy_cookies, unless: -> { Ahoy.api_only }
-        base.before_action :track_ahoy_visit, unless: -> { Ahoy.api_only }
-        base.before_action :set_ahoy_request_store
-      else
-        base.before_filter :set_ahoy_cookies, unless: -> { Ahoy.api_only }
-        base.before_filter :track_ahoy_visit, unless: -> { Ahoy.api_only }
-        base.before_filter :set_ahoy_request_store
+      if base.respond_to?(:helper_method)
+        base.helper_method :current_visit
+        base.helper_method :ahoy
       end
+      base.before_action :set_ahoy_cookies, unless: -> { Ahoy.api_only }
+      base.before_action :track_ahoy_visit, unless: -> { Ahoy.api_only }
+      base.around_action :set_ahoy_request_store
     end
 
     def ahoy
@@ -25,18 +19,33 @@ module Ahoy
     end
 
     def set_ahoy_cookies
-      ahoy.set_visitor_cookie
-      ahoy.set_visit_cookie
+      if Ahoy.cookies
+        ahoy.set_visitor_cookie
+        ahoy.set_visit_cookie
+      else
+        # delete cookies if exist
+        ahoy.reset
+      end
     end
 
     def track_ahoy_visit
-      if ahoy.new_visit?
-        ahoy.track_visit(defer: !Ahoy.track_visits_immediately)
+      defer = Ahoy.server_side_visits != true
+
+      if defer && !Ahoy.cookies
+        # avoid calling new_visit?, which triggers a database call
+      elsif ahoy.new_visit?
+        ahoy.track_visit(defer: defer)
       end
     end
 
     def set_ahoy_request_store
-      RequestStore.store[:ahoy] ||= ahoy
+      previous_value = Thread.current[:ahoy]
+      begin
+        Thread.current[:ahoy] = ahoy
+        yield
+      ensure
+        Thread.current[:ahoy] = previous_value
+      end
     end
   end
 end