mailkick 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00db7fdae2daa66b3d994ac64b34a084c385fb76d3dfa81d379955d4df0249d3
-  data.tar.gz: f78fce2a60960fc4c821f788bee0458e28f2c005655b972cccc95078abda4952
+  metadata.gz: 5a3e1a782d63a1ad223871a87aab2875c73c1a7860f614801184d005113d4d82
+  data.tar.gz: 802fdb1f89e3ca6c25761bb61fd085b1936336ea5fd6bc6a020a1b79a21859c0
 SHA512:
-  metadata.gz: ed17bf62b821fd7627152d62d02b572d304bbb6221032d76d07ab8c05afeab7304aa1ae2c12e35aa164ec0e081fac5580a00ec215a53ee7cbcffdfee5dc5afaf
-  data.tar.gz: 05a745028f412d6d7c626bd9fa5a20ebd40acd77ee84893078878176ca3f30f37e263676119c29bf142f30c6d2e3963e35b297a9746fbfe1d76557f2a0d3bb8e
+  metadata.gz: e93ee8b3bcf05fa1536141e2f9ef639e30efd236eb9d280bb88bc7e234f6a6aa9a246eb91bd6aee188c74226e11cf0cdcb67e636ffafeb76f525f89096ec5eda
+  data.tar.gz: 23441f577b0f294a46f47e61cc66c994a319d1e3d89ff310bd26d997c5b6bdbd2270318fda74de96e588f7da58691c63d3c188853be382a41a3608803034435d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.3 (2020-11-01)
+
+- Added support for AWS SES
+
 ## 0.4.2 (2020-04-06)
 
 - Added support for official SendGrid gem

data/README.md

@@ -1,6 +1,6 @@
 # Mailkick
 
-Email subscriptions made easy
+Email unsubscribes for Rails
 
 - Add one-click unsubscribe links to your emails
 - Fetch bounces and spam reports from your email service
@@ -91,6 +91,7 @@ Mailkick.fetch_opt_outs
 
 The following services are supported:
 
+- [AWS SES](#aws-ses)
 - [Mailchimp](#mailchimp)
 - [Mailgun](#mailgun)
 - [Mandrill](#mandrill)
@@ -99,6 +100,16 @@ The following services are supported:
 
 Will gladly accept pull requests for others.
 
+#### AWS SES
+
+Add the gem
+
+```ruby
+gem 'aws-sdk-sesv2'
+```
+
+And [configure your AWS credentials](https://github.com/aws/aws-sdk-ruby#configuration). Requires `ses:ListSuppressedDestinations` permission.
+
 #### Mailchimp
 
 Add the gem

data/lib/mailkick.rb

@@ -7,6 +7,7 @@ require "set"
 # modules
 require "mailkick/model"
 require "mailkick/service"
+require "mailkick/service/aws_ses"
 require "mailkick/service/mailchimp"
 require "mailkick/service/mailgun"
 require "mailkick/service/mandrill"
@@ -65,17 +66,16 @@ module Mailkick
   def self.opt_outs(options = {})
     relation = Mailkick::OptOut.where(active: true)
 
-    parts = []
-    binds = []
+    contact_relation = Mailkick::OptOut.none
     if (email = options[:email])
-      parts << "email = ?"
-      binds << email
+      contact_relation = contact_relation.or(Mailkick::OptOut.where(email: email))
     end
     if (user = options[:user])
-      parts << "(user_id = ? and user_type = ?)"
-      binds.concat [user.id, user.class.name]
+      contact_relation = contact_relation.or(
+        Mailkick::OptOut.where("user_id = ? AND user_type = ?", user.id, user.class.name)
+      )
     end
-    relation = relation.where(parts.join(" OR "), *binds) if parts.any?
+    relation = relation.merge(contact_relation) if email || user
 
     relation =
       if options[:list]
@@ -87,13 +87,15 @@ module Mailkick
     relation
   end
 
+  # TODO use keyword arguments
   def self.opted_out_emails(options = {})
-    Set.new(opt_outs(options).where("email IS NOT NULL").uniq.pluck(:email))
+    Set.new(opt_outs(options).where.not(email: nil).distinct.pluck(:email))
   end
 
+  # TODO use keyword arguments
   # 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))
+    Set.new(opt_outs(options).where.not(user_id: nil).map(&:user))
   end
 
   def self.message_verifier

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/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: andrew@chartkick.com
 executables: []
 extensions: []
@@ -198,6 +198,7 @@ files:
 - lib/mailkick/engine.rb
 - lib/mailkick/model.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
@@ -210,7 +211,7 @@ homepage: https://github.com/ankane/mailkick
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Email subscriptions made easy
+summary: Email unsubscribes for Rails
 test_files: []