postmark-rails-andyw8 0.22.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c55f036b9942ed71ac35eb876869692725f70dfcb051548ab731f688c6849c1d
+  data.tar.gz: c2fe27ed3c34e0245558a00a2f35e8a53d980ff854a3dc81ad431653bfe32608
+SHA512:
+  metadata.gz: dee0051558a32c2e86369eb793494ba09526de64caa3090ccf94f252c361ad893ae02af169b19bd67d3f062edcc431b3b2c95b93e662fbedd7c629ad813a8a89
+  data.tar.gz: bd78448f6559ff8bf66f0ad8e817f8ce62ad076c347ff76eabf9f56d4e6bf43482631c02fbba5af9056ac588905657e0d0d9b2e0dea603725b9e13093d9f8e76

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: Rails ${{ matrix.rails_version }} / Ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { rails_version: '~> 3.0', ruby_version: '2.5', mime_types_version: '1.25.1' }
+          - { rails_version: '~> 3.2', ruby_version: '2.5', mime_types_version: '1.25.1' }
+          - { rails_version: '~> 4.0', ruby_version: '2.5' }
+          - { rails_version: '~> 4.1', ruby_version: '2.5' }
+          - { rails_version: '~> 4.2', ruby_version: '2.5' }
+          - { rails_version: '~> 5.0', ruby_version: '2.5' }
+          - { rails_version: '~> 5.0', ruby_version: '2.6' }
+          - { rails_version: '~> 5.0', ruby_version: '2.7' }
+          - { rails_version: '~> 5.1', ruby_version: '2.5' }
+          - { rails_version: '~> 5.1', ruby_version: '2.6' }
+          - { rails_version: '~> 5.1', ruby_version: '2.7' }
+          - { rails_version: '~> 5.2', ruby_version: '2.5' }
+          - { rails_version: '~> 5.2', ruby_version: '2.6' }
+          - { rails_version: '~> 5.2', ruby_version: '2.7' }
+          - { rails_version: '~> 6.0', ruby_version: '2.5' }
+          - { rails_version: '~> 6.0', ruby_version: '2.6' }
+          - { rails_version: '~> 6.0', ruby_version: '2.7' }
+          - { rails_version: '~> 7.0', ruby_version: '2.7' }
+          - { rails_version: '~> 7.1', ruby_version: '3.2' }
+          - { rails_version: '~> 7.2', ruby_version: '3.3' }
+          - { rails_version: '~> 8.0', ruby_version: '3.4' }
+          - { rails_version: '~> 8.1', ruby_version: '4.0' }
+    env:
+      RAILS_TEST_VERSION: ${{ matrix.rails_version }}
+      MIME_TYPES_TEST_VERSION: ${{ matrix.mime_types_version || '~> 3.1' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler: latest
+          bundler-cache: true
+      - run: bundle exec rake spec

data/.gitignore

@@ -0,0 +1,11 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.rake_tasks
+.bundle
+.rvmrc
+Gemfile.lock
+gemfiles/*.lock
+**/*.idea

data/CHANGELOG.rdoc

@@ -0,0 +1,124 @@
+= Changelog
+
+== 0.22.1
+* Migrated to ActiveCampaign
+
+== 0.22.0
+
+* Added support for Rails 7
+
+== 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.
+* Added a section on error handling to the README.
+
+== 0.15.0
+
+* Update the postmark gem dependency to 1.10.x.
+
+== 0.14.0
+
+* Update the postmark gem dependency to 1.9.x.
+
+== 0.13.0
+
+* Update the postmark gem dependency to 1.8.x.
+* Verified ActionMailer 5.0 support.
+
+== 0.12.0
+
+* Updated the postmark gem dependency to 1.7.x.
+
+== 0.11.0
+
+* Updated the postmark gem dependency to 1.6.x.
+
+== 0.10.0
+
+* Updated the postmark gem dependency to 1.5.x
+* Called API access strings tokens instead of keys in documentation and code. Kept backwards compatibility.
+
+== 0.9.0
+
+* Enabled HTTPS by default.
+* Added custom User-Agent header.
+* Updated the postmark gem dependency to 1.4.x.
+
+== 0.8.0
+
+* Added support for open tracking.
+* Updated the postmark gem dependency to 1.3.x.
+
+== 0.7.0
+
+* Updated the postmark gem dependency to 1.2.x.
+
+== 0.6.0
+
+* Updated the postmark gem dependency.
+* Inherited inline images support.
+
+== 0.5.2
+
+* Removed the legacy code providing Rails 2 support.
+* Added a Railtie for proper initialization in Rails 3+.
+* Removed the post-install message.
+
+== 0.5.1
+
+* Upgraded actionmailer dependency to use >= 3.0.0.
+* Added multiple gemfiles to test against multiple actionmailer versions (currently 3.0.x, 3.2.x, 4.0.x).
+
+== 0.5.0
+
+* Added integration specs.
+* Updated the postmark gem dependency to 1.0.x.
+* Removed attachments fix.
+* Replaced README.rdoc with README.md.
+* Added unit and integration tests for messages with attachemtns.
+* Added batch delivery support.
+
+== 0.4.2
+
+* Updated the gem’s environment.
+* Fixed the postmark gem dependency on 0.9.x.
+* Added Travis-CI for integration testing.
+
+== 0.4.1
+
+* Fixed "returning" deprecation warning.
+
+== 0.4.0
+
+* Attachments support.
+
+== 0.3.0
+
+* Added support for Rails 3.

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/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'actionmailer', ENV.fetch('RAILS_TEST_VERSION', '~> 7.0')
+
+group :test do
+  gem 'rspec', '~> 3.7'
+  gem 'mime-types', ENV.fetch('MIME_TYPES_TEST_VERSION', '~> 3.1')
+end

data/LICENSE

@@ -0,0 +1,20 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+<a href="https://postmarkapp.com">
+    <img src="postmark.png" alt="Postmark Logo" title="Postmark" width="120" height="120" align="right">
+</a>
+
+# Postmark Rails Gem
+
+## This fork exists to address the issues described in [ActiveCampaign/postmark-rails#106](https://github.com/ActiveCampaign/postmark-rails/issues/106)
+
+[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.
+
+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).
+
+## Usage
+
+Please see the [wiki](https://github.com/ActiveCampaign/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).
+
+## Requirements
+
+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/andyw8/postmark-rails/wiki/Getting-Started).
+
+Also you will need a [postmark gem](https://github.com/ActiveCampaign/postmark-gem) version 1.0 and higher is required.
+
+### Supported Rails Versions
+
+- Rails 8.1
+- Rails 8.0
+- Rails 7.x
+- Rails 6.x
+- Rails 5.x
+- Rails 4.x
+- Rails 3.x
+
+For Rails 2.3 please take a look at [version 0.4](https://github.com/andyw8/postmark-rails/tree/v0.4.2).
+It may miss some new features, but receives all required bug fixes and other support if needed.
+
+## Installation
+
+Add `postmark-rails-andyw8` to your Gemfile and run `bundle install`.
+
+```ruby
+gem 'postmark-rails-andyw8'
+```
+
+## Rails 6-8
+
+Save your Postmark Server API Token to [config/credentials.yml.enc](https://guides.rubyonrails.org/security.html#custom-credentials):
+
+run `rails secret`, then run `rails credentials:edit` and add:
+
+```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: Rails.application.credentials.postmark_api_token }
+```
+
+## 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).
+
+```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 => Rails.application.secrets.postmark_api_token }
+```
+
+---
+
+**Note**: The `postmark_settings` hash can contain [any options](https://github.com/ActiveCampaign/postmark-gem#communicating-with-the-api) supported by `Postmark::ApiClient`.
+
+### Additional information
+
+Looking for the advanced usage examples? Check out [the documentation](https://github.com/ActiveCampaign/postmark-gem/blob/main/README.md) for the [postmark gem](https://github.com/ActiveCampaign/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
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
+
+## Authors & Contributors
+
+- Artem Chistyakov
+- Petyo Ivanov
+- Ilya Sabanin
+- Hristo Deshev
+- Randy Schmidt
+- Chris Williams
+- 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/ActiveCampaign/postmark-rails/blob/main/LICENSE) file for more information.
+
+## Copyright
+
+Copyright © 2022 ActiveCampaign LLC.

data/RELEASE.md

@@ -0,0 +1,13 @@
+New versions of the gem are cut by the Postmark team, this is a quick guide to ensuring a smooth release.
+
+1. Determine the next version of the gem by following the [SemVer](https://semver.org/) guidelines.
+2. Verify all builds are passing on CircleCI for your branch.
+3. Merge in your branch to main.
+4. Update `lib/postmark-rails/version.rb` with the new version.
+5. Update `CHANGELOG.rdoc` with a brief description of the changes.
+6. Commit to git with a comment of "Bump version to x.y.z".
+7. run `rake release` - This will push to github (with the version tag) and rubygems with the version in `lib/postmark-rails/version.rb`.
+  *Note that if you're on Bundler 1.17 there's a bug that hides the prompt for your OTP. If it hangs after adding the tag then it's asking for your OTP, enter your OTP and press Enter. Bundler 2.x and beyond resolved this issue. *
+8. Verify the new version is on [github](https://github.com/ActiveCampaign/postmark-rails) and [rubygems](https://rubygems.org/gems/postmark-rails).
+9. Create a new release for the version on [Github releases](https://github.com/ActiveCampaign/postmark-rails/releases).
+10. Add or update any related content to the [wiki](https://github.com/ActiveCampaign/postmark-rails/wiki).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rake'
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+end
+
+task :default => :spec

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/railtie.rb

@@ -0,0 +1,9 @@
+module PostmarkRails
+  class Railtie < Rails::Railtie
+    initializer 'postmark-rails', :before => 'action_mailer.set_configs' do
+      ActiveSupport.on_load :action_mailer do
+        PostmarkRails.install
+      end
+    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

@@ -0,0 +1,3 @@
+module PostmarkRails
+  VERSION = '0.22.1'
+end

data/lib/postmark-rails.rb

@@ -0,0 +1,28 @@
+require 'active_support/rescuable'
+require 'action_mailer'
+require 'postmark'
+
+module PostmarkRails
+  module ActionMailerExtensions
+    def metadata
+      @_message.metadata
+    end
+
+    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
+
+if defined?(Rails)
+  require 'postmark-rails/railtie'
+else
+  PostmarkRails.install
+end

data/postmark-rails.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "postmark-rails/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{postmark-rails-andyw8}
+  s.version = PostmarkRails::VERSION
+  s.authors = ["Petyo Ivanov", "Ilya Sabanin", "Artem Chistyakov", "Andy Waite"]
+  s.description = %q{The Postmark Rails Gem is a drop-in plug-in for ActionMailer to send emails via Postmark, an email delivery service for web apps.}
+  s.homepage = %q{https://postmarkapp.com}
+  s.summary = %q{Postmark adapter for ActionMailer}
+
+  s.metadata = {
+    "source_code_uri" => "https://github.com/andyw8/postmark-rails"
+  }
+
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.rdoc_options = ["--charset=UTF-8"]
+
+  s.add_dependency('actionmailer', ">= 3.0.0")
+  s.add_dependency('postmark', '>= 1.21.3', '< 2.0')
+
+  s.add_development_dependency("rake")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/fixtures/models/test_mailer.rb

@@ -0,0 +1,46 @@
+class TestMailer < ActionMailer::Base
+  default :subject  => 'hello',
+          :to       => 'sheldon@bigbangtheory.com',
+          :from     => 'leonard@bigbangtheory.com'
+
+  def simple_message
+    mail
+  end
+
+  def tagged_message
+    mail(:tag => 'delivery')
+  end
+
+  def tracked_message
+    mail(:track_opens => "true")
+  end
+
+  def multipart_message
+    mail(:subject => "Your invitation to join Mixlr.") do |format|
+      format.text
+      format.html
+    end
+  end
+
+  def message_with_attachment
+    attachments['empty.gif'] = File.read(image_file)
+    mail(:subject => "Message with attachment.")
+  end
+
+  def message_with_inline_image
+    attachments.inline['empty.gif'] = File.read(image_file)
+    mail(:subject => "Message with inline image.")
+  end
+
+  def message_with_metadata
+    metadata['foo'] = 'bar'
+    mail(:subject => 'Message with metadata.')
+  end
+
+  protected
+
+  def image_file
+    File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'empty.gif')
+  end
+
+end

data/spec/fixtures/views/test_mailer/message_with_attachment.erb

@@ -0,0 +1 @@
+attachments?

data/spec/fixtures/views/test_mailer/message_with_inline_image.html.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
+  </head>
+  <body text="#000000" bgcolor="#FFFFFF">
+    <img alt="postmark" src="<%= attachments['empty.gif'].url %>">
+  </body>
+</html>

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

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

data/spec/fixtures/views/test_mailer/multipart_message.html.erb

@@ -0,0 +1 @@
+<b>hello</b>

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

@@ -0,0 +1 @@
+hello

data/spec/fixtures/views/test_mailer/simple_message.erb

@@ -0,0 +1 @@
+hello

data/spec/fixtures/views/test_mailer/tagged_message.erb

@@ -0,0 +1 @@
+test

data/spec/fixtures/views/test_mailer/tracked_message.html.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
+  </head>
+  <body text="#000000" bgcolor="#FFFFFF">
+    <p>HELLO!</p>
+  </body>
+</html>

data/spec/integration/batch_delivery_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'Delivering emails in batches' do
+  let(:api_client) { Postmark::ApiClient.new('POSTMARK_API_TEST') }
+  let(:messages) { [TestMailer.simple_message,
+                    TestMailer.tagged_message,
+                    TestMailer.multipart_message,
+                    TestMailer.message_with_attachment] }
+
+  it 'delivers messages in batches' do
+    expect { api_client.deliver_messages(messages) }.
+        to change{messages.all? { |m| m.delivered?} }.to true
+  end
+end

data/spec/integration/delivery_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "Delivering messages with postmark-rails" do
+  let(:api_token) { 'POSTMARK_API_TEST' }
+
+  before do
+    ActionMailer::Base.postmark_settings = { :api_token => api_token }
+  end
+
+  it 'delivers a simple message' do
+    message = TestMailer.simple_message
+
+    expect { message.deliver }.to change{message.delivered?}.to(true)
+  end
+
+  it 'delivers a tagged message' do
+    message = TestMailer.tagged_message
+
+    expect { message.deliver }.to change{message.delivered?}.to(true)
+  end
+
+  it 'delivers a multipart message' do
+    message = TestMailer.multipart_message
+
+    expect { message.deliver }.to change{message.delivered?}.to(true)
+  end
+
+  it 'delivers a message with attachments' do
+    message = TestMailer.message_with_attachment
+    request = message.to_postmark_hash
+
+    expect(request['Attachments'].count).not_to be_zero
+    expect { message.deliver }.to change{message.delivered?}.to(true)
+  end
+
+  it 'delivers a message with inline image' do
+    message = TestMailer.message_with_inline_image
+    request = message.to_postmark_hash
+
+    expect(request['Attachments'].count).not_to be_zero
+    expect(request['Attachments'].first).to have_key('ContentID')
+    expect { message.deliver }.to change{message.delivered?}.to(true)
+  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.opts

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'postmark'
+
+# Without this, Rails 6 tests fail with error:
+# uninitialized constant ActiveSupport::LoggerThreadSafeLevel::Logger
+require 'logger'
+
+require 'postmark-rails'
+require 'json'
+
+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/postmark-rails_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe "PostmarkRails3" do
+  let!(:api_client) { Postmark::ApiClient.new('api-token') }
+
+  def deliver(message)
+    if message.respond_to?(:deliver_now)
+      message.deliver_now
+    else
+      message.deliver
+    end
+  end
+
+  it 'should allow setting an api token' do
+    ActionMailer::Base.postmark_settings = {:api_token => 'api-token'}
+    expect(ActionMailer::Base.postmark_settings[:api_token]).to eq('api-token')
+  end
+
+  it "should use postmark for delivery" do
+    expect(Postmark::ApiClient).to receive(:new) { api_client }
+    expect(api_client).to receive(:deliver_message) do |message|
+      expect(message.subject).to eq("hello")
+    end
+    deliver(TestMailer.simple_message)
+  end
+
+  it "should allow tagging of message" do
+    expect(Postmark::ApiClient).to receive(:new) { api_client }
+    expect(api_client).to receive(:deliver_message) do |message|
+      expect(message.tag.to_s).to eq("delivery")
+    end
+    deliver(TestMailer.tagged_message)
+  end
+
+  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_truthy
+      expect(message.to_postmark_hash['TrackOpens']).to be true
+    end
+    deliver(TestMailer.tracked_message)
+  end
+
+  it "should work with multipart messages" do
+    expect(Postmark::ApiClient).to receive(:new) { api_client }
+    expect(api_client).to receive(:deliver_message) do |message|
+      expect(message).to be_multipart
+      expect(message.body_text.strip).to eq("hello")
+      expect(message.body_html.strip).to eq("<b>hello</b>")
+    end
+    deliver(TestMailer.multipart_message)
+  end
+
+  it 'should work with messages containing attachments' do
+    expect(Postmark::ApiClient).to receive(:new) { api_client }
+    expect(api_client).to receive(:deliver_message) do |message|
+      expect(message).to have_attachments
+    end
+    deliver(TestMailer.message_with_attachment)
+  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@postmarkapp.com', :to => 'recipient@postmarkapp.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@postmarkapp.com',
+               :to => 'recipient@postmarkapp.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@postmarkapp.com',
+               :to => 'recipient@postmarkapp.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

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: postmark-rails-andyw8
+version: !ruby/object:Gem::Version
+  version: 0.22.1
+platform: ruby
+authors:
+- Petyo Ivanov
+- Ilya Sabanin
+- Artem Chistyakov
+- Andy Waite
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: postmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        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: '2.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'
+description: The Postmark Rails Gem is a drop-in plug-in for ActionMailer to send
+  emails via Postmark, an email delivery service for web apps.
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".document"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- CHANGELOG.rdoc
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- RELEASE.md
+- Rakefile
+- 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
+- spec/fixtures/views/test_mailer/tagged_message.erb
+- spec/fixtures/views/test_mailer/tracked_message.html.erb
+- spec/integration/batch_delivery_spec.rb
+- spec/integration/delivery_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: https://postmarkapp.com
+licenses: []
+metadata:
+  source_code_uri: https://github.com/andyw8/postmark-rails
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Postmark adapter for ActionMailer
+test_files:
+- 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
+- spec/fixtures/views/test_mailer/tagged_message.erb
+- spec/fixtures/views/test_mailer/tracked_message.html.erb
+- spec/integration/batch_delivery_spec.rb
+- spec/integration/delivery_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