ahoy_matey 2.0.0 → 3.2.0

data/app/controllers/ahoy/base_controller.rb

@@ -1,15 +1,12 @@
 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)
-      before_action :verify_request_size
-    else
-      skip_action_callback *filters
-      before_action :verify_request_size
-    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
 
     if respond_to?(:protect_from_forgery)
       protect_from_forgery with: :null_session, if: -> { Ahoy.protect_from_forgery }
@@ -21,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,7 +3,7 @@ module Ahoy
     def create
       events =
         if params[:name]
-          # legacy API
+          # legacy API and AMP
           [request.params]
         elsif params[:events]
           request.params[:events]

data/app/controllers/ahoy/visits_controller.rb

@@ -2,6 +2,7 @@ module Ahoy
   class VisitsController < BaseController
     def create
       ahoy.track_visit
+
       render json: {
         visit_token: ahoy.visit_token,
         visitor_token: ahoy.visitor_token,

data/app/jobs/ahoy/geocode_v2_job.rb

@@ -7,14 +7,13 @@ module Ahoy
         begin
           Geocoder.search(ip).first
         rescue => e
-          $stderr.puts e.message
+          Ahoy.log "Geocode error: #{e.class.name}: #{e.message}"
           nil
         end
 
-      if location
+      if location && location.country.present?
         data = {
-          visit_token: visit_token,
-          country: location.try(:country).presence,
+          country: location.country,
           region: location.try(:state).presence,
           city: location.try(:city).presence,
           postal_code: location.try(:postal_code).presence,

data/lib/ahoy.rb

@@ -1,12 +1,18 @@
+# stdlib
+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"
 require "ahoy/database_store"
+require "ahoy/helper"
 require "ahoy/model"
 require "ahoy/query_methods"
 require "ahoy/tracker"
@@ -22,8 +28,15 @@ module Ahoy
   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 :cookie_options
+  self.cookie_options = {}
+
   mattr_accessor :server_side_visits
   self.server_side_visits = true
 
@@ -56,7 +69,7 @@ module Ahoy
 
   mattr_accessor :user_method
   self.user_method = lambda do |controller|
-    (controller.respond_to?(:current_user) && controller.current_user) || (controller.respond_to?(:current_resource_owner, true) && controller.send(:current_resource_owner)) || nil
+    (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 :exclude_method
@@ -64,8 +77,42 @@ module Ahoy
   mattr_accessor :track_bots
   self.track_bots = false
 
+  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
+
+  def self.instance
+    Thread.current[:ahoy]
+  end
+
+  def self.instance=(value)
+    Thread.current[:ahoy] = value
+  end
 end
 
 ActiveSupport.on_load(:action_controller) do
@@ -76,7 +123,15 @@ ActiveSupport.on_load(:active_record) do
   extend Ahoy::Model
 end
 
+ActiveSupport.on_load(:action_view) do
+  include Ahoy::Helper
+end
+
 # Mongoid
+# TODO use
+# ActiveSupport.on_load(:mongoid) do
+#   Mongoid::Document::ClassMethods.include(Ahoy::Model)
+# end
 if defined?(ActiveModel)
   ActiveModel::Callbacks.include(Ahoy::Model)
 end

data/lib/ahoy/base_store.rb

@@ -24,9 +24,13 @@ module Ahoy
     def user
       @user ||= begin
         if Ahoy.user_method.respond_to?(:call)
-          Ahoy.user_method.call(controller)
+          if Ahoy.user_method.arity == 1
+            Ahoy.user_method.call(controller)
+          else
+            Ahoy.user_method.call(controller, request)
+          end
         else
-          controller.send(Ahoy.user_method)
+          controller.send(Ahoy.user_method) if controller.respond_to?(Ahoy.user_method, true)
         end
       end
     end
@@ -39,10 +43,35 @@ module Ahoy
       Ahoy.token_generator.call
     end
 
+    def visit_or_create
+      visit
+    end
+
     protected
 
     def bot?
-      @bot ||= request ? Browser.new(request.user_agent).bot? : false
+      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?

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
@@ -21,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.server_side_visits)
+      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 = Ahoy.instance
+      begin
+        Ahoy.instance = ahoy
+        yield
+      ensure
+        Ahoy.instance = previous_value
+      end
     end
   end
 end

data/lib/ahoy/database_store.rb

@@ -4,31 +4,39 @@ module Ahoy
       @visit = visit_model.create!(slice_data(visit_model, data))
     rescue => e
       raise e unless unique_exception?(e)
-      @visit = nil
+
+      # so next call to visit will try to fetch from DB
+      if defined?(@visit)
+        remove_instance_variable(:@visit)
+      end
     end
 
     def track_event(data)
-      # if we don't have a visit, let's try to create one first
-      ahoy.track_visit unless visit
-
-      event = event_model.new(slice_data(event_model, data))
-      event.visit = visit
-      begin
-        event.save!
-      rescue => e
-        raise e unless unique_exception?(e)
+      visit = visit_or_create(started_at: data[:time])
+      if visit
+        event = event_model.new(slice_data(event_model, data))
+        event.visit = visit
+        event.time = visit.started_at if event.time < visit.started_at
+        begin
+          event.save!
+        rescue => e
+          raise e unless unique_exception?(e)
+        end
+      else
+        Ahoy.log "Event excluded since visit not created: #{data[:visit_token]}"
       end
     end
 
     def geocode(data)
-      data = slice_data(visit_model, data.except(:visit_token))
+      visit_token = data.delete(:visit_token)
+      data = slice_data(visit_model, data)
       if defined?(Mongoid::Document) && visit_model < Mongoid::Document
         # upsert since visit might not be found due to eventual consistency
-        visit_model.where(visit_token: ahoy.visit_token).find_one_and_update({"$set": data}, {upsert: true})
+        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
-        $stderr.puts "[ahoy] Visit for geocode not found: #{data[:visit_token]}"
+        Ahoy.log "Visit for geocode not found: #{visit_token}"
       end
     end
 
@@ -44,7 +52,16 @@ module Ahoy
     end
 
     def visit
-      @visit ||= visit_model.where(visit_token: ahoy.visit_token).first if ahoy.visit_token
+      unless defined?(@visit)
+        @visit = visit_model.where(visit_token: ahoy.visit_token).first if ahoy.visit_token
+      end
+      @visit
+    end
+
+    # if we don't have a visit, let's try to create one first
+    def visit_or_create(started_at: nil)
+      ahoy.track_visit(started_at: started_at) if !visit && Ahoy.server_side_visits
+      visit
     end
 
     protected
@@ -59,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 |app|
+    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/helper.rb

@@ -0,0 +1,40 @@
+module Ahoy
+  module Helper
+    def amp_event(name, properties = {})
+      url = Ahoy::Engine.routes.url_helpers.events_url(
+        url_options.slice(:host, :port, :protocol).merge(
+          name: name,
+          properties: properties,
+          screen_width: "SCREEN_WIDTH",
+          screen_height: "SCREEN_HEIGHT",
+          platform: "Web",
+          landing_page: "AMPDOC_URL",
+          referrer: "DOCUMENT_REFERRER",
+          random: "RANDOM"
+        )
+      )
+      url = "#{url}&visit_token=${clientId(ahoy_visit)}&visitor_token=${clientId(ahoy_visitor)}"
+
+      content_tag "amp-analytics" do
+        content_tag "script", type: "application/json" do
+          json_escape({
+            requests: {
+              pageview: url
+            },
+            triggers: {
+              trackPageview: {
+                on: "visible",
+                request: "pageview"
+              }
+            },
+            transport: {
+              beacon: true,
+              xhrpost: true,
+              image: false
+            }
+          }.to_json).html_safe
+        end
+      end
+    end
+  end
+end

data/lib/ahoy/model.rb

@@ -2,12 +2,12 @@ module Ahoy
   module Model
     def visitable(name = :visit, **options)
       class_eval do
-        belongs_to(name, optional: true, class_name: "Ahoy::Visit", **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)
+          self.#{name} ||= Ahoy.instance.try(:visit_or_create)
         end
       }
     end

data/lib/ahoy/query_methods.rb

@@ -27,10 +27,11 @@ module Ahoy
                 v = "true"
               end
 
-              relation = relation.where("JSON_UNQUOTE(properties -> ?) = ?", "$.#{k.to_s}", v.as_json)
+              relation = relation.where("JSON_UNQUOTE(properties -> ?) = ?", "$.#{k}", v.as_json)
             end
           else
             properties.each do |k, v|
+              # TODO cast to json instead
               relation = relation.where("properties REGEXP ?", "[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "").gsub("+", "\\\\+")}[,}]")
             end
           end
@@ -57,6 +58,7 @@ module Ahoy
             end
           else
             properties.each do |k, v|
+              # TODO cast to jsonb instead
               relation = relation.where("properties SIMILAR TO ?", "%[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "").gsub("+", "\\\\+")}[,}]%")
             end
           end
@@ -66,6 +68,49 @@ module Ahoy
         relation
       end
       alias_method :where_properties, :where_props
+
+      def group_prop(*props)
+        # like with group
+        props.flatten!
+
+        relation = self
+        if respond_to?(:columns_hash)
+          column_type = columns_hash["properties"].type
+          adapter_name = connection.adapter_name.downcase
+        else
+          adapter_name = "mongoid"
+        end
+        case adapter_name
+        when "mongoid"
+          raise "Adapter not supported: #{adapter_name}"
+        when /mysql/
+          if connection.try(:mariadb?)
+            props.each do |prop|
+              quoted_prop = connection.quote("$.#{prop}")
+              relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(properties, #{quoted_prop}))")
+            end
+          else
+            column = column_type == :json ? "properties" : "CAST(properties AS JSON)"
+            props.each do |prop|
+              quoted_prop = connection.quote("$.#{prop}")
+              relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(#{column}, #{quoted_prop}))")
+            end
+          end
+        when /postgres|postgis/
+          # convert to jsonb to fix
+          # could not identify an equality operator for type json
+          # and for text columns
+          cast = [:jsonb, :hstore].include?(column_type) ? "" : "::jsonb"
+
+          props.each do |prop|
+            quoted_prop = connection.quote(prop)
+            relation = relation.group("properties#{cast} -> #{quoted_prop}")
+          end
+        else
+          raise "Adapter not supported: #{adapter_name}"
+        end
+        relation
+      end
     end
   end
 end