mailkick 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7342fb3956753b14f1345a70153ac76cc6cc73290a7b4c1d9e3f9a1b29e6a216
-  data.tar.gz: 06a13e7037c2ab1ffcab78f93f7a99272aa00b59f3388878ad10498d7ed73e70
+  metadata.gz: 5a3e1a782d63a1ad223871a87aab2875c73c1a7860f614801184d005113d4d82
+  data.tar.gz: 802fdb1f89e3ca6c25761bb61fd085b1936336ea5fd6bc6a020a1b79a21859c0
 SHA512:
-  metadata.gz: 2d0a3d927fee65871caf6b37d79e83663e45c382396e941e03651ec36de13e19680107f9582e4e9010f65454361d32e16b77787d8e0657857029ff05b3e2e510
-  data.tar.gz: 72698be727b60185179d2004af23531cf3812fabf6e68a8ad0d4da4b0119804bc3591dd60aa1f7a5c92b1d3d0c896f5329572a6e331985724f00c8778abb6623
+  metadata.gz: e93ee8b3bcf05fa1536141e2f9ef639e30efd236eb9d280bb88bc7e234f6a6aa9a246eb91bd6aee188c74226e11cf0cdcb67e636ffafeb76f525f89096ec5eda
+  data.tar.gz: 23441f577b0f294a46f47e61cc66c994a319d1e3d89ff310bd26d997c5b6bdbd2270318fda74de96e588f7da58691c63d3c188853be382a41a3608803034435d

data/CHANGELOG.md

@@ -1,73 +1,98 @@
-## 0.3.0
+## 0.4.3 (2020-11-01)
+
+- Added support for AWS SES
+
+## 0.4.2 (2020-04-06)
+
+- Added support for official SendGrid gem
+- Fixed deprecation warning
+
+## 0.4.1 (2019-10-27)
+
+- Added Postmark support
+
+## 0.4.0 (2019-07-15)
+
+- Fixed error with model methods and `email_key` option
+- Fixed bug with `opted_out` scope
+- Dropped support for Action Mailer 4.2
+
+## 0.3.1 (2018-04-21)
+
+- Fixed `Secret should not be nil` error in Rails 5.2
+- Gracefully handle missing email
+- Added `user` option to `mailkick_unsubscribe_url`
+
+## 0.3.0 (2018-04-20)
 
 - Improved performance
 - Fixed `Subscription not found` for Rails 5.2
 - Use `references` in migration
 - Use `smtp_settings[:domain]` for Mailgun
-- Dropped support for ActionMailer < 4.2
+- Dropped support for Action Mailer < 4.2
 
-## 0.2.1
+## 0.2.1 (2017-10-30)
 
 - Fixed errors with Rails 5+
 - Fixed errors with the latest version of Gibbon
 
-## 0.2.0
+## 0.2.0 (2017-05-01)
 
 - Added support for Rails 5.1
 
-## 0.1.6
+## 0.1.6 (2017-01-10)
 
 - Fixed error with frozen strings
 
-## 0.1.5
+## 0.1.5 (2016-12-06)
 
 - Use `safely`
 - Only discover services if not manually set
 - Added `mount` option
 
-## 0.1.4
+## 0.1.4 (2016-02-20)
 
 - Use `Module#prepend` instead of `alias_method_chain`
 
-## 0.1.3
+## 0.1.3 (2015-06-29)
 
 - Fixed issue with double escaping tokens
 
-## 0.1.2
+## 0.1.2 (2015-06-07)
 
 - Added support for Mailgun
 
-## 0.1.1
+## 0.1.1 (2015-01-31)
 
 - Fixed tokens with `+` in them
 
-## 0.1.0
+## 0.1.0 (2014-08-31)
 
 - Fixed secret token for Rails 4.1
 
-## 0.0.6
+## 0.0.6 (2014-05-09)
 
 - Rails 3 fix
 
-## 0.0.5
+## 0.0.5 (2014-05-05)
 
 - Fixed bug with subscriptions page
 
-## 0.0.4
+## 0.0.4 (2014-05-05)
 
 - Added `email_key` option to `mailkick_user`
 
