action_mailer_provider 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2b866699a8b9bf2a5cbe6f0d224a592abf75ee8
+  data.tar.gz: 7ecda3edba46ca85f2539f52fc3efa519562a7cf
+SHA512:
+  metadata.gz: ae1ba135359ad8b5233b856671f1a3632257e260be15fef7c504d9ebf982c49aa18f2fb032ee28fff7347d689388197099a7120e9a3c9a764d6ed7069667ce3e
+  data.tar.gz: d0e949408c1ff4a3f8853b0b4d92d526c5d93097debcd9888b8bf4fbc5234344c8534f9b0523b74620ca74a5f9572adeb13e43dbadf74ed8411a16c45c2d6635

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Miguel Palhas
+
+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.md

@@ -0,0 +1,51 @@
+# ActionMailerProvider
+
+Never again shall you have production errors due to wrong mail configuration
+
+This is a simple helper gem that configures your rails SMTP settings according
+to your provider.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_mailer_provider'
+
+And bundle:
+
+    $ bundle install
+
+Finally, use the generator to create the initializer file with your desired
+settings. By default, all data will be fetched from environment variables,
+although you can override that in the generator prompt.
+I do recommend using the environment variables through [dotenv](https://github.com/bkeepers/dotenv)) or another similar tool, as they are easier to update later, and more secure (your email password in kept in an untracked file)
+
+```
+$ rails generate action_mailer_provider:install
+By default, values will be fetched through env variables. Would you like to customize them instead? [yN] y
+What provider would you like to use? [ENV['EMAIL_PROVIDER']] zoho
+What's your email domain? [ENV['EMAIL_DOMAIN']] my.domain.com
+What's the email address to use? [ENV['EMAIL_USERNAME']] my-account@my.domain.com
+Email password [ENV['EMAIL_PASSWORD']] my-password
+      create  config/initializers/action_mailer_provider.rb
+```
+
+## Providers
+
+Currently the only supported providers are [ZohoMail](https://www.zoho.com/mail/) (`zoho`) and [Gmail](mail.google.com) (`gmail`)
+Each of them requires only that you speficy your custom domain, and default
+email account and password to use. The rest (smtp address, port, ssl, etc) is
+handled automatically
+
+## Why a gem for such a trivial task?
+
+Because i kept copying the same configuration over and over across every
+application, sometimes leading to errors only discovered in production
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/action_mailer_provider.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_mailer_provider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_mailer_provider"
+  spec.version       = ActionMailerProvider::VERSION
+  spec.authors       = ["Miguel Palhas"]
+  spec.email         = ["mpalhas@gmail.com"]
+  spec.description   = %q{Action Mailer configuration helper}
+  spec.summary       = %q{Configure Action Mailer gem according to your email provider specs (Google, Zoho Mail, etc)}
+  spec.homepage      = "https://github.com/naps62/action_mailer_provider"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "actionmailer"
+  spec.add_dependency "rails"
+end

data/lib/action_mailer_provider.rb

@@ -0,0 +1,5 @@
+require 'action_mailer_provider/version'
+require 'action_mailer_provider/configuration'
+
+module ActionMailerProvider
+end

data/lib/action_mailer_provider/configuration.rb

@@ -0,0 +1,30 @@
+require 'action_mailer_provider/strategies'
+
+module ActionMailerProvider
+  class Configuration
+    ATTRIBUTES = [:provider, :domain, :default_email, :default_email_password]
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize
+    end
+
+    def attributes
+      Hash[ATTRIBUTES.map { |attr| [attr, public_send(attr)] }]
+    end
+
+    def reload
+      strategy = ActionMailerProvider::Strategies.for(provider)
+      strategy.new(attributes).configure if strategy
+    end
+  end
+
+  class << self
+    attr_accessor :config
+
+    def configure(&block)
+      config ||= Configuration.new
+      yield config if block_given?
+      config.reload
+    end
+  end
+end

data/lib/action_mailer_provider/strategies.rb

@@ -0,0 +1,19 @@
+require 'action_mailer_provider/strategies/zoho'
+require 'action_mailer_provider/strategies/gmail'
+
+module ActionMailerProvider
+  module Strategies
+    def self.for(provider)
+      if provider
+        const = mapping(provider)
+        const_get(const) if const_defined?(const)
+      end
+    end
+
+    private
+
+    def self.mapping(provider)
+      provider.to_s.split('_').map { |w| w.capitalize }.join.to_sym
+    end
+  end
+end

data/lib/action_mailer_provider/strategies/abstract_smtp_strategy.rb

@@ -0,0 +1,31 @@
+module ActionMailerProvider
+  module Strategies
+    class AbstractSmtpStrategy
+      attr_reader :attributes
+
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def configure
+        ActionMailer::Base.smtp_settings = defaults.merge(configuration)
+      end
+
+      def configuration
+        raise 'AbstractStrategy called for ActionMailerProvider'
+      end
+
+      private
+
+      def defaults
+        {
+          domain: attributes[:domain],
+          user_name: attributes[:default_email],
+          password: attributes[:default_email_password],
+          authentication: :plain,
+          enable_starttls_auto: true
+        }
+      end
+    end
+  end
+end

data/lib/action_mailer_provider/strategies/gmail.rb

@@ -0,0 +1,14 @@
+require 'action_mailer_provider/strategies/abstract_smtp_strategy'
+
+module ActionMailerProvider
+  module Strategies
+    class Gmail < AbstractSmtpStrategy
+      def configuration
+        {
+          address: 'smtp.gmail.com',
+          port: 587
+        }
+      end
+    end
+  end
+end

data/lib/action_mailer_provider/strategies/zoho.rb

@@ -0,0 +1,16 @@
+require 'action_mailer_provider/strategies/abstract_smtp_strategy'
+
+module ActionMailerProvider
+  module Strategies
+    class Zoho < AbstractSmtpStrategy
+      def configuration
+        {
+          address: 'smtp.zoho.com',
+          port: 465,
+          ssl: true,
+          tls: true
+        }
+      end
+    end
+  end
+end

data/lib/action_mailer_provider/version.rb

@@ -0,0 +1,3 @@
+module ActionMailerProvider
+  VERSION = '0.1.1'
+end

data/lib/generators/action_mailer_provider/install_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators/base'
+
+module ActionMailerProvider
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path '../templates', __FILE__
+
+      def install
+        set_defaults
+        if yes?('By default, values will be fetched through env variables. Would you like to customize them instead? [yN]')
+          override_default(:provider, 'What provider would you like to use?')
+          override_default(:domain, 'What\'s your email domain?')
+          override_default(:email, 'What\'s the email address to use?')
+          override_default(:password, 'Email password')
+        end
+        template 'initializer.rb.erb', 'config/initializers/action_mailer_provider.rb'
+      end
+
+      private
+
+      attr_accessor :provider, :domain, :email, :password
+
+      def quote(str)
+        "'#{str}'"
+      end
+
+      def set_defaults
+        @provider = "ENV['EMAIL_PROVIDER']"
+        @domain = "ENV['EMAIL_DOMAIN']"
+        @email = "ENV['EMAIL_USERNAME']"
+        @password = "ENV['EMAIL_PASSWORD']"
+      end
+
+      def override_default(attr, question)
+        new_value = ask("#{question} [#{public_send(attr)}]")
+        if new_value.size > 0
+          public_send("#{attr}=", quote(new_value))
+        end
+      end
+    end
+  end
+end

data/lib/generators/action_mailer_provider/templates/initializer.rb.erb

@@ -0,0 +1,18 @@
+ActionMailerProvider.configure do |config|
+  # Set your provider here
+  # accepted options:
+  #   :zoho
+  #   :gmail
+  #   nil (to disable the gem)
+  config.provider = <%= @provider %>
+
+  # Your email domain
+  config.domain = <%= @domain %>
+
+  # set the default email account used by action mailer
+  # must belong to the selected provider
+  config.default_email = <%= @email %>
+
+  # password of the email account defined above
+  config.default_email_password = <%= @password %>
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer_provider
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Miguel Palhas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-04 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Action Mailer configuration helper
+email:
+- mpalhas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_mailer_provider.gemspec
+- lib/action_mailer_provider.rb
+- lib/action_mailer_provider/configuration.rb
+- lib/action_mailer_provider/strategies.rb
+- lib/action_mailer_provider/strategies/abstract_smtp_strategy.rb
+- lib/action_mailer_provider/strategies/gmail.rb
+- lib/action_mailer_provider/strategies/zoho.rb
+- lib/action_mailer_provider/version.rb
+- lib/generators/action_mailer_provider/install_generator.rb
+- lib/generators/action_mailer_provider/templates/initializer.rb.erb
+homepage: https://github.com/naps62/action_mailer_provider
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Configure Action Mailer gem according to your email provider specs (Google,
+  Zoho Mail, etc)
+test_files: []