pony 0.4 → 0.4.1

data/README.rdoc

@@ -0,0 +1,79 @@
+= Pony, the express way to send email in Ruby
+
+== Overview
+
+Ruby no longer has to be jealous of PHP's mail() function, which can send an email in a single command.
+
+  Pony.mail(:to => 'you@example.com', :from => 'me@example.com', :subject => 'hi', :body => 'Hello there.')
+  Pony.mail(:to => 'you@example.com', :from => 'me@example.com', :subject => 'hi', :body => '<h1>Hello there!</h1>', :content_type => 'text/html')
+  Pony.mail(:to => 'you@example.com', :cc => 'him@example.com', :from => 'me@example.com', :subject => 'hi', :body => 'Howdy')
+
+Any option key may be omitted except for :to.
+
+
+== Transport
+
+Pony uses /usr/sbin/sendmail to send mail if it is available, otherwise it uses SMTP to localhost.
+
+This can be over-ridden if you specify a via option
+
+  Pony.mail(:to => 'you@example.com', :via => :smtp) # sends via SMTP
+  
+  Pony.mail(:to => 'you@example.com', :via => :sendmail) # sends via sendmail
+
+You can also specify options for SMTP:
+
+  Pony.mail(:to => 'you@example.com', :via => :smtp, :smtp => {
+    :host   => 'smtp.yourserver.com',
+    :port   => '25',
+    :user   => 'user',
+    :pass   => 'pass',
+    :auth   => :plain # :plain, :login, :cram_md5, no auth by default
+    :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
+  }
+
+== TLS/SSL
+
+With smtp transport it also possible to use TLS/SSL:
+
+  Pony.mail(:to => 'you@example.com', :via => :smtp, :smtp => {
+    :host   => 'smtp.gmail.com',
+    :port   => '587',
+    :tls    => true,
+    :user   => 'user',
+    :pass   => 'pass',
+    :auth   => :plain # :plain, :login, :cram_md5, no auth by default
+    :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
+  })
+
+== Attachments
+
+You can attach a file or two with the :attachments option:
+
+  Pony.mail(..., :attachments => {"foo.zip" => File.read("path/to/foo.zip"), "hello.txt" => "hello!"})
+
+An attachment's mime-type is set based on the filename (as dictated by the ruby gem mime-types).  So 'foo.pdf' has a mime-type of 'application/pdf'
+
+== Meta
+
+Maintained by Ben Prew
+
+Written by Adam Wiggins
+
+Patches contributed by: Mathieu Martin, Arun Thampi, Thomas Hurst, Stephen
+Celis, Othmane Benkirane, Neil Mock, Hiroshi Saito, and Nickolas Means
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+http://github.com/benprew/pony
+
+== Releases
+
+0.4.1
+* Add :cc capability
+* fix bug: resolve body not displaying when attachments sent
+
+0.4
+* Implemented file attachments option
+* use TLS if :tls => true
+

data/Rakefile

@@ -29,29 +29,7 @@ require 'rake/clean'
 require 'rake/gempackagetask'
 require 'fileutils'
 
-version = "0.4"
-name = "pony"
-
-spec = Gem::Specification.new do |s|
-	s.name = name
-	s.version = version
-	s.summary = "Send email in one command: Pony.mail(:to => 'someone@example.com', :body => 'hello')"
-	s.description = "Send email in one command: Pony.mail(:to => 'someone@example.com', :body => 'hello')"
-	s.author = "Adam Wiggins, maint: Ben Prew"
-	s.email = "ben.prew@gmail.com"
-	s.homepage = "http://github.com/benprew/pony"
-	s.rubyforge_project = "pony"
-
-	s.platform = Gem::Platform::RUBY
-	s.has_rdoc = false
-
-	s.files = %w(Rakefile) + Dir.glob("{lib,spec}/**/*")
-
-	s.require_path = "lib"
-	s.add_dependency( 'tmail', '~> 1.0' )
-end
-
-Rake::GemPackageTask.new(spec) do |p|
+Rake::GemPackageTask.new(eval File.read('pony.gemspec')) do |p|
 	p.need_tar = true if RUBY_PLATFORM !~ /mswin/
 end
 

data/lib/pony.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'net/smtp'
+require 'mime/types'
 begin
 	require 'smtp_tls'
 rescue LoadError
@@ -31,16 +32,28 @@ module Pony
 		mail = TMail::Mail.new
 		mail.content_type = options[:content_type] if options[:content_type]
 		mail.to = options[:to]
+		mail.cc = options[:cc] || ''
 		mail.from = options[:from] || 'pony@unknown'
 		mail.subject = options[:subject]
-		mail.body = options[:body] || ""
-		(options[:attachments] || []).each do |name, body|
-			attachment = TMail::Mail.new
-			attachment.transfer_encoding = "base64"
-			attachment.body = Base64.encode64(body)
-			# attachment.set_content_type # TODO: if necessary
-			attachment.set_content_disposition "attachment", "filename" => name
-			mail.parts.push attachment
+		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
 		mail
 	end
@@ -66,7 +79,7 @@ module Pony
 			if pipe
 				pipe.write(tmail.to_s)
 			else
-				exec(sendmail_binary, *tmail.to)
+				exec(sendmail_binary, "-t")
 			end
 		end
 	end

data/pony.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+	s.name = %q{pony}
+	s.version = "0.4.1"
+
+	s.description = "Send email in one command: Pony.mail(:to => 'someone@example.com', :body => 'hello')"
+	s.summary = s.description
+	s.authors = ["Adam Wiggins", "maint: Ben Prew"]
+	s.email = %q{ben.prew@gmail.com}
+	s.homepage = %q{http://github.com/benprew/pony}
+	s.rubyforge_project = "pony"
+
+	s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+	s.files = ["README.rdoc", "Rakefile", "pony.gemspec" ] + Dir.glob("{lib,spec}/**/*")
+	s.has_rdoc = false
+	s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+	s.require_paths = ["lib"]
+	s.rubygems_version = %q{1.3.1}
+	s.add_dependency( 'tmail', '~> 1.0' )
+	s.add_dependency('mime-types', '>= 1.16')
+	s.platform = Gem::Platform::RUBY
+end

data/spec/pony_spec.rb

@@ -28,6 +28,10 @@ describe Pony do
 			Pony.build_tmail(:to => 'joe@example.com').to.should == [ 'joe@example.com' ]
 		end
 
+		it "cc" do
+			Pony.build_tmail(:cc => 'joe@example.com').cc.should == [ 'joe@example.com' ]
+		end
+
 		it "from" do
 			Pony.build_tmail(:from => 'joe@example.com').from.should == [ 'joe@example.com' ]
 		end
@@ -50,14 +54,29 @@ describe Pony do
 
 		it "attachments" do
 			tmail = Pony.build_tmail(:attachments => {"foo.txt" => "content of foo.txt"})
-			tmail.should have(1).parts
-			tmail.parts.first.to_s.should == <<-PART
+			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

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: pony
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: 0.4.1
 platform: ruby
 authors: 
-- "Adam Wiggins, maint: Ben Prew"
+- Adam Wiggins
+- "maint: Ben Prew"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 -08:00
+date: 2009-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +23,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+    version: 
 description: "Send email in one command: Pony.mail(:to => 'someone@example.com', :body => 'hello')"
 email: ben.prew@gmail.com
 executables: []
@@ -31,18 +42,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.rdoc
 - Rakefile
+- pony.gemspec
 - lib/pony.rb
 - spec/base.rb
 - spec/pony_spec.rb
-- spec/pony_spec.rb.orig
 has_rdoc: true
 homepage: http://github.com/benprew/pony
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/spec/pony_spec.rb.orig

@@ -1,145 +0,0 @@
-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 "from" do
-			Pony.build_tmail(:from => 'joe@example.com').from.should == [ 'joe@example.com' ]
-		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
-
-<<<<<<< HEAD:spec/pony_spec.rb
-    it "content_type" do
-			Pony.build_tmail(:content_type => 'text/html').content_type.should == 'text/html'
-    end
-=======
-		it "attachments" do
-			tmail = Pony.build_tmail(:attachments => {"foo.txt" => "content of foo.txt"})
-			tmail.should have(1).parts
-			tmail.parts.first.to_s.should == <<-PART
-Content-Transfer-Encoding: Base64
-Content-Disposition: attachment; filename=foo.txt
-
-Y29udGVudCBvZiBmb28udHh0
-			 PART
-		end
->>>>>>> c01d11243041d1897c67221bb92cdd5ff3fd6c0c:spec/pony_spec.rb
-	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 "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'))
-			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'), 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'), o)
-			end
-
-			it "starts the job" do
-				@smtp.should_receive(:start)
-				Pony.transport_via_smtp(mock('tmail', :to => 'to', :from => 'from', :to_s => 'message'))
-			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'))
-			end
-
-			it "finishes the job" do
-				@smtp.should_receive(:finish)
-				Pony.transport_via_smtp(mock('tmail', :to => 'to', :from => 'from', :to_s => 'message'))
-			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
-
-end