ahoy_matey 1.5.3 → 3.0.1

data/lib/ahoy/utils.rb

@@ -0,0 +1,7 @@
+module Ahoy
+  module Utils
+    def self.ensure_utf8(str)
+      str.encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "") if str
+    end
+  end
+end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.5.3"
+  VERSION = "3.0.1"
 end

data/lib/ahoy/visit_properties.rb

@@ -1,60 +1,122 @@
+require "cgi"
+require "device_detector"
+require "uri"
+
 module Ahoy
   class VisitProperties
-    REQUEST_KEYS = [:ip, :user_agent, :referrer, :landing_page, :platform, :app_version, :os_version, :screen_height, :screen_width]
-    TRAFFIC_SOURCE_KEYS = [:referring_domain, :search_keyword]
-    UTM_PARAMETER_KEYS = [:utm_source, :utm_medium, :utm_term, :utm_content, :utm_campaign]
-    TECHNOLOGY_KEYS = [:browser, :os, :device_type]
-    LOCATION_KEYS = [:country, :region, :city, :postal_code, :latitude, :longitude]
-
-    KEYS = REQUEST_KEYS + TRAFFIC_SOURCE_KEYS + UTM_PARAMETER_KEYS + TECHNOLOGY_KEYS + LOCATION_KEYS
+    attr_reader :request, :params, :referrer, :landing_page
 
-    delegate(*REQUEST_KEYS, to: :request_deckhand)
-    delegate(*TRAFFIC_SOURCE_KEYS, to: :traffic_source_deckhand)
-    delegate(*(UTM_PARAMETER_KEYS + [:landing_params]), to: :utm_parameter_deckhand)
-    delegate(*TECHNOLOGY_KEYS, to: :technology_deckhand)
-    delegate(*LOCATION_KEYS, to: :location_deckhand)
-
-    def initialize(request, options = {})
+    def initialize(request, api:)
       @request = request
-      @options = options
+      @params = request.params
+      @referrer = api ? params["referrer"] : request.referer
+      @landing_page = api ? params["landing_page"] : request.original_url
     end
 
-    def [](key)
-      send(key)
+    def generate
+      @generate ||= request_properties.merge(tech_properties).merge(traffic_properties).merge(utm_properties)
     end
 
-    def keys
-      if Ahoy.geocode == true # no location keys for :async
-        KEYS
-      else
-        KEYS - LOCATION_KEYS
+    private
+
+    def utm_properties
+      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].try(:first)
       end
+      props
     end
 
-    def to_hash
-      keys.inject({}) { |memo, key| memo[key] = send(key); memo }
+    def traffic_properties
+      uri = URI.parse(referrer) rescue nil
+      {
+        referring_domain: uri.try(:host).try(:first, 255)
+      }
     end
 
-    protected
+    def tech_properties
+      if Ahoy.user_agent_parser == :device_detector
+        client = DeviceDetector.new(request.user_agent)
+        device_type =
+          case client.device_type
+          when "smartphone"
+            "Mobile"
+          when "tv"
+            "TV"
+          else
+            client.device_type.try(:titleize)
+          end
 
-    def request_deckhand
-      @request_deckhand ||= Deckhands::RequestDeckhand.new(@request, @options)
-    end
+        {
+          browser: client.name,
+          os: client.os_name,
+          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)
 
-    def traffic_source_deckhand
-      @traffic_source_deckhand ||= Deckhands::TrafficSourceDeckhand.new(request_deckhand.referrer)
-    end
+        # cache for performance
+        @@user_agent_parser ||= UserAgentParser::Parser.new
+
+        user_agent = request.user_agent
+        agent = @@user_agent_parser.parse(user_agent)
+        browser = Browser.new(user_agent)
+        device_type =
+          if browser.bot?
+            "Bot"
+          elsif browser.device.tv?
+            "TV"
+          elsif browser.device.console?
+            "Console"
+          elsif browser.device.tablet?
+            "Tablet"
+          elsif browser.device.mobile?
+            "Mobile"
+          else
+            "Desktop"
+          end
 
-    def utm_parameter_deckhand
-      @utm_parameter_deckhand ||= Deckhands::UtmParameterDeckhand.new(request_deckhand.landing_page, request_deckhand.params)
+        {
+          browser: agent.name,
+          os: agent.os.name,
+          device_type: device_type
+        }
+      end
     end
 
-    def technology_deckhand
-      @technology_deckhand ||= Deckhands::TechnologyDeckhand.new(request_deckhand.user_agent)
+    # masking based on Google Analytics anonymization
+    # https://support.google.com/analytics/answer/2763052
+    def ip
+      ip = request.remote_ip
+      if ip && Ahoy.mask_ips
+        Ahoy.mask_ip(ip)
+      else
+        ip
+      end
     end
 
-    def location_deckhand
-      @location_deckhand ||= Deckhands::LocationDeckhand.new(request_deckhand.ip)
+    def request_properties
+      {
+        ip: ip,
+        user_agent: Ahoy::Utils.ensure_utf8(request.user_agent),
+        referrer: referrer,
+        landing_page: landing_page,
+        platform: params["platform"],
+        app_version: params["app_version"],
+        os_version: params["os_version"],
+        screen_height: params["screen_height"],
+        screen_width: params["screen_width"]
+      }
     end
   end
 end

data/lib/generators/ahoy/activerecord_generator.rb

@@ -0,0 +1,41 @@
+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
+        # use connection_config instead of connection.adapter
+        # so database connection isn't needed
+        case ActiveRecord::Base.connection_config[:adapter].to_s
+        when /postg/i # postgres, postgis
+          "jsonb"
+        when /mysql/i
+          "json"
+        else
+          "text"
+        end
+      end
+
+      def rails52?
+        ActiveRecord::VERSION::STRING >= "5.2"
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      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 properties_type == "text" %>
+
+  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 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
+
+      # 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.timestamp :started_at
+    end
+
+    add_index :ahoy_visits, [:visit_token], unique: true
+
+    create_table :ahoy_events do |t|
+      t.references :visit
+      t.references :user
+
+      t.string :name
+      t.<%= properties_type %> :properties
+      t.timestamp :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,20 @@
+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

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

@@ -0,0 +1,5 @@
+class Ahoy::Store < Ahoy::DatabaseStore
+end
+
+# set to true for JavaScript tracking
+Ahoy.api = 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, 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