mailkick 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f16bb5b552006639122c94a4b910982ed0845694bb503dfac08e23e3ed41f24
-  data.tar.gz: c82b3290c80af68f5d9817a38a4d30af8d5893a216121154182457d96f0904dc
+  metadata.gz: 53b4cfd8b344ad6273e734bad7531baaab340b50777e2e0590f2780b8ba72e96
+  data.tar.gz: 99d9c057e6fba352bc509368d49e4abda33fc6abd996ffef199866943e8625bf
 SHA512:
-  metadata.gz: a31f0bb8e3a84e0abcc6bca052a815fd4f98eb8130572903e010d479bc3e46c219ea0efb4b89cfba09d8cb3e7fd68a42f7c99716a1e4228ea9b65af6e663b21e
-  data.tar.gz: e9e0cc2fac1d027ee28650077977d30abcce514e4064eb27b73e0650147828f292bcae32631cdb600271b9a5e50ddd24603e1d328231a1227d523571cfdb003c
+  metadata.gz: 31c98f092a8fcf4f2deef3b6c2a1d385e1b7cc13df3d05ddaa35b9cd460c9d9fca966972abc59ba5cf20d3ff2442410ad809d109af1ddbb9c178ee14bb934701
+  data.tar.gz: 3b6b152bd2154d13fb88f5fe38d67297a4909c3b7f95b8401f7065020501f59eff2bad0642cd38be980f07df8b26506376c669d87c580886b765b521b59419bd

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 3.0.0 (2026-08-08)
+
+See the [upgrade notes](https://github.com/ankane/mailkick?tab=readme-ov-file#30)
+
+- Added `confirm_unsubscribe` option
+- Enabled `headers` by default
+- Improved CSP support
+- Fixed change to key generator hash digest class
+- Dropped support for Ruby < 3.3 and Rails < 7.2
+
+## 2.0.0 (2025-06-23)
+
+See the [upgrade notes](https://github.com/ankane/mailkick/blob/v2.0.0/README.md#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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2025 Andrew Kane
+Copyright (c) 2014-2026 Andrew Kane
 
 MIT License
 

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 3.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)
@@ -81,16 +83,20 @@ rails generate mailkick:views
 
 which copies the view into `app/views/mailkick`.
 
+To add a confirmation step to prevent issues with scanners, create `config/initializers/mailkick.rb` with:
+
+```ruby
+Mailkick.confirm_unsubscribe = true
+```
+
 ## Unsubscribe Headers
 
-For one-click unsubscribe headers ([RFC 8058](https://datatracker.ietf.org/doc/html/rfc8058)), create `config/initializers/mailkick.rb` with:
+One-click unsubscribe headers ([RFC 8058](https://datatracker.ietf.org/doc/html/rfc8058)) are automatically added to emails that call `mailkick_unsubscribe_url`. To disable, create `config/initializers/mailkick.rb` with:
 
 ```ruby
-Mailkick.headers = true
+Mailkick.headers = false
 ```
 
-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.
@@ -126,8 +132,6 @@ The following services are supported:
 - [Postmark](#postmark)
 - [SendGrid](#sendgrid)
 
-Will gladly accept pull requests for others.
-
 #### AWS SES
 
 Add the gem
@@ -168,7 +172,7 @@ Add the gem
 gem "mandrill-api"
 ```
 
-And set `ENV["MANDRILL_APIKEY"]`.
+And set `ENV["MANDRILL_API_KEY"]`.
 
 #### Postmark
 
@@ -196,7 +200,7 @@ For more control over services, set them by hand.
 
 ```ruby
 Mailkick.services = [
-  Mailkick::Service::SendGridV2.new(api_key: "API_KEY"),
+  Mailkick::Service::SendGrid.new(api_key: "API_KEY"),
   Mailkick::Service::Mailchimp.new(api_key: "API_KEY", list_id: "LIST_ID")
 ]
 ```
@@ -209,6 +213,32 @@ Access the subscription model directly
 Mailkick::Subscription.all
 ```
 
+Prefix method names with `mailkick_`
+
+```ruby
+class User < ApplicationRecord
+  has_subscriptions prefix: true
+end
+```
+
+## Upgrading
+
+### 3.0
+
+Versions 1.1.0-2.0.0 cause applications to use SHA1 for the key generator hash digest class if `Mailkick.secret_token` is not manually set (due to [this behavior in Rails](https://github.com/rails/rails/issues/56736)).
+
+To avoid breakage when upgrading, add to `config/application.rb`:
+
+```ruby
+config.active_support.key_generator_hash_digest_class = OpenSSL::Digest::SHA1
+```
+
+Also, one-click unsubscribe headers are enabled by default. To disable, create an initializer with:
+
+```ruby
+Mailkick.headers = false
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/mailkick/blob/master/CHANGELOG.md)

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -9,14 +9,16 @@ module Mailkick
     end
 
     def unsubscribe
-      subscription.delete_all
+      defer = Mailkick.confirm_unsubscribe && request.get? && !params[:confirmed]
 
-      Mailkick::Legacy.opt_out(legacy_options) if Mailkick::Legacy.opt_outs?
+      subscription.delete_all unless defer
 
       if request.post? && params["List-Unsubscribe"] == "One-Click"
         # must not redirect according to RFC 8058
         # could render show action instead
         render plain: "Unsubscribe successful"
+      elsif defer
+        render :show
       else
         redirect_to subscription_path(params[:id])
       end
@@ -25,8 +27,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
 
@@ -56,26 +56,28 @@ module Mailkick
     end
     helper_method :opted_out?
 
+    def unsubscribing?
+      action_name == "unsubscribe"
+    end
+    helper_method :unsubscribing?
+
     def subscribe_url
       subscribe_subscription_path(params[:id])
     end
     helper_method :subscribe_url
 
+    # custom views created before 3.0 will use GET instead of POST
+    # add confirmed parameter to ensure unsubscribed
     def unsubscribe_url
-      unsubscribe_subscription_path(params[:id])
+      unsubscribe_subscription_path(params[:id], {confirmed: true})
     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)
+    def style_nonce
+      if request.content_security_policy_nonce_directives&.include?("style-src")
+        content_security_policy_nonce
       end
-      {
-        email: @email,
-        user: user,
-        list: @list
-      }
     end
+    helper_method :style_nonce
   end
 end

data/app/views/mailkick/subscriptions/show.html.erb

@@ -3,33 +3,39 @@
   <head>
     <title>Subscriptions</title>
 
-    <style>
+    <%= content_tag :style, nonce: style_nonce do %>
       body {
         padding: 20px;
-        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+        font-family: system-ui, "Helvetica Neue", Arial, Helvetica, sans-serif;
         font-size: 14px;
         line-height: 1.4;
       }
 
-      a {
-        color: blue;
-      }
-
       .container {
         max-width: 500px;
         margin-left: auto;
         margin-right: auto;
       }
-    </style>
+
+      button {
+        cursor: pointer;
+        font: inherit;
+        padding: 5px 10px;
+      }
+    <% end %>
   </head>
   <body>
     <div class="container">
       <% if !subscribed? %>
         <p>You are unsubscribed.</p>
-        <p><%= link_to "Resubscribe", subscribe_url %></p>
+        <p><%= button_to "Resubscribe", subscribe_url %></p>
       <% else %>
-        <p>You are subscribed.</p>
-        <p><%= link_to "Unsubscribe", unsubscribe_url %></p>
+        <% if unsubscribing? %>
+          <p>Click the button below to confirm.</p>
+        <% else %>
+          <p>You are subscribed.</p>
+        <% end %>
+        <p><%= button_to "Unsubscribe", unsubscribe_url %></p>
       <% end %>
     </div>
   </body>

data/config/routes.rb

@@ -7,6 +7,7 @@ end
 Mailkick::Engine.routes.draw do
   resources :subscriptions, only: [:show] do
     match :unsubscribe, on: :member, via: [:get, :post]
-    get :subscribe, on: :member
+    # support GET for custom views created before 3.0
+    match :subscribe, on: :member, via: [:get, :post]
   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,8 @@ 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
+      # avoid app.key_generator due to https://github.com/ankane/ahoy_email/pull/168
+      Mailkick.secret_token ||= ActiveSupport::KeyGenerator.new(app.secret_key_base, iterations: 1000, hash_digest_class: OpenSSL::Digest::SHA1).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 = "3.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"
@@ -24,22 +21,25 @@ require_relative "mailkick/version"
 require_relative "mailkick/engine" if defined?(Rails)
 
 module Mailkick
-  mattr_accessor :services, :mount, :process_opt_outs_method, :headers
+  mattr_accessor :services, :mount, :process_opt_outs_method, :headers, :confirm_unsubscribe
   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
+  self.headers = true
+  self.confirm_unsubscribe = false
 
   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 +48,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: 3.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
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -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
@@ -65,14 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.16
 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