actionmailer 0.3.0 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,19 @@
+*0.4* (5)
+
+* Consolidated the server configuration options into Base#server_settings= and expanded that with controls for authentication and more [Marten]
+  NOTE: This is an API change that could potentially break your application if you used the old application form. Please do change!
+
+* Added Base#deliveries as an accessor for an array of emails sent out through that ActionMailer class when using the :test delivery option. [bitsweat]
+
+* Added Base#perform_deliveries= which can be set to false to turn off the actual delivery of the email through smtp or sendmail.
+  This is especially useful for functional testing that shouldn't send off real emails, but still trigger delivery_* methods.
+
+* Added option to specify delivery method with Base#delivery_method=. Default is :smtp and :sendmail is currently the only other option.
+  Sendmail is assumed to be present at "/usr/sbin/sendmail" if that option is used. [Kent Sibilev]
+
+* Dropped "include TMail" as it added to much baggage into the default namespace (like Version) [Chad Fowler]
+
+
 *0.3*
 
 * First release

data/lib/action_mailer.rb

@@ -36,7 +36,6 @@ require 'action_mailer/mail_helper'
 require 'action_mailer/vendor/tmail'
 require 'net/smtp'
 
-include TMail
 ActionView::Base.class_eval { include MailHelper }
 
 old_verbose, $VERBOSE = $VERBOSE, nil

data/lib/action_mailer/base.rb

@@ -34,18 +34,44 @@ module ActionMailer #:nodoc:
     # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
     cattr_accessor :logger
 
-    # Allows you to use a remote mail server. Just change it away from it's default "localhost" setting.
-    @@mail_server_address = "localhost"
-    cattr_accessor :mail_server_address
+    # Allows detailed configuration of the server:
+    # * <tt>:address</tt> Allows you to use a remote mail server. Just change it away from it's default "localhost" setting.
+    # * <tt>:port</tt> On the off change that your mail server doesn't run on port 25, you can change it.
+    # * <tt>:domain</tt> If you need to specify a HELO domain, you can do it here.
+    # * <tt>:user_name</tt> If your mail server requires authentication, set the username and password in these two settings.
+    # * <tt>:password</tt> If your mail server requires authentication, set the username and password in these two settings.
+    # * <tt>:authentication</tt> If your mail server requires authentication, you need to specify the authentication type here. 
+    #   This is a symbol and one of :plain, :login, :cram_md5
+    @@server_settings = { 
+      :address        => "localhost", 
+      :port           => 25, 
+      :domain         => 'localhost.localdomain', 
+      :user_name      => nil, 
+      :password       => nil, 
+      :authentication => nil
+    }
+    cattr_accessor :server_settings
 
-    # On the off change that your mail server doesn't run on port 25, you can change it.
-    @@mail_server_port = 25
-    cattr_accessor :mail_server_port
 
     # Whether or not errors should be raised if the email fails to be delivered
     @@raise_delivery_errors = true
     cattr_accessor :raise_delivery_errors
 
+    # Defines a delivery method. Possible values are :smtp (default), :sendmail, and :test.
+    # Sendmail is assumed to be present at "/usr/sbin/sendmail".
+    @@delivery_method = :smtp
+    cattr_accessor :delivery_method
+    
+    # Determines whether deliver_* methods are actually carried out. By default they are,
+    # but this can be turned off to help functional testing.
+    @@perform_deliveries = true
+    cattr_accessor :perform_deliveries
+    
+    # Keeps an array of all the emails sent out through the Action Mailer with delivery_method :test. Most useful
+    # for unit and functional testing.
+    @@deliveries = []
+    cattr_accessor :deliveries
+
     attr_accessor :recipients, :subject, :body, :from, :sent_on, :bcc, :cc
 
     class << self
@@ -62,26 +88,41 @@ module ActionMailer #:nodoc:
         end        
       end
 
-      def mail(to, subject, body, from, timestamp = nil)#:nodoc:
+      def mail(to, subject, body, from, timestamp = nil) #:nodoc:
         deliver(create(to, subject, body, from, timestamp))
       end
-  
-      def create(to, subject, body, from, timestamp = nil)#:nodoc:
-        m = Mail.new
+
+      def create(to, subject, body, from, timestamp = nil) #:nodoc:
+        m = TMail::Mail.new
         m.to, m.subject, m.body, m.from = to, subject, body, from
         m.date = timestamp.respond_to?("to_time") ? timestamp.to_time : (timestamp || Time.now)    
         return m
       end
 
-      def deliver(mail)#:nodoc:
+      def deliver(mail) #:nodoc:
         logger.info "Sent mail:\n #{mail.encoded}" unless logger.nil?
+        send("perform_delivery_#{delivery_method}", mail) if perform_deliveries
+      end
 
-        Net::SMTP.start(mail_server_address, mail_server_port) do |smtp|
-          smtp.sendmail(mail.encoded, mail.from_address, mail.destinations)
+      private      
+        def perform_delivery_smtp(mail)
+          Net::SMTP.start(server_settings[:address], server_settings[:port], server_settings[:domain], 
+              server_settings[:user_name], server_settings[:password], server_settings[:authentication]) do |smtp|
+            smtp.sendmail(mail.encoded, mail.from_address, mail.destinations)
+          end
+        end
+
+        def perform_delivery_sendmail(mail)
+          IO.popen("/usr/sbin/sendmail -i -t","w+") do |sm|
+            sm.print(mail.encoded)
+            sm.flush
+          end
+        end
+
+        def perform_delivery_test(mail)
+          deliveries << mail
         end
-      end
 
-      private
         def create_from_action(method_name, *parameters)
           mailer = new
           mailer.body = {}
@@ -108,4 +149,4 @@ module ActionMailer #:nodoc:
         end
     end
   end
