ahoy_email 2.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b84f8c566d81a470ba99f4318c2d7dd3f1b3fae6b05155491f486cbdbff7c0a6
-  data.tar.gz: 8ab62441cf6df6b4ab6af401a9cbed8864ac634d28dd728f6b83bfd743dce284
+  metadata.gz: b465af2a0497b6b85237fa5246c4c722d594978e07710f66ec96a9260fb44c98
+  data.tar.gz: 3f5e353adebbc67fbea887d9a8e36f01ba237a04d16431947855c81fc8be1bcd
 SHA512:
-  metadata.gz: cf70b92f9ba7b0d91324eae1927fe49464c3b3a76293272570559526064d20a1df5a3859a350dac9d6708113b787e8566a8db58cb6bc881d463ae2f4581865c8
-  data.tar.gz: 62019c44c7e66c5d3858c9862d20276dbb876d024ca21d1d8691e3969944778c493fa3e988e0e22e2253c7515a6d453d2f11c794867941fa024017c9f28eeb02
+  metadata.gz: ead0edcbeda702bd605ea00562addfb65cb321e6797a2fb0e8c1fed640511d8bb5bb2b34a4acfa3bde12447bb0401d0975548661bc867cc7e5c1b5585db01425
+  data.tar.gz: c903baeebe4fbd700a58d9e193094648ccf0a3205e70fd78fb20a84cf09dfaee3f642ef45d78e4a50eb86d287b9d0974e8d33075528eef03702fe311175aa5e1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 2.1.3 (2022-06-12)
+
+- Updated messages generator for Lockbox 1.0
+- Fixed deprecation warning with Redis 4.6+
+
+## 2.1.2 (2022-02-09)
+
+- Fixed external redirects with Rails 7
+
+## 2.1.1 (2021-12-13)
+
+- Added experimental support for Active Record encryption
+
 ## 2.1.0 (2021-09-25)
 
 - Fixed mailer `default_url_options` not being applied to click links

data/README.md

@@ -15,7 +15,7 @@ First-party email analytics for Rails
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'ahoy_email'
+gem "ahoy_email"
 ```
 
 ## Getting Started
@@ -28,17 +28,24 @@ There are three main features, which can be used independently:
 
 ## Message History
 
-To encrypt email addresses, install [Lockbox](https://github.com/ankane/lockbox) and [Blind Index](https://github.com/ankane/blind_index) and run:
+To encrypt email addresses with Lockbox, install [Lockbox](https://github.com/ankane/lockbox) and [Blind Index](https://github.com/ankane/blind_index) and run:
 
 ```sh
-rails generate ahoy:messages
+rails generate ahoy:messages --encryption=lockbox
+rails db:migrate
+```
+
+To use Active Record encryption (Rails 7+, experimental), run:
+
+```sh
+rails generate ahoy:messages --encryption=activerecord
 rails db:migrate
 ```
 
 If you prefer not to encrypt data, run:
 
 ```sh
-rails generate ahoy:messages --unencrypted
+rails generate ahoy:messages --encryption=none
 rails db:migrate
 ```
 
@@ -157,7 +164,7 @@ Ahoy::Message.where("created_at < ?", 1.year.ago).in_batches.delete_all
 Delete data for a specific user with:
 
 ```ruby
-Ahoy::Message.where(user_id: 1).in_batches.delete_all
+Ahoy::Message.where(user_id: 1, user_type: "User").in_batches.delete_all
 ```
 
 ## UTM Tagging
@@ -223,7 +230,7 @@ AhoyEmail.api = true
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'redis'
+gem "redis"
 ```
 
 And create `config/initializers/ahoy_email.rb` with:

data/app/controllers/ahoy/messages_controller.rb

@@ -25,6 +25,9 @@ module Ahoy
         expected_signature = AhoyEmail::Utils.signature(token: token, campaign: campaign, url: url)
       end
 
+      redirect_options = {}
+      redirect_options[:allow_other_host] = true if ActionPack::VERSION::MAJOR >= 7
+
       if ActiveSupport::SecurityUtils.secure_compare(signature, expected_signature)
         data = {}
         data[:campaign] = campaign if campaign
@@ -33,10 +36,10 @@ module Ahoy
         data[:controller] = self
         AhoyEmail::Utils.publish(:click, data)
 
-        redirect_to url
+        redirect_to url, **redirect_options
       else
         if AhoyEmail.invalid_redirect_url
-          redirect_to AhoyEmail.invalid_redirect_url
+          redirect_to AhoyEmail.invalid_redirect_url, **redirect_options
         else
           render plain: "Link expired", status: :not_found
         end

data/lib/ahoy_email/redis_subscriber.rb

@@ -9,17 +9,17 @@ module AhoyEmail
 
     def track_send(event)
       campaign_prefix = campaign_key(event[:campaign])
-      redis.pipelined do
-        redis.incr("#{campaign_prefix}:sends")
-        redis.sadd(campaigns_key, event[:campaign])
+      pipelined do |pipeline|
+        pipeline.incr("#{campaign_prefix}:sends")
+        pipeline.sadd(campaigns_key, event[:campaign])
       end
     end
 
     def track_click(event)
       campaign_prefix = campaign_key(event[:campaign])
-      redis.pipelined do
-        redis.incr("#{campaign_prefix}:clicks")
-        redis.pfadd("#{campaign_prefix}:unique_clicks", event[:token])
+      pipelined do |pipeline|
+        pipeline.incr("#{campaign_prefix}:clicks")
+        pipeline.pfadd("#{campaign_prefix}:unique_clicks", event[:token])
       end
     end
 
