openrain-action_mailer_tls 1.1.0

data/History.txt

@@ -0,0 +1,6 @@
+== 1.1.0 / 2009-02-10
+    * Converted plugin into a Rubygem with a Rails generator.
+    * Updated README with installation details.
+ 
+== 1.0.0 / 2009-02-09
+  * Tagging original SVN migration.

data/README.markdown

@@ -0,0 +1,82 @@
+ActionMailerTLS
+===============
+
+Background
+----------
+
+This Ruby on Rails plugin makes it trivial to send email through a Google Apps for business account.
+
+This gem will only work on Ruby 1.8.6.
+
+Installation
+------------
+
+If you're on Ruby 1.8.7 and Rails >= 2.2.1, you don't need this plugin. See Notes below.
+
+To install the gem (the preferred way):
+
+  1. sudo gem install openrain-action_mailer_tls -s http://gems.github.com
+  2. ./script/generate action_mailer_tls
+  3. Copy RAILS_ROOT/config/smtp_gmail.yml.sample to RAILS_ROOT/config/smtp_gmail.yml
+  4. Update the configuration file with your settings
+
+  To (optionally) vendor this gem
+  1. Add config.gem "openrain-action_mailer_tls", :source => "http://gems.github.com"
+  2. rake gems:unpack
+
+To install the plugin (the old way)
+
+  1. ./script/plugin install git://github.com/openrain/action_mailer_tls.git -r '1.0.0'
+  2. Copy vendor/plugins/action_mailer_tls/sample/smtp_gmail.rb to config/
+  3. Copy vendor/plugins/action_mailer_tls/sample/mailer.yml.sample to config/
+  4. Update the configuration file with your settings
+
+Testing it out
+--------------
+
+  1. ./script/generate mailer Notifier hello_world
+  2. Add the following lines to config/environments/development.rb 
+    config.action_mailer.raise_delivery_errors = true
+    config.action_mailer.perform_deliveries = true
+    config.action_mailer.delivery_method = :smtp
+  3. Update the recipients and from fields in app/models/notifier.rb
+  4. ./script/console 
+  5. >> Notifier.deliver_hello_world!
+
+Resources
+---------
+
+Blog posts
+
+* http://www.rubyinside.com/how-to-use-gmails-smtp-server-with-rails-394.html
+* http://www.prestonlee.com/archives/63
+
+Books
+
+* Advanced Rails Recipes pg. 238, Recipe #47.
+
+Notes
+-----
+
+If you're running Rails >= 2.2.1 [RC2] and Ruby 1.8.7, you don't need this plugin. Ruby 1.8.7 supports
+SMTP TLS and Rails 2.2.1 ships with an option to enable it if you're running Ruby 1.8.7.
+
+  To set it all up, in config/initializers/smtp_gmail.rb:
+    ActionMailer::Base.smtp_settings = {
+      :address => "smtp.gmail.com",
+      :port => 587,
+      :authentication => :plain,
+      :enable_starttls_auto => true
+      :user_name: your_username@gmail.com
+      :password: h@ckme
+    }
+
+  http://github.com/rails/rails/commit/732c724df61bc8b780dc42817625b25a321908e4
+
+Author
+------
+* Marc Chung - marc [dot] chung [at] openrain [dot] com
+
+License
+-------
+* Copyright (c) 2009 OpenRain, LLC. See MIT-LICENSE for details

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 1
+:minor: 1

data/generators/USAGE

@@ -0,0 +1,16 @@
+Description:
+    The action_mailer_tls generator adds smtp-tls support to your Rails projects.
+ 
+    The generator takes no arguments and only needs to be run once. It will create
+    a Rails initializer for Gmail, and a sample YAML configuration file.
+    
+    Modify the contents of the configuration file with your Gmail username and 
+    password
+ 
+Example:
+    ./script/generate action_mailer_tls
+ 
+    This will create the following files:
+        Initializer:  config/initializers/smtp_gmail.rb
+        Config:       config/smtp_gmail.yml.sample
+

data/generators/action_mailer_tls_generator.rb

@@ -0,0 +1,11 @@
+# This generator intalls ActionMailerTLS into a Rails project
+class ActionMailerTlsGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.file "config/smtp_gmail.yml.sample",        "config/smtp_gmail.yml.sample"
+      m.file "config/initializers/smtp_gmail.rb",   "config/initializers/smtp_gmail.rb"
+    end
+  end
+
+end

data/generators/templates/config/initializers/smtp_gmail.rb

@@ -0,0 +1,14 @@
+# This file is automatically copied into RAILS_ROOT/initializers
+
+require "smtp_tls"
+
+config_file = "#{RAILS_ROOT}/config/smtp_gmail.yml"
+raise "Sorry, you must have #{config_file}" unless File.exists?(config_file)
+
+config_options = YAML.load_file(config_file) 
+ActionMailer::Base.smtp_settings = {
+  :address => "smtp.gmail.com",
+  :port => 587,
+  :authentication => :plain,
+  :enable_starttls_auto => true
+}.merge(config_options) # Configuration options override default options

data/generators/templates/config/smtp_gmail.yml.sample

@@ -0,0 +1,3 @@
+--- 
+  :user_name: your_username@gmail.com
+  :password: h@ckme

data/lib/smtp_tls.rb

@@ -0,0 +1,65 @@
+require "openssl"
+require "net/smtp"
+
+Net::SMTP.class_eval do
+  private
+  def do_start(helodomain, user, secret, authtype)
+    raise IOError, 'SMTP session already started' if @started
+    check_auth_args user, secret, authtype if user or secret
+
+    sock = timeout(@open_timeout) { TCPSocket.open(@address, @port) }
+    @socket = Net::InternetMessageIO.new(sock)
+    @socket.read_timeout = 60 #@read_timeout
+
+    check_response(critical { recv_response() })
+    do_helo(helodomain)
+
+    if starttls
+      raise 'openssl library not installed' unless defined?(OpenSSL)
+      ssl = OpenSSL::SSL::SSLSocket.new(sock)
+      ssl.sync_close = true
+      ssl.connect
+      @socket = Net::InternetMessageIO.new(ssl)
+      @socket.read_timeout = 60 #@read_timeout
+      do_helo(helodomain)
+    end
+
+    authenticate user, secret, authtype if user
+    @started = true
+  ensure
+    unless @started
+      # authentication failed, cancel connection.
+      @socket.close if not @started and @socket and not @socket.closed?
+      @socket = nil
+    end
+  end
+
+  def do_helo(helodomain)
+    begin
+      if @esmtp
+        ehlo helodomain
+      else
+        helo helodomain
+      end
+    rescue Net::ProtocolError
+      if @esmtp
+        @esmtp = false
+        @error_occured = false
+        retry
+      end
+      raise
+    end
+  end
+
+  def starttls
+    getok('STARTTLS') rescue return false
+    return true
+  end
+
+  def quit
+    begin
+      getok('QUIT')
+    rescue EOFError
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: openrain-action_mailer_tls
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Marc Chung
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Conveniently send emails through Google's Hosted App service
+email: marc.chung@openrain.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- README.markdown
+- VERSION.yml
+- generators/USAGE
+- generators/action_mailer_tls_generator.rb
+- generators/templates
+- generators/templates/config
+- generators/templates/config/initializers
+- generators/templates/config/initializers/smtp_gmail.rb
+- generators/templates/config/smtp_gmail.yml.sample
+- lib/smtp_tls.rb
+has_rdoc: true
+homepage: http://github.com/openrain/action_mailer_tls
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Send Email via Gmail
+test_files: []
+