-end
+end

data/rakefile

@@ -6,7 +6,10 @@ require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "0.3.0"
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME      = 'actionmailer'
+PKG_VERSION   = '0.4.0' + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 desc "Default Task"
 task :default => [ :test ]
@@ -37,7 +40,7 @@ Rake::RDocTask.new { |rdoc|
 
 spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
-  s.name = 'actionmailer'
+  s.name = PKG_NAME
   s.summary = "Service layer for easy email delivery and testing."
   s.description = %q{Makes it trivial to test and deliver emails sent from a single service layer.}
   s.version = PKG_VERSION
@@ -47,7 +50,7 @@ spec = Gem::Specification.new do |s|
   s.rubyforge_project = "actionmailer"
   s.homepage = "http://actionmailer.rubyonrails.org"
 
-  s.add_dependency('actionpack', '>= 0.9.0')
+  s.add_dependency('actionpack', '>= 0.9.5')
 
   s.has_rdoc = true
   s.requirements << 'none'
@@ -66,6 +69,11 @@ Rake::GemPackageTask.new(spec) do |p|
 end
 
 
+# Publish beta gem
+desc "Publish the API documentation"
+task :pgem => [:package] do 
+  Rake::SshFilePublisher.new("davidhh@one.textdrive.com", "domains/rubyonrails.org/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
+end
 
 # Publish documentation
 desc "Publish the API documentation"
@@ -83,10 +91,10 @@ desc "Count lines in the main rake file"
 task :lines do
   lines = 0
   codelines = 0
-  Dir.foreach("lib/action_controller") { |file_name| 
+  Dir.foreach("lib/action_mailer") { |file_name| 
     next unless file_name =~ /.*rb/
     
-    f = File.open("lib/action_controller/" + file_name)
+    f = File.open("lib/action_mailer/" + file_name)
 
     while line = f.gets
       lines += 1
@@ -96,4 +104,4 @@ task :lines do
     end
   }
   puts "Lines #{lines}, LOC #{codelines}"
-end
+end

data/test/mail_service_test.rb

@@ -24,30 +24,69 @@ end
 TestMailer.template_root = File.dirname(__FILE__) + "/fixtures"
 
 class ActionMailerTest < Test::Unit::TestCase
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+    @recipient = 'test@localhost'
+  end
+
   def test_signed_up
     expected = TMail::Mail.new
-    expected.to      = "david@loudthinking.com"
-    expected.subject = "[Signed up] Welcome david@loudthinking.com"
-    expected.body    = "Hello there, \n\nMr. david@loudthinking.com"
+    expected.to      = @recipient
+    expected.subject = "[Signed up] Welcome #{@recipient}"
+    expected.body    = "Hello there, \n\nMr. #{@recipient}"
     expected.from    = "system@loudthinking.com"
     expected.date    = Time.local(2004, 12, 12)
 
-    assert_equal expected.encoded, TestMailer.create_signed_up("david@loudthinking.com").encoded
+    created = nil
+    assert_nothing_raised { created = TestMailer.create_signed_up(@recipient) }
+    assert_not_nil created
+    assert_equal expected.encoded, created.encoded
+
+    assert_nothing_raised { TestMailer.deliver_signed_up(@recipient) }
+    assert_not_nil ActionMailer::Base.deliveries.first
+    assert_equal expected.encoded, ActionMailer::Base.deliveries.first.encoded
   end
   
   def test_cancelled_account
     expected = TMail::Mail.new
-    expected.to      = "david@loudthinking.com"
-    expected.subject = "[Cancelled] Goodbye david@loudthinking.com"
-    expected.body    = "Goodbye, Mr. david@loudthinking.com"
+    expected.to      = @recipient
+    expected.subject = "[Cancelled] Goodbye #{@recipient}"
+    expected.body    = "Goodbye, Mr. #{@recipient}"
     expected.from    = "system@loudthinking.com"
     expected.date    = Time.local(2004, 12, 12)
 
-    assert_equal expected.encoded, TestMailer.create_cancelled_account("david@loudthinking.com").encoded
+    created = nil
+    assert_nothing_raised { created = TestMailer.create_cancelled_account(@recipient) }
+    assert_not_nil created
+    assert_equal expected.encoded, created.encoded
+
+    assert_nothing_raised { TestMailer.deliver_cancelled_account(@recipient) }
+    assert_not_nil ActionMailer::Base.deliveries.first
+    assert_equal expected.encoded, ActionMailer::Base.deliveries.first.encoded
   end
   
   def test_instances_are_nil
     assert_nil ActionMailer::Base.new
     assert_nil TestMailer.new
   end
-end
+
+  def test_deliveries_array
+    assert_not_nil ActionMailer::Base.deliveries
+    assert_equal 0, ActionMailer::Base.deliveries.size
+    TestMailer.deliver_signed_up(@recipient)
+    assert_equal 1, ActionMailer::Base.deliveries.size
+    assert_not_nil ActionMailer::Base.deliveries.first
+  end
+
+  def test_perform_deliveries_flag
+    ActionMailer::Base.perform_deliveries = false
+    TestMailer.deliver_signed_up(@recipient)
+    assert_equal 0, ActionMailer::Base.deliveries.size
+    ActionMailer::Base.perform_deliveries = true
+    TestMailer.deliver_signed_up(@recipient)
+    assert_equal 1, ActionMailer::Base.deliveries.size
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: actionmailer
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2004-10-25
+  version: 0.4.0
+date: 2004-11-18
 summary: Service layer for easy email delivery and testing.
 require_paths: 
   - lib
@@ -82,5 +82,5 @@ dependencies:
         - 
           - ">="
           - !ruby/object:Gem::Version 
-            version: 0.9.0
+            version: 0.9.5
       version: