twelvefactor-mailer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71009536aea3c2ad3eccfb3a3081b298ebf9df27
+  data.tar.gz: f35a89d5ad005b887f27cf256cf4338479b21910
+SHA512:
+  metadata.gz: bcebcaf30785fb5a683cce35d879388cc55f7d782aee8681fba4782e8c4ad95dab2115b86301651bd86cfb2ee8ce2be4d6984f7cd670270492ac42eaa05e956a
+  data.tar.gz: 7d8c22fe3a0bab691c470eb5fca33f134857731b643ca5eb187237900f72d71dd1fa585e0f9b7d35a9d03af7bf7319c9de41372077a8118fbe264cff471802d5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  config_file: .rubocop.yml
+fail_on_violations: true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Include:
+  - "**/*.gemspec"
+  - "**/Gemfile"
+  Exclude:
+  - "vendor/**/*"
+  - "spec/**/*"
+  - "features/**/*"
+  - "db/schema.rb"
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kbourn@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twelvefactor.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,75 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Konstantin Burnaev
+
+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,88 @@
+# twelvefactor-mailer
+
+Adds support for MAILER_URL environment variable in a way similar to
+[http://edgeguides.rubyonrails.org/configuring.html](DATABASE_URL).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twelvefactor-mailer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twelvefactor-mailer
+
+## Usage
+
+1. Add `MAILER_URL` to your application environment.
+
+```
+MAILER_URL=letter-opener://localhost
+MAILER_URL=test://localhost
+MAILER_URL=smtp://mail:1025
+```
+
+2. Remove old mailer configuration code (`action_mailer.delivery_method` and
+`action_mailer.smtp_settings`) from `application.rb` and `ENV.rb`
+
+### Supported delivery methods
+
+smtp
+
+```
+MAILER_URL=smtp://user:password@localhost:1025?domain=test.com&authentication=plain
+```
+
+sendmail
+```
+MAILER_URL=sendmail:///usr/bin/sendmail?-i%20-t
+```
+
+file
+```
+MAILER_URL=file:///home/username/tmp/mail
+```
+
+test
+```
+MAILER_URL=test://localhost
+```
+
+letter-opener (https://github.com/ryanb/letter_opener)
+```
+MAILER_URL=letter-opener://localhost
+```
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/bkon/twelvefactor.  This project is intended to be
+a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "twelvefactor/environment/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

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/circle.yml

@@ -0,0 +1,12 @@
+machine:
+  ruby:
+    version: 2.3.1
+
+dependencies:
+  pre:
+    - gem install bundler -v "1.12.5"
+
+test:
+  override:
+    - bundle exec rubocop
+    - bundle exec rspec

data/lib/twelvefactor/environment/mailer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Twelvefactor; end
+module Twelvefactor::Environment; end
+class Twelvefactor::Environment::Mailer; end
+
+require "twelvefactor/environment/mailer/smtp"
+require "twelvefactor/environment/mailer/sendmail"
+require "twelvefactor/environment/mailer/file"
+require "twelvefactor/environment/mailer/test"
+require "twelvefactor/environment/mailer/letter_opener"
+
+class Twelvefactor::Environment::Mailer
+  VERSION = "1.0.0".freeze
+
+  HANDLERS = {
+    "smtp" => Smtp,
+    "sendmail" => Sendmail,
+    "file" => File,
+    "test" => Test,
+    "letter-opener" => LetterOpener
+  }.freeze
+
+  def self.apply app, mailer_url
+    handler = HANDLERS.fetch mailer_url.scheme, Test
+    handler.apply app, mailer_url
+  end
+end

data/lib/twelvefactor/environment/mailer/file.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class Twelvefactor::Environment::Mailer::File
+  def self.apply app, mailer_url
+    config = app.config
+    config.action_mailer.delivery_method = :file
+    config.action_mailer.file_settings = file_settings mailer_url
+  end
+
+  def self.file_settings url
+    {
+      location: url.path
+    }
+  end
+end

data/lib/twelvefactor/environment/mailer/letter_opener.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+class Twelvefactor::Environment::Mailer::LetterOpener
+  def self.apply app, _
+    config = app.config
+    config.action_mailer.delivery_method = :letter_opener
+  end
+end

data/lib/twelvefactor/environment/mailer/sendmail.rb

@@ -0,0 +1,17 @@
+require "active_support/core_ext/hash"
+
+# frozen_string_literal: true
+class Twelvefactor::Environment::Mailer::Sendmail
+  def self.apply app, mailer_url
+    config = app.config
+    config.action_mailer.delivery_method = :sendmail
+    config.action_mailer.sendmail_settings = sendmail_settings mailer_url
+  end
+
+  def self.sendmail_settings url
+    {
+      location: url.path,
+      arguments: url.query && URI.decode(url.query)
+    }.compact
+  end
+end

data/lib/twelvefactor/environment/mailer/smtp.rb

@@ -0,0 +1,34 @@
+require "active_support/core_ext/hash"
+
+# frozen_string_literal: true
+class Twelvefactor::Environment::Mailer::Smtp
+  def self.apply app, mailer_url
+    config = app.config
+    config.action_mailer.delivery_method = :smtp
+    config.action_mailer.smtp_settings = smtp_settings mailer_url
+  end
+
+  def self.smtp_settings url
+    basic_settings(url)
+      .merge(extra_settings(url.query))
+      .compact
+  end
+
+  def self.basic_settings url
+    {
+      address: url.host,
+      port: url.port,
+      user_name: url.user,
+      password: url.password
+    }
+  end
+
+  def self.extra_settings query
+    return {} unless query
+
+    CGI
+      .parse(query)
+      .map { |k, val| [k.to_sym, val.first] }
+      .to_h
+  end
+end

data/lib/twelvefactor/environment/mailer/test.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+class Twelvefactor::Environment::Mailer::Test
+  def self.apply app, _
+    config = app.config
+    config.action_mailer.delivery_method = :test
+  end
+end

data/twelvefactor-mailer.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "twelvefactor/environment/mailer"
+
+Gem::Specification.new do |spec|
+  spec.name          = "twelvefactor-mailer"
+  spec.version       = Twelvefactor::Environment::Mailer::VERSION
+  spec.authors       = ["Konstantin Burnaev"]
+  spec.email         = ["kbourn@gmail.com"]
+
+  spec.summary       = <<EOF
+MAILER_URL for 12-factor mailer configuration in Rails applications.
+EOF
+
+  spec.homepage      = "https://github.com/bkon/twelvefactor-mailer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "twelvefactor", "~> 1.0"
+  spec.add_dependency "railties", "~> 4.1"
+  spec.add_dependency "activesupport", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "guard-rubocop", "~> 1.2"
+  spec.add_development_dependency "codecov"
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: twelvefactor-mailer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Konstantin Burnaev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twelvefactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: 
+email:
+- kbourn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/twelvefactor/environment/mailer.rb
+- lib/twelvefactor/environment/mailer/file.rb
+- lib/twelvefactor/environment/mailer/letter_opener.rb
+- lib/twelvefactor/environment/mailer/sendmail.rb
+- lib/twelvefactor/environment/mailer/smtp.rb
+- lib/twelvefactor/environment/mailer/test.rb
+- twelvefactor-mailer.gemspec
+homepage: https://github.com/bkon/twelvefactor-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.1
+signing_key: 
+specification_version: 4
+summary: MAILER_URL for 12-factor mailer configuration in Rails applications.
+test_files: []