postmark_mailer 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e6bd29eeef550d9a64ed7b5bc53b31f8a9fe8cf
+  data.tar.gz: b9d5f9e35700b6e82daf2b9982aaba7ffdd0913a
+SHA512:
+  metadata.gz: 0b753e46aa48f657b2da94c3b7f58775ff5fb3fa6871f83307680ed68257ffd959843f7e6707675eaf5ffe4f08e6c69213a9b2255483799ca341496ed3121560
+  data.tar.gz: a89ac4dd4ad93aa1ab786da61f49c674af1b8c4a9a9d01116b33240cb4b48603fd8b14a8f867a40adca7211b63dfa7dc140bfc8b83a518d88f04e0df36dc7d0e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.0

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.1.3] - 2018-09-27
+### Added
+- A crude facsimile of `#action_name` to mimic the method of the same name found in ActionMailer.
+- Documentation in README for `#prevent_delivery?` usage.
+
+## [0.1.2] - 2018-04-04
+### Added
+- Support for Rails 5.
+
+## [0.1.1] - 2017-12-01
+### Added
+- Basic configuration options.
+
+### Removed
+- Copypasta from initial commit.
+
+## [0.1.0] - 2017-12-01
+### Added
+- Rough outline of initial code extracted from Science Exchange.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in postmark_mailer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    postmark_mailer (0.1.0)
+      activejob (~> 4.2)
+      postmark
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (4.2.10)
+      activesupport (= 4.2.10)
+      globalid (>= 0.3.0)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.10.3)
+    postmark (1.10.0)
+      json
+      rake
+    rake (10.4.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  postmark_mailer!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Science Exchange, 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,141 @@
+# PostmarkMailer
+
+This gem is designed to provide a (nearly) drop-in replacement for Ruby on Rails' `ActionMailer` for those wishing to deliver emails using [Postmark's Templates API](https://postmarkapp.com/why/templates). Its interface mimics that of `ActionMailer` so switching existing mailers should require minimal effort, and usage should be familiar to most Ruby on Rails developers.
+
+_**NOTE:** This gem only provides a means of delivering transactional emails from a Ruby on Rails application with a Postmark template, and does **not** provide any functionality for managing templates. Such functionality is already provided by Postmark's API and their Ruby client._
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postmark_mailer', github: 'scienceexchange/postmark_mailer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postmark_mailer
+
+## Usage
+
+To start sending emails with Postmark's templates, you will need to set up some minimal configuration, and then make some changes to the mailer classes themselves.
+
+### Configuration
+
+In `app/initializers/postmark_mailer.rb`, add the following configuration block:
+
+```ruby
+PostmarkMailer.configure do |config|
+  config.api_key = YOUR_POSTMARK_API_KEY # required
+  config.default_delivery_queue = :mailers # defaults to :default
+end
+```
+
+### Defining Mailers
+
+To illustrate the usage of `PostmarkMailer`, let's take a look at a typical Rails mailer:
+
+```ruby
+class MyCoolMailer < ActionMailer::Base
+  def welcome(user)
+    @user = user
+
+    mail(
+      to: @user.email,
+      subject: 'Welcome to Our Product!'
+    )
+  end
+end
+```
+
+The same mailer, using this gem would look like this:
+
+```ruby
+class MyCoolMailer < PostmarkMailer::Base
+  def welcome(user)
+    mail(
+      to: user.email,
+      template_id: 123_456,
+      template_model: {
+        first_name: user.first_name
+      }
+    )
+  end
+end
+```
+
+Note the important changes:
+
+* The mailer now inherits from `PostmarkMailer::Base` instead of `ActionMailer::Base`.
+* You add `template_id` to your options hash. _(This is required.)_
+* You add `template_model` to your options hash, which is an optional hash of whatever data you'd like to render in your template. _(This is optional–in the unlikely event your template does not render any specific data, you can safely omit this option.)_
+
+The options you pass into the `#mail` method are ultimately passed on to the `#deliver_with_template` method provided by the Postmark API Ruby client, and so you'll want to [refer to their documentation for a list of all the availabale options](https://postmarkapp.com/developer/api/templates-api#email-with-template).
+
+Because Postmark handles the templating and rendering, you no longer need the views for this mailer, so in this example, you could safely remove `app/views/mailers/my_cool_mailer/welcome.html.erb`.
+
+### Delivering Mailers
+
+Just as you would with a standard mailer, simply call:
+
+```ruby
+MyCoolMailer.welcome(user).deliver_later
+```
+
+or, less optimally:
+
+```ruby
+MyCoolMailer.welcome(user).deliver_now
+```
+
+### Preventing Delivery
+
+In some mailers, you may wish to prevent delivery based on some business logic. For instance, if you offer email preferences to your users, you may want to check their preferences and prevent delivery if they've disabled email notifications.
+
+To add mailer-wide logic, simply define a `prevent_delivery?` method in your mailer:
+
+```ruby
+class MyCoolMailer < PostmarkMailer::Base
+  def welcome(user)
+    @user = user
+    mail(
+      to: @user.email,
+      template_id: 123_456,
+      template_model: {
+        first_name: @user.first_name
+      }
+    )
+  end
+
+  private
+
+  def prevent_delivery?
+    # Substitute the line below with your own logic
+    @user.all_emails_disabled?
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+This gem is in it's infancy, so functionality is extremely limited at this point. Bug reports and pull requests are welcome on GitHub at https://github.com/scienceexchange/postmark_mailer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## About Science Exchange
+
+PostmarkMailer is maintained by [Science Exchange](https://www.scienceexchange.com), the leading platform for outsourcing scientific research and development. Science Exchange is not affiliated with Postmark or Wildbit, LLC, and usage of Postmark is subject to their Terms of Service.
+
+If you're interested helping improve the pace of scientific research, you should know that [we're hiring!](https://jobs.lever.co/scienceexchange/e277508e-1bda-4ed2-b3f3-ed78d3345402)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "postmark_mailer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/postmark_mailer.rb

@@ -0,0 +1,20 @@
+require 'postmark_mailer/version'
+require 'postmark_mailer/configuration'
+require 'postmark_mailer/base'
+require 'postmark_mailer/delivery_job'
+require 'postmark_mailer/message_delivery'
+require 'postmark_mailer/null_delivery'
+
+module PostmarkMailer
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/postmark_mailer/base.rb

@@ -0,0 +1,37 @@
+module PostmarkMailer
+  class Base
+    attr_accessor :action_name
+
+    class << self
+      private
+
+      def respond_to_missing?(method, *)
+        new.respond_to?(method) || super
+      end
+
+      def method_missing(method, *args)
+        if respond_to_missing?(method)
+          new(method.to_s).public_send(method, *args)
+        else
+          super
+        end
+      end
+    end
+
+    private
+
+    def initialize(method_name = nil)
+      @action_name = method_name
+    end
+
+    def mail(options)
+      if prevent_delivery?
+        NullDelivery.new(options)
+      else
+        MessageDelivery.new(options)
+      end
+    end
+
+    def prevent_delivery?; end
+  end
+end

data/lib/postmark_mailer/configuration.rb

@@ -0,0 +1,10 @@
+module PostmarkMailer
+  class Configuration
+    attr_accessor :api_key, :default_delivery_queue
+
+    def initialize
+      @api_key = nil
+      @default_delivery_queue = :default
+    end
+  end
+end

data/lib/postmark_mailer/delivery_job.rb

@@ -0,0 +1,11 @@
+require "active_job"
+
+module PostmarkMailer
+  class DeliveryJob < ActiveJob::Base
+    queue_as { PostmarkMailer.configuration.default_delivery_queue }
+
+    def perform(options)
+      MessageDelivery.new(options).deliver_now
+    end
+  end
+end

data/lib/postmark_mailer/message_delivery.rb

@@ -0,0 +1,20 @@
+require 'postmark'
+
+module PostmarkMailer
+  class MessageDelivery
+    attr_accessor :client, :options
+
+    def initialize(opts)
+      @client = Postmark::ApiClient.new(PostmarkMailer.configuration.api_key)
+      @options = opts
+    end
+
+    def deliver_now
+      client.deliver_with_template(options)
+    end
+
+    def deliver_later
+      DeliveryJob.perform_later(options)
+    end
+  end
+end

data/lib/postmark_mailer/null_delivery.rb

@@ -0,0 +1,14 @@
+require 'postmark_mailer'
+# Null object for MessageDelivery. Follows the same interface but performs no
+# deliveries.
+module PostmarkMailer
+  class NullDelivery < MessageDelivery
+    # Does nothing
+    # @return [nil]
+    def deliver_now; end
+
+    # Does nothing
+    # @return [nil]
+    def deliver_later; end
+  end
+end

data/lib/postmark_mailer/version.rb

@@ -0,0 +1,3 @@
+module PostmarkMailer
+  VERSION = '0.1.3'.freeze
+end

data/postmark_mailer.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postmark_mailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postmark_mailer'
+  spec.version       = PostmarkMailer::VERSION
+  spec.authors       = ['John Ellis']
+  spec.email         = ['john@scienceexchange.com']
+
+  spec.summary       = 'An ActionMailer replacement for those wishing to send emails using Postmark Templates.'
+  spec.description   = "Designed to mimic ActionMailer's familiar interface, this gem offers a way to send transactional emails that are rendered by Postmark's Templates feature and delivered via the Postmark API."
+  spec.homepage      = 'https://github.com/scienceexchange/postmark_mailer'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'activejob', '>= 4.2'
+  spec.add_dependency 'postmark'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: postmark_mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- John Ellis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: postmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Designed to mimic ActionMailer's familiar interface, this gem offers
+  a way to send transactional emails that are rendered by Postmark's Templates feature
+  and delivered via the Postmark API.
+email:
+- john@scienceexchange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/postmark_mailer.rb
+- lib/postmark_mailer/base.rb
+- lib/postmark_mailer/configuration.rb
+- lib/postmark_mailer/delivery_job.rb
+- lib/postmark_mailer/message_delivery.rb
+- lib/postmark_mailer/null_delivery.rb
+- lib/postmark_mailer/version.rb
+- postmark_mailer.gemspec
+homepage: https://github.com/scienceexchange/postmark_mailer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: An ActionMailer replacement for those wishing to send emails using Postmark
+  Templates.
+test_files: []