ahoy_email 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55896391d55a0158cdf032a2d7a29860984db55a4c116b96317e8986acdef143
-  data.tar.gz: 6c1c742d62fa0c2b2b62832dc0030fa7dad31839fc5e015f3806766c14ce9804
+  metadata.gz: e11cd64d52d35113df4fe7e29042683f3f5de6aa256ef75ae8f8455d2d1eec1f
+  data.tar.gz: f38baf49086ddaa1759243644074da6486cddbb0793c1d71e93e352228f12b66
 SHA512:
-  metadata.gz: 411579c14c08b65b59aaf34dafa6e37e0fdff00acc2232eb9962c31ce7077826aa228d3e7e7b09f657b2e6a2542b003b005e43237106b162ffd60930a13e9cf8
-  data.tar.gz: a042562ba6f0a1ed0e342f823bd75b7960fdae2490699f02cbfd1320f81fd82cd19bdaabb437369825701656eb78f5a1663a14ccf918c28605257c3af966dbbf
+  metadata.gz: dd32bc570175e43d4b601d1b6bf7289f44c51912fe3b5f3fafc86cfbd505a4aa40b8c7ea224cfa0c29d790d0d9994acc92d0d143d4a482152539fec1904cce9b
+  data.tar.gz: 81e1d2e90a4a82621b5fb3b755653f6536cc755f3702c9d89a57e0be90b6ea1111b6cf5b737093f37e859c1c5742f137492b1ee41841125b6504623c6bd830da

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.4.0 (2024-11-11)
+
+- Added `html5` option
+- Improved generator for Active Record encryption and MySQL
+- Removed support for Ruby < 3.1 and Rails < 7
+- Removed support for Mongoid < 8
+
+## 2.3.1 (2024-09-09)
+
+- Fixed deprecation warning with Rails 7.1
+
 ## 2.3.0 (2024-06-01)
 
 - Added support for secret token rotation
@@ -176,4 +187,14 @@ Breaking changes
 
 ## 0.1.0 (2014-04-29)
 
-- First major release
+- Changed option names
+
+## 0.0.2 (2014-04-29)
+
+- Added open and click tracking
+- Added UTM parameters
+- Rescue errors
+
+## 0.0.1 (2014-04-28)
+
+- First release

data/README.md

@@ -33,7 +33,7 @@ rails generate ahoy:messages --encryption=lockbox
 rails db:migrate
 ```
 
-To use Active Record encryption (Rails 7+, experimental), run:
+To use Active Record encryption, run:
 
 ```sh
 rails generate ahoy:messages --encryption=activerecord
@@ -106,7 +106,7 @@ user.messages
 Add extra data to messages. Create a migration like:
 
 ```ruby
-class AddCouponIdToAhoyMessages < ActiveRecord::Migration[7.1]
+class AddCouponIdToAhoyMessages < ActiveRecord::Migration[8.0]
   def change
     add_column :ahoy_messages, :coupon_id, :integer
   end
@@ -156,7 +156,7 @@ end
 Delete older data with:
 
 ```ruby
-Ahoy::Message.where("created_at < ?", 1.year.ago).in_batches.delete_all
+Ahoy::Message.where("sent_at < ?", 1.year.ago).in_batches.delete_all
 ```
 
 Delete data for a specific user with:
@@ -324,53 +324,15 @@ Get stats for a campaign
 AhoyEmail.stats("my-campaign")
 ```
 
-## Upgrading
+## HTML Parsing
 
-### 2.0
+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).
 
-Ahoy Email 2.0 brings a number of changes. Here are a few to be aware of:
+To use HTML5 parsing, create `config/initializers/ahoy_email.rb` with:
 
