ahoy_matey 2.2.1 → 3.0.4

data/app/controllers/ahoy/base_controller.rb

@@ -1,13 +1,10 @@
 module Ahoy
   class BaseController < ApplicationController
     filters = _process_action_callbacks.map(&:filter) - Ahoy.preserve_callbacks
-    if Rails::VERSION::MAJOR >= 5
-      skip_before_action(*filters, raise: false)
-      skip_after_action(*filters, raise: false)
-      skip_around_action(*filters, raise: false)
-    else
-      skip_action_callback(*filters)
-    end
+    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
 
@@ -31,7 +28,7 @@ module Ahoy
     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/lib/ahoy.rb

@@ -1,11 +1,12 @@
 require "ipaddr"
 
+# dependencies
 require "active_support"
 require "active_support/core_ext"
-require "addressable/uri"
 require "geocoder"
 require "safely/core"
 
+# modules
 require "ahoy/utils"
 require "ahoy/base_store"
 require "ahoy/controller"
@@ -29,8 +30,12 @@ module Ahoy
   mattr_accessor :cookies
   self.cookies = true
 
+  # TODO deprecate in favor of cookie_options
   mattr_accessor :cookie_domain
 
+  mattr_accessor :cookie_options
+  self.cookie_options = {}
+
   mattr_accessor :server_side_visits
   self.server_side_visits = true
 
@@ -72,7 +77,7 @@ module Ahoy
   self.track_bots = false
 
   mattr_accessor :bot_detection_version
-  self.bot_detection_version = 1
+  self.bot_detection_version = 2
 
   mattr_accessor :token_generator
   self.token_generator = -> { SecureRandom.uuid }
@@ -81,10 +86,12 @@ module Ahoy
   self.mask_ips = false
 
   mattr_accessor :user_agent_parser
-  self.user_agent_parser = :legacy
+  self.user_agent_parser = :device_detector
+
+  mattr_accessor :logger
 
   def self.log(message)
-    Rails.logger.info { "[ahoy] #{message}" }
+    logger.info { "[ahoy] #{message}" } if logger
   end
 
   def self.mask_ip(ip)

data/lib/ahoy/base_store.rb

@@ -26,7 +26,7 @@ module Ahoy
         if Ahoy.user_method.respond_to?(:call)
           Ahoy.user_method.call(controller)
         else
-          controller.send(Ahoy.user_method)
+          controller.send(Ahoy.user_method) if controller.respond_to?(Ahoy.user_method, true)
         end
       end
     end
@@ -52,11 +52,13 @@ module Ahoy
             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.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

data/lib/ahoy/controller.rb

@@ -1,5 +1,3 @@
-require "request_store"
-
 module Ahoy
   module Controller
     def self.included(base)
@@ -9,7 +7,7 @@ module Ahoy
       end
       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
+      base.around_action :set_ahoy_request_store
     end
 
     def ahoy
@@ -41,7 +39,13 @@ module Ahoy
     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

data/lib/ahoy/database_store.rb

@@ -34,7 +34,7 @@ module Ahoy
         # upsert since visit might not be found due to eventual consistency
         visit_model.where(visit_token: visit_token).find_one_and_update({"$set": data}, {upsert: true})
       elsif visit
-        visit.update_attributes(data)
+        visit.update!(data)
       else
         Ahoy.log "Visit for geocode not found: #{visit_token}"
       end
@@ -76,7 +76,7 @@ module Ahoy
 
     def slice_data(model, data)
       column_names = model.try(:column_names) || model.attribute_names
-      data.slice(*column_names.map(&:to_sym)).select { |_, v| v }
+      data.slice(*column_names.map(&:to_sym)).select { |_, v| !v.nil? }
     end
 
     def unique_exception?(e)

data/lib/ahoy/engine.rb

@@ -1,6 +1,8 @@
 module Ahoy
   class Engine < ::Rails::Engine
     initializer "ahoy", after: "sprockets.environment" do
+      Ahoy.logger ||= Rails.logger
+
       # allow Devise to be loaded after Ahoy
       require "ahoy/warden" if defined?(Warden)
 

data/lib/ahoy/model.rb

@@ -2,14 +2,12 @@ module Ahoy
   module Model
     def visitable(name = :visit, **options)
       class_eval do
-        safe_options = options.dup
-        safe_options[:optional] = true if Rails::VERSION::MAJOR >= 5
-        belongs_to(name, class_name: "Ahoy::Visit", **safe_options)
+        belongs_to(name, class_name: "Ahoy::Visit", optional: true, **options)
         before_create :set_ahoy_visit
       end
       class_eval %{
         def set_ahoy_visit
-          self.#{name} ||= RequestStore.store[:ahoy].try(:visit_or_create)
+          self.#{name} ||= Thread.current[:ahoy].try(:visit_or_create)
         end
       }
     end

