postmark-rails 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2a5b9a0937f1bda26743204ebeef53656210e5b
-  data.tar.gz: d56a163059b6b033a376ac762adcbe66601bd059
+  metadata.gz: 11103f47e603b5ae549757fb861bff414067ca90
+  data.tar.gz: 862e1cb8268be1498a138440ba5abb63ea4a8045
 SHA512:
-  metadata.gz: 1bba6d10683068621f0468af583b5a93ca0739056cbab26730fd3dbc9765f02225ebdc3509b72e6f09cefbb1d46d24d7da143e71cf877d0e33a455222247e37d
-  data.tar.gz: eac0b6e74a69acaa17e5c970ea45a00b1df47d5bd46a0ea06c20005e5fb7777cb4941a01db5268c3186fbbfa23a955a764fba546506664d6a309cff56393a9b3
+  metadata.gz: eaf79340d2482125dd51cf6b380c5bc33aac14bb2718a46735bea798df0ef185a68ee94509129a011369014e4978588f3d2f0c39ba71aaa4162668b4dc745f20
+  data.tar.gz: b260ee5d8aa82bcbd7492fb91a812faac8365dd18d0ae95ce4a2e6714ad9750964e7dba32c1a167b030b5f38a9460336f3cb06246dbfd739d268bf3611a6ff3c

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = Changelog
 
+== 0.16.0
+
+* Update the postmark gem dependency to 1.11.x.
+* Added a section on error handling to the README.
+
 == 0.15.0
 
 * Update the postmark gem dependency to 1.10.x.

data/Gemfile

