ahoy_matey 1.5.5 → 4.2.1

data/lib/ahoy.rb

@@ -1,69 +1,49 @@
+# stdlib
+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"
-require "ahoy/controller"
-require "ahoy/model"
-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/nats_store"
-require "ahoy/stores/nsq_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)
+# modules
+require_relative "ahoy/utils"
+require_relative "ahoy/base_store"
+require_relative "ahoy/controller"
+require_relative "ahoy/database_store"
+require_relative "ahoy/helper"
+require_relative "ahoy/model"
+require_relative "ahoy/query_methods"
+require_relative "ahoy/tracker"
+require_relative "ahoy/version"
+require_relative "ahoy/visit_properties"
 
-# deprecated
-require "ahoy/subscribers/active_record"
+require_relative "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
+
+  # TODO deprecate in favor of cookie_options
   mattr_accessor :cookie_domain
 
-  mattr_accessor :track_visits_immediately
-  self.track_visits_immediately = false
+  mattr_accessor :cookie_options
+  self.cookie_options = {}
+
+  mattr_accessor :server_side_visits
+  self.server_side_visits = true
 
   mattr_accessor :quiet
   self.quiet = true
 
   mattr_accessor :geocode
-  self.geocode = true
+  self.geocode = false
 
   mattr_accessor :max_content_length
   self.max_content_length = 8192
@@ -71,71 +51,81 @@ 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
-    ActionController::API.send :include, Ahoy::Controller if defined?(ActionController::API)
+  mattr_accessor :bot_detection_version
+  self.bot_detection_version = 2
+
+  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
+
+  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
 
-  ActiveSupport.on_load(:active_record) do
-    ActiveRecord::Base.send(:extend, Ahoy::Model)
+  def self.instance
+    Thread.current[:ahoy]
   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.instance=(value)
+    Thread.current[:ahoy] = value
   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
+
+ActiveSupport.on_load(:mongoid) do
+  Mongoid::Document::ClassMethods.include(Ahoy::Model)
+end

data/lib/ahoy_matey.rb

@@ -1 +1 @@
-require "ahoy"
+require_relative "ahoy"

data/lib/generators/ahoy/activerecord_generator.rb

@@ -0,0 +1,67 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Ahoy
+  module Generators
+    class ActiverecordGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      class_option :database, type: :string, aliases: "-d"
+
+      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
+        puts "\nAlmost set! Last, run:\n\n    rails db:migrate"
+      end
+
+      def properties_type
+        case adapter
+        when /postg/i # postgres, postgis
+          "jsonb"
+        when /mysql/i
+          "json"
+        else
+          "text"
+        end
+      end
+
+      # requires database connection to check for MariaDB
+      def serialize_properties?
+        properties_type == "text" || (properties_type == "json" && ActiveRecord::Base.connection.try(:mariadb?))
+      end
+
+      # use connection_config instead of connection.adapter
+      # so database connection isn't needed
+      def adapter
+        if ActiveRecord::VERSION::STRING.to_f >= 6.1
+          ActiveRecord::Base.connection_db_config.adapter.to_s
+        else
+          ActiveRecord::Base.connection_config[:adapter].to_s
+        end
+      end
+
+      def rails52?
+        ActiveRecord::VERSION::STRING.to_f >= 5.2
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def primary_key_type
+        ", id: :#{key_type}" if key_type
+      end
+
+      def foreign_key_type
+        ", type: :#{key_type}" if key_type
+      end
+
+      def key_type
+        Rails.configuration.generators.options.dig(:active_record, :primary_key_type)
+      end
+    end
+  end
+end

data/lib/generators/ahoy/base_generator.rb

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

data/lib/generators/ahoy/install_generator.rb

@@ -0,0 +1,44 @@
+require "rails/generators"
+
+module Ahoy
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        activerecord = defined?(ActiveRecord)
+        mongoid = defined?(Mongoid)
+
+        selection =
+          if activerecord && mongoid
+            puts <<-MSG
+
+Which data store would you like to use?
+ 1. ActiveRecord (default)
+ 2. Mongoid
+ 3. Neither
+            MSG
+
+            ask(">")
+          elsif activerecord
+            "1"
+          elsif mongoid
+            "2"
+          else
+            "3"
+          end
+
+        case selection
+        when "", "1"
+          invoke "ahoy:activerecord"
+        when "2"
+          invoke "ahoy:mongoid"
+        when "3"
+          invoke "ahoy:base"
+        else
+          abort "Error: must enter a number [1-3]"
+        end
+      end
+    end
+  end
+end

