ahoy_matey 5.1.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8f4afce5d34400d46473e74e607c7758ef18e93d719d476b83c54bca455bd76
-  data.tar.gz: a64234a08867ad06f2084d4191c920f1ef12c0e290161e906303e8bcb744ead1
+  metadata.gz: 44d4e5d43d7fad25db6c27bc9bdfcefa0a4226be502b312a53aa6ad845f17d4d
+  data.tar.gz: 51798d1dd69a5f42f64dc18d3195d8ad80fe85568c78d839c470d708bfc6b18a
 SHA512:
-  metadata.gz: 2ef86e6a698447417887b1dbbd5491ca4e073811cba9bcff2cfd1b42d42291ae39c96652d8dce8c006945264932d611ed80321c1ab8f3c02ed4e9f8f98e6bd64
-  data.tar.gz: 1427722ca7b83c98e7db34eaf56fc86a46fd10c5d14659bb93e1e465cb7f24345cf15fc7125916d13512fa6e269c378cd5ca06e9c7b927ea62df967ee54762c3
+  metadata.gz: 78fceba09807aa17acf80c2c6d61d10b4eb9f8318780650f07714d0307864c417003084de42a6f856065e46cf977743aab0e5008f308924c741e4ecc786db3c7
+  data.tar.gz: e0603191b7a45e2835617b7b32c6d59aaa00f04dd641683a5fd0b8a4b841422819d51b124b93f9f0b6301dbbdc80a3dabdf1928fc21c0119930002a07c07d7cf

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## 5.5.0 (2026-04-08)
+
+- Fixed error with `Ahoy::Tracker` outside of requests
+- Dropped support for Ruby < 3.3 and Rails < 7.2
+
+## 5.4.2 (2026-03-31)
+
+- Fixed cookie deletion with `cookie_domain` and `cookie_options` options
+- Updated Ahoy.js to 0.4.5
+
+## 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
@@ -354,3 +385,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-2024 Andrew Kane
+Copyright (c) 2014-2026 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,8 +4,6 @@
 
 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 5.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)
@@ -48,7 +46,7 @@ And restart your web server.
 
 ### JavaScript
 
-For Importmap (Rails 7 default), add to `config/importmap.rb`:
+For Importmap (Rails default), add to `config/importmap.rb`:
 
 ```ruby
 pin "ahoy", to: "ahoy.js"
@@ -60,13 +58,15 @@ And add to `app/javascript/application.js`:
 import "ahoy"
 ```
 
-For Webpacker (Rails 6 default), run:
+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"
@@ -197,7 +197,7 @@ 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 AddAhoyVisitToOrders < ActiveRecord::Migration[7.1]
+class AddAhoyVisitToOrders < ActiveRecord::Migration[8.1]
   def change
     add_reference :orders, :ahoy_visit
   end
