mailkick 0.3.1 → 1.0.0

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/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/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.3.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,202 +16,50 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: gibbon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: mailgun-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mandrill-api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sendgrid_toolkit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email:
-- andrew@chartkick.com
+        version: '5.2'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - 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/legacy.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
+- 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
-- test/gemfiles/actionmailer42.gemfile
-- test/gemfiles/actionmailer50.gemfile
-- test/gemfiles/actionmailer51.gemfile
-- test/internal/app/mailers/user_mailer.rb
-- test/internal/app/models/user.rb
-- test/internal/app/views/user_mailer/welcome.html.erb
-- test/internal/app/views/user_mailer/welcome.text.erb
-- test/internal/config/database.yml
-- test/internal/db/schema.rb
-- test/mailkick_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/mailkick
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -219,27 +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.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Email subscriptions made easy
-test_files:
-- test/gemfiles/actionmailer42.gemfile
-- test/gemfiles/actionmailer50.gemfile
-- test/gemfiles/actionmailer51.gemfile
-- test/internal/app/mailers/user_mailer.rb
-- test/internal/app/models/user.rb
-- test/internal/app/views/user_mailer/welcome.html.erb
-- test/internal/app/views/user_mailer/welcome.text.erb
-- test/internal/config/database.yml
-- test/internal/db/schema.rb
-- test/mailkick_test.rb
-- test/test_helper.rb
+summary: Email subscriptions for Rails
+test_files: []

data/.gitignore

@@ -1,25 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.log
-*.sqlite
-*.lock