mailkick 0.1.4 → 1.0.1

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

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

data/lib/mailkick/engine.rb

@@ -3,11 +3,19 @@ module Mailkick
     isolate_namespace Mailkick
 
     initializer "mailkick" do |app|
-      Mailkick.discover_services
-      secrets = app.respond_to?(:secrets) ? app.secrets : app.config
-      Mailkick.secret_token ||= secrets.respond_to?(:secret_key_base) ? secrets.secret_key_base : secrets.secret_token
-      ActiveSupport.on_load :action_mailer do
-        helper Mailkick::UrlHelper
+      Mailkick.discover_services unless Mailkick.services.any?
+
+      Mailkick.secret_token ||= begin
+        creds =
+          if app.respond_to?(:credentials) && app.credentials.secret_key_base
+            app.credentials
+          elsif app.respond_to?(:secrets)
+            app.secrets
+          else
+            app.config
+          end
+
+        creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
       end
     end
   end

data/lib/mailkick/legacy.rb

@@ -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

@@ -1,32 +1,22 @@
 module Mailkick
   module Model
-    def mailkick_user(options = {})
-      email_key = options[:email_key] || :email
+    def has_subscriptions
       class_eval do
-        scope :opted_out, proc {|options = {}|
-          binds = [self.class.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)
-        }
-        scope :not_opted_out, proc {|options = {}|
-          opted_out(options.merge(not: true))
-        }
+        has_many :mailkick_subscriptions, class_name: "Mailkick::Subscription", as: :subscriber
+        scope :subscribed, -> (list) { joins(:mailkick_subscriptions).where(mailkick_subscriptions: {list: list}) }
 
-        def opted_out?(options = {})
-          Mailkick.opted_out?({email: email, user: self}.merge(options))
+        def subscribe(list)
+          mailkick_subscriptions.where(list: list).first_or_create!
+          nil
         end
 
-        def opt_out(options = {})
-          Mailkick.opt_out({email: email, user: self}.merge(options))
+        def unsubscribe(list)
+          mailkick_subscriptions.where(list: list).delete_all
+          nil
         end
 
-        def opt_in(options = {})
-          Mailkick.opt_in({email: email, user: self}.merge(options))
+        def subscribed?(list)
+          mailkick_subscriptions.where(list: list).exists?
         end
       end
     end

data/lib/mailkick/service/aws_ses.rb

@@ -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

data/lib/mailkick/service/mailchimp.rb

@@ -4,7 +4,7 @@ module Mailkick
   class Service
     class Mailchimp < Mailkick::Service
       def initialize(options = {})
-        @gibbon = ::Gibbon::API.new(options[:api_key] || ENV["MAILCHIMP_API_KEY"])
+        @gibbon = ::Gibbon::Request.new(api_key: options[:api_key] || ENV["MAILCHIMP_API_KEY"])
         @list_id = options[:list_id] || ENV["MAILCHIMP_LIST_ID"]
       end
 
@@ -14,11 +14,11 @@ module Mailkick
       end
 
       def unsubscribes
-        fetch(@gibbon.lists.members(id: @list_id, status: "unsubscribed"), "unsubscribe")
+        fetch(@gibbon.lists(@list_id).members.retrieve(params: {status: "unsubscribed"}).body["members"], "unsubscribe")
       end
 
       def spam_reports
-        fetch(@gibbon.lists.abuse_reports(id: @list_id), "spam")
+        fetch(@gibbon.lists(@list_id).abuse_reports.retrieve.body["abuse_reports"], "spam")
       end
 
       def self.discoverable?
@@ -28,9 +28,9 @@ module Mailkick
       protected
 
       def fetch(response, reason)
-        response["data"].map do |record|
+        response.map do |record|
           {
-            email: record["email"],
+            email: record["email_address"],
             time: ActiveSupport::TimeZone["UTC"].parse(record["timestamp_opt"] || record["date"]),
             reason: reason
           }

data/lib/mailkick/service/mailgun.rb

@@ -6,7 +6,7 @@ module Mailkick
       def initialize(options = {})
         require "mailgun"
         mailgun_client = ::Mailgun::Client.new(options[:api_key] || ENV["MAILGUN_API_KEY"])
-        domain = options[:domain] || ActionMailer::Base.default_url_options[:host]
+        domain = options[:domain] || ActionMailer::Base.smtp_settings[:domain]
         @mailgun_events = ::Mailgun::Events.new(mailgun_client, domain)
       end
 

data/lib/mailkick/service/mandrill.rb

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

data/lib/mailkick/service/postmark.rb

