mailkick 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c69391f60c043d1a2ad07d45adf6dd4dcfdfae381570e4e5c6ccc81df0d2ae6
-  data.tar.gz: 18f7747bed0cfd2a802b0ef8464a0d25696acc873c86f2784242c9ff9a8d2db7
+  metadata.gz: f9cc5e031a75a29b20c985acb8b16922338dab5e65a1df97818facd9a94c75e3
+  data.tar.gz: 433257564c2918ad55eeb41efc5219e86720d2d29bca3808ff084ba76a085524
 SHA512:
-  metadata.gz: 39166cce458a3949b88ed4ebc27d49da862039830495693e955a78a7364a8ac5410d6fe4a24f6ba62de6d222e23c13f3920debab9f071223bafae0b57741c1f2
-  data.tar.gz: 5038361e264b4d953d87d6427ef04832ac3dc724dc4f5bb9c9e8a9631e573f2baa2a5c114dd3dc343e7c655cedf3371d3f9187c3785204be895b2a020c6806df
+  metadata.gz: 1c28e41447543e5498ca2f91fa66e1e0cf1dce16160d76d73b883be236f8a5d36091c2e768d3f5668702a371759891e1a3a5187f4a440cb35b313f9021734908
+  data.tar.gz: 1fe58111dc7a26644d68a425be18824a660cf16c4305207c8b63ae8916609381d376a72bd449b4e21b02fe1541e571a210b0086d7947b764e619ed67a3f8a5dd

data/CHANGELOG.md

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

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/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.0"
 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.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-01-19 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.3
 signing_key:
 specification_version: 4
 summary: Email subscriptions for Rails