@@ -62,10 +62,10 @@ module AhoyEmail
       unique_clicks = nil
 
       campaign_prefix = campaign_key(campaign)
-      redis.pipelined do
-        sends = redis.get("#{campaign_prefix}:sends")
-        clicks = redis.get("#{campaign_prefix}:clicks")
-        unique_clicks = redis.pfcount("#{campaign_prefix}:unique_clicks")
+      pipelined do |pipeline|
+        sends = pipeline.get("#{campaign_prefix}:sends")
+        clicks = pipeline.get("#{campaign_prefix}:clicks")
+        unique_clicks = pipeline.pfcount("#{campaign_prefix}:unique_clicks")
       end
 
       {
@@ -75,5 +75,17 @@ module AhoyEmail
         ctr: 100 * unique_clicks.value / sends.value.to_f
       }
     end
+
+    def pipelined
+      if Redis::VERSION.to_f >= 4.6
+        redis.pipelined do |pipeline|
+          yield pipeline
+        end
+      else
+        redis.pipelined do
+          yield redis
+        end
+      end
+    end
   end
 end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "2.1.0"
+  VERSION = "2.1.3"
 end

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

@@ -7,15 +7,21 @@ module Ahoy
         include ActiveRecord::Generators::Migration
         source_root File.join(__dir__, "templates")
 
+        class_option :encryption, type: :string
+        # deprecated
         class_option :unencrypted, type: :boolean
 
         def copy_migration
+          encryption # ensure valid
           migration_template "migration.rb", "db/migrate/create_ahoy_messages.rb", migration_version: migration_version
         end
 
         def copy_template
-          if encrypted?
-            template "model_encrypted.rb", "app/models/ahoy/message.rb"
+          case encryption
+          when "lockbox"
+            template "model_lockbox.rb", "app/models/ahoy/message.rb", lockbox_method: lockbox_method
+          when "activerecord"
+            template "model_activerecord.rb", "app/models/ahoy/message.rb"
           end
         end
 
@@ -24,15 +30,38 @@ module Ahoy
         end
 
         def to_column
-          if encrypted?
+          case encryption
+          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"
           end
         end
 
-        def encrypted?
-          !options[:unencrypted]
+        # 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
+        end
+
+        def lockbox_method
+          if defined?(Lockbox::VERSION) && Lockbox::VERSION.to_i < 1
+            "encrypts"
+          else
+            "has_encrypted"
+          end
         end
       end
     end

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

@@ -6,13 +6,41 @@ module Ahoy
       class MongoidGenerator < Rails::Generators::Base
         source_root File.join(__dir__, "templates")
 
+        class_option :encryption, type: :string
+        # deprecated
         class_option :unencrypted, type: :boolean
 
         def copy_templates
-          if options[:unencrypted]
+          case encryption
+          when "lockbox"
+            template "mongoid_lockbox.rb", "app/models/ahoy/message.rb", lockbox_method: lockbox_method
+          else
             template "mongoid.rb", "app/models/ahoy/message.rb"
+          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
+        end
+
+        def lockbox_method
+          if defined?(Lockbox::VERSION) && Lockbox::VERSION.to_i < 1
+            "encrypts"
           else
-            template "mongoid_encrypted.rb", "app/models/ahoy/message.rb"
+            "has_encrypted"
           end
         end
       end

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

@@ -0,0 +1,7 @@
+class Ahoy::Message < ActiveRecord::Base
+  self.table_name = "ahoy_messages"
+
+  belongs_to :user, polymorphic: true, optional: true
+
+  encrypts :to, deterministic: true
+end

data/lib/generators/ahoy/messages/templates/{model_encrypted.rb.tt → model_lockbox.rb.tt}

@@ -3,6 +3,6 @@ class Ahoy::Message < ActiveRecord::Base
 
   belongs_to :user, polymorphic: true, optional: true
 
-  encrypts :to
+  <%= lockbox_method %> :to
   blind_index :to
 end

data/lib/generators/ahoy/messages/templates/{mongoid_encrypted.rb.tt → mongoid_lockbox.rb.tt}

@@ -11,6 +11,6 @@ class Ahoy::Message
 
   index({to_bidx: 1})
 
-  encrypts :to
+  <%= lockbox_method %> :to
   blind_index :to
 end

data/lib/generators/ahoy/messages_generator.rb

@@ -3,6 +3,8 @@ require "rails/generators"
 module Ahoy
   module Generators
     class MessagesGenerator < Rails::Generators::Base
+      class_option :encryption, type: :string
+      # deprecated
       class_option :unencrypted, type: :boolean
 
       def copy_templates

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -99,9 +99,10 @@ files:
 - lib/generators/ahoy/messages/activerecord_generator.rb
 - lib/generators/ahoy/messages/mongoid_generator.rb
 - lib/generators/ahoy/messages/templates/migration.rb.tt
-- lib/generators/ahoy/messages/templates/model_encrypted.rb.tt
+- lib/generators/ahoy/messages/templates/model_activerecord.rb.tt
+- lib/generators/ahoy/messages/templates/model_lockbox.rb.tt
 - lib/generators/ahoy/messages/templates/mongoid.rb.tt
-- lib/generators/ahoy/messages/templates/mongoid_encrypted.rb.tt
+- lib/generators/ahoy/messages/templates/mongoid_lockbox.rb.tt
 - lib/generators/ahoy/messages_generator.rb
 homepage: https://github.com/ankane/ahoy_email
 licenses:
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: First-party email analytics for Rails