-- The `to` field is encrypted by default for new installations. If you’d like to encrypt an existing installation, install [Lockbox](https://github.com/ankane/lockbox) and [Blind Index](https://github.com/ankane/blind_index) and follow the Lockbox instructions for [migrating existing data](https://github.com/ankane/lockbox#migrating-existing-data).
-
-  For the model, create `app/models/ahoy/message.rb` with:
-
-  ```ruby
-  class Ahoy::Message < ActiveRecord::Base
-    self.table_name = "ahoy_messages"
-
-    belongs_to :user, polymorphic: true, optional: true
-
-    encrypts :to, migrating: true
-    blind_index :to, migrating: true
-  end
-  ```
-
-- The `track` method has been broken into:
-
-  - `has_history` for message history
-  - `utm_params` for UTM tagging
-  - `track_clicks` for click analytics
-
-- Message history is no longer enabled by default. Add `has_history` to individual mailers, or create an initializer with:
-
-  ```ruby
-  AhoyEmail.default_options[:message] = true
-  ```
-
-- For privacy, open tracking has been removed.
-
-- For clicks, we encourage you to try [aggregate analytics](#click-analytics) to measure the performance of campaigns. You can use a library like [Rollup](https://github.com/ankane/rollup) to aggregate existing data, then drop the `token` and `clicked_at` columns.
-
-  To keep individual analytics, use `has_history` and `track_clicks campaign: false` and create an initializer with:
-
-  ```ruby
-  AhoyEmail.save_token = true
-  AhoyEmail.subscribers << AhoyEmail::MessageSubscriber
-  ```
-
-  If you use a custom subscriber, `:message` is no longer included in click events. You can use `:token` to query the message if needed.
-
-- Users are shown a link expired page when signature verification fails instead of being redirected to the homepage when `AhoyEmail.invalid_redirect_url` is not set
+```ruby
+AhoyEmail.default_options[:html5] = true
+```
 
 ## History
 

data/app/controllers/ahoy/messages_controller.rb

@@ -25,7 +25,7 @@ module Ahoy
       end
 
       redirect_options = {}
-      redirect_options[:allow_other_host] = true if ActionPack::VERSION::MAJOR >= 7
+      redirect_options[:allow_other_host] = true
 
       if AhoyEmail::Utils.signature_verified?(legacy: legacy, token: token, campaign: campaign, url: url, signature: signature)
         data = {}

data/lib/ahoy_email/engine.rb

@@ -11,7 +11,7 @@ module AhoyEmail
         creds =
           if app.respond_to?(:credentials) && app.credentials.secret_key_base
             app.credentials
-          elsif app.respond_to?(:secrets)
+          elsif app.respond_to?(:secrets) && (Rails::VERSION::STRING.to_f < 7.1 || app.config.paths["config/secrets"].existent.any?)
             app.secrets
           else
             app.config

data/lib/ahoy_email/mailer.rb

@@ -63,6 +63,9 @@ module AhoyEmail
       # only call other options if needed
       if options[key]
         AhoyEmail::Utils::OPTION_KEYS[key].each do |k|
+          # make sure html5 only called once
+          next if options.key?(k)
+
           v = ahoy_options[k]
           options[k] = v.respond_to?(:call) ? instance_exec(&v) : v
         end

data/lib/ahoy_email/processor.rb

@@ -53,7 +53,7 @@ module AhoyEmail
       if html_part?
         part = message.html_part || message
 
-        doc = Nokogiri::HTML::Document.parse(part.body.raw_source)
+        doc = parser_class.parse(part.body.raw_source)
         doc.css("a[href]").each do |link|
           uri = parse_uri(link["href"])
           next unless trackable?(uri)
@@ -92,6 +92,19 @@ module AhoyEmail
       end
     end
 
+    # use document instead of fragment
+    # https://github.com/ankane/ahoy_email/pull/150
+    def parser_class
+      case options[:html5]
+      when true
+        Nokogiri::HTML5::Document
+      when false
+        Nokogiri::HTML4::Document
+      else
+        Nokogiri::HTML::Document
+      end
+    end
+
     def html_part?
       (message.html_part || message).content_type =~ /html/
     end

data/lib/ahoy_email/utils.rb

@@ -2,8 +2,8 @@ module AhoyEmail
   class Utils
     OPTION_KEYS = {
       message: %i(message mailer user extra),
-      utm_params: %i(utm_source utm_medium utm_term utm_content utm_campaign),
-      click: %i(campaign url_options unsubscribe_links)
+      utm_params: %i(utm_source utm_medium utm_term utm_content utm_campaign html5),
+      click: %i(campaign url_options unsubscribe_links html5)
     }
 
     class << self

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/lib/ahoy_email.rb

@@ -48,7 +48,10 @@ module AhoyEmail
     click: false,
     campaign: nil,
     url_options: {},
-    unsubscribe_links: false
+    unsubscribe_links: false,
+
+    # utm params and click analytics
+    html5: nil
   }
 
   self.track_method = lambda do |data|

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

@@ -34,8 +34,11 @@ module Ahoy
           when "lockbox"
             "t.text :to_ciphertext\n      t.string :to_bidx, index: true"
           else
-            # TODO add limit: 510 for Active Record encryption + MySQL?
-            "t.string :to, index: true"
+            if encryption == "activerecord" && mysql?
+              "t.string :to, limit: 510, index: true"
+            else
+              "t.string :to, index: true"
+            end
           end
         end
 
@@ -63,6 +66,14 @@ module Ahoy
             "has_encrypted"
           end
         end
+
+        def mysql?
+          adapter =~ /mysql|trilogy/i
+        end
+
+        def adapter
+          ActiveRecord::Base.connection_db_config.adapter.to_s
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-01 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -116,14 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: First-party email analytics for Rails