nmeans-pony 0.3.2

data/README.rdoc

@@ -0,0 +1,62 @@
+= 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.')
+
+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!"})
+
+== Meta
+
+Written by Adam Wiggins
+
+Patches contributed by: Mathieu Martin, Arun Thampi, Thomas Hurst, Stephen
+Celis, Othmane Benkirane, and Neil Mock
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+http://github.com/adamwiggins/pony
+

data/Rakefile

@@ -0,0 +1,73 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Print specdocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+	t.spec_opts = ["--format", "specdoc", "--dry-run"]
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+	t.spec_files = FileList['spec/*_spec.rb']
+	t.rcov = true
+	t.rcov_opts = ['--exclude', 'examples']
+end
+
+task :default => :spec
+
+######################################################
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'fileutils'
+
+version = "0.3"
+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"
+	s.email = "adam@heroku.com"
+	s.homepage = "http://github.com/adamwiggins/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|
+	p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :install => [ :package ] do
+	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [ :clean ] do
+	sh %{sudo gem uninstall #{name}}
+end
+
+Rake::TestTask.new do |t|
+	t.libs << "spec"
+	t.test_files = FileList['spec/*_spec.rb']
+	t.verbose = true
+end
+
+CLEAN.include [ 'pkg', '*.gem', '.config' ]
+

data/lib/pony.rb

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'net/smtp'
+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.from = options[:from] || 'pony@unknown'
+		mail.subject = options[:subject]
+    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)
+        # attachment.set_content_type # TODO: if necessary
+        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
+    puts mail
+		mail
+	end
+
+	def self.sendmail_binary
+		@sendmail_binary ||= `which sendmail`.chomp
+	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, *tmail.to)
+			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.to
+		smtp.finish
+	end
+end

data/pony.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pony}
+  s.version = "0.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nickolas Means"]
+  s.date = %q{2009-07-10}
+  s.description = %q{hiroshi/pony + true multipart messages when sending attachments}
+  s.email = %q{nick@heliumsyndicate.com}
+  s.files = ["README.rdoc", "Rakefile", "lib/pony.rb", "pony.gemspec", "spec/base.rb", "spec/pony_spec.rb"]
+  s.has_rdoc = false
+  s.homepage = %q{http://github.com/nmeans/pony}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = s.description
+end

data/spec/base.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/pony'

data/spec/pony_spec.rb

@@ -0,0 +1,139 @@
+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
+
+		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
+	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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: nmeans-pony
+version: !ruby/object:Gem::Version 
+  version: 0.3.2
+platform: ruby
+authors: 
+- Nickolas Means
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: hiroshi/pony + true multipart messages when sending attachments
+email: nick@heliumsyndicate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+- lib/pony.rb
+- pony.gemspec
+- spec/base.rb
+- spec/pony_spec.rb
+has_rdoc: false
+homepage: http://github.com/nmeans/pony
+licenses: 
+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.3.5
+signing_key: 
+specification_version: 2
+summary: hiroshi/pony + true multipart messages when sending attachments
+test_files: []
+