@@ -0,0 +1,41 @@
+# https://github.com/wildbit/postmark-gem
+
+module Mailkick
+  class Service
+    class Postmark < Mailkick::Service
+      REASONS_MAP = {
+        "SpamNotification" => "spam",
+        "SpamComplaint" => "spam",
+        "Unsubscribe" => "unsubscribe",
+      }
+
+      def initialize(options = {})
+        @client = ::Postmark::ApiClient.new(options[:api_key] || ENV["POSTMARK_API_KEY"])
+      end
+
+      def opt_outs
+        bounces
+      end
+
+      def bounces
+        fetch(@client.bounces)
+      end
+
+      def self.discoverable?
+        !!(defined?(::Postmark) && ENV["POSTMARK_API_KEY"])
+      end
+
+      protected
+
+      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")
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mailkick/service/sendgrid.rb

@@ -2,7 +2,7 @@
 
 module Mailkick
   class Service
-    class Sendgrid < Mailkick::Service
+    class SendGrid < Mailkick::Service
       def initialize(options = {})
         @api_user = options[:api_user] || ENV["SENDGRID_USERNAME"]
         @api_key = options[:api_key] || ENV["SENDGRID_PASSWORD"]
@@ -41,5 +41,8 @@ module Mailkick
         end
       end
     end
+
+    # backwards compatibility
+    Sendgrid = SendGrid
   end
 end

data/lib/mailkick/service/sendgrid_v2.rb

@@ -0,0 +1,52 @@
+# 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

data/lib/mailkick/service.rb

@@ -1,21 +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/url_helper.rb

@@ -0,0 +1,8 @@
+module Mailkick
+  module UrlHelper
+    def mailkick_unsubscribe_url(subscriber, list, **options)
+      token = Mailkick.generate_token(subscriber, list)
+      mailkick.unsubscribe_subscription_url(token, **options)
+    end
+  end
+end

data/lib/mailkick/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "0.1.4"
+  VERSION = "1.0.1"
 end

data/lib/mailkick.rb

@@ -1,19 +1,31 @@
-require "mailkick/version"
-require "mailkick/engine"
-require "mailkick/processor"
-require "mailkick/mailer"
+# dependencies
+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/mailgun"
-require "set"
+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
+  mattr_accessor :services, :secret_token, :mount, :process_opt_outs_method
   self.services = []
-  self.user_method = proc { |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)
@@ -25,67 +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
+  def self.message_verifier
+    @message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token)
   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.generate_token(subscriber, list)
+    raise ArgumentError, "Missing subscriber" unless subscriber
+    raise ArgumentError, "Missing list" unless list.present?
 
-  def self.opted_out_emails(options = {})
-    Set.new(opt_outs(options).where("email IS NOT NULL").uniq.pluck(:email))
+    message_verifier.generate([nil, subscriber.id, subscriber.class.name, list])
   end
+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
+ActiveSupport.on_load :action_mailer do
+  helper Mailkick::UrlHelper
 end
 
-ActionMailer::Base.send(:prepend, Mailkick::Mailer)
-ActiveRecord::Base.send(:extend, Mailkick::Model) if defined?(ActiveRecord)
+ActiveSupport.on_load(:active_record) do
+  extend Mailkick::Model
+end

metadata

@@ -1,81 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '5.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Email subscriptions made easy
-email:
-- andrew@chartkick.com
+        version: '5.2'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - app/controllers/mailkick/subscriptions_controller.rb
-- app/helpers/mailkick/url_helper.rb
 - app/models/mailkick/opt_out.rb
+- app/models/mailkick/subscription.rb
 - app/views/mailkick/subscriptions/show.html.erb
 - config/routes.rb
 - lib/generators/mailkick/install_generator.rb
-- lib/generators/mailkick/templates/install.rb
+- lib/generators/mailkick/templates/install.rb.tt
 - lib/generators/mailkick/views_generator.rb
 - lib/mailkick.rb
 - lib/mailkick/engine.rb
-- lib/mailkick/mailer.rb
+- lib/mailkick/legacy.rb
 - lib/mailkick/model.rb
-- lib/mailkick/processor.rb
 - lib/mailkick/service.rb
+- lib/mailkick/service/aws_ses.rb
 - lib/mailkick/service/mailchimp.rb
 - lib/mailkick/service/mailgun.rb
 - 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
-- mailkick.gemspec
 homepage: https://github.com/ankane/mailkick
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,17 +67,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Email subscriptions made easy
+summary: Email subscriptions for Rails
 test_files: []
-has_rdoc: