mailkick 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e4c1d35fb49e05d3415afe507e229c2cbe7f4da0e2f684e91b5754a0418422f
-  data.tar.gz: 0fe44b2723b4dbce1d4d5486530a3cbacfc14bfb406c1b47ff28bbb28f2f7a20
+  metadata.gz: 00db7fdae2daa66b3d994ac64b34a084c385fb76d3dfa81d379955d4df0249d3
+  data.tar.gz: f78fce2a60960fc4c821f788bee0458e28f2c005655b972cccc95078abda4952
 SHA512:
-  metadata.gz: 1271af0d6c368f853f77dad646584e4a91b90bde9033c93ce29cba4c5d1a646c298983fcf46d0c89b2979ddf3cb40764e63574846673e29cd9b7f15053f69674
-  data.tar.gz: 37db46884bdec50cb02503e898e3834bc878d83cec5681a616da71f12c3b21236c90d32e9da2e7e2812f0fef88cff99292c73e65d1fe399c765d5a8d9cb45e1a
+  metadata.gz: ed17bf62b821fd7627152d62d02b572d304bbb6221032d76d07ab8c05afeab7304aa1ae2c12e35aa164ec0e081fac5580a00ec215a53ee7cbcffdfee5dc5afaf
+  data.tar.gz: 05a745028f412d6d7c626bd9fa5a20ebd40acd77ee84893078878176ca3f30f37e263676119c29bf142f30c6d2e3963e35b297a9746fbfe1d76557f2a0d3bb8e

data/CHANGELOG.md

@@ -1,20 +1,25 @@
-## 0.4.1
+## 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
+## 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
+## 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
+## 0.3.0 (2018-04-20)
 
 - Improved performance
 - Fixed `Subscription not found` for Rails 5.2
@@ -22,68 +27,68 @@
 - Use `smtp_settings[:domain]` for Mailgun
 - 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/README.md

@@ -89,51 +89,65 @@ Fetch bounces, spam reports, and unsubscribes from your email service.
 Mailkick.fetch_opt_outs
 ```
 
-#### Sendgrid
+The following services are supported:
 
-Add the gem
+- [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.
+#### Mailchimp
 
-#### Mandrill
+Add the gem
 
 ```ruby
-gem 'mandrill-api'
+gem 'gibbon', '>= 2'
 ```
 
-Be sure `ENV["MANDRILL_APIKEY"]` is set.
+And set `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]`.
 
-#### Mailchimp
+#### Mailgun
+
+Add the gem
 
 ```ruby
-gem 'gibbon', '>= 2'
+gem 'mailgun-ruby'
 ```
 
-Be sure `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]` are set.
+And set `ENV["MAILGUN_API_KEY"]`.
 
-#### Mailgun
+#### Mandrill
+
+Add the gem
 
 ```ruby
-gem 'mailgun-ruby'
+gem 'mandrill-api'
 ```
 
-Be sure `ENV["MAILGUN_API_KEY"]` is set.
+And set `ENV["MANDRILL_APIKEY"]`.
 
 #### Postmark
 
+Add the gem
+
 ```ruby
 gem 'postmark'
 ```
 
-Be sure `ENV["POSTMARK_API_KEY"]` is set.
+And set `ENV["POSTMARK_API_KEY"]`.
 
-#### Other
+#### SendGrid
 
-Will gladly accept pull requests.
+Add the gem
+
+```ruby
+gem 'sendgrid-ruby'
+```
+
+And set `ENV["SENDGRID_API_KEY"]`. The API key requires only the `Suppressions` permission.
 
 ### Advanced
 
@@ -141,8 +155,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")
 ]
 ```
 
@@ -229,3 +243,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/lib/mailkick.rb

@@ -1,7 +1,9 @@
 # dependencies
-require "set"
 require "active_support"
 
+# stdlib
+require "set"
+
 # modules
 require "mailkick/model"
 require "mailkick/service"
@@ -9,7 +11,9 @@ 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
@@ -104,6 +108,10 @@ module Mailkick
   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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -188,7 +188,6 @@ files:
 - LICENSE.txt
 - README.md
 - 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
@@ -204,6 +203,8 @@ files:
 - 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
 homepage: https://github.com/ankane/mailkick
 licenses:
@@ -224,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Email subscriptions made easy