mailkick 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f16bb5b552006639122c94a4b910982ed0845694bb503dfac08e23e3ed41f24
-  data.tar.gz: c82b3290c80af68f5d9817a38a4d30af8d5893a216121154182457d96f0904dc
+  metadata.gz: 6d3592c25635ef911ea75b5bd5f07bbf512cbc3066bda2a7a7deb39e0d969821
+  data.tar.gz: 521daa545720254493b7dbef3806a95e44ac739041e6a9ab4fd33a5ef41881b7
 SHA512:
-  metadata.gz: a31f0bb8e3a84e0abcc6bca052a815fd4f98eb8130572903e010d479bc3e46c219ea0efb4b89cfba09d8cb3e7fd68a42f7c99716a1e4228ea9b65af6e663b21e
-  data.tar.gz: e9e0cc2fac1d027ee28650077977d30abcce514e4064eb27b73e0650147828f292bcae32631cdb600271b9a5e50ddd24603e1d328231a1227d523571cfdb003c
+  metadata.gz: fb7e324a4812673f7278bb8ce890ea0d67ac74c6e923ae4d43dc0c6e447fa28282a56beeb25c86fe9d5e9e34d3ecda03099d2240773b5d74ca3a940cc4b8c6e5
+  data.tar.gz: ce6f5ba95efec816c0571189a3e2f1a99060fe389927656836110a750f61fe768810b7f2a342325081acb6d5b7e66f1464db1b449fbc5f1467a4e595d9a3c51c

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.0.0 (2025-06-23)
+
+See the [upgrade notes](https://github.com/ankane/mailkick?tab=readme-ov-file#20)
+
+- Added `prefix` option to `has_subscriptions`
+- Switched to suppressions API for Postmark and changed default stream to `broadcast`
+- Dropped support for legacy opt-outs
+- Dropped support for legacy secret token generation and serialization
+- Dropped support for legacy SendGrid service
+
 ## 1.4.0 (2025-04-03)
 
 - Dropped support for Ruby < 3.2 and Rails < 7.1

data/README.md

@@ -5,6 +5,8 @@ Email subscriptions for Rails
 - Add one-click unsubscribe links and headers to your emails
 - Fetch bounces and spam reports from your email service
 
+**Mailkick 2.0 was recently released** - see [how to upgrade](#upgrading)
+
 :postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for analytics
 
 [![Build Status](https://github.com/ankane/mailkick/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/mailkick/actions)
@@ -126,8 +128,6 @@ The following services are supported:
 - [Postmark](#postmark)
 - [SendGrid](#sendgrid)
 
-Will gladly accept pull requests for others.
-
 #### AWS SES
 
 Add the gem
@@ -168,7 +168,7 @@ Add the gem
 gem "mandrill-api"
 ```
 
-And set `ENV["MANDRILL_APIKEY"]`.
+And set `ENV["MANDRILL_API_KEY"]`.
 
 #### Postmark
 
@@ -209,6 +209,30 @@ Access the subscription model directly
 Mailkick::Subscription.all
 ```
 
+Prefix method names with `mailkick_`
+
+```ruby
+class User < ApplicationRecord
+  has_subscriptions prefix: true
+end
+```
+
+## Upgrading
+
+### 2.0
+
+Unsubscribe links created before version 1.1.1 will no longer work by default. Determine if this is acceptable for your application (for instance, in the US, links must work [for 30 days](https://www.ftc.gov/business-guidance/resources/can-spam-act-compliance-guide-business) after the message is sent). To restore support, [determine the previous secret token](https://github.com/ankane/mailkick/blob/v1.4.0/lib/mailkick/engine.rb#L13-L22) and create an initializer with:
+
+```ruby
+Mailkick.message_verifier.rotate(previous_secret_token, serializer: Marshal)
+```
+
+If fetching bounces, spam reports, and unsubscribes from Postmark, the suppressions API is now used and the default stream has been changed to `broadcast`. To use `outbound`, create an initializer with:
+
+```ruby
+Mailkick.services = [Mailkick::Service::Postmark.new(api_key: api_key, stream_id: "outbound")]
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/mailkick/blob/master/CHANGELOG.md)

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -11,8 +11,6 @@ module Mailkick
     def unsubscribe
       subscription.delete_all
 
-      Mailkick::Legacy.opt_out(legacy_options) if Mailkick::Legacy.opt_outs?
-
       if request.post? && params["List-Unsubscribe"] == "One-Click"
         # must not redirect according to RFC 8058
         # could render show action instead
@@ -25,8 +23,6 @@ module Mailkick
     def subscribe
       subscription.first_or_create!
 
-      Mailkick::Legacy.opt_in(legacy_options) if Mailkick::Legacy.opt_outs?
-
       redirect_to subscription_path(params[:id])
     end
 
@@ -65,17 +61,5 @@ module Mailkick
       unsubscribe_subscription_path(params[:id])
     end
     helper_method :unsubscribe_url
-
-    def legacy_options
-      if @subscriber_type
-        # on the unprobabilistic chance subscriber_type is compromised, not much damage
-        user = @subscriber_type.constantize.find(@subscriber_id)
-      end
-      {
-        email: @email,
-        user: user,
-        list: @list
-      }
-    end
   end
 end

data/lib/generators/mailkick/install_generator.rb

@@ -14,6 +14,18 @@ module Mailkick
       def migration_version
         "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       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/mailkick/templates/install.rb.tt

@@ -1,7 +1,7 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :mailkick_subscriptions do |t|
-      t.references :subscriber, polymorphic: true, index: false
+    create_table :mailkick_subscriptions<%= primary_key_type %> do |t|
+      t.references :subscriber<%= foreign_key_type %>, polymorphic: true, index: false
       t.string :list
       t.timestamps
     end

data/lib/generators/mailkick/views_generator.rb

@@ -3,7 +3,7 @@ require "rails/generators"
 module Mailkick
   module Generators
     class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../app/views", __FILE__)
+      source_root File.expand_path("../../../app/views", __dir__)
 
       def copy_initializer_file
         directory "mailkick", "app/views/mailkick"

data/lib/mailkick/engine.rb

@@ -5,23 +5,7 @@ module Mailkick
     initializer "mailkick" do |app|
       Mailkick.discover_services unless Mailkick.services.any?
 
-      unless Mailkick.secret_token
-        Mailkick.secret_token = app.key_generator.generate_key("mailkick")
-        Mailkick.message_verifier = ActiveSupport::MessageVerifier.new(Mailkick.secret_token, serializer: JSON)
-
-        # TODO remove in 2.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
-        Mailkick.message_verifier.rotate(token, serializer: Marshal) if token
-      end
+      Mailkick.secret_token ||= app.key_generator.generate_key("mailkick")
     end
   end
 end

data/lib/mailkick/model.rb

@@ -1,21 +1,23 @@
 module Mailkick
   module Model
-    def has_subscriptions
+    def has_subscriptions(prefix: false)
+      prefix = prefix ? "mailkick_" : ""
+
       class_eval do
         has_many :mailkick_subscriptions, class_name: "Mailkick::Subscription", as: :subscriber
-        scope :subscribed, ->(list) { joins(:mailkick_subscriptions).where(mailkick_subscriptions: {list: list}) }
+        scope "#{prefix}subscribed", ->(list) { joins(:mailkick_subscriptions).where(mailkick_subscriptions: {list: list}) }
 
-        def subscribe(list)
+        define_method("#{prefix}subscribe") do |list|
           mailkick_subscriptions.where(list: list).first_or_create!
           nil
         end
 
-        def unsubscribe(list)
+        define_method("#{prefix}unsubscribe") do |list|
           mailkick_subscriptions.where(list: list).delete_all
           nil
         end
 
-        def subscribed?(list)
+        define_method("#{prefix}subscribed?") do |list|
           mailkick_subscriptions.where(list: list).exists?
         end
       end

data/lib/mailkick/service/aws_ses.rb

@@ -8,8 +8,7 @@ module Mailkick
         "COMPLAINT" => "spam"
       }
 
-      def initialize(options = {})
-        @options = options
+      def initialize
       end
 
       def opt_outs

data/lib/mailkick/service/mailchimp.rb

@@ -3,9 +3,9 @@
 module Mailkick
   class Service
     class Mailchimp < Mailkick::Service
-      def initialize(options = {})
-        @gibbon = ::Gibbon::Request.new(api_key: options[:api_key] || ENV["MAILCHIMP_API_KEY"])
-        @list_id = options[:list_id] || ENV["MAILCHIMP_LIST_ID"]
+      def initialize(api_key: nil, list_id: nil)
+        @gibbon = ::Gibbon::Request.new(api_key: api_key || ENV["MAILCHIMP_API_KEY"])
+        @list_id = list_id || ENV["MAILCHIMP_LIST_ID"]
       end
 
       # TODO paginate

data/lib/mailkick/service/mailgun.rb

@@ -3,10 +3,10 @@
 module Mailkick
   class Service
     class Mailgun < Mailkick::Service
-      def initialize(options = {})
+      def initialize(api_key: nil, domain: nil)
         require "mailgun"
-        mailgun_client = ::Mailgun::Client.new(options[:api_key] || ENV["MAILGUN_API_KEY"])
-        domain = options[:domain] || ActionMailer::Base.smtp_settings[:domain]
+        mailgun_client = ::Mailgun::Client.new(api_key || ENV["MAILGUN_API_KEY"])
+        domain ||= ActionMailer::Base.smtp_settings[:domain]
         @mailgun_events = ::Mailgun::Events.new(mailgun_client, domain)
       end
 

data/lib/mailkick/service/mandrill.rb

@@ -10,11 +10,10 @@ module Mailkick
         "unsub" => "unsubscribe"
       }
 
-      # TODO remove ENV["MANDRILL_APIKEY"]
-      def initialize(options = {})
+      def initialize(api_key: nil)
         require "mandrill"
         @mandrill = ::Mandrill::API.new(
-          options[:api_key] || ENV["MANDRILL_APIKEY"] || ENV["MANDRILL_API_KEY"]
+          api_key || ENV["MANDRILL_APIKEY"] || ENV["MANDRILL_API_KEY"]
         )
       end
 
@@ -29,7 +28,6 @@ module Mailkick
         end
       end
 
-      # TODO remove ENV["MANDRILL_APIKEY"]
       def self.discoverable?
         !!(defined?(::Mandrill::API) && (ENV["MANDRILL_APIKEY"] || ENV["MANDRILL_API_KEY"]))
       end

data/lib/mailkick/service/postmark.rb

@@ -1,24 +1,25 @@
-# https://github.com/wildbit/postmark-gem
+# https://github.com/ActiveCampaign/postmark-gem
 
 module Mailkick
   class Service
     class Postmark < Mailkick::Service
       REASONS_MAP = {
-        "SpamNotification" => "spam",
+        "HardBounce" => "bounce",
         "SpamComplaint" => "spam",
-        "Unsubscribe" => "unsubscribe"
+        "ManualSuppression" => "unsubscribe"
       }
 
-      def initialize(options = {})
-        @client = ::Postmark::ApiClient.new(options[:api_key] || ENV["POSTMARK_API_KEY"])
+      def initialize(api_key: nil, stream_id: "broadcast")
+        @client = ::Postmark::ApiClient.new(api_key || ENV["POSTMARK_API_KEY"])
+        @stream_id = stream_id
       end
 
       def opt_outs
-        bounces
+        suppressions
       end
 
-      def bounces
-        fetch(@client.bounces)
+      def suppressions
+        fetch(@client.dump_suppressions(@stream_id))
       end
 
       def self.discoverable?
@@ -30,9 +31,9 @@ module Mailkick
       def fetch(response)
         response.map do |record|
           {
-            email: record[:email],
-            time: ActiveSupport::TimeZone["UTC"].parse(record[:bounced_at]),
-            reason: REASONS_MAP.fetch(record[:type], "bounce")
+            email: record[:email_address],
+            time: ActiveSupport::TimeZone["UTC"].parse(record[:created_at]),
+            reason: REASONS_MAP[record[:suppression_reason]]
           }
         end
       end

data/lib/mailkick/service/sendgrid.rb

@@ -1,41 +1,48 @@
-# https://github.com/freerobby/sendgrid_toolkit
+# https://github.com/sendgrid/sendgrid-ruby
 
 module Mailkick
   class Service
     class SendGrid < Mailkick::Service
-      def initialize(options = {})
-        @api_user = options[:api_user] || ENV["SENDGRID_USERNAME"]
-        @api_key = options[:api_key] || ENV["SENDGRID_PASSWORD"]
+      def initialize(api_key: nil)
+        @api_key = api_key || ENV["SENDGRID_API_KEY"]
       end
 
-      # TODO paginate
       def opt_outs
         unsubscribes + spam_reports + bounces
       end
 
       def unsubscribes
-        fetch(::SendgridToolkit::Unsubscribes, "unsubscribe")
+        fetch(client.suppression.unsubscribes, "unsubscribe")
       end
 
       def spam_reports
-        fetch(::SendgridToolkit::SpamReports, "spam")
+        fetch(client.suppression.spam_reports, "spam")
       end
 
       def bounces
-        fetch(::SendgridToolkit::Bounces, "bounce")
+        fetch(client.suppression.bounces, "bounce")
       end
 
       def self.discoverable?
-        !!(defined?(::SendgridToolkit) && ENV["SENDGRID_USERNAME"] && ENV["SENDGRID_PASSWORD"])
+        !!(defined?(::SendGrid::API) && ENV["SENDGRID_API_KEY"])
       end
 
       protected
 
-      def fetch(klass, reason)
-        klass.new(@api_user, @api_key).retrieve_with_timestamps.map do |record|
+      def client
+        @client ||= ::SendGrid::API.new(api_key: @api_key).client
+      end
+
+      def fetch(query, reason)
+        # TODO paginate
+        response = query.get
+
+        raise "Bad status code: #{response.status_code}" if response.status_code.to_i != 200
+
+        response.parsed_body.map do |record|
           {
-            email: record["email"],
-            time: record["created"],
+            email: record[:email],
+            time: Time.at(record[:created]),
             reason: reason
           }
         end
@@ -43,6 +50,6 @@ module Mailkick
     end
 
     # backwards compatibility
-    Sendgrid = SendGrid
+    SendGridV2 = SendGrid
   end
 end

data/lib/mailkick/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "1.4.0"
+  VERSION = "2.0.0"
 end

data/lib/mailkick.rb

@@ -6,16 +6,13 @@ require "json"
 require "set"
 
 # modules
-require_relative "mailkick/legacy"
 require_relative "mailkick/model"
-require_relative "mailkick/serializer"
 require_relative "mailkick/service"
 require_relative "mailkick/service/aws_ses"
 require_relative "mailkick/service/mailchimp"
 require_relative "mailkick/service/mailgun"
 require_relative "mailkick/service/mandrill"
 require_relative "mailkick/service/sendgrid"
-require_relative "mailkick/service/sendgrid_v2"
 require_relative "mailkick/service/postmark"
 require_relative "mailkick/url_helper"
 require_relative "mailkick/version"
@@ -34,12 +31,14 @@ module Mailkick
 
   def self.fetch_opt_outs
     services.each(&:fetch_opt_outs)
+    nil
   end
 
   def self.discover_services
     Service.subclasses.each do |service|
       services << service.new if service.discoverable?
     end
+    nil
   end
 
   def self.secret_token=(token)
@@ -48,7 +47,7 @@ module Mailkick
   end
 
   def self.message_verifier
-    @@message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token, serializer: Serializer)
+    @@message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token, serializer: JSON)
   end
 
   def self.generate_token(subscriber, list)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Kane
 bindir: bin
 cert_chain: []
-date: 2025-04-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -32,7 +32,6 @@ files:
 - LICENSE.txt
 - README.md
 - app/controllers/mailkick/subscriptions_controller.rb
-- app/models/mailkick/opt_out.rb
 - app/models/mailkick/subscription.rb
 - app/views/mailkick/subscriptions/show.html.erb
 - config/routes.rb
@@ -41,9 +40,7 @@ files:
 - lib/generators/mailkick/views_generator.rb
 - lib/mailkick.rb
 - lib/mailkick/engine.rb
-- lib/mailkick/legacy.rb
 - lib/mailkick/model.rb
-- lib/mailkick/serializer.rb
 - lib/mailkick/service.rb
 - lib/mailkick/service/aws_ses.rb
 - lib/mailkick/service/mailchimp.rb
@@ -51,7 +48,6 @@ files:
 - lib/mailkick/service/mandrill.rb
 - lib/mailkick/service/postmark.rb
 - lib/mailkick/service/sendgrid.rb
-- lib/mailkick/service/sendgrid_v2.rb
 - lib/mailkick/url_helper.rb
 - lib/mailkick/version.rb
 homepage: https://github.com/ankane/mailkick
@@ -72,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Email subscriptions for Rails
 test_files: []

data/app/models/mailkick/opt_out.rb

@@ -1,7 +0,0 @@
-module Mailkick
-  class OptOut < ActiveRecord::Base
-    self.table_name = "mailkick_opt_outs"
-
-    belongs_to :user, polymorphic: true, optional: true
-  end
-end

data/lib/mailkick/legacy.rb

@@ -1,70 +0,0 @@
-module Mailkick
-  module Legacy
-    # checks for table as long as it exists
-    def self.opt_outs?
-      unless defined?(@opt_outs) && @opt_outs == false
-        @opt_outs = ActiveRecord::Base.connection_pool.with_connection { |c| c.table_exists?("mailkick_opt_outs") }
-      end
-      @opt_outs
-    end
-
-    def self.opted_out?(options)
-      opt_outs(options).any?
-    end
-
-    def self.opt_out(options)
-      unless opted_out?(options)
-        time = options[:time] || Time.now
-        Mailkick::OptOut.create! do |o|
-          o.email = options[:email]
-          o.user = options[:user]
-          o.reason = options[:reason] || "unsubscribe"
-          o.list = options[:list]
-          o.created_at = time
-          o.updated_at = time
-        end
-      end
-      true
-    end
-
-    def self.opt_in(options)
-      opt_outs(options).each do |opt_out|
-        opt_out.active = false
-        opt_out.save!
-      end
-      true
-    end
-
-    def self.opt_outs(options = {})
-      relation = Mailkick::OptOut.where(active: true)
-
-      contact_relation = Mailkick::OptOut.none
-      if (email = options[:email])
-        contact_relation = contact_relation.or(Mailkick::OptOut.where(email: email))
-      end
-      if (user = options[:user])
-        contact_relation = contact_relation.or(
-          Mailkick::OptOut.where("user_id = ? AND user_type = ?", user.id, user.class.name)
-        )
-      end
-      relation = relation.merge(contact_relation) if email || user
-
-      relation =
-        if options[:list]
-          relation.where("list IS NULL OR list = ?", options[:list])
-        else
-          relation.where("list IS NULL")
-        end
-
-      relation
-    end
-
-    def self.opted_out_emails(options = {})
-      Set.new(opt_outs(options).where.not(email: nil).distinct.pluck(:email))
-    end
-
-    def self.opted_out_users(options = {})
-      Set.new(opt_outs(options).where.not(user_id: nil).map(&:user))
-    end
-  end
-end

data/lib/mailkick/serializer.rb

@@ -1,15 +0,0 @@
-# need custom class due to
-# https://github.com/rails/rails/issues/47185
-module Mailkick
-  class Serializer
-    def self.dump(value)
-      ActiveSupport::JSON.encode(value)
-    end
-
-    def self.load(value)
-      ActiveSupport::JSON.decode(value)
-    rescue JSON::ParserError
-      Marshal.load(value)
-    end
-  end
-end

data/lib/mailkick/service/sendgrid_v2.rb

@@ -1,52 +0,0 @@
-# https://github.com/sendgrid/sendgrid-ruby
-
-module Mailkick
-  class Service
-    class SendGridV2 < Mailkick::Service
-      def initialize(options = {})
-        @api_key = options[:api_key] || ENV["SENDGRID_API_KEY"]
-      end
-
-      def opt_outs
-        unsubscribes + spam_reports + bounces
-      end
-
-      def unsubscribes
-        fetch(client.suppression.unsubscribes, "unsubscribe")
-      end
-
-      def spam_reports
-        fetch(client.suppression.spam_reports, "spam")
-      end
-
-      def bounces
-        fetch(client.suppression.bounces, "bounce")
-      end
-
-      def self.discoverable?
-        !!(defined?(::SendGrid::API) && ENV["SENDGRID_API_KEY"])
-      end
-
-      protected
-
-      def client
-        @client ||= ::SendGrid::API.new(api_key: @api_key).client
-      end
-
-      def fetch(query, reason)
-        # TODO paginate
-        response = query.get
-
-        raise "Bad status code: #{response.status_code}" if response.status_code.to_i != 200
-
-        response.parsed_body.map do |record|
-          {
-            email: record[:email],
-            time: Time.at(record[:created]),
-            reason: reason
-          }
-        end
-      end
-    end
-  end
-end