RubyGems - mailkick - Versions diffs - 0.4.0 → 1.0.1 - Mend

mailkick 0.4.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +40 -18
data/LICENSE.txt +1 -1
data/README.md +151 -89
data/app/controllers/mailkick/subscriptions_controller.rb +37 -15
data/app/models/mailkick/subscription.rb +9 -0
data/app/views/mailkick/subscriptions/show.html.erb +1 -1
data/lib/generators/mailkick/install_generator.rb +1 -1
data/lib/generators/mailkick/templates/install.rb.tt +3 -6
data/lib/mailkick.rb +18 -68
data/lib/mailkick/engine.rb +0 -4
data/lib/mailkick/legacy.rb +70 -0
data/lib/mailkick/model.rb +11 -22
data/lib/mailkick/service.rb +1 -16
data/lib/mailkick/service/aws_ses.rb +47 -0
data/lib/mailkick/service/postmark.rb +41 -0
data/lib/mailkick/service/sendgrid.rb +4 -1
data/lib/mailkick/service/sendgrid_v2.rb +52 -0
data/lib/mailkick/url_helper.rb +8 -0
data/lib/mailkick/version.rb +1 -1
metadata +18 -153
data/app/helpers/mailkick/url_helper.rb +0 -15

data/app/controllers/mailkick/subscriptions_controller.rb CHANGED Viewed

@@ -2,40 +2,50 @@ module Mailkick
   class SubscriptionsController < ActionController::Base
     protect_from_forgery with: :exception
-    before_action :set_email
+    before_action :set_subscription
     def show
     end
     def unsubscribe
-      Mailkick.opt_out(@options)
+      subscription.delete_all
+      Mailkick::Legacy.opt_out(legacy_options) if Mailkick::Legacy.opt_outs?
       redirect_to subscription_path(params[:id])
     end
     def subscribe
-      Mailkick.opt_in(@options)
+      subscription.first_or_create!
+      Mailkick::Legacy.opt_in(legacy_options) if Mailkick::Legacy.opt_outs?
       redirect_to subscription_path(params[:id])
     end
     protected
-    def set_email
-      @email, user_id, user_type, @list = Mailkick.message_verifier.verify(params[:id])
-      if user_type
-        # on the unprobabilistic chance user_type is compromised, not much damage
-        @user = user_type.constantize.find(user_id)
-      end
-      @options = {
-        email: @email,
-        user: @user,
-        list: @list
-      }
+    def set_subscription
+      @email, @subscriber_id, @subscriber_type, @list = Mailkick.message_verifier.verify(params[:id])
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       render plain: "Subscription not found", status: :bad_request
     end
+    def subscription
+      Mailkick::Subscription.where(
+        subscriber_id: @subscriber_id,
+        subscriber_type: @subscriber_type,
+        list: @list
+      )
+    end
+    def subscribed?
+      subscription.exists?
+    end
+    helper_method :subscribed?
     def opted_out?
-      Mailkick.opted_out?(@options)
+      !subscribed?
     end
     helper_method :opted_out?
@@ -48,5 +58,17 @@ 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/app/models/mailkick/subscription.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Mailkick
+  class Subscription < ActiveRecord::Base
+    self.table_name = "mailkick_subscriptions"
+    belongs_to :subscriber, polymorphic: true
+    validates :list, presence: true
+  end
+end

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

@@ -24,7 +24,7 @@
   </head>
   <body>
     <div class="container">
-      <% if opted_out? %>
+      <% if !subscribed? %>
         <p>You are unsubscribed.</p>
         <p><%= link_to "Resubscribe", subscribe_url %></p>
       <% else %>

data/lib/generators/mailkick/install_generator.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module Mailkick
       source_root File.join(__dir__, "templates")
       def copy_migration
-        migration_template "install.rb", "db/migrate/install_mailkick.rb", migration_version: migration_version
+        migration_template "install.rb", "db/migrate/create_mailkick_subscriptions.rb", migration_version: migration_version
       end
       def migration_version

data/lib/generators/mailkick/templates/install.rb.tt CHANGED Viewed

@@ -1,14 +1,11 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :mailkick_opt_outs do |t|
-      t.string :email
-      t.references :user, polymorphic: true
-      t.boolean :active, null: false, default: true
-      t.string :reason
+    create_table :mailkick_subscriptions do |t|
+      t.references :subscriber, polymorphic: true, index: false
       t.string :list
       t.timestamps
     end
-    add_index :mailkick_opt_outs, :email
+    add_index :mailkick_subscriptions, [:subscriber_type, :subscriber_id, :list], unique: true, name: "index_mailkick_subscriptions_on_subscriber_and_list"
   end
 end

data/lib/mailkick.rb CHANGED Viewed

@@ -1,24 +1,31 @@
 # dependencies
-require "set"
 require "active_support"
+# stdlib
+require "set"
 # modules
+require "mailkick/legacy"
 require "mailkick/model"
 require "mailkick/service"
+require "mailkick/service/aws_ses"
 require "mailkick/service/mailchimp"
 require "mailkick/service/mailgun"
 require "mailkick/service/mandrill"
 require "mailkick/service/sendgrid"
+require "mailkick/service/sendgrid_v2"
+require "mailkick/service/postmark"
+require "mailkick/url_helper"
 require "mailkick/version"
 # integrations
 require "mailkick/engine" if defined?(Rails)
 module Mailkick
-  mattr_accessor :services, :user_method, :secret_token, :mount
+  mattr_accessor :services, :secret_token, :mount, :process_opt_outs_method
   self.services = []
-  self.user_method = ->(email) { User.where(email: email).first rescue nil }
   self.mount = true
+  self.process_opt_outs_method = ->(_) { raise "process_opt_outs_method not defined" }
   def self.fetch_opt_outs
     services.each(&:fetch_opt_outs)