-## 0.0.3
+## 0.0.3 (2014-05-04)
 
 - Added support for multiple lists
 - Changed `mailkick_user` method names - sorry early adopters :(
 
-## 0.0.2
+## 0.0.2 (2014-05-04)
 
 - Added Mailchimp service
 - Fixed Mandrill service
 - Added `uniq` to `subscribed` scope
 
-## 0.0.1
+## 0.0.1 (2014-05-04)
 
 - First release

data/LICENSE.txt

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

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
@@ -89,43 +89,76 @@ Fetch bounces, spam reports, and unsubscribes from your email service.
 Mailkick.fetch_opt_outs
 ```
 
-#### Sendgrid
+The following services are supported:
 
-Add the gem
+- [AWS SES](#aws-ses)
+- [Mailchimp](#mailchimp)
+- [Mailgun](#mailgun)
+- [Mandrill](#mandrill)
+- [Postmark](#postmark)
+- [SendGrid](#sendgrid)
 
-```ruby
-gem 'sendgrid_toolkit'
-```
+Will gladly accept pull requests for others.
 
-Be sure `ENV["SENDGRID_USERNAME"]` and `ENV["SENDGRID_PASSWORD"]` are set.
+#### AWS SES
 
-#### Mandrill
+Add the gem
 
 ```ruby
-gem 'mandrill-api'
+gem 'aws-sdk-sesv2'
 ```
 
-Be sure `ENV["MANDRILL_APIKEY"]` is set.
+And [configure your AWS credentials](https://github.com/aws/aws-sdk-ruby#configuration). Requires `ses:ListSuppressedDestinations` permission.
 
 #### Mailchimp
 
+Add the gem
+
 ```ruby
 gem 'gibbon', '>= 2'
 ```
 
-Be sure `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]` are set.
+And set `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]`.
 
 #### Mailgun
 
+Add the gem
+
 ```ruby
 gem 'mailgun-ruby'
 ```
 
-Be sure `ENV["MAILGUN_API_KEY"]` is set.
+And set `ENV["MAILGUN_API_KEY"]`.
 
-#### Other
+#### Mandrill
+
+Add the gem
+
+```ruby
+gem 'mandrill-api'
+```
+
+And set `ENV["MANDRILL_APIKEY"]`.
 
-Will gladly accept pull requests.
+#### Postmark
+
+Add the gem
+
+```ruby
+gem 'postmark'
+```
+
+And set `ENV["POSTMARK_API_KEY"]`.
+
+#### SendGrid
+
+Add the gem
+
+```ruby
+gem 'sendgrid-ruby'
+```
+
+And set `ENV["SENDGRID_API_KEY"]`. The API key requires only the `Suppressions` permission.
 
 ### Advanced
 
@@ -133,8 +166,8 @@ For more control over services, set them by hand.
 
 ```ruby
 Mailkick.services = [
-  Mailkick::Service::Sendgrid.new(api_key: "API_KEY"),
-  Mailkick::Service::Mandrill.new(api_key: "API_KEY")
+  Mailkick::Service::SendGridV2.new(api_key: "API_KEY"),
+  Mailkick::Service::Mailchimp.new(api_key: "API_KEY", list_id: "LIST_ID")
 ]
 ```
 
@@ -203,6 +236,12 @@ Resubscribe
 user.opt_in
 ```
 
+Access the opt-out model directly
+
+```ruby
+Mailkick::OptOut.all
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/mailkick/blob/master/CHANGELOG.md)
@@ -215,3 +254,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/mailkick/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/mailkick.git
+cd mailkick
+bundle install
+bundle exec rake test
+```

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -31,11 +31,7 @@ module Mailkick
         list: @list
       }
     rescue ActiveSupport::MessageVerifier::InvalidSignature
-      if Rails::VERSION::MAJOR >= 5
-        render plain: "Subscription not found", status: :bad_request
-      else
-        render text: "Subscription not found", status: :bad_request
-      end
+      render plain: "Subscription not found", status: :bad_request
     end
 
     def opted_out?

data/app/models/mailkick/opt_out.rb

@@ -2,6 +2,6 @@ module Mailkick
   class OptOut < ActiveRecord::Base
     self.table_name = "mailkick_opt_outs"
 
