mailkick 1.2.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c69391f60c043d1a2ad07d45adf6dd4dcfdfae381570e4e5c6ccc81df0d2ae6
-  data.tar.gz: 18f7747bed0cfd2a802b0ef8464a0d25696acc873c86f2784242c9ff9a8d2db7
+  metadata.gz: 6a9bd60adb2d9f1ce219b451369a4c5547f3dea808fa3123e31fb317fccfe843
+  data.tar.gz: 9fab1707325fdc093ddc9123c94d331d6c7b4b17ceaae1d5f8760cdb30b4f74b
 SHA512:
-  metadata.gz: 39166cce458a3949b88ed4ebc27d49da862039830495693e955a78a7364a8ac5410d6fe4a24f6ba62de6d222e23c13f3920debab9f071223bafae0b57741c1f2
-  data.tar.gz: 5038361e264b4d953d87d6427ef04832ac3dc724dc4f5bb9c9e8a9631e573f2baa2a5c114dd3dc343e7c655cedf3371d3f9187c3785204be895b2a020c6806df
+  metadata.gz: 8f1160fff3f3ef81e4ff3d2ab9fae04076e84db93f95ab17f1655a99185331c22783c262dac0433484575371bebedc05750744a1434fdfa6f9d32cac87609050
+  data.tar.gz: f0cfecb317f7fc74848ec9479248f635f268194bfd9d4c38ecda06cb3ec9815eb9c17d8b9044ca38ca0dd459a5e3fe9d8acfefd3d7953ded84b132bb5286a9ff

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.3.1 (2024-09-09)
+
+- Fixed deprecation warning with Rails 7.1
+
+## 1.3.0 (2024-01-18)
+
+- Added support for one-click unsubscribe headers (RFC 8058)
+
 ## 1.2.2 (2023-10-30)
 
 - Fixed error when secret key base set with `SECRET_KEY_BASE_DUMMY`

data/README.md

@@ -2,12 +2,12 @@
 
 Email subscriptions for Rails
 
-- Add one-click unsubscribe links to your emails
+- Add one-click unsubscribe links and headers to your emails
 - Fetch bounces and spam reports from your email service
 
 :postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for analytics
 
-[![Build Status](https://github.com/ankane/mailkick/workflows/build/badge.svg?branch=master)](https://github.com/ankane/mailkick/actions)
+[![Build Status](https://github.com/ankane/mailkick/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/mailkick/actions)
 
 ## Installation
 
@@ -81,6 +81,16 @@ rails generate mailkick:views
 
 which copies the view into `app/views/mailkick`.
 
+## Unsubscribe Headers
+
+For one-click unsubscribe headers ([RFC 8058](https://datatracker.ietf.org/doc/html/rfc8058)), create `config/initializers/mailkick.rb` with:
+
+```ruby
+Mailkick.headers = true
+```
+
+Headers will automatically be added to emails that call `mailkick_unsubscribe_url`.
+
 ## Bounces and Spam Reports
 
 Fetch bounces, spam reports, and unsubscribes from your email service. Create `config/initializers/mailkick.rb` with a method to handle opt outs.
@@ -199,68 +209,6 @@ Access the subscription model directly
 Mailkick::Subscription.all
 ```
 
-## Upgrading
-
-### 1.0
-
-Mailkick 1.0 stores subscriptions instead of opt-outs. To migrate:
-
-1. Add a table to store subscriptions
-
-```sh
-rails generate mailkick:install
-rails db:migrate
-```
-
-2. Change the following methods in your code:
-
-- `mailkick_user` to `has_subscriptions`
-- `User.not_opted_out` to `User.subscribed(list)`
-- `opt_in` to `subscribe(list)`
-- `opt_out` to `unsubscribe(list)`
-- `opted_out?` to `!subscribed?(list)`
-
-3. Add a user and list to `mailkick_unsubscribe_url`
-
-```ruby
-mailkick_unsubscribe_url(user, list)
-```
-
-4. Migrate data for each of your lists
-
-```ruby
-opted_out_emails = Mailkick::Legacy.opted_out_emails(list: nil)
-opted_out_users = Mailkick::Legacy.opted_out_users(list: nil)
-
-User.find_in_batches do |users|
-  users.reject! { |u| opted_out_emails.include?(u.email) }
-  users.reject! { |u| opted_out_users.include?(u) }
-
-  now = Time.now
-  records =
-    users.map do |user|
-      {
-        subscriber_type: user.class.name,
-        subscriber_id: user.id,
-        list: "sales",
-        created_at: now,
-        updated_at: now
-      }
-    end
-
-  # use create! for Active Record < 6
-  Mailkick::Subscription.insert_all!(records)
-end
-```
-
-5. Drop the `mailkick_opt_outs` table
-
-```ruby
-drop_table :mailkick_opt_outs
-```
-
-Also, if you use `Mailkick.fetch_opt_outs`, [add a method](#bounces-and-spam-reports) to handle opt outs.
-
 ## History
 
 View the [changelog](https://github.com/ankane/mailkick/blob/master/CHANGELOG.md)

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -1,6 +1,7 @@
 module Mailkick
   class SubscriptionsController < ActionController::Base
     protect_from_forgery with: :exception
+    skip_forgery_protection only: [:unsubscribe]
 
     before_action :set_subscription
 
@@ -12,7 +13,13 @@ module Mailkick
 
       Mailkick::Legacy.opt_out(legacy_options) if Mailkick::Legacy.opt_outs?
 
-      redirect_to subscription_path(params[:id])
+      if request.post? && params["List-Unsubscribe"] == "One-Click"
+        # must not redirect according to RFC 8058
+        # could render show action instead
+        render plain: "Unsubscribe successful"
+      else
+        redirect_to subscription_path(params[:id])
+      end
     end
 
     def subscribe

data/config/routes.rb

@@ -6,7 +6,7 @@ end
 
 Mailkick::Engine.routes.draw do
   resources :subscriptions, only: [:show] do
-    get :unsubscribe, on: :member
+    match :unsubscribe, on: :member, via: [:get, :post]
     get :subscribe, on: :member
   end
 end

data/lib/mailkick/engine.rb

@@ -13,7 +13,7 @@ module Mailkick
         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/mailkick/model.rb

@@ -3,7 +3,7 @@ module Mailkick
     def has_subscriptions
       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 :subscribed, ->(list) { joins(:mailkick_subscriptions).where(mailkick_subscriptions: {list: list}) }
 
         def subscribe(list)
           mailkick_subscriptions.where(list: list).first_or_create!

data/lib/mailkick/service/postmark.rb

@@ -6,7 +6,7 @@ module Mailkick
       REASONS_MAP = {
         "SpamNotification" => "spam",
         "SpamComplaint" => "spam",
-        "Unsubscribe" => "unsubscribe",
+        "Unsubscribe" => "unsubscribe"
       }
 
       def initialize(options = {})

data/lib/mailkick/url_helper.rb

@@ -2,7 +2,12 @@ module Mailkick
   module UrlHelper
     def mailkick_unsubscribe_url(subscriber, list, **options)
       token = Mailkick.generate_token(subscriber, list)
-      mailkick.unsubscribe_subscription_url(token, **options)
+      url = mailkick.unsubscribe_subscription_url(token, **options)
+      if Mailkick.headers && headers["List-Unsubscribe"].nil?
+        headers["List-Unsubscribe-Post"] ||= "List-Unsubscribe=One-Click"
+        headers["List-Unsubscribe"] = "<#{url}>"
+      end
+      url
     end
   end
 end

data/lib/mailkick/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "1.2.2"
+  VERSION = "1.3.1"
 end

data/lib/mailkick.rb

@@ -24,12 +24,13 @@ require_relative "mailkick/version"
 require_relative "mailkick/engine" if defined?(Rails)
 
 module Mailkick
-  mattr_accessor :services, :mount, :process_opt_outs_method
+  mattr_accessor :services, :mount, :process_opt_outs_method, :headers
   mattr_reader :secret_token
   mattr_writer :message_verifier
   self.services = []
   self.mount = true
   self.process_opt_outs_method = ->(_) { raise "process_opt_outs_method not defined" }
+  self.headers = false
 
   def self.fetch_opt_outs
     services.each(&:fetch_opt_outs)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Email subscriptions for Rails