ahoy_email 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa1850e7d07ec2fe43003f8e6c2046a10bd8229c6e5e8d12849cc8a2d819f670
-  data.tar.gz: 4eefd3654e671eb6c65b064025d9ea5c7dd7810d73f12bbc8b34cafb2e5e00f4
+  metadata.gz: d7ace81db2d79de0385596b9cc076ce32f7ead8b0ac96f18be9d4df728814332
+  data.tar.gz: 2cf40755b20d6acf97e1d5d88d1b58da2d0de85647bd34f02c734ae2366275fa
 SHA512:
-  metadata.gz: 0e021685e661cbb627a5d95fde8dfccbc0630398a391eea319d64ce268f3219918a6442a23f1ed9a2a06b69761a97f09aa8cb2a633e282affc200e4ac45b7d7b
-  data.tar.gz: 104b6dfebf8f9d3bb3381e09b972708f539122ff2ca062cfc0aaf5a5af529661e06c196dfa35e862a8709b2ede56af3dcf13af9ee1bb15552ce036323ced9f39
+  metadata.gz: 7f7051e5893e5a489cacb2f3b76f238fb448d1065ba3fe12c02b36b89515bd591b42243ccb03e9a056b7d64f2c1a8da558d2c25135dab2db5a202261ac81f24b
+  data.tar.gz: ec4ece8d9c5becd279980fc72c3fe046a20a8305b41eb7df8fc9fc0cc61e8ff29dc3f0020dc929332a9551bcb13a3d569c95f2a7f277ae5f695224a656b972bf

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.0.0 (2025-07-02)
+
+See the [upgrade notes](https://github.com/ankane/ahoy_email?tab=readme-ov-file#30)
+
+- Switched to HTML5 parsing by default (when available)
+- Removed support for legacy secret token generation
+
 ## 2.5.0 (2025-05-04)
 
 - Removed support for Ruby < 3.2 and Rails < 7.1

data/LICENSE.txt

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

data/README.md

@@ -2,6 +2,8 @@
 
 First-party email analytics for Rails
 
+**Ahoy Email 3.0 was recently released** - see [how to upgrade](#upgrading)
+
 :fire: For web and native app analytics, check out [Ahoy](https://github.com/ankane/ahoy)
 
 :bullettrain_side: To manage email subscriptions, check out [Mailkick](https://github.com/ankane/mailkick)
@@ -324,14 +326,20 @@ Get stats for a campaign
 AhoyEmail.stats("my-campaign")
 ```
 
-## HTML Parsing
+## Upgrading
+
+### 3.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:
 
-By default, Nokogiri’s default HTML parser is used to rewrite links for UTM tagging and click analytics. This currently uses HTML4, which [only allows inline elements inside links](https://github.com/sparklemotion/nokogiri/issues/1876#issuecomment-468276937).
+```ruby
+AhoyEmail.secret_token = [AhoyEmail.secret_token, previous_secret_token]
+```
 
-To use HTML5 parsing, create `config/initializers/ahoy_email.rb` with:
+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] = true
+AhoyEmail.default_options[:html5] = false
 ```
 
 ## History

data/lib/ahoy_email/engine.rb

@@ -3,26 +3,7 @@ require "rails/engine"
 module AhoyEmail
   class Engine < ::Rails::Engine
     initializer "ahoy_email" do |app|
-      AhoyEmail.secret_token ||= begin
-        tokens = []
-        tokens << app.key_generator.generate_key("ahoy_email")
-
-        # TODO remove in 3.0
-        creds =
-          if app.respond_to?(:credentials) && app.credentials.secret_key_base
-            app.credentials
-          elsif app.respond_to?(:secrets) && app.config.paths["config/secrets"].existent.any?
-            app.secrets
-          else
-            app.config
-          end
-
-        token = creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
-        token ||= app.secret_key_base # should come first, but need to maintain backward compatibility
-        tokens << token
-
-        tokens
-      end
+      AhoyEmail.secret_token ||= app.key_generator.generate_key("ahoy_email")
     end
   end
 end

data/lib/ahoy_email/processor.rb

@@ -101,7 +101,11 @@ module AhoyEmail
       when false
         Nokogiri::HTML4::Document
       else
-        Nokogiri::HTML::Document
+        if defined?(Nokogiri::HTML5::Document)
+          Nokogiri::HTML5::Document
+        else
+          Nokogiri::HTML4::Document
+        end
       end
     end
 

data/lib/ahoy_email/utils.rb

@@ -20,6 +20,7 @@ module AhoyEmail
         secret_tokens.any? do |secret_token|
           expected_signature =
             if legacy
+              # TODO remove legacy support in 4.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 = "2.5.0"
+  VERSION = "3.0.0"
 end

data/lib/generators/ahoy/clicks/activerecord_generator.rb

@@ -14,6 +14,14 @@ module Ahoy
         def migration_version
           "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
         end
+
+        def primary_key_type
+          ", id: :#{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/clicks/templates/migration.rb.tt

@@ -1,6 +1,6 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :ahoy_clicks do |t|
+    create_table :ahoy_clicks<%= primary_key_type %> do |t|
       t.string :campaign, index: true
       t.string :token
     end

data/lib/generators/ahoy/clicks_generator.rb

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

data/lib/generators/ahoy/messages/activerecord_generator.rb

@@ -42,18 +42,10 @@ module Ahoy
           end
         end
 
-        # TODO remove default
         def encryption
           case options[:encryption]
           when "lockbox", "activerecord", "none"
             options[:encryption]
-          when nil
-            if options[:unencrypted]
-              # TODO deprecation warning
-              "none"
-            else
-              "lockbox"
-            end
           else
             abort "Error: encryption must be lockbox, activerecord, or none"
           end
@@ -74,6 +66,18 @@ module Ahoy
         def adapter
           ActiveRecord::Base.connection_db_config.adapter.to_s
         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/messages/mongoid_generator.rb

@@ -19,18 +19,10 @@ module Ahoy
           end
         end
 
-        # TODO remove default
         def encryption
           case options[:encryption]
           when "lockbox", "none"
             options[:encryption]
-          when nil
-            if options[:unencrypted]
-              # TODO deprecation warning
-              "none"
-            else
-              "lockbox"
-            end
           else
             abort "Error: encryption must be lockbox or none"
           end

data/lib/generators/ahoy/messages/templates/migration.rb.tt

@@ -1,7 +1,7 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :ahoy_messages do |t|
-      t.references :user, polymorphic: true
+    create_table :ahoy_messages<%= primary_key_type %> do |t|
+      t.references :user<%= foreign_key_type %>, polymorphic: true
       <%= to_column %>
       t.string :mailer
       t.text :subject

data/lib/generators/ahoy/messages_generator.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -29,42 +29,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: safely_block
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 email: andrew@ankane.org
 executables: []
 extensions: []