@@ -3,6 +3,6 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
-  gem 'mime-types', '~> 1.25.1'
+  gem 'rspec', '~> 3.7'
+  gem 'mime-types', '~> 3.1'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Petyo Ivanov
+Copyright (c) 2009 Wildbit LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -14,24 +14,26 @@ For Rails 2.3 please take a look at [version 0.4](https://github.com/wildbit/pos
 
 ## Configuring your Rails application
 
-Add this to your Gemfile: (change version numbers if needed)
+Add `postmark-rails` to your Gemfile (change version numbers if needed) and run `bundle install`.
 
 ``` ruby
 gem 'postmark-rails', '~> 0.15.0'
 ```
 
-Don’t forget to run `bundle install` command every time you change something in the Gemfile.
+Save your Postmark API token to [config/secrets.yml](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml).
 
-Add this to your config/application.rb:
+``` yaml
+postmark_api_token: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+```
+
+Set Postmark as your preferred mail delivery method via `config/application.rb`:
 
 ``` ruby
 config.action_mailer.delivery_method = :postmark
-config.action_mailer.postmark_settings = { :api_token => "your-api-token" }
+config.action_mailer.postmark_settings = { :api_token => Rails.application.secrets.postmark_api_token }
 ```
 
-The `postmark_settings` hash can contain [all options](https://github.com/wildbit/postmark-gem#communicating-with-the-api) supported by `Postmark::ApiClient`.
-
-For the API details, refer to the [developer documentation](http://developer.postmarkapp.com).
+**Note**: The `postmark_settings` hash can contain [any options](https://github.com/wildbit/postmark-gem#communicating-with-the-api) supported by `Postmark::ApiClient`.
 
 ## Tracking opens and tagging your deliveries
 
@@ -102,6 +104,101 @@ messages.all?(&:delivered)
 # => true
 ```
 
+## Error handling
+
+The gem respects the `ActionMailer::Base.raise_delivery_errors` setting and will surpress any exceptions
+if it’s set to `false`. When delivery errors are enabled, the gem can raise any one of the exceptions
+listed in the [postmark](https://github.com/wildbit/postmark-gem#error-handling) gem docs.
+
+
+### ActionMailer 5
+
+For ActionMailer 5 and above, use `ActionMailer::Base.rescue_from` to define handlers for
+each error you care about.
+
+#### Example
+
+``` ruby
+class ApplicationMailer < ActionMailer::Base
+  default from: 'user@example.org'
+  layout 'mailer'
+
+  rescue_from Postmark::InactiveRecipientError, with: :reactivate_and_retry
+
+  private
+
+  def postmark_client
+    ::Postmark::ApiClient.new(ActionMailer::Base.postmark_settings[:api_token],
+                              ActionMailer::Base.postmark_settings.except(:api_token))
+  end
+
+
+  # This is just an example. Sometimes you might not want to reactivate
+  # an address that hard bounced.
+  # Warning: Having too many bounces can affect your delivery reputation
+  # with email providers
+  def reactivate_and_retry(error)
+    Rails.logger.info("Error when sending #{message} to #{error.recipients.join(', ')}")
+    Rails.logger.info(error)
+
+    error.recipients.each do |recipient|
+      bounce = postmark_client.bounces(emailFilter: recipient).first
+      next unless bounce
+      postmark_client.activate_bounce(bounce[:id])
+    end
+
+    # Try again immediately
+    message.deliver
+  end
+end
+```
+
+### ActionMailer 4 and below
+
+Wrap any calls to `#deliver_now` in error handlers like the one described
+in the [postmark](https://github.com/wildbit/postmark-gem#error-handling) gem
+docs.
+
+Rails 4.2 introduces `#deliver_later` but doesn’t support `rescue_from` for
+mailer classes. Instead, use the following monkey patch for
+`ActionMailer::DeliveryJob`.
+
+``` ruby
+# app/mailers/application_mailer.rb
+
+class ApplicationMailer < ActionMailer::Base
+  default from: 'user@example.org'
+end
+
+class ActionMailer::DeliveryJob
+  rescue_from Postmark::InactiveRecipientError, with: :reactivate_and_retry
+
+  def postmark_client
+    ::Postmark::ApiClient.new(ActionMailer::Base.postmark_settings[:api_token],
+                              ActionMailer::Base.postmark_settings.except(:api_token))
+  end
+
+
+  # This is just an example. Sometimes you might not want to reactivate
+  # an address that hard bounced.
+  # Warning: Having too many bounces can affect your delivery reputation
+  # with email providers
+  def reactivate_and_retry(error)
+    Rails.logger.info("Error when sending a message to #{error.recipients.join(', ')}")
+    Rails.logger.info(error)
+
+    error.recipients.each do |recipient|
+      bounce = postmark_client.bounces(emailFilter: recipient).first
+      next unless bounce
+      postmark_client.activate_bounce(bounce[:id])
+    end
+
+    # Try again immediately
+    perform(*arguments)
+  end
+end
+```
+
 ## Additional information
 
 Looking for the advanced usage examples? Check out [the documentation](https://github.com/wildbit/postmark-gem/blob/master/README.md) for the `postmark` gem. The `postmark-rails` gem is built on top of it, so you can benefit from all its features.
@@ -133,4 +230,4 @@ Looking for the advanced usage examples? Check out [the documentation](https://g
 
 ## Copyright
 
-Copyright © 2010—2013 Wildbit LLC. See LICENSE for details.
+Copyright © 2010—2018 Wildbit LLC. See LICENSE for details.

data/gemfiles/Gemfile.actionmailer-3.0.x

@@ -4,11 +4,11 @@ gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
 gem 'rake', '< 11.0.0'
-gem 'postmark', '~> 1.10.0', :path => ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.11.0', :path => ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 3.0.0'
 gem 'rack-cache', '~> 1.2.0'
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
+  gem 'rspec', '~> 3.7'
   gem 'mime-types', '~> 1.25.1'
 end

data/gemfiles/Gemfile.actionmailer-3.2.x

@@ -4,12 +4,12 @@ gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
 gem 'rake', '< 11.0.0'
-gem 'postmark', '~> 1.10.0', :path => ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.11.0', :path => ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', :github => 'rails', :branch => '3-2-stable'
 gem 'i18n', '~> 0.6.0'
 gem 'rack-cache', '~> 1.2.0'
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
+  gem 'rspec', '~> 3.7'
   gem 'mime-types', '~> 1.25.1'
 end

data/gemfiles/Gemfile.actionmailer-4.0.x

@@ -3,10 +3,10 @@ source "https://rubygems.org"
 gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
-gem 'postmark', '~> 1.10.0', path: ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.11.0', path: ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 4.0.0'
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
+  gem 'rspec', '~> 3.7'
   gem 'mime-types', '~> 1.25.1'
 end

data/gemfiles/Gemfile.actionmailer-4.1.x

@@ -3,10 +3,10 @@ source "https://rubygems.org"
 gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
-gem 'postmark', '~> 1.10.0', path: ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.11.0', path: ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 4.1.0'
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
+  gem 'rspec', '~> 3.7'
   gem 'mime-types', '~> 1.25.1'
 end

data/gemfiles/Gemfile.actionmailer-4.2.x

@@ -3,10 +3,10 @@ source "https://rubygems.org"
 gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
-gem 'postmark', '~> 1.10.0', path: ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.11.0', path: ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 4.2.0'
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
+  gem 'rspec', '~> 3.7'
   gem 'mime-types', '~> 1.25.1'
 end

data/lib/postmark-rails/version.rb

@@ -1,3 +1,3 @@
 module PostmarkRails
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/postmark-rails.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
 
   s.add_dependency('actionmailer', ">= 3.0.0")
-  s.add_dependency('postmark', "~> 1.10.0")
+  s.add_dependency('postmark', "~> 1.11.0")
 
   s.add_development_dependency("rake")
 

data/spec/postmark-rails_spec.rb

@@ -35,8 +35,8 @@ describe "PostmarkRails3" do
   it "allows to enable open tracking" do
     expect(Postmark::ApiClient).to receive(:new) { api_client }
     expect(api_client).to receive(:deliver_message) do |message|
-      expect(message.track_opens).to be_true
-      expect(message.to_postmark_hash['TrackOpens']).to be_true
+      expect(message.track_opens).to be_truthy
+      expect(message.to_postmark_hash['TrackOpens']).to be true
     end
     deliver(TestMailer.tracked_message)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark-rails
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Postmark adapter for ActionMailer