ahoy_email 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b84f8c566d81a470ba99f4318c2d7dd3f1b3fae6b05155491f486cbdbff7c0a6
-  data.tar.gz: 8ab62441cf6df6b4ab6af401a9cbed8864ac634d28dd728f6b83bfd743dce284
+  metadata.gz: bf88f44f04ee798926e9363928aed4be7c34d0b4f5456b01f1dc210f18967cc4
+  data.tar.gz: bb0c2ea92f067cbd6f37f7d06bb7700f51427dd68f178d0405ccf31f02b21fea
 SHA512:
-  metadata.gz: cf70b92f9ba7b0d91324eae1927fe49464c3b3a76293272570559526064d20a1df5a3859a350dac9d6708113b787e8566a8db58cb6bc881d463ae2f4581865c8
-  data.tar.gz: 62019c44c7e66c5d3858c9862d20276dbb876d024ca21d1d8691e3969944778c493fa3e988e0e22e2253c7515a6d453d2f11c794867941fa024017c9f28eeb02
+  metadata.gz: 9568577466f777d12ad274926490b72f0976eec913b12e8e524f3af66612f22a9a07fa5065c5e2f8817b735ee4ed683a2391b62211aadda716168b3b12833f4b
+  data.tar.gz: 122f4e7758d69d4cba1c16b3ff677317084b562921db52d7bcd9408b760aa5ef3e5ebd61808e04e39c1f6e538722d51247daba68037bad88939338049db6f80e

data/CHANGELOG.md

@@ -1,3 +1,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

@@ -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

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 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"
+          when "activerecord"
+            template "model_activerecord.rb", "app/models/ahoy/message.rb"
           end
         end
 
@@ -24,15 +30,30 @@ 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
       end
     end

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

@@ -6,13 +6,33 @@ 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"
+          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
-            template "mongoid_encrypted.rb", "app/models/ahoy/message.rb"
+            abort "Error: encryption must be lockbox or none"
           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_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.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-12-14 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.2.32
 signing_key:
 specification_version: 4
 summary: First-party email analytics for Rails