ahoy_matey 4.0.0 → 5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb8aecda5242614f518d06dbdc9449305f0ed30677d667e01eb1edefc627bc7
-  data.tar.gz: 8f52fbe0bab0a0ac1c5722b06f342add3d31c0c441230b77f03ae566e07f746b
+  metadata.gz: df3e089d0f7806605ca6cb9215118d0a7791fdd9127f91dd13d0df59add4cb51
+  data.tar.gz: 69e7c817399a7e2488f54cbd4d4e136d383542de0194c5bc638bc191bdeae6d7
 SHA512:
-  metadata.gz: '059927d7fe2344882860ae81ff23e142a09ed955da818da8d3e679b03173b39e64ffc611e4e682a912901678cd9b790b461805f788c423cd2b4331c2a340c226'
-  data.tar.gz: f2d53c35500ee4d30485cfbf6c5d444cbf03c50cec4762783a972411343e19b8baf53b61286cc4aa78bbbe98a69df21da701989422263780447341fdce756db0
+  metadata.gz: cb08e2f80841ef62c2ad48881912c9cb2e81b40b03b7c4dead2ce006a49726571c3b9dee235cc9450bdbc7e72def56dbf201c2bf1d72d395aec849aca6cf323a
+  data.tar.gz: b92e534e57a6d3874e9b623a2bb1d55dc5d7fbfbd4ad16e94cb6d1350112b7623c56e569320baf2718a436db6991d1a1d943ace871d947d502f81b21b58b2fc7

data/CHANGELOG.md

@@ -1,6 +1,78 @@
+## 5.4.1 (2025-09-30)
+
+- Fixed deprecation warning with Rack 3.1+
+
+## 5.4.0 (2025-05-04)
+
+- Dropped support for Ruby < 3.2 and Rails < 7.1
+
+## 5.3.0 (2025-02-01)
+
+- Dropped support for Ruby < 3.1 and Rails < 7
+- Dropped support for Mongoid < 8
+
+## 5.2.1 (2024-10-07)
+
+- Fixed connection leasing for Active Record 7.2+
+
+## 5.2.0 (2024-09-04)
+
+- Improved error handling for invalid API parameters
+
+## 5.1.0 (2024-03-26)
+
+- Added support for Trilogy
+- Updated Ahoy.js to 0.4.4
+
+## 5.0.2 (2023-10-05)
+
+- Excluded visits from Rails health check
+
+## 5.0.1 (2023-10-01)
+
+- Fixed error with geocoding with anonymity sets
+
+## 5.0.0 (2023-10-01)
+
+- Changed visits to expire with anonymity sets
+- Fixed error when Active Job is not available
+- Fixed deprecation warning with Rails 7.1
+- Dropped support for Ruby < 3 and Rails < 6.1
+- Dropped support for Mongoid 6
+
+## 4.2.1 (2023-02-23)
+
+- Updated Ahoy.js to 0.4.2
+
+## 4.2.0 (2023-02-07)
+
+- Added primary key type to generated migration
+- Updated Ahoy.js to 0.4.1
+
+## 4.1.0 (2022-06-12)
+
+- Ensure `exclude_method` is only called once per request
+- Fixed error with Mongoid when `Mongoid.raise_not_found_error` is `true`
+- Fixed association for Mongoid
+
+## 4.0.3 (2022-01-15)
+
+- Support for `importmap-rails` is no longer experimental
+- Fixed asset precompilation error with `importmap-rails`
+
+## 4.0.2 (2021-11-06)
+
+- Added experimental support for `importmap-rails`
+
+## 4.0.1 (2021-08-18)
+
+- Added support for `where_event`, `where_props`, and `where_group` for SQLite
+- Fixed results with `where_event` for MySQL, MariaDB, and Postgres `hstore`
+- Fixed results with `where_props` and `where_group` when used with other scopes for MySQL, MariaDB, and Postgres `hstore`
+
 ## 4.0.0 (2021-08-14)
 
-- Disabled geocoding by default
+- Disabled geocoding by default (this was already the case for new installations with 3.2.0+)
 - Made the `geocoder` gem an optional dependency
 - Updated Ahoy.js to 0.4.0
 - Updated API to return 400 status code when missing required parameters
@@ -303,3 +375,19 @@ Breaking changes
 ## 0.1.0 (2014-03-19)
 
 - First major release
+
+## 0.0.4 (2014-03-01)
+
+- Added UTM parameters
+
+## 0.0.3 (2014-02-26)
+
+- Renamed `ahoy_visit` method to `current_visit`
+
+## 0.0.2 (2014-02-26)
+
+- Added `ahoy_visit` method to controllers
+
+## 0.0.1 (2014-02-26)
+
+- First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2021 Andrew Kane
+Copyright (c) 2014-2025 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,20 +4,18 @@
 
 Track visits and events in Ruby, JavaScript, and native apps. Data is stored in your database by default, and you can customize it for any data store as you grow.
 
-**Ahoy 4.0 was recently released** - see [how to upgrade](#upgrading)
-
 :postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for emails and [Field Test](https://github.com/ankane/field_test) for A/B testing
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://github.com/ankane/ahoy/workflows/build/badge.svg?branch=master)](https://github.com/ankane/ahoy/actions)
+[![Build Status](https://github.com/ankane/ahoy/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/ahoy/actions)
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'ahoy_matey'
+gem "ahoy_matey"
 ```
 
 And run:
@@ -48,19 +46,33 @@ And restart your web server.
 
 ### JavaScript
 
-For Rails 6 / Webpacker, run:
+For Importmap (Rails 7+ default), add to `config/importmap.rb`:
+
+```ruby
+pin "ahoy", to: "ahoy.js"
+```
+
+And add to `app/javascript/application.js`:
+
+```javascript
+import "ahoy"
+```
+
+For Bun, esbuild, rollup.js, or Webpack, run:
 
 ```sh
+bun add ahoy.js
+# or
 yarn add ahoy.js
 ```
 
-And add to `app/javascript/packs/application.js`:
+And add to `app/javascript/application.js`:
 
 ```javascript
-import ahoy from "ahoy.js";
+import ahoy from "ahoy.js"
 ```
 
-For Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
+For Sprockets, add to `app/assets/javascripts/application.js`:
 
 ```javascript
 //= require ahoy
@@ -185,9 +197,9 @@ Order.joins(:ahoy_visit).group("device_type").count
 Here’s what the migration to add the `ahoy_visit_id` column should look like:
 
 ```ruby
-class AddVisitIdToOrders < ActiveRecord::Migration[6.1]
+class AddAhoyVisitToOrders < ActiveRecord::Migration[8.0]
   def change
-    add_column :orders, :ahoy_visit_id, :bigint
+    add_reference :orders, :ahoy_visit
   end
 end
 ```
@@ -200,7 +212,7 @@ visitable :sign_up_visit
 
 ### Users
 
-Ahoy automatically attaches the `current_user` to the visit. With [Devise](https://github.com/plataformatec/devise), it attaches the user even if they sign in after the visit starts.
+Ahoy automatically attaches the `current_user` to the visit. With [Devise](https://github.com/heartcombo/devise), it attaches the user even if they sign in after the visit starts.
 
 With other authentication frameworks, add this to the end of your sign in method:
 
@@ -250,28 +262,6 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-#### Knock
-
-To attach the user with [Knock](https://github.com/nsarno/knock), either include `Knock::Authenticable`in `ApplicationController`:
-
-```ruby
-class ApplicationController < ActionController::API
-  include Knock::Authenticable
-end
-```
-
-Or include it in Ahoy:
-
-```ruby
-Ahoy::BaseController.include Knock::Authenticable
-```
-
-And use:
-
-```ruby
-Ahoy.user_method = ->(controller) { controller.send(:authenticate_entity, "user") }
-```
-
 ### Exclusions
 
 Bots are excluded from tracking by default. To include them, use:
@@ -296,6 +286,14 @@ By default, a new visit is created after 4 hours of inactivity. Change this with
 Ahoy.visit_duration = 30.minutes
 ```
 
+### Visitor Duration
+
+By default, a new `visitor_token` is generated after 2 years. Change this with:
+
+```ruby
+Ahoy.visitor_duration = 30.days
+```
+
 ### Cookies
 
 To track visits across multiple subdomains, use:
@@ -314,15 +312,15 @@ You can also [disable cookies](#anonymity-sets--cookies)
 
 ### Token Generation
 
-Ahoy uses random UUIDs for visit and visitor tokens by default, but you can use your own generator like [Druuid](https://github.com/recurly/druuid).
+Ahoy uses random UUIDs for visit and visitor tokens by default, but you can use your own generator like [ULID](https://github.com/rafaelsales/ulid).
 
 ```ruby
-Ahoy.token_generator = -> { Druuid.gen }
+Ahoy.token_generator = -> { ULID.generate }
 ```
 
 ### Throttling
 
-You can use [Rack::Attack](https://github.com/kickstarter/rack-attack) to throttle requests to the API.
+You can use [Rack::Attack](https://github.com/rack/rack-attack) to throttle requests to the API.
 
 ```ruby
 class Rack::Attack
@@ -349,7 +347,7 @@ Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for geocoding. We
 To enable geocoding, add this line to your application’s Gemfile:
 
 ```ruby
-gem 'geocoder'
+gem "geocoder"
 ```
 
 And update `config/initializers/ahoy.rb`:
@@ -366,13 +364,17 @@ Ahoy.job_queue = :low_priority
 
 ### Local Geocoding
 
-For privacy and performance, we recommend geocoding locally. Add this line to your application’s Gemfile:
+For privacy and performance, we recommend geocoding locally.
+
+For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data).
+
+Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'maxminddb'
+gem "maxminddb"
 ```
 
-For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and create `config/initializers/geocoder.rb` with:
+And create `config/initializers/geocoder.rb` with:
 
 ```ruby
 Geocoder.configure(
@@ -389,6 +391,12 @@ For country-level geocoding, install the `geoip-database` package. It’s preins
 sudo apt-get install geoip-database
 ```
 
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "geoip"
+```
+
 And create `config/initializers/geocoder.rb` with:
 
 ```ruby
@@ -438,7 +446,7 @@ class Ahoy::Store < Ahoy::DatabaseStore
 end
 
 Ahoy.mask_ips = true
-Ahoy.cookies = false
+Ahoy.cookies = :none
 ```
 
 This:
@@ -476,12 +484,14 @@ end
 
 ### Anonymity Sets & Cookies
 
-Ahoy can switch from cookies to [anonymity sets](https://privacypatterns.org/patterns/Anonymity-set). Instead of cookies, visitors with the same IP mask and user agent are grouped together in an anonymity set.
+Ahoy can switch from cookies to [anonymity sets](https://privacypatterns.org/patterns/Anonymity-set). Instead of cookies, visitors with the same IP mask and user agent are grouped together in an anonymity set.
 
 ```ruby
-Ahoy.cookies = false
+Ahoy.cookies = :none
 ```
 
+Note: If Ahoy was installed before v5, [add an index](https://github.com/ankane/ahoy/tree/v5.0.0?tab=readme-ov-file#50) before making this change.
+
 Previously set cookies are automatically deleted. If you use JavaScript tracking, also set:
 
 ```javascript
@@ -625,7 +635,7 @@ end
 
 [Blazer](https://github.com/ankane/blazer) is a great tool for exploring your data.
 
-With ActiveRecord, you can do:
+With Active Record, you can do:
 
 ```ruby
 Ahoy::Visit.group(:search_keyword).count
@@ -661,7 +671,7 @@ Group by properties with:
 Ahoy::Event.group_prop(:product_id, :category).count
 ```
 
-Note: MySQL and MariaDB always return string keys (include `"null"` for `nil`) for `group_prop`.
+Note: MySQL and MariaDB always return string keys (including `"null"` for `nil`) for `group_prop`.
 
 ### Funnels
 
@@ -694,6 +704,24 @@ daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
 Prophet.forecast(daily_visits)
 ```
 
+### Anomaly Detection
+
+To detect anomalies in visits and events, check out [AnomalyDetection.rb](https://github.com/ankane/AnomalyDetection.rb).
+
+```ruby
+daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
+AnomalyDetection.detect(daily_visits, period: 7)
+```
+
+### Breakout Detection
+
+To detect breakouts in visits and events, check out [Breakout](https://github.com/ankane/breakout).
+
+```ruby
+daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
+Breakout.detect(daily_visits)
+```
+
 ### Recommendations
 
 To make recommendations based on events, check out [Disco](https://github.com/ankane/disco#ahoy).
@@ -737,28 +765,12 @@ Send a `POST` request to `/ahoy/events` with `Content-Type: application/json` an
       "properties": {
         "item_id": 123
       },
-      "time": "2018-01-01T00:00:00-07:00"
+      "time": "2025-01-01T00:00:00-07:00"
     }
   ]
 }
 ```
 
-## Upgrading
-
-### 4.0
-
-There are two notable changes to geocoding:
-
-1. Geocoding is now disabled by default (this was already the case for new installations with 3.2.0+). Check out the instructions for [how to enable it](#geocoding).
-
-2. The `geocoder` gem is now an optional dependency. To use geocoding, add it to your Gemfile:
-
-  ```ruby
-  gem 'geocoder'
-  ```
-
-Also, check out the [upgrade notes](https://github.com/ankane/ahoy.js#upgrading) for Ahoy.js.
-
 ## History
 
 View the [changelog](https://github.com/ankane/ahoy/blob/master/CHANGELOG.md)
@@ -781,10 +793,10 @@ bundle install
 bundle exec rake test
 ```
 
-To test query methods, start PostgreSQL, MySQL, and MongoDB and use:
+To test different adapters, use:
 
 ```sh
-createdb ahoy_test
-mysqladmin create ahoy_test
-bundle exec rake test:query_methods
+ADAPTER=postgresql bundle exec rake test
+ADAPTER=mysql2 bundle exec rake test
+ADAPTER=mongoid bundle exec rake test
 ```

data/app/controllers/ahoy/base_controller.rb

@@ -36,7 +36,8 @@ module Ahoy
     def verify_request_size
       if request.content_length > Ahoy.max_content_length
         logger.info "[ahoy] Payload too large"
-        render plain: "Payload too large\n", status: :payload_too_large
+        status = Rack::RELEASE.to_f >= 3.1 ? :content_too_large : :payload_too_large
+        render plain: "Payload too large\n", status: status
       end
     end
   end

data/app/controllers/ahoy/events_controller.rb

@@ -17,12 +17,23 @@ module Ahoy
           begin
             ActiveSupport::JSON.decode(data)
           rescue ActiveSupport::JSON.parse_error
-            # do nothing
+            # TODO change to nil in Ahoy 6
             []
           end
         end
 
-      events.first(Ahoy.max_events_per_request).each do |event|
+      max_events_per_request = Ahoy.max_events_per_request
+
+      # check before creating any events
+      unless events.is_a?(Array) && events.first(max_events_per_request).all? { |v| v.is_a?(Hash) }
+        logger.info "[ahoy] Invalid parameters"
+        # :unprocessable_entity is probably more correct
+        # but keep consistent with missing parameters for now
+        render plain: "Invalid parameters\n", status: :bad_request
+        return
+      end
+
+      events.first(max_events_per_request).each do |event|
         time = Time.zone.parse(event["time"]) rescue nil
 
         # timestamp is deprecated

data/lib/ahoy/base_store.rb

@@ -3,6 +3,7 @@ module Ahoy
     attr_writer :user
 
     def initialize(options)
+      @user = options[:user]
       @options = options
     end
 
@@ -36,7 +37,9 @@ module Ahoy
     end
 
     def exclude?
-      (!Ahoy.track_bots && bot?) || exclude_by_method?
+      (!Ahoy.track_bots && bot?) ||
+        exclude_by_method? ||
+        (defined?(Rails::HealthController) && controller.is_a?(Rails::HealthController))
     end
 
     def generate_id

data/lib/ahoy/controller.rb

@@ -5,9 +5,8 @@ module Ahoy
         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
+      base.around_action :set_ahoy_request_store, unless: -> { Ahoy.api_only }
     end
 
     def ahoy
@@ -19,7 +18,7 @@ module Ahoy
     end
 
     def set_ahoy_cookies
-      if Ahoy.cookies
+      if Ahoy.cookies?
         ahoy.set_visitor_cookie
         ahoy.set_visit_cookie
       else
@@ -31,11 +30,17 @@ module Ahoy
     def track_ahoy_visit
       defer = Ahoy.server_side_visits != true
 
-      if defer && !Ahoy.cookies
+      if defer && !Ahoy.cookies?
         # avoid calling new_visit?, which triggers a database call
+      elsif !Ahoy.cookies? && ahoy.exclude?
+        # avoid calling new_visit?, which triggers a database call
+        # may or may not be a new visit
+        Ahoy.log("Request excluded")
       elsif ahoy.new_visit?
         ahoy.track_visit(defer: defer)
       end
+
+      set_ahoy_cookies
     end
 
     def set_ahoy_request_store

data/lib/ahoy/database_store.rb

@@ -53,7 +53,14 @@ module Ahoy
 
     def visit
       unless defined?(@visit)
-        @visit = visit_model.find_by(visit_token: ahoy.visit_token) if ahoy.visit_token
+        if ahoy.send(:existing_visit_token) || ahoy.instance_variable_get(:@visit_token)
+          # find_by raises error by default with Mongoid when not found
+          @visit = visit_model.where(visit_token: ahoy.visit_token).take if ahoy.visit_token
+        elsif !Ahoy.cookies? && ahoy.visitor_token
+          @visit = visit_model.where(visitor_token: ahoy.visitor_token).where(started_at: Ahoy.visit_duration.ago..).order(started_at: :desc).first
+        else
+          @visit = nil
+        end
       end
       @visit
     end

data/lib/ahoy/engine.rb

@@ -26,5 +26,12 @@ module Ahoy
         alias_method :call, :call_with_quiet_ahoy
       end
     end
+
+    # for importmap
+    initializer "ahoy.importmap" do |app|
+      if app.config.respond_to?(:assets) && defined?(Importmap) && defined?(Sprockets)
+        app.config.assets.precompile << "ahoy.js"
+      end
+    end
   end
 end

data/lib/ahoy/query_methods.rb

@@ -8,47 +8,40 @@ module Ahoy
       end
 
       def where_props(properties)
-        relation = self
-        if respond_to?(:columns_hash)
-          column_type = columns_hash["properties"].type
-          adapter_name = connection.adapter_name.downcase
-        else
-          adapter_name = "mongoid"
-        end
+        return all if properties.empty?
+
+        adapter_name = respond_to?(:connection_db_config) ? connection_db_config.adapter.to_s : "mongoid"
         case adapter_name
         when "mongoid"
-          relation = where(Hash[properties.map { |k, v| ["properties.#{k}", v] }])
-        when /mysql/
-          column = column_type == :json || connection.try(:mariadb?) ? "properties" : "CAST(properties AS JSON)"
-          properties.each do |k, v|
-            if v.nil?
-              v = "null"
-            elsif v == true
-              v = "true"
-            end
-
-            relation = relation.where("JSON_UNQUOTE(JSON_EXTRACT(#{column}, ?)) = ?", "$.#{k}", v.as_json)
-          end
-        when /postgres|postgis/
-          case column_type
-          when :jsonb
-            relation = relation.where("properties @> ?", properties.to_json)
+          where(properties.to_h { |k, v| ["properties.#{k}", v] })
+        when /mysql|trilogy/i
+          where("JSON_CONTAINS(properties, ?, '$') = 1", properties.to_json)
+        when /postg/i
+          case columns_hash["properties"].type
           when :hstore
-            properties.each do |k, v|
-              relation =
-                if v.nil?
-                  relation.where("properties -> ? IS NULL", k.to_s)
-                else
-                  relation.where("properties -> ? = ?", k.to_s, v.to_s)
-                end
+            properties.inject(all) do |relation, (k, v)|
+              if v.nil?
+                relation.where("properties -> ? IS NULL", k.to_s)
+              else
+                relation.where("properties -> ? = ?", k.to_s, v.to_s)
+              end
             end
+          when :jsonb
+            where("properties @> ?", properties.to_json)
           else
-            relation = relation.where("properties::jsonb @> ?", properties.to_json)
+            where("properties::jsonb @> ?", properties.to_json)
+          end
+        when /sqlite/i
+          properties.inject(all) do |relation, (k, v)|
+            if v.nil?
+              relation.where("JSON_EXTRACT(properties, ?) IS NULL", "$.#{k}")
+            else
+              relation.where("JSON_EXTRACT(properties, ?) = ?", "$.#{k}", v.as_json)
+            end
           end
         else
           raise "Adapter not supported: #{adapter_name}"
         end
-        relation
       end
       alias_method :where_properties, :where_props
 
@@ -56,32 +49,32 @@ module Ahoy
         # 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
+        relation = all
+        adapter_name = respond_to?(:connection_db_config) ? connection_db_config.adapter.to_s : "mongoid"
         case adapter_name
         when "mongoid"
           raise "Adapter not supported: #{adapter_name}"
-        when /mysql/
-          column = column_type == :json || connection.try(:mariadb?) ? "properties" : "CAST(properties AS JSON)"
+        when /mysql|trilogy/i
           props.each do |prop|
-            quoted_prop = connection.quote("$.#{prop}")
-            relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(#{column}, #{quoted_prop}))")
+            quoted_prop = connection_pool.with_connection { |c| c.quote("$.#{prop}") }
+            relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(properties, #{quoted_prop}))")
           end
-        when /postgres|postgis/
+        when /postg/i
           # convert to jsonb to fix
           # could not identify an equality operator for type json
           # and for text columns
+          column_type = columns_hash["properties"].type
           cast = [:jsonb, :hstore].include?(column_type) ? "" : "::jsonb"
 
           props.each do |prop|
-            quoted_prop = connection.quote(prop)
+            quoted_prop = connection_pool.with_connection { |c| c.quote(prop) }
             relation = relation.group("properties#{cast} -> #{quoted_prop}")
           end
+        when /sqlite/i
+          props.each do |prop|
+            quoted_prop = connection_pool.with_connection { |c| c.quote("$.#{prop}") }
+            relation = relation.group("JSON_EXTRACT(properties, #{quoted_prop})")
+          end
         else
           raise "Adapter not supported: #{adapter_name}"
         end

data/lib/ahoy/tracker.rb

@@ -49,7 +49,7 @@ module Ahoy
             visit_token: visit_token,
             visitor_token: visitor_token,
             user_id: user.try(:id),
-            started_at: trusted_time(started_at),
+            started_at: trusted_time(started_at)
           }.merge(visit_properties).select { |_, v| v }
 
           @store.track_visit(data)
@@ -99,7 +99,7 @@ module Ahoy
     end
 
     def new_visit?
-      Ahoy.cookies ? !existing_visit_token : visit.nil?
+      Ahoy.cookies? ? !existing_visit_token : visit.nil?
     end
 
     def new_visitor?
@@ -145,6 +145,13 @@ module Ahoy
       delete_cookie("ahoy_track")
     end
 
+    def exclude?
+      unless defined?(@exclude)
+        @exclude = @store.exclude?
+      end
+      @exclude
+    end
+
     protected
 
     def api?
@@ -153,7 +160,7 @@ module Ahoy
 
     # private, but used by API
     def missing_params?
-      if Ahoy.cookies && api? && Ahoy.protect_from_forgery
+      if Ahoy.cookies? && api? && Ahoy.protect_from_forgery
         !(existing_visit_token && existing_visitor_token)
       else
         false
@@ -162,7 +169,7 @@ module Ahoy
 
     def set_cookie(name, value, duration = nil, use_domain = true)
       # safety net
-      return unless Ahoy.cookies && request
+      return unless Ahoy.cookies? && request
 
       cookie = Ahoy.cookie_options.merge(value: value)
       cookie[:expires] = duration.from_now if duration
@@ -184,10 +191,6 @@ module Ahoy
       end
     end
 
-    def exclude?
-      @store.exclude?
-    end
-
     def report_exception(e)
       if defined?(ActionDispatch::RemoteIp::IpSpoofAttackError) && e.is_a?(ActionDispatch::RemoteIp::IpSpoofAttackError)
         debug "Tracking excluded due to IP spoofing"
@@ -204,7 +207,7 @@ module Ahoy
     def visit_token_helper
       @visit_token_helper ||= begin
         token = existing_visit_token
-        token ||= visit_anonymity_set unless Ahoy.cookies
+        token ||= visit&.visit_token unless Ahoy.cookies?
         token ||= generate_id unless Ahoy.api_only
         token
       end
@@ -213,7 +216,7 @@ module Ahoy
     def visitor_token_helper
       @visitor_token_helper ||= begin
         token = existing_visitor_token
-        token ||= visitor_anonymity_set unless Ahoy.cookies
+        token ||= visitor_anonymity_set unless Ahoy.cookies?
         token ||= generate_id unless Ahoy.api_only
         token
       end
@@ -222,7 +225,7 @@ module Ahoy
     def existing_visit_token
       @existing_visit_token ||= begin
         token = visit_header
-        token ||= visit_cookie if Ahoy.cookies && !(api? && Ahoy.protect_from_forgery)
+        token ||= visit_cookie if Ahoy.cookies? && !(api? && Ahoy.protect_from_forgery)
         token ||= visit_param if api?
         token
       end
@@ -231,16 +234,12 @@ module Ahoy
     def existing_visitor_token
       @existing_visitor_token ||= begin
         token = visitor_header
-        token ||= visitor_cookie if Ahoy.cookies && !(api? && Ahoy.protect_from_forgery)
+        token ||= visitor_cookie if Ahoy.cookies? && !(api? && Ahoy.protect_from_forgery)
         token ||= visitor_param if api?
         token
       end
     end
 
-    def visit_anonymity_set
-      @visit_anonymity_set ||= Digest::UUID.uuid_v5(UUID_NAMESPACE, ["visit", Ahoy.mask_ip(request.remote_ip), request.user_agent].join("/"))
-    end
-
     def visitor_anonymity_set
       @visitor_anonymity_set ||= Digest::UUID.uuid_v5(UUID_NAMESPACE, ["visitor", Ahoy.mask_ip(request.remote_ip), request.user_agent].join("/"))
     end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "4.0.0"
+  VERSION = "5.4.1"
 end

data/lib/ahoy.rb

@@ -7,27 +7,59 @@ require "active_support/core_ext"
 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"
-require "ahoy/version"
-require "ahoy/visit_properties"
-
-require "ahoy/engine" if defined?(Rails)
+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"
+
+require_relative "ahoy/engine" if defined?(Rails)
 
 module Ahoy
+  # activejob optional
+  autoload :GeocodeV2Job, "ahoy/geocode_v2_job"
+
   mattr_accessor :visit_duration
   self.visit_duration = 4.hours
 
   mattr_accessor :visitor_duration
   self.visitor_duration = 2.years
 
-  mattr_accessor :cookies
+  def self.cookies=(value)
+    if value == false
+      if defined?(Mongoid::Document) && defined?(Ahoy::Visit) && Ahoy::Visit < Mongoid::Document
+        raise <<~EOS
+          This feature requires a new index in Ahoy 5. Set:
+
+            class Ahoy::Visit
+              index({visitor_token: 1, started_at: 1})
+            end
+
+          Create the index before upgrading, and set:
+
+            Ahoy.cookies = :none
+        EOS
+      else
+        raise <<~EOS
+          This feature requires a new index in Ahoy 5. Create a migration with:
+
+            add_index :ahoy_visits, [:visitor_token, :started_at]
+
+          Run it before upgrading, and set:
+
+            Ahoy.cookies = :none
+        EOS
+      end
+    end
+    @@cookies = value
+  end
+
+  mattr_reader :cookies
   self.cookies = true
 
   # TODO deprecate in favor of cookie_options
@@ -94,6 +126,10 @@ module Ahoy
     logger.info { "[ahoy] #{message}" } if logger
   end
 
+  def self.cookies?
+    cookies && cookies != :none
+  end
+
   def self.mask_ip(ip)
     addr = IPAddr.new(ip)
     if addr.ipv4?
@@ -126,7 +162,6 @@ ActiveSupport.on_load(:action_view) do
   include Ahoy::Helper
 end
 
-# Mongoid
 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

@@ -1,3 +1,4 @@
+require "rails/generators"
 require "rails/generators/active_record"
 
 module Ahoy
@@ -20,7 +21,7 @@ module Ahoy
         case adapter
         when /postg/i # postgres, postgis
           "jsonb"
-        when /mysql/i
+        when /mysql|trilogy/i
           "json"
         else
           "text"
@@ -32,23 +33,27 @@ module Ahoy
         properties_type == "text" || (properties_type == "json" && ActiveRecord::Base.connection.try(:mariadb?))
       end
 
-      # use connection_config instead of connection.adapter
+      # use connection_db_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
+        ActiveRecord::Base.connection_db_config.adapter.to_s
       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/install_generator.rb

@@ -11,12 +11,12 @@ module Ahoy
 
         selection =
           if activerecord && mongoid
-            puts <<-MSG
+            puts <<~MSG
 
-Which data store would you like to use?
- 1. ActiveRecord (default)
- 2. Mongoid
- 3. Neither
+              Which data store would you like to use?
+               1. ActiveRecord (default)
+               2. Mongoid
+               3. Neither
             MSG
 
             ask(">")

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

@@ -6,5 +6,5 @@ class Ahoy::Event < ApplicationRecord
   belongs_to :visit
   belongs_to :user, optional: true<% if serialize_properties? %>
 
-  serialize :properties, JSON<% end %>
+  serialize :properties, coder: JSON<% end %>
 end

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

@@ -1,6 +1,6 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :ahoy_visits do |t|
+    create_table :ahoy_visits<%= primary_key_type %> do |t|
       t.string :visit_token
       t.string :visitor_token
 
@@ -8,7 +8,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       # simply remove any you don't want
 
       # user
-      t.references :user
+      t.references :user<%= foreign_key_type %>
 
       # standard
       t.string :ip
@@ -45,18 +45,18 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     end
 
     add_index :ahoy_visits, :visit_token, unique: true
+    add_index :ahoy_visits, [:visitor_token, :started_at]
 
-    create_table :ahoy_events do |t|
-      t.references :visit
-      t.references :user
+    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 %>
+    add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" %>
+    add_index :ahoy_events, :properties, using: :gin, opclass: :jsonb_path_ops<% end %>
   end
 end

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

@@ -2,7 +2,7 @@ class Ahoy::Event
   include Mongoid::Document
 
   # associations
-  belongs_to :visit, index: true
+  belongs_to :visit, class_name: "Ahoy::Visit", index: true
   belongs_to :user, index: true, optional: true
 
   # fields

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

@@ -46,4 +46,5 @@ class Ahoy::Visit
   field :started_at, type: Time
 
   index({visit_token: 1}, {unique: true})
+  index({visitor_token: 1, started_at: 1})
 end

data/vendor/assets/javascripts/ahoy.js

@@ -1,16 +1,15 @@
 /*!
- * Ahoy.js
+ * Ahoy.js v0.4.4
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.4.0
  * MIT License
  */
 
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
-  (global = global || self, global.ahoy = factory());
-}(this, (function () { 'use strict';
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.ahoy = factory());
+})(this, (function () { 'use strict';
 
   // https://www.quirksmode.org/js/cookies.html
 
@@ -67,7 +66,7 @@
 
   ahoy.configure = function (options) {
     for (var key in options) {
-      if (options.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(options, key)) {
         config[key] = options[key];
       }
     }
@@ -102,7 +101,7 @@
   function serialize(object) {
     var data = new FormData();
     for (var key in object) {
-      if (object.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(object, key)) {
         data.append(key, object[key]);
       }
     }
@@ -170,6 +169,9 @@
     document.addEventListener(eventName, function (e) {
       var matchedElement = matchesSelector(e.target, selector);
       if (matchedElement) {
+        var skip = getClosest(matchedElement, "data-ahoy-skip");
+        if (skip !== null && skip !== "false") { return; }
+
         callback.call(matchedElement, e);
       }
     });
@@ -186,8 +188,13 @@
 
   // https://stackoverflow.com/a/2117523/1177228
   function generateId() {
-    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
-      var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
+    if (window.crypto && window.crypto.randomUUID) {
+      return window.crypto.randomUUID();
+    }
+
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      var r = Math.random() * 16 | 0;
+      var v = c === 'x' ? r : (r & 0x3 | 0x8);
       return v.toString(16);
     });
   }
@@ -237,11 +244,11 @@
         xhr.withCredentials = config.withCredentials;
         xhr.setRequestHeader("Content-Type", "application/json");
         for (var header in config.headers) {
-          if (config.headers.hasOwnProperty(header)) {
+          if (Object.prototype.hasOwnProperty.call(config.headers, header)) {
             xhr.setRequestHeader(header, config.headers[header]);
           }
         }
-        xhr.onload = function() {
+        xhr.onload = function () {
           if (xhr.status === 200) {
             success();
           }
@@ -266,11 +273,11 @@
   }
 
   function trackEvent(event) {
-    ahoy.ready( function () {
-      sendRequest(eventsUrl(), eventData(event), function() {
+    ahoy.ready(function () {
+      sendRequest(eventsUrl(), eventData(event), function () {
         // remove from queue
         for (var i = 0; i < eventQueue.length; i++) {
-          if (eventQueue[i].id == event.id) {
+          if (eventQueue[i].id === event.id) {
             eventQueue.splice(i, 1);
             break;
           }
@@ -281,7 +288,7 @@
   }
 
   function trackEventNow(event) {
-    ahoy.ready( function () {
+    ahoy.ready(function () {
       var data = eventData(event);
       var param = csrfParam();
       var token = csrfToken();
@@ -303,7 +310,7 @@
 
   function cleanObject(obj) {
     for (var key in obj) {
-      if (obj.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
         if (obj[key] === null) {
           delete obj[key];
         }
@@ -318,14 +325,14 @@
       id: presence(this.id),
       "class": presence(this.className),
       page: page(),
-      section: getClosestSection(this)
+      section: getClosest(this, "data-section")
     });
   }
 
-  function getClosestSection(element) {
-    for ( ; element && element !== document; element = element.parentNode) {
-      if (element.hasAttribute('data-section')) {
-        return element.getAttribute('data-section');
+  function getClosest(element, attribute) {
+    for (; element && element !== document; element = element.parentNode) {
+      if (element.hasAttribute(attribute)) {
+        return element.getAttribute(attribute);
       }
     }
 
@@ -377,7 +384,7 @@
         }
 
         for (var key in config.visitParams) {
-          if (config.visitParams.hasOwnProperty(key)) {
+          if (Object.prototype.hasOwnProperty.call(config.visitParams, key)) {
             data[key] = config.visitParams[key];
           }
         }
@@ -431,12 +438,12 @@
       js: true
     };
 
-    ahoy.ready( function () {
+    ahoy.ready(function () {
       if (config.cookies && !ahoy.getVisitId()) {
         createVisit();
       }
 
-      ahoy.ready( function () {
+      ahoy.ready(function () {
         log(event);
 
         event.visit_token = ahoy.getVisitId();
@@ -449,7 +456,7 @@
           saveEventQueue();
 
           // wait in case navigating to reduce duplicate events
-          setTimeout( function () {
+          setTimeout(function () {
             trackEvent(event);
           }, 1000);
         }
@@ -467,8 +474,8 @@
     };
 
     if (additionalProperties) {
-      for(var propName in additionalProperties) {
-        if (additionalProperties.hasOwnProperty(propName)) {
+      for (var propName in additionalProperties) {
+        if (Object.prototype.hasOwnProperty.call(additionalProperties, propName)) {
           properties[propName] = additionalProperties[propName];
         }
       }
@@ -482,7 +489,7 @@
     }
     onEvent("click", selector, function (e) {
       var properties = eventProperties.call(this, e);
-      properties.text = properties.tag == "input" ? this.value : (this.textContent || this.innerText || this.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
+      properties.text = properties.tag === "input" ? this.value : (this.textContent || this.innerText || this.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
       properties.href = this.href;
       ahoy.track("$click", properties);
     });
@@ -526,7 +533,7 @@
     ahoy.start = function () {};
   };
 
-  documentReady(function() {
+  documentReady(function () {
     if (config.startOnReady) {
       ahoy.start();
     }
@@ -534,4 +541,4 @@
 
   return ahoy;
 
-})));
+}));

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.4.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,43 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: safely_block
+  name: device_detector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: device_detector
+  name: safely_block
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description:
+        version: '0.4'
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -65,14 +63,13 @@ files:
 - app/controllers/ahoy/base_controller.rb
 - app/controllers/ahoy/events_controller.rb
 - app/controllers/ahoy/visits_controller.rb
-- app/jobs/ahoy/geocode_job.rb
-- app/jobs/ahoy/geocode_v2_job.rb
 - config/routes.rb
 - lib/ahoy.rb
 - lib/ahoy/base_store.rb
 - lib/ahoy/controller.rb
 - lib/ahoy/database_store.rb
 - lib/ahoy/engine.rb
+- lib/ahoy/geocode_v2_job.rb
 - lib/ahoy/helper.rb
 - lib/ahoy/model.rb
 - lib/ahoy/query_methods.rb
@@ -98,7 +95,6 @@ homepage: https://github.com/ankane/ahoy
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple, powerful, first-party analytics for Rails
 test_files: []

data/app/jobs/ahoy/geocode_job.rb

@@ -1,10 +0,0 @@
-# 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