mta-settings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 077a057f8597de915994a206fdd24f3dfdb94884
+  data.tar.gz: a5338bac532f193a5803e7564974131f66b1fb2f
+SHA512:
+  metadata.gz: 6ff91e9730954becfbb21ef0e03eebf8af5cb744756c3affcb817a275f68b378622a72e872cd844b262e0b45447e449a6829eb640893d0aa06c6f5ed8fceff8d
+  data.tar.gz: ed82a6b4de34bac0e9f1df332d67c3e7e734f388faae0890abe4c69ed1aad623a5f631fc5af108024c71df7534d61e1d3c3edca6ec885a5efc548b5e9fef5f69

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) Tim Pope
+
+MIT License
+
+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.markdown

@@ -0,0 +1,69 @@
+# MTA Settings for Ruby
+
+The `mta-settings` gem enables transparent MTA (mail transport agent)
+configuration from the environment for both [ActionMailer][] and [Mail][],
+based on either an explicit `MTA_URL` variable or popular conventions for
+Sendgrid, Mandrill, Postmark, and Mailgun (as provided by Heroku addons, for
+example).
+
+[ActionMailer]: https://github.com/rails/rails/tree/master/actionmailer
+[Mail]: https://github.com/mikel/mail
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mta-settings'
+
+### ActionMailer
+
+If `mta-settings` is required (which Bundler does automatically by default),
+ActionMailer configuration is fully automatic.  With Rails, be aware that
+`config.action_mailer` assignments will take precedence, so you might want to
+strip those out of your apps `config/environments/` files.
+
+### Mail
+
+    Mail.defaults do
+      delivery_method *MtaSettings.from_env
+      # delivery_method *MtaSettings.from_url(ENV['MTA_URL'])
+    end
+
+## Usage
+
+Configuration will happen based on the presence of the following environment
+variables, in order of decreasing precedence:
+
+* `MTA_PROVIDER`: points to another environment variable containing an MTA URL
+* `MTA_URL`: See below
+* `SENDGRID_USERNAME`: Sendgrid
+* `MANDRILL_APIKEY`: Mandrill
+* `POSTMARK_API_TOKEN`: Postmark
+* `MAILGUN_SMTP_LOGIN`: Mailgun
+
+If no supported environment variable is found, the configuration is left
+blank.  This enables easy defaulting:
+
+    ActionMailer::Base.delivery_method ||= :letter_opener
+
+### MTA URLs
+
+The scheme of an MTA URL is used to set the delivery method.  The user,
+password, host, port, and path portions are used to populate the `user_name`,
+`address`, `port`, and `location` settings of the chosen delivery method.
+Query parameters are then merged in.
+
+* The `sendmail` and `file` adapters both respect the ActionMailer `location`
+  defaults, so you can just give `sendmail:///` or `file:///`.
+* If a path is given in an `smtp` URL, it will be used as `domain` rather than
+  `location` (minus the leading slash).
+* If `domain` is set, the default from address will be set to `noreply` at
+  that domain.
+
+Here's an example for Gmail:
+
+    smtp://username%40gmail.com:password@smtp.gmail.com:587/
+
+Using an MTA URL is highly recommended even when your SMTP provider is
+supported out of the box.  MTA URLs are much easier to copy between
+environments or try out locally for debugging.

data/lib/mta-settings.rb

@@ -0,0 +1,10 @@
+require 'mta_settings'
+
+ActiveSupport.on_load(:action_mailer) do
+  self.mta_settings =
+    if ENV['RAILS_ENV'] == 'test'
+      :test
+    else
+      ENV
+    end
+end

data/lib/mta_settings.rb