data/lib/ahoy/tracker.rb

@@ -11,6 +11,7 @@ module Ahoy
       @controller = options[:controller]
       @request = options[:request] || @controller.try(:request)
       @visit_token = options[:visit_token]
+      @user = options[:user]
       @options = options
     end
 
@@ -57,7 +58,7 @@ module Ahoy
 
           @store.track_visit(data)
 
-          Ahoy::GeocodeV2Job.perform_later(visit_token, data[:ip]) if Ahoy.geocode
+          Ahoy::GeocodeV2Job.perform_later(visit_token, data[:ip]) if Ahoy.geocode && data[:ip]
         end
       end
       true
@@ -127,9 +128,8 @@ module Ahoy
       @user ||= @store.user
     end
 
-    # TODO better name
     def visit_properties
-      @visit_properties ||= Ahoy::VisitProperties.new(request, api: api?).generate
+      @visit_properties ||= request ? Ahoy::VisitProperties.new(request, api: api?).generate : {}
     end
 
     def visit_token
@@ -169,24 +169,23 @@ module Ahoy
 
     def set_cookie(name, value, duration = nil, use_domain = true)
       # safety net
-      return unless Ahoy.cookies
+      return unless Ahoy.cookies && request
 
-      cookie = {
-        value: value
-      }
+      cookie = Ahoy.cookie_options.merge(value: value)
       cookie[:expires] = duration.from_now if duration
-      domain = Ahoy.cookie_domain
-      cookie[:domain] = domain if domain && use_domain
+      # prefer cookie_options[:domain] over cookie_domain
+      cookie[:domain] ||= Ahoy.cookie_domain if Ahoy.cookie_domain
+      cookie.delete(:domain) unless use_domain
       request.cookie_jar[name] = cookie
     end
 
     def delete_cookie(name)
-      request.cookie_jar.delete(name) if request.cookie_jar[name]
+      request.cookie_jar.delete(name) if request && request.cookie_jar[name]
     end
 
     def trusted_time(time = nil)
       if !time || (api? && !(1.minute.ago..Time.now).cover?(time))
-        Time.zone.now
+        Time.current
       else
         time
       end
@@ -197,8 +196,12 @@ module Ahoy
     end
 
     def report_exception(e)
-      raise e if Rails.env.development? || Rails.env.test?
-      Safely.report_exception(e)
+      if defined?(ActionDispatch::RemoteIp::IpSpoofAttackError) && e.is_a?(ActionDispatch::RemoteIp::IpSpoofAttackError)
+        debug "Tracking excluded due to IP spoofing"
+      else
+        raise e if !defined?(Rails) || Rails.env.development? || Rails.env.test?
+        Safely.report_exception(e)
+      end
     end
 
     def generate_id

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "2.2.1"
+  VERSION = "3.0.4"
 end

data/lib/ahoy/visit_properties.rb

@@ -1,7 +1,6 @@
-require "browser"
+require "cgi"
 require "device_detector"
-require "referer-parser"
-require "user_agent_parser"
+require "uri"
 
 module Ahoy
   class VisitProperties
@@ -21,23 +20,26 @@ module Ahoy
     private
 
     def utm_properties
-      landing_uri = Addressable::URI.parse(landing_page) rescue nil
-      landing_params = (landing_uri && landing_uri.query_values) || {}
+      landing_params = {}
+      begin
+        landing_uri = URI.parse(landing_page)
+        # could also use Rack::Utils.parse_nested_query
+        landing_params = CGI.parse(landing_uri.query) if landing_uri
+      rescue
+        # do nothing
+      end
 
       props = {}
       %w(utm_source utm_medium utm_term utm_content utm_campaign).each do |name|
-        props[name.to_sym] = params[name] || landing_params[name]
+        props[name.to_sym] = params[name] || landing_params[name].try(:first)
       end
       props
     end
 
     def traffic_properties
-      # cache for performance
-      @@referrer_parser ||= RefererParser::Parser.new
-
+      uri = URI.parse(referrer) rescue nil
       {
-        referring_domain: (Addressable::URI.parse(referrer).host.first(255) rescue nil),
-        search_keyword: (@@referrer_parser.parse(@referrer)[:term].first(255) rescue nil).presence
+        referring_domain: uri.try(:host).try(:first, 255)
       }
     end
 