data/lib/generators/ahoy/mongoid_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Ahoy
+  module Generators
+    class MongoidGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        template "database_store_initializer.rb", "config/initializers/ahoy.rb"
+        template "mongoid_visit_model.rb", "app/models/ahoy/visit.rb"
+        template "mongoid_event_model.rb", "app/models/ahoy/event.rb"
+        puts "\nAlmost set! Last, run:\n\n    rake db:mongoid:create_indexes"
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,62 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :ahoy_visits<%= primary_key_type %> do |t|
+      t.string :visit_token
+      t.string :visitor_token
+
+      # the rest are recommended but optional
+      # simply remove any you don't want
+
+      # user
+      t.references :user<%= foreign_key_type %>
+
+      # standard
+      t.string :ip
+      t.text :user_agent
+      t.text :referrer
+      t.string :referring_domain
+      t.text :landing_page
+
+      # technology
+      t.string :browser
+      t.string :os
+      t.string :device_type
+
+      # location
+      t.string :country
+      t.string :region
+      t.string :city
+      t.float :latitude
+      t.float :longitude
+
+      # utm parameters
+      t.string :utm_source
+      t.string :utm_medium
+      t.string :utm_term
+      t.string :utm_content
+      t.string :utm_campaign
+
+      # native apps
+      t.string :app_version
+      t.string :os_version
+      t.string :platform
+
+      t.datetime :started_at
+    end
+
+    add_index :ahoy_visits, :visit_token, unique: true
+
+    create_table :ahoy_events<%= primary_key_type %> do |t|
+      t.references :visit<%= foreign_key_type %>
+      t.references :user<%= foreign_key_type %>
+
+      t.string :name
+      t.<%= properties_type %> :properties
+      t.datetime :time
+    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

@@ -0,0 +1,6 @@
+class Ahoy::Visit < ApplicationRecord
+  self.table_name = "ahoy_visits"
+
+  has_many :events, class_name: "Ahoy::Event"
+  belongs_to :user, optional: true
+end

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

@@ -0,0 +1,25 @@
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    # do
+  end
+
+  def track_event(data)
+    # something
+  end
+
+  def geocode(data)
+    # amazing
+  end
+
+  def authenticate(data)
+    # !!!
+  end
+end
+
+# set to true for JavaScript tracking
+Ahoy.api = false
+
+# set to true for geocoding (and add the geocoder gem to your Gemfile)
+# we recommend configuring local geocoding as well
+# see https://github.com/ankane/ahoy#geocoding
+Ahoy.geocode = false

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

@@ -0,0 +1,10 @@
+class Ahoy::Store < Ahoy::DatabaseStore
+end
+
+# set to true for JavaScript tracking
+Ahoy.api = false
+
+# set to true for geocoding (and add the geocoder gem to your Gemfile)
+# we recommend configuring local geocoding as well
+# see https://github.com/ankane/ahoy#geocoding
+Ahoy.geocode = false

data/lib/generators/ahoy/{stores/templates/mongoid_event_model.rb → templates/mongoid_event_model.rb.tt}

@@ -2,11 +2,13 @@ class Ahoy::Event
   include Mongoid::Document
 
   # associations
-  belongs_to :visit
-  belongs_to :user
+  belongs_to :visit, class_name: "Ahoy::Visit", index: true
+  belongs_to :user, index: true, optional: true
 
   # fields
   field :name, type: String
   field :properties, type: Hash
   field :time, type: Time
+
+  index({name: 1, time: 1})
 end

data/lib/generators/ahoy/{stores/templates/mongoid_visit_model.rb → templates/mongoid_visit_model.rb.tt}

@@ -1,11 +1,13 @@
-class Visit
+class Ahoy::Visit
   include Mongoid::Document
 
   # associations
-  belongs_to :user
+  has_many :events, class_name: "Ahoy::Event"
+  belongs_to :user, index: true, optional: true
 
   # required
-  field :visitor_id, type: <%= @visitor_id_type %>
+  field :visit_token, type: String
+  field :visitor_token, type: String
 
   # the rest are recommended but optional
   # simply remove the columns you don't want
@@ -14,23 +16,20 @@ class Visit
   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
+  field :landing_page, type: String
 
   # technology
   field :browser, type: String
   field :os, type: String
   field :device_type, type: String
-  field :screen_height, type: Integer
-  field :screen_width, type: Integer
 
   # location
   field :country, type: String
   field :region, type: String
   field :city, type: String
+  field :latitude, type: Float
+  field :longitude, type: Float
 
   # utm parameters
   field :utm_source, type: String
@@ -39,5 +38,12 @@ class Visit
   field :utm_content, type: String
   field :utm_campaign, type: String
 
+  # native apps
+  field :app_version, type: String
+  field :os_version, type: String
+  field :platform, type: String
+
   field :started_at, type: Time
+
+  index({visit_token: 1}, {unique: true})
 end