rhizmail 0.1.2 → 0.1.3

data/lib/rhizmail.rb

@@ -30,6 +30,10 @@
 # RhizMail comes with a SimpleTemplateMessage class, suited for times when you 
 # want email templating that is simpler than Amrita or ERB.
 #
+# == Contributors
+#
+# Brian Takita added SMTP authentication for 0.1.3.
+#
 # == Dependencies
 #
 # RhizMail depends on three external libraries:
@@ -44,7 +48,17 @@ require 'net/smtp'
 require 'text/format'
 
 module RhizMail
-	Version = '0.1.2'
+	Version = '0.1.3'
+	
+	# Sets RhizMail to run using mocks for use in testing. Calling
+	# <tt>RhizMail.mock = true</tt> sets the Mailer to use MockMailer instead.
+	def self.mock=( maybe_mock )
+		if maybe_mock and Mailer.get_mailer.is_a?( Mailer )
+			Mailer.set_mailer MockMailer.new
+		elsif !maybe_mock and Mailer.get_mailer.is_a?( MockMailer )
+			ContextualService::Context.instance.set_resource( Mailer, nil )
+		end
+	end
 
 	# Returns a boolean value describing whether <tt>address</tt> is a plausible 
 	# email address format.
@@ -61,7 +75,42 @@ module RhizMail
 	class Mailer < ContextualService::Service
 		@@smtpServer = 'localhost'
 		@@smtpClass = Net::SMTP
+		@@smtpLogin = nil
+		@@smtpPassword = nil
+		@@smtpAuthType = nil
 		@@messagesSent = []
+		
+		def self.smtp_server
+			@@smtpServer
+		end
+		
+		def self.smtp_server=(smtpServer)
+			@@smtpServer = smtpServer
+		end
+		
+		def self.smtp_login
+			@@smtpLogin
+		end
+		
+		def self.smtp_login=(smtpLogin)
+			@@smtpLogin = smtpLogin
+		end
+		
+		def self.smtp_password
+			@@smtpPassword
+		end
+		
+		def self.smtp_password=(smtpPassword)
+			@@smtpPassword = smtpPassword
+		end
+		
+		def self.smtp_auth_type
+			@@smtpAuthType
+		end
+		
+		def self.smtp_auth_type=(smtpAuthType)
+			@@smtpAuthType = smtpAuthType
+		end
 	
 		# Flushes record of messages sent.
 		def self.flush; @@messagesSent = []; end
@@ -79,7 +128,9 @@ module RhizMail
 			msg << "\n"
 			msg << email.body
 			begin
-				@@smtpClass.start( @@smtpServer ) { |smtp|
+				@@smtpClass.start(
+					@@smtpServer, @@smtpLogin, @@smtpPassword, @@smtpAuthType
+				) { |smtp|
 					smtp.sendmail(msg, email.from_address, [ email.to_address ])
 				}
 				@@messagesSent << email
@@ -137,7 +188,7 @@ module RhizMail
 		def from_header # :nodoc:
 			fromHeader = "From: "
 			if @from_name
-				fromHeader += "#{@from_name} <#{@from_address}>"
+				fromHeader += "\"#{@from_name}\" <#{@from_address}>"
 			else
 				fromHeader += "#{@from_address}"
 			end
@@ -164,9 +215,9 @@ module RhizMail
 		def to_header # :nodoc:
 			toHeader = "To: "
 			if @to_name
-				toHeader += " #{@to_name} <#{@to_address}>"
+				toHeader += "\"#{@to_name}\" <#{@to_address}>"
 			else
-				toHeader += " #{@to_address}"
+				toHeader += "#{@to_address}"
 			end
 			toHeader
 		end

data/lib/rhizmail.rb~

@@ -32,10 +32,11 @@
 #
 # == Dependencies
 #
-# RhizMail depends on two external libraries:
+# RhizMail depends on three external libraries:
 #
 # * ContextualService: http://contxtlservice.rubyforge.org
 # * MockFS: http://mockfs.rubyforge.org
+# * Text::Format: http://rubyforge.org/projects/text-format
 
 require 'contxtlservice'
 require 'mockfs'
@@ -43,7 +44,7 @@ require 'net/smtp'
 require 'text/format'
 
 module RhizMail
-	Version = '0.1.1'
+	Version = '0.1.2'
 
 	# Returns a boolean value describing whether <tt>address</tt> is a plausible 
 	# email address format.
@@ -133,25 +134,23 @@ module RhizMail
 		# Sends the email.
 		def deliver; Mailer.get_mailer.send_email( self ); end
 		
-		# Returns an array of strings describing the headers for this email
-		# message.
-		def headers
-			headers = []
-			headers << "Subject: #{@subject}"
-			toHeader = "To: "
-			if @to_name
-				toHeader += " #{@to_name} <#{@to_address}>"
-			else
-				toHeader += " #{@to_address}"
-			end
-			headers << toHeader
+		def from_header # :nodoc:
 			fromHeader = "From: "
 			if @from_name
 				fromHeader += "#{@from_name} <#{@from_address}>"
 			else
 				fromHeader += "#{@from_address}"
 			end
-			headers << fromHeader
+			fromHeader
+		end
+			
+		# Returns an array of strings describing the headers for this email
+		# message.
+		def headers
+			headers = []
+			headers << "Subject: #{@subject}"
+			headers << to_header
+			headers << from_header
 			if content_type == :html
 				headers << "Content-Type: text/html; charset=\"#{@charset}\""
 				headers << "MIME-Version: 1.0"
@@ -161,6 +160,16 @@ module RhizMail
 			end
 			headers
 		end
+		
+		def to_header # :nodoc:
+			toHeader = "To: "
+			if @to_name
+				toHeader += " #{@to_name} <#{@to_address}>"
+			else
+				toHeader += " #{@to_address}"
+			end
+			toHeader
+		end
 	
 		# Mailer calls this before sending a message; subclasses can override this
 		# if they want to ensure that certain parts of the message are valid before 
@@ -225,8 +234,17 @@ module RhizMail
 	#
 	#   Thanks!
 	#
-	# Note that the first line needs to be in the format "Subject: [ SUBJECT ]", 
-	# and should be followed by a blank line.
+	# The Subject and From information can be set explicitly in the template,
+	# with lines like:
+	#
+	#   Subject: Thanks for joining Website.com!
+	#   From: "Bill Smith" <bill.smith@email.com>
+	#
+	# These header lines need to be at the top of the template, and they should
+	# be followed by a blank line dividing them from the template body. Header 
+	# lines are optional; you can leave them and set them explicitly using 
+	# SimpleTemplateMessage#subject=, SimpleTemplateMessage#from_name=, and 
+	# SimpleTemplateMessage#from_address= instead.
 	#
 	# Then you create an instance of SimpleTemplateMessage and use 
 	# SimpleTemplateMessage#substitute to change the contents:
@@ -286,7 +304,7 @@ module RhizMail
 	#
 	# If you call SimpleTemplateMessage#deliver without doing all the
 	# substitutions required by the template, it will raise an InvalidStateError. 
-	# (Getting an exception is probably better than sending a customer an email
+	# (Getting an exception is probably better than sending somebody an email
 	# with funny symbols in it.)
 	class SimpleTemplateMessage < Message
 		SubclassAttributes = Struct.new( :substitutions, :template, :from_address )
@@ -357,23 +375,7 @@ module RhizMail
 		def initialize( *args )
 			if args.first.is_a? Hash
 				h = args.first.clone
-				verboten_keys = [ :body, :charset, :content_type, :subject ]
-				raise InvalidStateError unless ( h.keys & verboten_keys ).empty?
-				template_file = nil
-				if h[:template_file]
-					template_file = h[:template_file]
-					h.delete :template_file
-				else
-					template_file = class_attributes.template
-				end
-				raise InvalidStateError if template_file.nil?
-				read_template template_file
-				if class_attributes.from_address and !h[:from_address]
-					h[:from_address] = class_attributes.from_address
-				end
-				unless h[:body_wrap].nil?
-					@body_wrap = h.delete :body_wrap
-				end
+				initialize_from_hash h
 				super h
 			else
 				to_address, from_address, template_file = args
@@ -396,11 +398,15 @@ module RhizMail
 		def body_template( template ) # :nodoc:
 			body = ''
 			blank_line_found = false
+			headers_included = true
 			template.each { |line|
-				if blank_line_found
+				if blank_line_found or !headers_included
 					body += line
-				else
+				elsif line =~ /: /
 					blank_line_found = true if line =~ /^\n/
+				else
+					headers_included = false
+					body += line
 				end
 			}
 			body
@@ -424,11 +430,29 @@ module RhizMail
 			}
 		end
 		
+		def initialize_from_hash( h ) # :nodoc:
+			verboten_keys = [ :body, :charset, :content_type, :subject ]
+			raise InvalidStateError unless ( h.keys & verboten_keys ).empty?
+			template_file = template_file_from_hash h
+			raise InvalidStateError if template_file.nil?
+			read_template template_file
+			if class_attributes.from_address and !h[:from_address]
+				h[:from_address] = class_attributes.from_address
+			end
+			unless h[:body_wrap].nil?
+				@body_wrap = h.delete :body_wrap
+			end
+		end
+		
 		def read_template( template_file ) # :nodoc:
 			@template = ''
 			MockFS.file.open( template_file ) { |file| @template = file.gets nil }
 			@template =~ /Subject: (.*)/
-			@subject = $1
+			@subject = ( $1 or '' )
+			if @template =~ /^From: "(.*?)" \<(.*?)\>$/m
+				self.from_name = $1
+				self.from_address = $2
+			end
 		end
 	
 		# Substitute a token with a value in the email body.
@@ -452,6 +476,14 @@ module RhizMail
 		# to make when you create a new instance. +substitutions+ should always 
 		# return a hash of tokens to either values or Procs.
 		def substitutions; {}; end
+			
+		def template_file_from_hash( h ) # :nodoc:
+			if h[:template_file]
+				h.delete :template_file
+			else
+				template_file = class_attributes.template
+			end
+		end
 		
 		# Mailer will call this before sending this message; this will fail if any
 		# tokens are left unsubstituted.

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.6
 specification_version: 1
 name: rhizmail
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2005-09-16
+  version: 0.1.3
+date: 2005-10-26
 summary: RhizMail is a test-friendly library for sending out customized emails.
 require_paths: 
   - lib