@@ -490,7 +490,7 @@ Ahoy can switch from cookies to [anonymity sets](https://privacypatterns.org/pat
 Ahoy.cookies = :none
 ```
 
-Note: If Ahoy was installed before v5, [add an index](#50) before making this change.
+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:
 
@@ -765,38 +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
-
-### 5.0
-
-Visits now expire with anonymity sets. If using `Ahoy.cookies = false`, a new index is needed.
-
-For Active Record, create a migration with:
-
-```ruby
-add_index :ahoy_visits, [:visitor_token, :started_at]
-```
-
-For Mongoid, set:
-
-```ruby
-class Ahoy::Visit
-  index({visitor_token: 1, started_at: 1})
-end
-```
-
-Create the index before upgrading, and set:
-
-```ruby
-Ahoy.cookies = :none
-```
-
 ## History
 
 View the [changelog](https://github.com/ankane/ahoy/blob/master/CHANGELOG.md)

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/engine.rb

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

data/lib/ahoy/query_methods.rb

@@ -10,13 +10,13 @@ module Ahoy
       def where_props(properties)
         return all if properties.empty?
 
-        adapter_name = respond_to?(:connection) ? connection.adapter_name.downcase : "mongoid"
+        adapter_name = respond_to?(:connection_db_config) ? connection_db_config.adapter.to_s : "mongoid"
         case adapter_name
         when "mongoid"
           where(properties.to_h { |k, v| ["properties.#{k}", v] })
-        when /mysql|trilogy/
+        when /mysql|trilogy/i
           where("JSON_CONTAINS(properties, ?, '$') = 1", properties.to_json)
-        when /postgres|postgis/
+        when /postg/i
           case columns_hash["properties"].type
           when :hstore
             properties.inject(all) do |relation, (k, v)|
@@ -31,7 +31,7 @@ module Ahoy
           else
             where("properties::jsonb @> ?", properties.to_json)
           end
-        when /sqlite/
+        when /sqlite/i
           properties.inject(all) do |relation, (k, v)|
             if v.nil?
               relation.where("JSON_EXTRACT(properties, ?) IS NULL", "$.#{k}")
@@ -50,16 +50,16 @@ module Ahoy
         props.flatten!
 
         relation = all
-        adapter_name = respond_to?(:connection) ? connection.adapter_name.downcase : "mongoid"
+        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|trilogy/
+        when /mysql|trilogy/i
           props.each do |prop|
-            quoted_prop = connection.quote("$.#{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
@@ -67,12 +67,12 @@ module Ahoy
           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/
+        when /sqlite/i
           props.each do |prop|
-            quoted_prop = connection.quote("$.#{prop}")
+            quoted_prop = connection_pool.with_connection { |c| c.quote("$.#{prop}") }
             relation = relation.group("JSON_EXTRACT(properties, #{quoted_prop})")
           end
         else

data/lib/ahoy/tracker.rb

@@ -43,13 +43,13 @@ module Ahoy
         if defer
           set_cookie("ahoy_track", true, nil, false)
         else
-          delete_cookie("ahoy_track")
+          delete_cookie("ahoy_track", false)
 
           data = {
             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)
@@ -142,7 +142,7 @@ module Ahoy
     def reset_visit
       delete_cookie("ahoy_visit")
       delete_cookie("ahoy_events")
-      delete_cookie("ahoy_track")
+      delete_cookie("ahoy_track", false)
     end
 
     def exclude?
@@ -179,8 +179,15 @@ module Ahoy
       request.cookie_jar[name] = cookie
     end
 
-    def delete_cookie(name)
-      request.cookie_jar.delete(name) if request && request.cookie_jar[name]
+    def delete_cookie(name, use_domain = true)
+      if request && request.cookie_jar[name]
+        options = Ahoy.cookie_options.slice(:path)
+        if use_domain
+          domain = Ahoy.cookie_options[:domain] || Ahoy.cookie_domain
+          options[:domain] = domain if domain
+        end
+        request.cookie_jar.delete(name, **options)
+      end
     end
 
     def trusted_time(time = nil)
@@ -241,7 +248,7 @@ module Ahoy
     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("/"))
+      @visitor_anonymity_set ||= request && Digest::UUID.uuid_v5(UUID_NAMESPACE, ["visitor", Ahoy.mask_ip(request.remote_ip), request.user_agent].join("/"))
     end
 
     def visit_cookie

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "5.1.0"
+  VERSION = "5.5.0"
 end

data/lib/generators/ahoy/activerecord_generator.rb

@@ -33,10 +33,6 @@ module Ahoy
         properties_type == "text" || (properties_type == "json" && ActiveRecord::Base.connection.try(:mariadb?))
       end
 
-      def serialize_options
-        ActiveRecord::VERSION::STRING.to_f >= 7.1 ? "coder: JSON" : "JSON"
-      end
-
       # use connection_db_config instead of connection.adapter
       # so database connection isn't needed
       def adapter

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, <%= serialize_options %><% end %>
+  serialize :properties, coder: JSON<% end %>
 end

data/vendor/assets/javascripts/ahoy.js

@@ -1,5 +1,5 @@
 /*!
- * Ahoy.js v0.4.4
+ * Ahoy.js v0.4.5
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
  * MIT License
@@ -119,7 +119,7 @@
   }
 
   function destroyCookie(name) {
-    Cookies.set(name, "", -1);
+    Cookies.set(name, "", -1, config.cookieDomain || config.domain);
   }
 
   function log(message) {

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: device_detector
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
-description:
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -97,7 +109,6 @@ homepage: https://github.com/ankane/ahoy
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,15 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Simple, powerful, first-party analytics for Rails
 test_files: []