@@ -0,0 +1,156 @@
+require 'uri'
+require 'cgi'
+require 'active_support/core_ext/object/blank'
+require 'active_support/lazy_load_hooks'
+
+module MtaSettings
+  LOCALHOST = 'localhost.localdomain'
+
+  def self.from_url(url)
+    return if url.blank?
+    # Use MTA_URL=: to short circuit configuration
+    return [nil, nil] if url == ':'
+    # Use MTA_URL=test: to use the test method without changing settings
+    return [$1.tr('+-.', '___').to_sym, nil] if url =~ /\A^([\w+-.]+):\z/
+    uri = URI.parse(url.to_s)
+
+    settings = {
+      :user_name => (CGI.unescape(uri.user) if uri.user),
+      :password => (CGI.unescape(uri.password) if uri.password),
+      :address => uri.host,
+      :port => uri.port,
+      :location => (uri.path if uri.path != '/'),
+    }.reject do |k, v|
+      v.nil?
+    end
+
+    if !settings[:location] && uri.opaque =~ /^[^?]/
+      settings[:location] = CGI.unescape(uri.opaque.split('?').first)
+    end
+
+    CGI.parse(uri.query || uri.opaque.to_s.split('?')[1].to_s).each do |k, v|
+      settings[k.to_sym] = v.join("\n")[/.+/m]
+    end
+
+    adapter = uri.scheme.downcase.tr('+-.', '___').to_sym
+    case adapter
+    when :sendmail, :exim
+      settings[:location] ||= "/usr/sbin/#{adapter}"
+      settings[:arguments] ||= '-i -t'
+
+    when :file
+      settings[:location] ||=
+        if defined?(Rails.root)
+          "#{Rails.root}/tmp/mails"
+        else
+          "#{Dir.tmpdir}/mails"
+        end
+
+    when :smtp, :smtps
+      settings[:ssl] = (adapter == :smtps)
+      adapter = :smtp
+      settings[:enable_starttls_auto] = true
+      settings[:authentication] ||= :plain if settings[:user_name]
+      settings[:domain] ||=
+        (settings.delete(:location) || LOCALHOST).sub(/^\//, '')
+
+    end
+
+    [adapter, settings]
+  end
+
+  def self.from_env(env = ENV)
+    domain = env['MTA_DOMAIN'] || LOCALHOST
+    if url = env[env['MTA_PROVIDER'].presence || 'MTA_URL'].presence
+      method, settings = from_url(url)
+      if method == :smtp && settings[:domain] == LOCALHOST
+        settings[:domain] = domain
+      end
+      [method, settings]
+    elsif env['SENDGRID_USERNAME'].present?
+      [:smtp, {
+        :address              => "smtp.sendgrid.net",
+        :port                 => 587,
+        :authentication       => :plain,
+        :enable_starttls_auto => true,
+        :user_name            => env['SENDGRID_USERNAME'],
+        :password             => env['SENDGRID_PASSWORD'],
+        :domain               => domain,
+      }]
+    elsif env['MANDRILL_APIKEY'].present?
+      [:smtp, {
+        :address              => "smtp.mandrillapp.com",
+        :port                 => 587,
+        :authentication       => :plain,
+        :enable_starttls_auto => true,
+        :user_name            => env['MANDRILL_USERNAME'],
+        :password             => env['MANDRILL_APIKEY'],
+        :domain               => domain,
+      }]
+    elsif env['POSTMARK_API_TOKEN'].present?
+      [:smtp, {
+        :address              => env['POSTMARK_SMTP_SERVER'] || 'smtp.postmarkapp.com',
+        :port                 => 25,
+        :authentication       => :cram_md5,
+        :enable_starttls_auto => true,
+        :user_name            => env['POSTMARK_API_TOKEN'],
+        :password             => env['POSTMARK_API_TOKEN'],
+        :domain               => domain,
+      }]
+    elsif env['MAILGUN_SMTP_LOGIN'].present?
+      [:smtp, {
+        :address              => env['MAILGUN_SMTP_SERVER'] || 'smtp.mailgun.org',
+        :port                 => env['MAILGUN_SMTP_PORT'] || '25',
+        :authentication       => :plain,
+        :enable_starttls_auto => true,
+        :user_name            => env['MAILGUN_SMTP_LOGIN'],
+        :password             => env['MAILGUN_SMTP_PASSWORD'],
+        :domain               => domain,
+      }]
+    end
+  end
+
+  module ActionMailerExtensions
+    def mta_settings
+      [delivery_method, send("#{delivery_method}_settings")] if delivery_method
+    end
+
+    def mta_settings=(arg)
+      self.delivery_method, settings =
+        *case arg
+        when nil, ""
+          [nil, nil]
+        when String, URI
+          MtaSettings.from_url(arg)
+        when Array
+          arg
+        when Symbol
+          [arg, {}]
+        when Hash
+          arg = arg.dup
+          [arg.delete(:adapter) || arg.delete(:transport), arg]
+        when ENV
+          MtaSettings.from_env(arg)
+        else
+          raise ArgumentError, "Unsupported MTA settings #{arg.inspect}"
+        end
+      return unless delivery_method && settings
+      accessor = :"#{delivery_method}_settings"
+      class_attribute(accessor) unless respond_to?(accessor)
+      send(:"#{accessor}=", settings)
+      if settings[:from]
+        default from: settings[:from]
+      elsif !default.has_key?(:from) &&
+          ![nil, LOCALHOST].include?(settings[:domain])
+        default from: "noreply@#{settings[:domain]}"
+      elsif !default.has_key?(:from) &&
+          settings[:user_name] =~ /\A\S+@\S+\.\w+\z/
+        default from: settings[:user_name]
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_mailer) do
+  extend MtaSettings::ActionMailerExtensions
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: mta-settings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Pope
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: |
+  Configure ActionMailer or Mail delivery settings based on either a singular
+  MTA_URL environment variable or common conventions for popular off the shelf
+  SMTP providers.
+email:
+- codeAtpope.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.markdown
+- lib/mta-settings.rb
+- lib/mta_settings.rb
+homepage: https://github.com/tpope/mta-settings
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Configure ActionMailer or Mail delivery settings based on the environment
+test_files: []