-    belongs_to :user, ActiveRecord::VERSION::MAJOR >= 5 ? {polymorphic: true, optional: true} : {polymorphic: true}
+    belongs_to :user, polymorphic: true, optional: true
   end
 end

data/lib/generators/mailkick/install_generator.rb

@@ -1,34 +1,17 @@
-# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module Mailkick
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "install.rb", "db/migrate/install_mailkick.rb", migration_version: migration_version
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/mailkick.rb

@@ -1,15 +1,25 @@
-require "set"
+# dependencies
 require "active_support"
 
-require "mailkick/engine" if defined?(Rails)
+# stdlib
+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"
 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
   self.services = []
@@ -56,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]
@@ -78,25 +87,33 @@ 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
     @message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token)
   end
 
-  def self.generate_token(email, list: nil)
-    user = Mailkick.user_method.call(email) if Mailkick.user_method
+  def self.generate_token(email, user: nil, list: nil)
+    raise ArgumentError, "Missing email" unless email
+
+    user ||= Mailkick.user_method.call(email) if Mailkick.user_method
     message_verifier.generate([email, user.try(:id), user.try(:class).try(: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

@@ -7,7 +7,7 @@ module Mailkick
 
       Mailkick.secret_token ||= begin
         creds =
-          if app.respond_to?(:credentials)
+          if app.respond_to?(:credentials) && app.credentials.secret_key_base
             app.credentials
           elsif app.respond_to?(:secrets)
             app.secrets
@@ -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/model.rb

@@ -3,8 +3,8 @@ module Mailkick
     def mailkick_user(opts = {})
       email_key = opts[:email_key] || :email
       class_eval do
-        scope :opted_out, proc {|options = {}|
-          binds = [self.class.name, true]
+        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]
@@ -13,20 +13,21 @@ module Mailkick
           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 = {}|
+
+        scope :not_opted_out, lambda { |options = {}|
           opted_out(options.merge(not: true))
         }
 
-        def opted_out?(options = {})
-          Mailkick.opted_out?({email: email, user: self}.merge(options))
+        define_method :opted_out? do |options = {}|
+          Mailkick.opted_out?({email: send(email_key), user: self}.merge(options))
         end
 
-        def opt_out(options = {})
-          Mailkick.opt_out({email: email, user: self}.merge(options))
+        define_method :opt_out do |options = {}|
+          Mailkick.opt_out({email: send(email_key), user: self}.merge(options))
         end
 
-        def opt_in(options = {})
-          Mailkick.opt_in({email: email, user: self}.merge(options))
+        define_method :opt_in do |options = {}|
+          Mailkick.opt_in({email: send(email_key), user: self}.merge(options))
         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/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/{app/helpers → lib}/mailkick/url_helper.rb

@@ -1,12 +1,13 @@
 module Mailkick
   module UrlHelper
-    def mailkick_unsubscribe_url(email: nil, list: nil, **options)
-      email ||= controller.message.to.first
+    def mailkick_unsubscribe_url(email: nil, user: nil, list: nil, **options)
+      email ||= controller.try(:message).try(:to).try(:first)
+
       Mailkick::Engine.routes.url_helpers.url_for(
         (ActionMailer::Base.default_url_options || {}).merge(options).merge(
           controller: "mailkick/subscriptions",
           action: "unsubscribe",
-          id: Mailkick.generate_token(email, list: list)
+          id: Mailkick.generate_token(email, user: user, list: list)
         )
       )
     end

data/lib/mailkick/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: postmark
+  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
@@ -164,54 +178,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email:
-- andrew@chartkick.com
+description:
+email: andrew@chartkick.com
 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/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/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 +219,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 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.1.4
+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 unsubscribes for Rails
+test_files: []

data/.gitignore

@@ -1,24 +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

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.2
-sudo: false
-script: bundle exec rake test
-before_script:
-  - gem install bundler
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-gemfile:
-  - Gemfile
-  - test/gemfiles/actionmailer51.gemfile
-  - test/gemfiles/actionmailer50.gemfile
-  - test/gemfiles/actionmailer42.gemfile

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in mailkick.gemspec
-gemspec
-
-gem "actionmailer", "~> 5.2.0"

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.warning = false
-end

data/mailkick.gemspec

@@ -1,32 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mailkick/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "mailkick"
-  spec.version       = Mailkick::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Email subscriptions made easy"
-  spec.homepage      = "https://github.com/ankane/mailkick"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", ">= 4.2"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "gibbon", ">= 2"
-  spec.add_development_dependency "mailgun-ruby"
-  spec.add_development_dependency "mandrill-api"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "sendgrid_toolkit"
-  spec.add_development_dependency "combustion"
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "sqlite3"
-end

data/test/gemfiles/actionmailer42.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in mailkick.gemspec
-gemspec path: "../../"
-
-gem "actionmailer", "~> 4.2.0"

data/test/gemfiles/actionmailer50.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in mailkick.gemspec
-gemspec path: "../../"
-
-gem "actionmailer", "~> 5.0.0"

data/test/gemfiles/actionmailer51.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in mailkick.gemspec
-gemspec path: "../../"
-
-gem "actionmailer", "~> 5.1.0"

data/test/internal/app/mailers/user_mailer.rb

@@ -1,7 +0,0 @@
-class UserMailer < ActionMailer::Base
-  default from: "from@example.com"
-
-  def welcome
-    mail to: "test@example.org", subject: "Hello"
-  end
-end

data/test/internal/app/models/user.rb

@@ -1,3 +0,0 @@
-class User < ActiveRecord::Base
-  mailkick_user
-end

data/test/internal/app/views/user_mailer/welcome.html.erb

@@ -1 +0,0 @@
-<p><%= mailkick_unsubscribe_url %></p>

data/test/internal/app/views/user_mailer/welcome.text.erb

@@ -1 +0,0 @@
-Unsubscribe: <%= mailkick_unsubscribe_url %>

data/test/internal/config/database.yml

@@ -1,3 +0,0 @@
-test:
-  adapter:  sqlite3
-  database: db/combustion_test.sqlite

data/test/internal/db/schema.rb

@@ -1,16 +0,0 @@
-ActiveRecord::Schema.define do
-  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
-    t.string :list
-    t.timestamps
-  end
-
-  add_index :mailkick_opt_outs, :email
-
-  create_table :users do |t|
-    t.string :email
-  end
-end

data/test/mailkick_test.rb

@@ -1,29 +0,0 @@
-require_relative "test_helper"
-
-class MailkickTest < Minitest::Test
-  def test_unsubscribe_url
-    message = UserMailer.welcome.deliver_now
-    html_body = message.html_part.body.to_s
-    assert_includes html_body, "BAhbCUkiFXRlc3RAZXhhbXBsZS5vcmcGOgZFVDAwMA==--f435e91ba90e1732d3e999af1f2126dcc8182a5d"
-    text_body = message.text_part.body.to_s
-    assert_includes text_body, "BAhbCUkiFXRlc3RAZXhhbXBsZS5vcmcGOgZFVDAwMA==--f435e91ba90e1732d3e999af1f2126dcc8182a5d"
-  end
-
-  def test_opt_out
-    email = "test2@example.org"
-    user = User.create!(email: email)
-
-    Mailkick.opt_out(email: email, user: user)
-
-    opt_outs = Mailkick::OptOut.all.to_a
-    assert_equal 1, opt_outs.size
-
-    opt_out = opt_outs.first
-    assert_equal email, opt_out.email
-    assert_equal user, opt_out.user
-
-    assert user.opted_out?
-    assert_equal 1, User.opted_out.count
-    assert_equal 0, User.not_opted_out.count
-  end
-end

data/test/test_helper.rb

@@ -1,20 +0,0 @@
-require "bundler/setup"
-require "combustion"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-require "logger"
-
-Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
-
-Combustion.path = "test/internal"
-Combustion.initialize! :all do
-  if config.active_record.sqlite3.respond_to?(:represent_boolean_as_integer)
-    config.active_record.sqlite3.represent_boolean_as_integer = false
-  end
-end
-
-ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
-ActionMailer::Base.delivery_method = :test
-
-Mailkick.secret_token = "test123"