postmark-rails 0.16.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 11103f47e603b5ae549757fb861bff414067ca90
-  data.tar.gz: 862e1cb8268be1498a138440ba5abb63ea4a8045
+SHA256:
+  metadata.gz: 13b5d927c9a95b15fca7756699014d8d7c6aad06ca2c89393f146d730e643503
+  data.tar.gz: 44a410c53c18648827593cdc549997ee30d8fcca0ae11e8c9ac2c0a274ce8deb
 SHA512:
-  metadata.gz: eaf79340d2482125dd51cf6b380c5bc33aac14bb2718a46735bea798df0ef185a68ee94509129a011369014e4978588f3d2f0c39ba71aaa4162668b4dc745f20
-  data.tar.gz: b260ee5d8aa82bcbd7492fb91a812faac8365dd18d0ae95ce4a2e6714ad9750964e7dba32c1a167b030b5f38a9460336f3cb06246dbfd739d268bf3611a6ff3c
+  metadata.gz: 7c779410e7e648223fe32a193ed602a2ee98c5050ec7fde4fa727e6c1090fa1757cb59dc9cf53a57bc6a9911f1579edf78fe945bdb9abf60e268c32ce6f9df95
+  data.tar.gz: 8c46978be1f750f5e088ee2d0ea2ca7b6d32d084611f05d5213387eb19db7a5526736bb6915a77bd9466b039121f1faf6d3f345d522ffbb509ea5fd28c7ffc4a

data/.gitignore

@@ -8,3 +8,4 @@ pkg
 .rvmrc
 Gemfile.lock
 gemfiles/*.lock
+**/*.idea

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.3
   - 2.0.0
-  - 2.1.9
-  - 2.2.5
+  - 2.1.10
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - 2.7.0
 script: bundle exec rake spec
 gemfile:
   - Gemfile
@@ -13,22 +16,68 @@ gemfile:
   - gemfiles/Gemfile.actionmailer-4.0.x
   - gemfiles/Gemfile.actionmailer-4.1.x
   - gemfiles/Gemfile.actionmailer-4.2.x
+  - gemfiles/Gemfile.actionmailer-5.0.x
+  - gemfiles/Gemfile.actionmailer-5.1.x
+  - gemfiles/Gemfile.actionmailer-5.2.x
+  - gemfiles/Gemfile.actionmailer-6.0.x
 matrix:
   exclude:
-    - rvm: 1.8.7
-      gemfile: Gemfile
-    - rvm: 1.9.3
-      gemfile: Gemfile
     - rvm: 2.0.0
       gemfile: Gemfile
-    - rvm: 2.1.9
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.actionmailer-5.0.x
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.actionmailer-5.1.x
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.actionmailer-5.2.x
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.actionmailer-6.0.x
+
+    - rvm: 2.1.10
       gemfile: Gemfile
-    - rvm: 1.8.7
+    - rvm: 2.1.10
+      gemfile: gemfiles/Gemfile.actionmailer-5.0.x
+    - rvm: 2.1.10
+      gemfile: gemfiles/Gemfile.actionmailer-5.1.x
+    - rvm: 2.1.10
+      gemfile: gemfiles/Gemfile.actionmailer-5.2.x
+    - rvm: 2.1.10
+      gemfile: gemfiles/Gemfile.actionmailer-6.0.x
+
+    - rvm: 2.2.10
+      gemfile: gemfiles/Gemfile.actionmailer-6.0.x
+
+    - rvm: 2.3.8
+      gemfile: gemfiles/Gemfile.actionmailer-6.0.x
+
+    - rvm: 2.4.5
+      gemfile: gemfiles/Gemfile.actionmailer-6.0.x
+
+    - rvm: 2.5.3
+      gemfile: gemfiles/Gemfile.actionmailer-3.0.x
+    - rvm: 2.5.3
+      gemfile: gemfiles/Gemfile.actionmailer-3.2.x
+
+    - rvm: 2.6.0
+      gemfile: gemfiles/Gemfile.actionmailer-3.0.x
+    - rvm: 2.6.0
+      gemfile: gemfiles/Gemfile.actionmailer-3.2.x
+    - rvm: 2.6.0
+      gemfile: gemfiles/Gemfile.actionmailer-4.0.x
+    - rvm: 2.6.0
+      gemfile: gemfiles/Gemfile.actionmailer-4.1.x
+    - rvm: 2.6.0
+      gemfile: gemfiles/Gemfile.actionmailer-4.2.x
+
+    - rvm: 2.7.0
+      gemfile: gemfiles/Gemfile.actionmailer-3.0.x
+    - rvm: 2.7.0
+      gemfile: gemfiles/Gemfile.actionmailer-3.2.x
+    - rvm: 2.7.0
       gemfile: gemfiles/Gemfile.actionmailer-4.0.x
