ahoy_email 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7ace81db2d79de0385596b9cc076ce32f7ead8b0ac96f18be9d4df728814332
-  data.tar.gz: 2cf40755b20d6acf97e1d5d88d1b58da2d0de85647bd34f02c734ae2366275fa
+  metadata.gz: bd188dfb55eeecb5ff5b601ab679f04df570515a2176af9184192ea0cd8688bc
+  data.tar.gz: 176f9e44b50fc890e29d522e80bc68143739fcd5c14235977ec8c1f258d84043
 SHA512:
-  metadata.gz: 7f7051e5893e5a489cacb2f3b76f238fb448d1065ba3fe12c02b36b89515bd591b42243ccb03e9a056b7d64f2c1a8da558d2c25135dab2db5a202261ac81f24b
-  data.tar.gz: ec4ece8d9c5becd279980fc72c3fe046a20a8305b41eb7df8fc9fc0cc61e8ff29dc3f0020dc929332a9551bcb13a3d569c95f2a7f277ae5f695224a656b972bf
+  metadata.gz: 6b375f8a1fbb1d78e6bf87b7092c40484ea889f3d71a7f9d2d7916e365161edb229e947aea7f2db517a430775cfc7b29881223efd00391232bb3cea7a859f4e3
+  data.tar.gz: c9fb82f641e3905f7039b81c6465df26a01d9ddc529a25e600d966eb58b4ed96017e8ff6ae0e2d135a4f7545eb9a9a6eea297f8e6c56edb1e4a632b1926325fb

data/CHANGELOG.md

@@ -1,6 +1,13 @@
+## 4.0.0 (2026-08-08)
+
+See the [upgrade notes](https://github.com/ankane/ahoy_email?tab=readme-ov-file#40)
+
+- Fixed change to key generator hash digest class
+- Removed support for Ruby < 3.3 and Rails < 7.2
+
 ## 3.0.0 (2025-07-02)
 
-See the [upgrade notes](https://github.com/ankane/ahoy_email?tab=readme-ov-file#30)
+See the [upgrade notes](https://github.com/ankane/ahoy_email/blob/v3.0.0/README.md#upgrading)
 
 - Switched to HTML5 parsing by default (when available)
 - Removed support for legacy secret token generation

data/README.md

@@ -2,7 +2,7 @@
 
 First-party email analytics for Rails
 
-**Ahoy Email 3.0 was recently released** - see [how to upgrade](#upgrading)
+**Ahoy Email 4.0 was recently released** - see [how to upgrade](#upgrading)
 
 :fire: For web and native app analytics, check out [Ahoy](https://github.com/ankane/ahoy)
 
@@ -108,7 +108,7 @@ user.messages
 Add extra data to messages. Create a migration like:
 
 ```ruby
-class AddCouponIdToAhoyMessages < ActiveRecord::Migration[8.0]
+class AddCouponIdToAhoyMessages < ActiveRecord::Migration[8.1]
   def change
     add_column :ahoy_messages, :coupon_id, :integer
   end
@@ -328,18 +328,12 @@ AhoyEmail.stats("my-campaign")
 
 ## Upgrading
 
-### 3.0
+### 4.0
 
-Links that use click analytics created before version 2.3.0 (released June 2024) will no longer work by default. To restore support, [determine the previous secret token](https://github.com/ankane/ahoy_email/blob/v2.5.0/lib/ahoy_email/engine.rb#L11-L21) and create an initializer with:
+Versions 2.3.0-3.0.0 cause applications to use SHA1 for the key generator hash digest class if `AhoyEmail.secret_token` is not manually set (due to [this behavior in Rails](https://github.com/rails/rails/issues/56736)). To avoid breakage when upgrading, add to `config/application.rb`:
 
 ```ruby
-AhoyEmail.secret_token = [AhoyEmail.secret_token, previous_secret_token]
-```
-
-Also, Nokogiri’s HTML5 parser is now used to rewrite links for UTM tagging and click analytics when available. To use HTML4 parsing, create an initializer with:
-
-```ruby
-AhoyEmail.default_options[:html5] = false
+config.active_support.key_generator_hash_digest_class = OpenSSL::Digest::SHA1
 ```
 
 ## History

data/lib/ahoy_email/engine.rb

@@ -3,7 +3,8 @@ require "rails/engine"
 module AhoyEmail
   class Engine < ::Rails::Engine
     initializer "ahoy_email" do |app|
-      AhoyEmail.secret_token ||= app.key_generator.generate_key("ahoy_email")
+      # avoid app.key_generator due to https://github.com/ankane/ahoy_email/pull/168
+      AhoyEmail.secret_token ||= ActiveSupport::KeyGenerator.new(app.secret_key_base, iterations: 1000, hash_digest_class: OpenSSL::Digest::SHA1).generate_key("ahoy_email")
     end
   end
 end

data/lib/ahoy_email/utils.rb

@@ -20,7 +20,7 @@ module AhoyEmail
         secret_tokens.any? do |secret_token|
           expected_signature =
             if legacy
-              # TODO remove legacy support in 4.0
+              # TODO remove legacy support in 5.0
               OpenSSL::HMAC.hexdigest("SHA1", secret_token, url)
             else
               signature(token: token, campaign: campaign, url: url, secret_token: secret_token)

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "3.0.0"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.16
 specification_version: 4
 summary: First-party email analytics for Rails
 test_files: []