@@ -30,79 +37,22 @@ module Mailkick
     end
   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)
-    parts = []
-    binds = []
-    if (email = options[:email])
-      parts << "email = ?"
-      binds << email
-    end
-    if (user = options[:user])
-      parts << "(user_id = ? and user_type = ?)"
-      binds.concat [user.id, user.class.name]
-    end
-    relation = relation.where(parts.join(" OR "), *binds) if parts.any?
-    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("email IS NOT NULL").uniq.pluck(:email))
-  end
-  # does not take into account emails
-  def self.opted_out_users(options = {})
-    Set.new(opt_outs(options).where("user_id IS NOT NULL").map(&:user))
-  end
   def self.message_verifier
     @message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token)
   end
-  def self.generate_token(email, user: nil, list: nil)
-    raise ArgumentError, "Missing email" unless email
+  def self.generate_token(subscriber, list)
+    raise ArgumentError, "Missing subscriber" unless subscriber
+    raise ArgumentError, "Missing list" unless list.present?
-    user ||= Mailkick.user_method.call(email) if Mailkick.user_method
-    message_verifier.generate([email, user.try(:id), user.try(:class).try(:name), list])
+    message_verifier.generate([nil, subscriber.id, subscriber.class.name, list])
   end
 end
+ActiveSupport.on_load :action_mailer do
+  helper Mailkick::UrlHelper
+end
 ActiveSupport.on_load(:active_record) do
   extend Mailkick::Model
 end

data/lib/mailkick/engine.rb CHANGED Viewed

@@ -17,10 +17,6 @@ module Mailkick
         creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
       end
-      ActiveSupport.on_load :action_mailer do
-        helper Mailkick::UrlHelper
-      end
     end
   end
 end

data/lib/mailkick/legacy.rb ADDED Viewed

@@ -0,0 +1,70 @@
+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.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/model.rb CHANGED Viewed

@@ -1,33 +1,22 @@
 module Mailkick
   module Model
-    def mailkick_user(opts = {})
-      email_key = opts[:email_key] || :email
+    def has_subscriptions
       class_eval do
-        scope :opted_out, lambda { |options = {}|
-          binds = [name, true]
-          if options[:list]
-            query = "(mailkick_opt_outs.list IS NULL OR mailkick_opt_outs.list = ?)"
-            binds << options[:list]
-          else
-            query = "mailkick_opt_outs.list IS NULL"
-          end
-          where("#{options[:not] ? 'NOT ' : ''}EXISTS(SELECT * FROM mailkick_opt_outs WHERE (#{table_name}.#{email_key} = mailkick_opt_outs.email OR (#{table_name}.#{primary_key} = mailkick_opt_outs.user_id AND mailkick_opt_outs.user_type = ?)) AND mailkick_opt_outs.active = ? AND #{query})", *binds)
-        }
+        has_many :mailkick_subscriptions, class_name: "Mailkick::Subscription", as: :subscriber
+        scope :subscribed, -> (list) { joins(:mailkick_subscriptions).where(mailkick_subscriptions: {list: list}) }
-        scope :not_opted_out, lambda { |options = {}|
-          opted_out(options.merge(not: true))
-        }
-        define_method :opted_out? do |options = {}|
-          Mailkick.opted_out?({email: send(email_key), user: self}.merge(options))
+        def subscribe(list)
+          mailkick_subscriptions.where(list: list).first_or_create!
+          nil
         end
-        define_method :opt_out do |options = {}|
-          Mailkick.opt_out({email: send(email_key), user: self}.merge(options))
+        def unsubscribe(list)
+          mailkick_subscriptions.where(list: list).delete_all
+          nil
         end
-        define_method :opt_in do |options = {}|
-          Mailkick.opt_in({email: send(email_key), user: self}.merge(options))
+        def subscribed?(list)
+          mailkick_subscriptions.where(list: list).exists?
         end
       end
     end

data/lib/mailkick/service.rb CHANGED Viewed

@@ -1,22 +1,7 @@
 module Mailkick
   class Service
     def fetch_opt_outs
-      opt_outs.each do |api_data|
-        email = api_data[:email]
-        time = api_data[:time]
-        opt_out = Mailkick::OptOut.where(email: email).order("updated_at desc").first
-        if !opt_out || (time > opt_out.updated_at && !opt_out.active)
-          Mailkick.opt_out(
-            email: email,
-            user: Mailkick.user_method ? Mailkick.user_method.call(email) : nil,
-            reason: api_data[:reason],
-            time: time
-          )
-        end
-      end
-      true
+      Mailkick.process_opt_outs_method.call(opt_outs)
     end
   end
 end

data/lib/mailkick/service/aws_ses.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html
+module Mailkick
+  class Service
+    class AwsSes < Mailkick::Service
+      REASONS_MAP = {
+        "BOUNCE" => "bounce",
+        "COMPLAINT" => "spam"
+      }
+      def initialize(options = {})
+        @options = options
+      end
+      def opt_outs
+        response = client.list_suppressed_destinations({
+          reasons: ["BOUNCE", "COMPLAINT"],
+          # TODO make configurable
+          start_date: Time.now - (86400 * 365),
+          end_date: Time.now
+        })
+        opt_outs = []
+        response.each do |page|
+          page.suppressed_destination_summaries.each do |record|
+            opt_outs << {
+              email: record.email_address,
+              time: record.last_update_time,
+              reason: REASONS_MAP[record.reason]
+            }
+          end
+        end
+        opt_outs
+      end
+      def self.discoverable?
+        !!defined?(::Aws::SESV2::Client)
+      end
+      private
+      def client
+        @client ||= ::Aws::SESV2::Client.new
+      end
+    end
+  end
+end