-    - rvm: 1.8.7
+    - rvm: 2.7.0
       gemfile: gemfiles/Gemfile.actionmailer-4.1.x
-    - rvm: 1.8.7
+    - rvm: 2.7.0
       gemfile: gemfiles/Gemfile.actionmailer-4.2.x
 before_install:
-  - gem update --system
-  - gem install bundler
+  - .travis/setup.sh

data/.travis/setup.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -eax
+
+echo "Configuring Ruby and Bundler..."
+echo "TRAVIS_RUBY_VERSION=${TRAVIS_RUBY_VERSION}"
+
+if [[ "$TRAVIS_RUBY_VERSION" < "2.3" ]];
+then
+  gem install bundler -v '< 2'
+else
+  gem install bundler
+fi

data/CHANGELOG.rdoc

@@ -1,5 +1,32 @@
 = Changelog
 
+== 0.21.0
+
+* Update minimum postmark gem dependency to avoid use of TLS v1
+
+== 0.20.0
+
+* Update the postmark gem dependency to 1.x
+* Added support for Rails 6
+* Dropped support for Ruby 1.8.7 and 1.9.3
+* Added support for Ruby 2.7
+
+== 0.19.0
+
+* Update the postmark gem dependency to 1.15.x.
+* Added support for templated mailers.
+* Added source_code_uri to the gemspec.
+* Tested against all stable versions of ActionMailer 3.0-5.2 and Ruby 1.8.7-2.6.0.
+
+== 0.18.0
+
+* Update the postmark gem dependency to 1.14.x.
+
+== 0.17.0
+
+* Add support for metadata.
+* Update the postmark gem dependency to 1.13.x.
+
 == 0.16.0
 
 * Update the postmark gem dependency to 1.11.x.

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Before you report an issue or submit a pull request
+
+*If you are blocked or need help with Postmark, please [contact
+Postmark Support](https://postmarkapp.com/contact)*. For other, non-urgent
+cases you’re welcome to report a bug and/or contribute to this project. We will
+make our best effort to review your contributions and triage any bug reports in
+a timely fashion.
+
+If you’d like to submit a pull request:
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important to prevent future regressions.
+* Do not mess with rakefile, version, or history.
+* Update the CHANGELOG, list your changes under Unreleased.
+* Update the README if necessary.
+* Write short, descriptive commit messages, following the format used in therepo.
+* Send a pull request. Bonus points for topic branches.

data/README.md

@@ -1,221 +1,93 @@
-# postmark-rails gem
+<a href="https://postmarkapp.com">
+    <img src="postmark.png" alt="Postmark Logo" title="Postmark" width="120" height="120" align="right">
+</a>
+
+# Postmark Rails Gem
 
 [![Build Status](https://travis-ci.org/wildbit/postmark-rails.svg?branch=master)](https://travis-ci.org/wildbit/postmark-rails) [![Code Climate](https://codeclimate.com/github/wildbit/postmark-rails/badges/gpa.svg)](https://codeclimate.com/github/wildbit/postmark-rails)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://www.opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/postmark-rails.svg)](https://badge.fury.io/rb/postmark-rails)
 
-The Postmark Rails Gem is a drop-in plug-in for ActionMailer to send emails via [Postmark](https://postmarkapp.com), an email delivery service for web apps. The gem has been created for fast implementation and fully supports all of [Postmark’s features](https://postmarkapp.com/why).
+[Postmark](https://postmarkapp.com) allows you to send your emails with high delivery rates.
+It also includes detailed statistics. In addition, Postmark can parse incoming emails which are forwarded back to your application.
 
-## Supported Rails Versions
+The Postmark Rails Gem is a drop-in plug-in for ActionMailer to send emails via [Postmark](https://postmarkapp.com).
+The gem has been created for fast implementation and fully supports all of [Postmark’s features](https://postmarkapp.com/why).
 
-* Rails 5.0
-* Rails 4.x
-* Rails 3.x
+## Usage
 
-For Rails 2.3 please take a look at [version 0.4](https://github.com/wildbit/postmark-rails/tree/v0.4.2). It may miss some new features, but receives all required bug fixes and other support if needed.
+Please see the [wiki](https://github.com/wildbit/postmark-rails/wiki) for detailed instructions about library features.
+For details about Postmark API in general, please check out [Postmark developer docs](https://postmarkapp.com/developer).
 
-## Configuring your Rails application
-
-Add `postmark-rails` to your Gemfile (change version numbers if needed) and run `bundle install`.
-
-``` ruby
-gem 'postmark-rails', '~> 0.15.0'
-```
-
-Save your Postmark API token to [config/secrets.yml](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml).
+## Requirements
 
-``` yaml
-postmark_api_token: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-```
+You will need a Postmark account, server and sender signature (or verified domain) set up to use it.
+For details about setup, check out [wiki pages](https://github.com/wildbit/postmark-rails/wiki/Getting-Started).
 
-Set Postmark as your preferred mail delivery method via `config/application.rb`:
+Also you will need a [postmark gem](https://github.com/wildbit/postmark-gem) version 1.0 and higher is required.
 
-``` ruby
-config.action_mailer.delivery_method = :postmark
-config.action_mailer.postmark_settings = { :api_token => Rails.application.secrets.postmark_api_token }
-```
+### Supported Rails Versions
 
-**Note**: The `postmark_settings` hash can contain [any options](https://github.com/wildbit/postmark-gem#communicating-with-the-api) supported by `Postmark::ApiClient`.
+* Rails 6.0
+* Rails 5.0
+* Rails 4.x
+* Rails 3.x
 
-## Tracking opens and tagging your deliveries
+For Rails 2.3 please take a look at [version 0.4](https://github.com/wildbit/postmark-rails/tree/v0.4.2).
+It may miss some new features, but receives all required bug fixes and other support if needed.
 
-You can use tags to categorize outgoing messages and attach application-specific information. Tagging the different types of email that you send lets you [review statistics and bounce reports separately](http://developer.postmarkapp.com/developer-build.html#message-format).
+## Installation
 
-Pass `:track_opens => 'true'` to enable/disable open tracking on per-message basis. Check out the [Triggers API](https://github.com/wildbit/postmark-gem/wiki/The-Triggers-API-Support) to see how Postmark can help you control this with tags. **Note that we pass a string here, since it becomes a header value. Passing a boolean may or may not work depending on your Rails version.**
+Add `postmark-rails` to your Gemfile and run `bundle install`.
 
 ``` ruby
-class TestMailer < ActionMailer::Base
-
-  def tagged_message
-    mail(
-      :subject => 'hello',
-      :to      => 'sheldon@bigbangtheory.com',
-      :from    => 'leonard@bigbangtheory.com',
-      :tag     => 'my-tag',
-      :track_opens => 'true'
-    )
-  end
-
-end
+gem 'postmark-rails'
 ```
 
-## Sending attachments
 
-You can also send file attachments with Postmark. Read our Developer docs for [additional information](http://developer.postmarkapp.com/developer-build.html#attachments).
 
-The Postmark gem is compatible with [ActionMailer attachments API](http://api.rubyonrails.org/classes/ActionMailer/Base.html#method-i-attachments). It allows you to specify the name, content-type and other attributes for your attachments.
+## Rails 6
+Save your Postmark Server API Token to [config/credentials.yml.enc](https://guides.rubyonrails.org/security.html#custom-credentials):
 
-The legacy `:postmark_attachments` attribute is *no longer supported* on Rails 3.2.13 and above.
+run `rails secret`, then run `rails credentials:edit` and add:
 
-``` ruby
-class TestMailer < ActionMailer::Base
-
-  def message_with_attachment
-    attachments.inline['logo.png'] = File.read("/path/to/image") # Inline image
-    attachments['42.jpg'] = File.read("/path/to/file") # Attached file
-    mail(
-      :subject              => 'hello',
-      :to                   => 'sheldon@bigbangtheory.com',
-      :from                 => 'leonard@bigbangtheory.com'
-    )
-  end
-
-end
+``` yaml
+postmark_api_token: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 ```
-
-## Sending in batches
-
-While Postmark is focused on transactional email, we understand that developers
-with higher volumes or processing time constraints need to send their messages
-in batches. To facilitate this we provide a batching endpoint that permits you
-to send up to 500 well-formed Postmark messages in a single API call.
+Set Postmark as your preferred mail delivery method via `config/application.rb`:
 
 ``` ruby
-client = Postmark::ApiClient.new('your-api-token')
-
-messages = []
-messages << DigestMailer.weekly_digest(@user1)
-messages << DigestMailer.weekly_digest(@user2)
-
-client.deliver_messages(messages)
-
-messages.first.delivered?
-# => true
-
-messages.all?(&:delivered)
-# => true
+config.action_mailer.delivery_method = :postmark
+config.action_mailer.postmark_settings = { api_token: Rails.application.credentials.postmark_api_token }
 ```
 
-## Error handling
+## Rails 3-5
+Save your Postmark Server API token to [config/secrets.yml](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml).
 
-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
+``` yaml
+postmark_api_token: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 ```
 
-### 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`.
+Set Postmark as your preferred mail delivery method via `config/application.rb`:
 
 ``` 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
+config.action_mailer.delivery_method = :postmark
+config.action_mailer.postmark_settings = { :api_token => Rails.application.secrets.postmark_api_token }
 ```
 
-## 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.
+**Note**: The `postmark_settings` hash can contain [any options](https://github.com/wildbit/postmark-gem#communicating-with-the-api) supported by `Postmark::ApiClient`.
 
-## Requirements
 
-* `postmark` gem version 1.0 and higher is required.
-* You will also need a Postmark account, a server and at least one sender signature set up to use it. To get an account, [sign up](https://postmarkapp.com/sign_up)!
+### 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](https://github.com/wildbit/postmark-gem).
+The `postmark-rails` gem is built on top of it, so you can benefit from all it's features.
 
 ## Note on Patches/Pull Requests
 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so we don’t break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-* Send a pull request. Bonus points for topic branches.
+See [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
 
 ## Authors & Contributors
 
@@ -228,6 +100,16 @@ Looking for the advanced usage examples? Check out [the documentation](https://g
 * Nicolás Sanguinetti
 * Laust Rud Jacobsen (rud)
 
+## Issues & Comments
+
+Feel free to contact us if you encounter any issues with the library or Postmark API.
+Please leave all comments, bugs, requests and issues on the Issues page.
+
+## License
+
+The Postmark Rails gem is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) license.
+Refer to the [LICENSE](https://github.com/wildbit/postmark-rails/blob/master/LICENSE) file for more information.
+
 ## Copyright
 
-Copyright © 2010—2018 Wildbit LLC. See LICENSE for details.
+Copyright © 2021 Wildbit LLC.

data/gemfiles/Gemfile.actionmailer-3.0.x

@@ -4,7 +4,7 @@ gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
 gem 'rake', '< 11.0.0'
-gem 'postmark', '~> 1.11.0', :path => ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.15', :path => ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 3.0.0'
 gem 'rack-cache', '~> 1.2.0'
 

data/gemfiles/Gemfile.actionmailer-3.2.x

@@ -4,7 +4,7 @@ gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
 gem 'rake', '< 11.0.0'
-gem 'postmark', '~> 1.11.0', :path => ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.15', :path => ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', :github => 'rails', :branch => '3-2-stable'
 gem 'i18n', '~> 0.6.0'
 gem 'rack-cache', '~> 1.2.0'

data/gemfiles/Gemfile.actionmailer-4.0.x

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
-gem 'postmark', '~> 1.11.0', path: ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 4.0.0'
 
 group :test do

data/gemfiles/Gemfile.actionmailer-4.1.x

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
-gem 'postmark', '~> 1.11.0', path: ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 4.1.0'
 
 group :test do

data/gemfiles/Gemfile.actionmailer-4.2.x

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec :path => '../'
 
 gem 'json', '< 2.0.0'
-gem 'postmark', '~> 1.11.0', path: ENV['POSTMARK_GEM_PATH']
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
 gem 'actionmailer', '~> 4.2.0'
 
 group :test do

data/gemfiles/Gemfile.actionmailer-5.0.x

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec :path => '../'
+
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
+gem 'actionmailer', '~> 5.0.0'
+
+group :test do
+  gem 'rspec', '~> 3.7'
+  gem 'mime-types', '~> 3.2.2'
+end

data/gemfiles/Gemfile.actionmailer-5.1.x

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec :path => '../'
+
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
+gem 'actionmailer', '~> 5.1.0'
+
+group :test do
+  gem 'rspec', '~> 3.7'
+  gem 'mime-types', '~> 3.2.2'
+end

data/gemfiles/Gemfile.actionmailer-5.2.x

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec :path => '../'
+
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
+gem 'actionmailer', '~> 5.2.0'
+
+group :test do
+  gem 'rspec', '~> 3.7'
+  gem 'mime-types', '~> 3.2.2'
+end

data/gemfiles/Gemfile.actionmailer-6.0.x

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec :path => '../'
+
+gem 'postmark', '~> 1.15', path: ENV['POSTMARK_GEM_PATH']
+gem 'actionmailer', '~> 6.0.0'
+
+group :test do
+  gem 'rspec', '~> 3.7'
+  gem 'mime-types', '~> 3.2.2'
+end

data/lib/postmark-rails.rb

@@ -3,10 +3,21 @@ require 'action_mailer'
 require 'postmark'
 
 module PostmarkRails
-  extend self
+  module ActionMailerExtensions
+    def metadata
+      @_message.metadata
+    end
 
-  def install
+    def metadata=(val)
+      @_message.metadata=(val)
+    end
+  end
+
+  def self.install
+    require 'postmark-rails/preview_interceptor'
+    require 'postmark-rails/templated_mailer'
     ActionMailer::Base.add_delivery_method :postmark, Mail::Postmark
+    ActionMailer::Base.send(:include, ActionMailerExtensions)
   end
 end
 

data/lib/postmark-rails/preview_interceptor.rb

@@ -0,0 +1,10 @@
+module PostmarkRails
+  class PreviewInterceptor
+    def self.previewing_email(message)
+      return unless message.templated?
+
+      message.delivery_method(::Mail::Postmark, ::ActionMailer::Base.postmark_settings)
+      message.prerender
+    end
+  end
+end

data/lib/postmark-rails/templated_mailer.rb

@@ -0,0 +1,68 @@
+require 'active_support/hash_with_indifferent_access'
+
+module PostmarkRails
+  module TemplatedMailerMixin
+    READ_ONLY_HEADERS = %w(body content_type subject).freeze
+    BODY_STUB = 'Temporary Postmark Template Body'.freeze
+    SUBJECT_STUB = 'Temporary Postmark Template Subject'.freeze
+    ALIAS_STUB = proc { action_name }
+
+    def self.included(mailer)
+      mailer.default(
+        :body => BODY_STUB,
+        :content_type => 'text/plain',
+        :subject => SUBJECT_STUB,
+        :postmark_template_alias => ALIAS_STUB
+      )
+      mailer.extend(ClassMethods)
+    end
+
+    def template_model(*args)
+      message.template_model(*args)
+    end
+
+    def template_model=(model)
+      message.template_model = model
+    end
+
+    def mail(headers = {})
+      super(self.class.safe_headers(headers))
+    ensure
+      message.body = standard_template_body
+      message.subject = standard_template_subject
+    end
+
+    private
+
+    module ClassMethods
+      def default(headers = {})
+        super(safe_headers(headers))
+      end
+
+      def safe_headers(headers = {})
+        headers = ActiveSupport::HashWithIndifferentAccess.new(headers)
+        violation = READ_ONLY_HEADERS.find { |h| headers.key?(h) }
+        raise ArgumentError, "Overriding '#{violation}' header in a templated mailer is not allowed." if violation
+        headers
+      end
+    end
+
+    def standard_template_body
+      "This message is using a Postmark template.\n\n" \
+      "Alias: #{message.template_alias.inspect}\n" \
+      "Model:\n#{JSON.pretty_generate(message.template_model || {})}\n\n" \
+      'Use the #prerender method on this object to contact the Postmark API ' \
+      "to pre-render the template.\n\n" \
+      "Cheers,\n" \
+      'Your friends at Postmark'
+    end
+
+    def standard_template_subject
+      "Postmark Template: #{message.template_alias.inspect}"
+    end
+  end
+
+  class TemplatedMailer < ::ActionMailer::Base
+    include TemplatedMailerMixin
+  end
+end

data/lib/postmark-rails/version.rb

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

data/postmark-rails.gemspec

@@ -10,6 +10,10 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://postmarkapp.com}
   s.summary = %q{Postmark adapter for ActionMailer}
 
+  s.metadata = {
+    "source_code_uri" => "https://github.com/wildbit/postmark-rails"
+  }
+
   s.extra_rdoc_files = [
     "LICENSE",
      "README.md"
@@ -17,7 +21,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
 
   s.add_dependency('actionmailer', ">= 3.0.0")
-  s.add_dependency('postmark', "~> 1.11.0")
+  s.add_dependency('postmark', '>= 1.21.3', '< 2.0')
 
   s.add_development_dependency("rake")
 

data/spec/fixtures/models/test_mailer.rb

@@ -32,6 +32,11 @@ class TestMailer < ActionMailer::Base
     mail(:subject => "Message with inline image.")
   end
 
+  def message_with_metadata
+    metadata['foo'] = 'bar'
+    mail(:subject => 'Message with metadata.')
+  end
+
   protected
 
   def image_file

data/spec/fixtures/views/test_mailer/message_with_metadata.text.erb

@@ -0,0 +1 @@
+This is a message with metadata.

data/spec/integration/delivery_spec.rb

@@ -42,4 +42,12 @@ describe "Delivering messages with postmark-rails" do
     expect { message.deliver }.to change{message.delivered?}.to(true)
   end
 
-end
+  it 'delivers a message with metadata' do
+    message = TestMailer.message_with_metadata
+
+    request = message.to_postmark_hash
+
+    expect(request['Metadata']).to eq('foo' => 'bar')
+    expect { message.deliver }.to change { message.delivered? }.to true
+  end
+end

data/spec/spec_helper.rb

@@ -10,3 +10,12 @@ ActionMailer::Base.delivery_method = :postmark
 ActionMailer::Base.prepend_view_path(File.join(File.dirname(__FILE__), "fixtures", "views"))
 
 Dir["#{File.dirname(__FILE__)}/fixtures/models/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  def make_mailer(base, &block)
+    mailer = Class.new(base, &block)
+    @mailer_number = 0
+    stub_const("Mailer#{@mailer_number += 1}", mailer)
+    mailer
+  end
+end

data/spec/unit/preview_interceptor_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe PostmarkRails::PreviewInterceptor do
+  describe '.previewing_email' do
+    subject(:preview) { described_class.previewing_email(message) }
+    let(:settings) { { :api_token => 'secret' } }
+
+    before do
+      ActionMailer::Base.postmark_settings = settings
+    end
+
+    context 'when given a templated message' do
+      let(:message) do
+        Mail::Message.new do
+          template_alias 'foo'
+        end
+      end
+
+      it 'changes the message' do
+        message.freeze
+        expect { preview }.to raise_error(StandardError, /can't modify/)
+      end
+
+      it 'changes delivery method to Postmark and prerenders' do
+        expect(message).to receive(:prerender).exactly(1)
+        expect { preview }.to change { message.delivery_method }.to(Mail::Postmark)
+        expect(message.delivery_method.settings).to eq(settings)
+      end
+    end
+
+    context 'when given a non-templated message' do
+      let(:message) { Mail::Message.new }
+
+      it 'returns the message "as is"' do
+        message.freeze
+        expect { preview }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/unit/templated_mailer_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+RSpec.describe PostmarkRails::TemplatedMailer do
+  subject(:message) { mailer.test_message }
+
+  shared_examples_for 'templated message' do |template_alias, model|
+    it { is_expected.to be_templated }
+    specify { expect(message.template_alias).to eq(template_alias) }
+    specify { expect(message.template_model).to eq model }
+    specify { expect(message.subject).to eq "Postmark Template: #{template_alias.inspect}" }
+    specify { expect(message.body_text).to include(template_alias.inspect) }
+    specify { expect(message.body_text).to include(JSON.pretty_generate(model || {})) }
+  end
+
+  context 'when template is not specified' do
+    let(:mailer) do
+      make_mailer(described_class) do
+        def test_message
+          mail :from => 'sender@wildbit.com', :to => 'recipient@wildbit.com'
+        end
+      end
+    end
+
+    it_behaves_like 'templated message', 'test_message'
+  end
+
+  context 'when template is specified' do
+    let(:mailer) do
+      make_mailer(described_class) do
+        def test_message
+          mail :from => 'sender@wildbit.com',
+               :to => 'recipient@wildbit.com',
+               :postmark_template_alias => 'custom_template'
+        end
+      end
+    end
+
+    it_behaves_like 'templated message', 'custom_template'
+  end
+
+  context 'when template model is specified' do
+    let(:mailer) do
+      make_mailer(described_class) do
+        def test_message
+          self.template_model = { :foo => 'bar' }
+          mail :from => 'sender@wildbit.com',
+               :to => 'recipient@wildbit.com'
+        end
+      end
+    end
+
+    it_behaves_like 'templated message', 'test_message', :foo => 'bar'
+  end
+
+  describe '.default' do
+    it 'protects sensitive default headers from being overwritten' do
+      %w(subject body content_type).each do |header|
+        expect { described_class.default(header => 'foo') }.
+          to raise_error(ArgumentError, "Overriding '#{header}' header in a templated mailer is not allowed.")
+      end
+    end
+  end
+
+  describe '#mail' do
+    context "when overriding subject" do
+      let(:mailer) do
+        make_mailer(described_class) do
+          def test_message
+            mail :subject => 'Subject'
+          end
+        end
+      end
+
+      it 'protects it from being overwritten' do
+        expect { mailer.test_message.subject }.
+          to raise_error(ArgumentError, "Overriding 'subject' header in a templated mailer is not allowed.")
+      end
+    end
+
+    context "when overriding body" do
+      let(:mailer) do
+        make_mailer(described_class) do
+          def test_message
+            mail :body => 'body'
+          end
+        end
+      end
+
+      it 'protects it from being overwritten' do
+        expect { mailer.test_message.body }.
+          to raise_error(ArgumentError, "Overriding 'body' header in a templated mailer is not allowed.")
+      end
+    end
+
+    context "when overriding content_type" do
+      let(:mailer) do
+        make_mailer(described_class) do
+          def test_message
+            mail :content_type => 'content_type'
+          end
+        end
+      end
+
+      it 'protects it from being overwritten' do
+        expect { mailer.test_message.content_type }.
+          to raise_error(ArgumentError, "Overriding 'content_type' header in a templated mailer is not allowed.")
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: postmark-rails
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Petyo Ivanov
 - Ilya Sabanin
 - Artem Chistyakov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -30,16 +30,22 @@ dependencies:
   name: postmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +72,9 @@ files:
 - ".document"
 - ".gitignore"
 - ".travis.yml"
+- ".travis/setup.sh"
 - CHANGELOG.rdoc
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -76,14 +84,22 @@ files:
 - gemfiles/Gemfile.actionmailer-4.0.x
 - gemfiles/Gemfile.actionmailer-4.1.x
 - gemfiles/Gemfile.actionmailer-4.2.x
+- gemfiles/Gemfile.actionmailer-5.0.x
+- gemfiles/Gemfile.actionmailer-5.1.x
+- gemfiles/Gemfile.actionmailer-5.2.x
+- gemfiles/Gemfile.actionmailer-6.0.x
 - lib/postmark-rails.rb
+- lib/postmark-rails/preview_interceptor.rb
 - lib/postmark-rails/railtie.rb
+- lib/postmark-rails/templated_mailer.rb
 - lib/postmark-rails/version.rb
 - postmark-rails.gemspec
+- postmark.png
 - spec/fixtures/empty.gif
 - spec/fixtures/models/test_mailer.rb
 - spec/fixtures/views/test_mailer/message_with_attachment.erb
 - spec/fixtures/views/test_mailer/message_with_inline_image.html.erb
+- spec/fixtures/views/test_mailer/message_with_metadata.text.erb
 - spec/fixtures/views/test_mailer/multipart_message.html.erb
 - spec/fixtures/views/test_mailer/multipart_message.text.erb
 - spec/fixtures/views/test_mailer/simple_message.erb
@@ -91,13 +107,16 @@ files:
 - spec/fixtures/views/test_mailer/tracked_message.html.erb
 - spec/integration/batch_delivery_spec.rb
 - spec/integration/delivery_spec.rb
-- spec/postmark-rails_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/unit/postmark-rails_spec.rb
+- spec/unit/preview_interceptor_spec.rb
+- spec/unit/templated_mailer_spec.rb
 homepage: http://postmarkapp.com
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/wildbit/postmark-rails
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -113,9 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Postmark adapter for ActionMailer
 test_files:
@@ -123,6 +141,7 @@ test_files:
 - spec/fixtures/models/test_mailer.rb
 - spec/fixtures/views/test_mailer/message_with_attachment.erb
 - spec/fixtures/views/test_mailer/message_with_inline_image.html.erb
+- spec/fixtures/views/test_mailer/message_with_metadata.text.erb
 - spec/fixtures/views/test_mailer/multipart_message.html.erb
 - spec/fixtures/views/test_mailer/multipart_message.text.erb
 - spec/fixtures/views/test_mailer/simple_message.erb
@@ -130,6 +149,8 @@ test_files:
 - spec/fixtures/views/test_mailer/tracked_message.html.erb
 - spec/integration/batch_delivery_spec.rb
 - spec/integration/delivery_spec.rb
-- spec/postmark-rails_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/unit/postmark-rails_spec.rb
+- spec/unit/preview_interceptor_spec.rb
+- spec/unit/templated_mailer_spec.rb