pony 1.0 → 1.0.1

data/README.rdoc

@@ -81,6 +81,7 @@ Options passed pretty much directly to Mail
  attachments # see Attachments section above
  headers # see Custom headers section above
  message_id
+ sender
 
 Other options
  via # :smtp or :sendmail, see Transport section above

data/lib/pony.rb

@@ -85,6 +85,7 @@ require 'base64'
 #  attachments # see Attachments section above
 #  headers # see Custom headers section above
 #  message_id
+#  sender  # Sets "envelope from" (and the Sender header)
 # 
 # Other options
 #  via # :smtp or :sendmail, see Transport section above
@@ -155,6 +156,7 @@ module Pony
 			subject options[:subject]
 			date options[:date] || Time.now
 			message_id options[:message_id]
+			sender options[:sender] if options[:sender]
 
 			if options[:html_body]
 				html_part do

data/lib/pony.rb~

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'net/smtp'
+require 'mime/types'
+begin
+	require 'smtp_tls'
+rescue LoadError
+end
+require 'base64'
+begin
+	require 'tmail'
+rescue LoadError
+	require 'actionmailer'
+end
+
+module Pony
+	def self.mail(options)
+		raise(ArgumentError, ":to is required") unless options[:to]
+
+		via = options.delete(:via)
+		if via.nil?
+			transport build_tmail(options)
+		else
+			if via_options.include?(via.to_s)
+				send("transport_via_#{via}", build_tmail(options), options)
+			else
+				raise(ArgumentError, ":via must be either smtp or sendmail")
+			end
+		end
+	end
+
+	def self.build_tmail(options)
+		mail = TMail::Mail.new
+		mail.to = options[:to]
+		mail.cc = options[:cc]
+		mail.bcc = options[:bcc]
+		mail.from = options[:from] || 'pony@unknown'
+		mail.subject = options[:subject]
+		mail.date = options[:date] || Time.now
+		mail.message_id = options[:message_id]
+		if options[:attachments]
+			# If message has attachment, then body must be sent as a message part
+			# or it will not be interpreted correctly by client.
+			body = TMail::Mail.new
+			body.body = options[:body] || ""
+			body.content_type = options[:content_type] || "text/plain"
+			mail.parts.push body
+			(options[:attachments] || []).each do |name, body|
+				attachment = TMail::Mail.new
+				attachment.transfer_encoding = "base64"
+				attachment.body = Base64.encode64(body)
+				content_type = MIME::Types.type_for(name).to_s
+				attachment.content_type = content_type unless content_type == ""
+				attachment.set_content_disposition "attachment", "filename" => name
+				mail.parts.push attachment
+			end
+		else
+			mail.content_type = options[:content_type] || "text/plain"
+			mail.body = options[:body] || ""
+		end
+		(options[:headers] ||= {}).each do |key, value|
+			mail[key] = value
+		end
+		mail.charset = options[:charset] # charset must be set after setting content_type
+		mail
+	end
+
+	def self.sendmail_binary
+		sendmail = `which sendmail`.chomp
+		sendmail.empty? ? '/usr/sbin/sendmail' : sendmail
+	end
+
+	def self.transport(tmail)
+		if File.executable? sendmail_binary
+			transport_via_sendmail(tmail)
+		else
+			transport_via_smtp(tmail)
+		end
+	end
+
+	def self.via_options
+		%w(sendmail smtp)
+	end
+
+	def self.transport_via_sendmail(tmail, options={})
+		IO.popen('-', 'w+') do |pipe|
+			if pipe
+				pipe.write(tmail.to_s)
+			else
+				exec(sendmail_binary, "-t")
+			end
+		end
+	end
+
+	def self.transport_via_smtp(tmail, options={:smtp => {}})
+		default_options = {:smtp => { :host => 'localhost', :port => '25', :domain => 'localhost.localdomain' }}
+		o = default_options[:smtp].merge(options[:smtp])
+		smtp = Net::SMTP.new(o[:host], o[:port])
+		if o[:tls]
+			raise "You may need: gem install smtp_tls" unless smtp.respond_to?(:enable_starttls)
+			smtp.enable_starttls
+		end
+		if o.include?(:auth)
+			smtp.start(o[:domain], o[:user], o[:password], o[:auth])
+		else
+			smtp.start(o[:domain])
+		end
+		smtp.send_message tmail.to_s, tmail.from, tmail.destinations
+		smtp.finish
+	end
+end

data/pony.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
 	s.name = %q{pony}
-	s.version = "1.0"
+	s.version = "1.0.1"
 
 	s.description = "Send email in one command: Pony.mail(:to => 'someone@example.com', :body => 'hello')"
 	s.summary = s.description

data/spec/pony_spec.rb

@@ -118,6 +118,10 @@ describe Pony do
 			Pony.build_mail(:headers => {"List-ID" => "<abc@def.com>"})['List-ID'].to_s.should == '<abc@def.com>'
 		end
 
+		it "sender" do
+			Pony.build_mail(:sender => "abc@def.com")['Sender'].to_s.should == 'abc@def.com'
+		end
+
 		it "utf-8 encoded subject line" do
 			mail = Pony.build_mail(:to => 'btp@foo', :subject => 'Café', :body => 'body body body')
 			mail['subject'].encoded.should =~ /^Subject: =\?UTF-8/;

data/spec/pony_spec.rb~

@@ -0,0 +1,232 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Pony do
+	it "sends mail" do
+		Pony.should_receive(:transport) do |tmail|
+			tmail.to.should == [ 'joe@example.com' ]
+			tmail.from.should == [ 'sender@example.com' ]
+			tmail.subject.should == 'hi'
+			tmail.body.should == 'Hello, Joe.'
+		end
+		Pony.mail(:to => 'joe@example.com', :from => 'sender@example.com', :subject => 'hi', :body => 'Hello, Joe.')
+	end
+
+	it "requires :to param" do
+		Pony.stub!(:transport)
+		lambda { Pony.mail({}) }.should raise_error(ArgumentError)
+	end
+
+	it "doesn't require any other param" do
+		Pony.stub!(:transport)
+		lambda { Pony.mail(:to => 'joe@example.com') }.should_not raise_error
+	end
+
+	####################
+
+	describe "builds a TMail object with field:" do
+		it "to" do
+			Pony.build_tmail(:to => 'joe@example.com').to.should == [ 'joe@example.com' ]
+		end
+		
+		it "to with multiple recipients" do
+			Pony.build_tmail(:to => 'joe@example.com, friedrich@example.com').to.should == [ 'joe@example.com', 'friedrich@example.com' ]
+		end
+		
+		it "to with multiple recipients and names" do
+			Pony.build_tmail(:to => 'joe@example.com, "Friedrich Hayek" <friedrich@example.com>').to.should == [ 'joe@example.com', 'friedrich@example.com' ]
+		end
+		
+		it "to with multiple recipients and names in an array" do
+			Pony.build_tmail(:to => ['joe@example.com', '"Friedrich Hayek" <friedrich@example.com>']).to.should == [ 'joe@example.com', 'friedrich@example.com' ]
+		end
+
+		it "cc" do
+			Pony.build_tmail(:cc => 'joe@example.com').cc.should == [ 'joe@example.com' ]
+		end
+		
+		it "cc with multiple recipients" do
+			Pony.build_tmail(:cc => 'joe@example.com, friedrich@example.com').cc.should == [ 'joe@example.com', 'friedrich@example.com' ]
+		end
+
+		it "from" do
+			Pony.build_tmail(:from => 'joe@example.com').from.should == [ 'joe@example.com' ]
+		end
+
+		it "bcc" do
+			Pony.build_tmail(:bcc => 'joe@example.com').bcc.should == [ 'joe@example.com' ]
+		end
+
+		it "bcc with multiple recipients" do
+			Pony.build_tmail(:bcc => 'joe@example.com, friedrich@example.com').bcc.should == [ 'joe@example.com', 'friedrich@example.com' ]
+		end
+
+		it "charset" do
+			Pony.build_tmail(:charset => 'UTF-8').charset.should == 'UTF-8'
+		end
+
+		it "default charset" do
+			Pony.build_tmail(:body => 'body').charset.should == nil
+			Pony.build_tmail(:body => 'body', :content_type => 'text/html').charset.should == nil
+		end
+
+		it "from (default)" do
+			Pony.build_tmail({}).from.should == [ 'pony@unknown' ]
+		end
+
+		it "subject" do
+			Pony.build_tmail(:subject => 'hello').subject.should == 'hello'
+		end
+
+		it "body" do
+			Pony.build_tmail(:body => 'What do you know, Joe?').body.should == 'What do you know, Joe?'
+		end
+
+		it "content_type" do
+			Pony.build_tmail(:content_type => 'text/html').content_type.should == 'text/html'
+		end
+
+		it "message_id" do
+			Pony.build_tmail(:message_id => '<abc@def.com>').message_id.should == '<abc@def.com>'
+		end
+
+		it "custom headers" do
+			Pony.build_tmail(:headers => {"List-ID" => "<abc@def.com>"})['List-ID'].to_s.should == '<abc@def.com>'
+		end
+
+		it "attachments" do
+			tmail = Pony.build_tmail(:attachments => {"foo.txt" => "content of foo.txt"})
+			tmail.should have(2).parts
+			tmail.parts.first.to_s.should == "Content-Type: text/plain\n\n"
+			tmail.parts.last.to_s.should == <<-PART
+Content-Type: text/plain
+Content-Transfer-Encoding: Base64
+Content-Disposition: attachment; filename=foo.txt
+
+Y29udGVudCBvZiBmb28udHh0
+			 PART
+		end
+
+		it "suggests mime-type" do
+			tmail = Pony.build_tmail(:attachments => {"foo.pdf" => "content of foo.pdf"})
+			tmail.should have(2).parts
+			tmail.parts.first.to_s.should == "Content-Type: text/plain\n\n"
+			tmail.parts.last.to_s.should == <<-PART
+Content-Type: application/pdf
+Content-Transfer-Encoding: Base64
+Content-Disposition: attachment; filename=foo.pdf
+
+Y29udGVudCBvZiBmb28ucGRm
+			 PART
+		end
+	end
+
+	describe "transport" do
+		it "transports via the sendmail binary if it exists" do
+			File.stub!(:executable?).and_return(true)
+			Pony.should_receive(:transport_via_sendmail).with(:tmail)
+			Pony.transport(:tmail)
+		end
+
+		it "transports via smtp if no sendmail binary" do
+			Pony.stub!(:sendmail_binary).and_return('/does/not/exist')
+			Pony.should_receive(:transport_via_smtp).with(:tmail)
+			Pony.transport(:tmail)
+		end
+
+		it "transports mail via /usr/sbin/sendmail binary" do
+			pipe = mock('sendmail pipe')
+			IO.should_receive(:popen).with('-',"w+").and_yield(pipe)
+			pipe.should_receive(:write).with('message')
+			Pony.transport_via_sendmail(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message'))
+		end
+
+		describe "SMTP transport" do
+			before do
+				@smtp = mock('net::smtp object')
+				@smtp.stub!(:start)
+				@smtp.stub!(:send_message)
+				@smtp.stub!(:finish)
+				Net::SMTP.stub!(:new).and_return(@smtp)
+			end
+
+			it "passes cc and bcc as the list of recipients" do
+				@smtp.should_receive(:send_message).with("message", ['from'], ['to', 'cc', 'bcc'])
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :cc => ['cc'], :from => ['from'], :to_s => 'message', :bcc => ['bcc'], :destinations => ['to', 'cc', 'bcc']))
+				@smtp.should_receive(:send_message).with("message", 'from', ['to', 'cc'])
+				Pony.transport_via_smtp(mock('tmail', :to => 'to', :cc => 'cc', :from => 'from', :to_s => 'message', :bcc => nil, :destinations => ['to', 'cc']))
+			end
+
+			it "only pass cc as the list of recipients" do
+				@smtp.should_receive(:send_message).with("message", ['from'], ['to', 'cc' ])
+					Pony.transport_via_smtp(mock('tmail', :to => ['to'], :cc => ['cc'], :from => ['from'], :to_s => 'message', :bcc => nil, :destinations => ['to', 'cc']))
+			end
+
+			it "only pass bcc as the list of recipients" do
+				@smtp.should_receive(:send_message).with("message", ['from'], ['to', 'bcc' ])
+					Pony.transport_via_smtp(mock('tmail', :to => ['to'], :cc => nil, :from => ['from'], :to_s => 'message', :bcc => ['bcc'], :destinations => ['to', 'bcc']))
+			end
+
+			it "passes cc and bcc as the list of recipients when there are a few of them" do
+				@smtp.should_receive(:send_message).with("message", ['from'], ['to', 'to2', 'cc', 'bcc', 'bcc2', 'bcc3'])
+					Pony.transport_via_smtp(mock('tmail', :to => ['to', 'to2'], :cc => ['cc'], :from => ['from'], :to_s => 'message', :bcc => ['bcc', 'bcc2', 'bcc3'], :destinations => ['to', 'to2', 'cc', 'bcc', 'bcc2', 'bcc3']))
+			end
+
+			it "defaults to localhost as the SMTP server" do
+				Net::SMTP.should_receive(:new).with('localhost', '25').and_return(@smtp)
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message', :cc => nil, :bcc => nil, :destinations => ['to']))
+			end
+
+			it "uses SMTP authorization when auth key is provided" do
+				o = { :smtp => { :user => 'user', :password => 'password', :auth => 'plain'}}
+				@smtp.should_receive(:start).with('localhost.localdomain', 'user', 'password', 'plain')
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message', :cc => nil, :bcc => nil, :destinations => ['to']), o)
+			end
+
+			it "enable starttls when tls option is true" do
+				o = { :smtp => { :user => 'user', :password => 'password', :auth => 'plain', :tls => true}}
+				@smtp.should_receive(:enable_starttls)
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message', :cc => nil, :bcc => nil, :destinations => ['to']), o)
+			end
+
+			it "starts the job" do
+				@smtp.should_receive(:start)
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message', :cc => nil, :bcc => nil, :destinations => ['to']))
+			end
+
+			it "sends a tmail message" do
+				@smtp.should_receive(:send_message)
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message', :cc => nil, :bcc => nil, :destinations => ['to']))
+			end
+
+			it "finishes the job" do
+				@smtp.should_receive(:finish)
+				Pony.transport_via_smtp(mock('tmail', :to => ['to'], :from => ['from'], :to_s => 'message', :cc => nil, :bcc => nil, :destinations => ['to']))
+			end
+
+		end
+	end
+
+	describe ":via option should over-ride the default transport mechanism" do
+		it "should send via sendmail if :via => sendmail" do
+			Pony.should_receive(:transport_via_sendmail)
+			Pony.mail(:to => 'joe@example.com', :via => :sendmail)
+		end
+
+		it "should send via smtp if :via => smtp" do
+			Pony.should_receive(:transport_via_smtp)
+			Pony.mail(:to => 'joe@example.com', :via => :smtp)
+		end
+
+		it "should raise an error if via is neither smtp nor sendmail" do
+			lambda { Pony.mail(:to => 'joe@plumber.com', :via => :pigeon) }.should raise_error(ArgumentError)
+		end
+	end
+
+	describe "sendmail binary location" do
+		it "should default to /usr/sbin/sendmail if not in path" do
+			Pony.stub!(:'`').and_return('')
+			Pony.sendmail_binary.should == '/usr/sbin/sendmail'
+		end
+	end
+
+end

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  version: "1.0"
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 -06:00
+date: 2010-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,9 +43,11 @@ files:
 - README.rdoc
 - Rakefile
 - pony.gemspec
+- lib/pony.rb~
 - lib/pony.rb
-- spec/pony_spec.rb
 - spec/base.rb
+- spec/pony_spec.rb~
+- spec/pony_spec.rb
 has_rdoc: true
 homepage: http://github.com/benprew/pony
 licenses: []