@@ -60,6 +62,9 @@ module Ahoy
           device_type: device_type
         }
       else
+        raise "Add browser to your Gemfile to use legacy user agent parsing" unless defined?(Browser)
+        raise "Add user_agent_parser to your Gemfile to use legacy user agent parsing" unless defined?(UserAgentParser)
+
         # cache for performance
         @@user_agent_parser ||= UserAgentParser::Parser.new
 

data/lib/generators/ahoy/activerecord_generator.rb

@@ -1,34 +1,19 @@
-# 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 Generators
     class ActiverecordGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path("../templates", __FILE__)
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       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_templates
         template "database_store_initializer.rb", "config/initializers/ahoy.rb"
         template "active_record_visit_model.rb", "app/models/ahoy/visit.rb"
         template "active_record_event_model.rb", "app/models/ahoy/event.rb"
         migration_template "active_record_migration.rb", "db/migrate/create_ahoy_visits_and_events.rb", migration_version: migration_version
-        migrate_command = rails5? ? "rails" : "rake"
-        puts "\nAlmost set! Last, run:\n\n    #{migrate_command} db:migrate"
+        puts "\nAlmost set! Last, run:\n\n    rails db:migrate"
       end
 
       def properties_type
@@ -44,14 +29,12 @@ module Ahoy
         end
       end
 
-      def rails5?
-        Rails::VERSION::MAJOR >= 5
+      def rails52?
+        ActiveRecord::VERSION::STRING >= "5.2"
       end
 
       def migration_version
-        if rails5?
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/ahoy/base_generator.rb

@@ -3,7 +3,7 @@ require "rails/generators"
 module Ahoy
   module Generators
     class BaseGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.join(__dir__, "templates")
 
       def copy_templates
         template "base_store_initializer.rb", "config/initializers/ahoy.rb"

data/lib/generators/ahoy/install_generator.rb

@@ -3,7 +3,7 @@ require "rails/generators"
 module Ahoy
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.join(__dir__, "templates")
 
       def copy_templates
         activerecord = defined?(ActiveRecord)

data/lib/generators/ahoy/mongoid_generator.rb

@@ -3,7 +3,7 @@ require "rails/generators"
 module Ahoy
   module Generators
     class MongoidGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.join(__dir__, "templates")
 
       def copy_templates
         template "database_store_initializer.rb", "config/initializers/ahoy.rb"
@@ -11,10 +11,6 @@ module Ahoy
         template "mongoid_event_model.rb", "app/models/ahoy/event.rb"
         puts "\nAlmost set! Last, run:\n\n    rake db:mongoid:create_indexes"
       end
-
-      def rails5?
-        Rails::VERSION::MAJOR >= 5
-      end
     end
   end
 end

data/lib/generators/ahoy/templates/active_record_event_model.rb.tt

@@ -1,10 +1,10 @@
-class Ahoy::Event < <%= rails5? ? "ApplicationRecord" : "ActiveRecord::Base" %>
+class Ahoy::Event < ApplicationRecord
   include Ahoy::QueryMethods
 
   self.table_name = "ahoy_events"
 
   belongs_to :visit
-  belongs_to :user<%= rails5? ? ", optional: true" : nil %><% if properties_type == "text" %>
+  belongs_to :user, optional: true<% if properties_type == "text" %>
 
   serialize :properties, JSON<% end %>
 end

data/lib/generators/ahoy/templates/active_record_migration.rb.tt

@@ -26,8 +26,8 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :country
       t.string :region
       t.string :city
-      t.decimal :latitude, precision: 10, scale: 8
-      t.decimal :longitude, precision: 11, scale: 8
+      t.float :latitude
+      t.float :longitude
 
       # utm parameters
       t.string :utm_source
@@ -55,7 +55,8 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.timestamp :time
     end
 
-    add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" && rails5? %>
-    add_index :ahoy_events, "properties jsonb_path_ops", using: "gin"<% end %>
+    add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" %><% if rails52? %>
+    add_index :ahoy_events, :properties, using: :gin, opclass: :jsonb_path_ops<% else %>
+    add_index :ahoy_events, "properties jsonb_path_ops", using: "gin"<% end %><% end %>
   end
 end

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

@@ -1,6 +1,6 @@
-class Ahoy::Visit < <%= rails5? ? "ApplicationRecord" : "ActiveRecord::Base" %>
+class Ahoy::Visit < ApplicationRecord
   self.table_name = "ahoy_visits"
 
   has_many :events, class_name: "Ahoy::Event"
-  belongs_to :user<%= rails5? ? ", optional: true" : nil %>
+  belongs_to :user, optional: true
 end