erikhansson-emailer 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Erik Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,54 @@
+= emailer
+
+Emailer is a collection of utility classes for sending emails
+using an existing SMTP service. I personally only use it with
+AuthSMTP, and it's not been extensively tested. Use at your 
+own risk.
+
+Notice that you'll need to install TMail to use emailer. I've
+not included it as a dependency as the gem does not currently
+install with Ruby 1.9, there are, however, patched versions out 
+there.
+
+I apologize in advance for the lack of documentation. There is
+little going on in the code, and the interface should be easy
+enough for anyone to figure out with a minute to glance at the
+code. Here's a taste:
+
+== Basic use
+
+  smtp = Emailer::AuthsmtpFacade.new :username => '[username]', :pasword => '[password]', :domain => 'localhost'
+  smtp.open do
+    smtp.send_text(
+        :from => 'your@email.com',
+        :to => 'to@email.com',
+        :subject => 'Thanks',
+        :body => 'Mail body.'
+      )
+  end
+
+== Bulk messages
+
+  queue = Emailer::MailQueue.new smtp
+  queue.add(
+      :from => 'your@email.com',
+      :to => 'to@email.com',
+      :subject => 'Thanks',
+      :body => 'Mail body.'
+    ) { |success, mail| puts "Sent mail to #{mail[:to]}..." }
+  queue.process
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Erik Hansson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "emailer"
+    gem.summary = %Q{A really simple way to send emails...}
+    gem.description = %Q{}
+    gem.email = "erik@bits2life.com"
+    gem.homepage = "http://github.com/erikhansson/emailer"
+    gem.authors = ["Erik Hansson"]
+    gem.add_development_dependency "rspec", ">= 1.2.4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "emailer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/emailer.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{emailer}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Erik Hansson"]
+  s.date = %q{2009-08-21}
+  s.description = %q{}
+  s.email = %q{erik@bits2life.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "emailer.gemspec",
+     "lib/emailer.rb",
+     "lib/emailer/authsmtp_facade.rb",
+     "lib/emailer/mail_queue.rb",
+     "lib/emailer/mock_smtp_facade.rb",
+     "lib/emailer/smtp_facade.rb",
+     "spec/emailer/authsmtp_facade_spec.rb",
+     "spec/emailer/mail_queue_spec.rb",
+     "spec/emailer/smtp_facade_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/erikhansson/emailer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A really simple way to send emails...}
+  s.test_files = [
+    "spec/emailer/authsmtp_facade_spec.rb",
+     "spec/emailer/mail_queue_spec.rb",
+     "spec/emailer/smtp_facade_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.4"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.4"])
+  end
+end

data/lib/emailer/authsmtp_facade.rb

@@ -0,0 +1,18 @@
+
+module Emailer
+  class AuthSmtpFacade < SmtpFacade
+    
+    def self.default_configuration
+      {
+        :host => 'mail.authsmtp.com',
+        :port => 2525,
+        :authentication => :cram_md5
+      }
+    end
+        
+    def initialize(settings)
+      super AuthSmtpFacade.default_configuration.merge(settings)
+    end
+    
+  end
+end

data/lib/emailer/mail_queue.rb

@@ -0,0 +1,60 @@
+
+module Emailer
+  class MailQueue
+    def initialize(smtp)
+      @smtp = smtp
+      @queue = []
+    end
+    
+    def empty?
+      @queue.empty?
+    end
+    
+    def length
+      @queue.length
+    end
+    
+    def add(mail, &callback)
+      mail[:content_type] ||= 'text/plain'
+      mail[:encoding] ||= 'utf-8'
+      
+      @queue << mail.merge(:callback => callback)
+    end
+    
+    def add_html(mail, &callback)
+      add({ :content_type => 'text/html' }.merge(mail))
+    end
+    
+    def last
+      @queue.last
+    end
+    
+    def process(tcount = 4)
+      tcount = length if length < tcount
+      
+      threads = []
+      mutex = Mutex.new
+      
+      tcount.times do |n|
+        threads << Thread.new(n) do |tid|
+          while !empty?
+            send_mail mutex
+          end
+        end
+      end
+      
+      threads.each { |thr| thr.join }
+    end
+    
+    def send_mail(mutex)
+      smtp = @smtp.clone
+      smtp.open do
+        while mail = mutex.synchronize { @queue.shift }
+          result = smtp.send_mail mail
+          mail[:callback].call(result, mail) if mail[:callback]
+        end
+      end
+    end
+    
+  end
+end

data/lib/emailer/mock_smtp_facade.rb

@@ -0,0 +1,37 @@
+module Emailer
+  
+  class MockNetSmtp
+    def start(*args); end
+    def sendmail(*args); end
+    def finish; end
+  end
+  
+  class MockSmtpFacade < SmtpFacade
+    
+    attr_reader :sent
+    
+    def initialize(settings = {})
+      @sent = []
+      super
+    end
+    
+    # Don't open connections...
+    def get_net_smtp_instance
+      MockNetSmtp.new
+    end
+    
+    # And save, don't send, mail...
+    def send_mail(options)
+      raise ConnectionNotOpenError unless @open
+      @sent << options
+      true
+    rescue ConnectionNotOpenError => e
+      raise e
+    rescue StandardError => e
+      @error = e
+      @offending_mail = mail
+      false
+    end
+    
+  end
+end

data/lib/emailer/smtp_facade.rb

@@ -0,0 +1,87 @@
+require 'tmail'
+require 'net/smtp'
+
+module Emailer
+  
+  class MailerError < RuntimeError; end
+  class ConnectionNotOpenError < MailerError; end
+  
+  class SmtpFacade
+    attr_reader :settings, :error, :offending_mail
+    
+    def initialize(settings)
+      @settings = settings
+      @settings.keys.each do |key|
+        raise ArgumentError unless [
+            :host, :port, :username, :password, :authentication, :domain
+          ].include?(key)
+      end
+    end
+    
+    def open
+      @open = true
+      open_connection
+      yield
+    ensure
+      @open = false
+      close_connection
+    end
+    
+    def get_net_smtp_instance
+      Net::SMTP.new settings[:host], settings[:port]
+    end
+    
+    ##
+    # Sends a mail to the represented SMTP server. Options is expected to include
+    # :to, :from, :subject, :body, :content_type and :encoding. Use send_html or
+    # send_text to provide defaults for :content_type and :encoding.
+    #
+    def send_mail(options)
+      raise ConnectionNotOpenError unless @open
+      
+      content_type_args = options[:content_type].split('/') << { 'charset' => options[:encoding] }
+      
+      mail = TMail::Mail.new
+      mail.set_content_type *content_type_args
+      mail.to = options[:to]
+      mail.from = options[:from]
+      mail.subject = options[:subject]
+      mail.body = options[:body]
+
+      @connection.sendmail(mail.encoded, mail.from[0], mail.destinations)
+      true
+    rescue ConnectionNotOpenError => e
+      raise e
+    rescue StandardError => e
+      @error = e
+      @offending_mail = mail
+      close_connection
+      false
+    end
+    
+    def send_html(options)
+      send_mail(options.merge(:content_type => 'text/html', :encoding => 'utf-8'))
+    end
+    
+    def send_text(options)
+      send_mail(options.merge(:content_type => 'text/plain', :encoding => 'utf-8'))
+    end
+    
+    private
+    def open_connection
+      @connection = get_net_smtp_instance
+      @connection.start(
+        settings[:domain], 
+        settings[:username],
+        settings[:password],
+        settings[:authentication]
+      )
+    end
+    
+    def close_connection
+      @connection.finish if @connection
+      @connection = @open = nil
+    end
+    
+  end
+end

data/lib/emailer.rb

@@ -0,0 +1,4 @@
+
+require 'emailer/smtp_facade'
+require 'emailer/authsmtp_facade'
+require 'emailer/mail_queue'

data/spec/emailer/authsmtp_facade_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), "../spec_helper")
+
+module Emailer
+  describe AuthSmtpFacade do
+    
+    describe :initialize do
+      it "should default to standard AuthSMTP settings" do
+        smtp = AuthSmtpFacade.new :username => 'username', :password => 'password', :domain => 'www.domain.com'
+        smtp.settings[:host].should == 'mail.authsmtp.com'
+        smtp.settings[:port].should == 2525
+        smtp.settings[:authentication].should == :cram_md5
+      end
+    end
+    
+  end
+end

data/spec/emailer/mail_queue_spec.rb

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), "../spec_helper")
+
+module Emailer
+  describe MailQueue do
+    
+    before(:each) do
+      @smtp = MockSmtpFacade.new
+      @queue = MailQueue.new @smtp
+    end
+    
+    describe "a new MailQueue" do
+      it "should be empty" do
+        @queue.should be_empty
+      end
+    end
+    
+    describe :add do
+      before(:each) do
+        @queue.add(
+          :from => 'from@email.com',
+          :to => 'to@email.com',
+          :subject => 'subject',
+          :body => 'body'
+        )
+      end
+      
+      it "should default :content_type to 'text/plain'" do
+        @queue.last[:content_type].should == 'text/plain'
+      end
+      
+      it "should default :encoding to 'utf-8'" do
+        @queue.last[:encoding].should == 'utf-8'
+      end
+    end
+    
+    describe :add_html do
+      it "should default :content_type to 'text/html'" do
+        @queue.add_html(
+          :from => 'from@email.com',
+          :to => 'to@email.com',
+          :subject => 'subject',
+          :body => 'body'
+        )
+        @queue.last[:content_type].should == 'text/html'
+      end
+    end
+    
+    context "a mail queue with two mails" do
+      def add_mail
+        @queue.add(
+          :from => 'from@email.com',
+          :to => 'to@email.com',
+          :subject => 'subject',
+          :body => 'body'
+        ) do |success, mail|
+          @verified << mail
+        end
+      end
+      
+      before(:each) do
+        @verified = []
+        2.times { add_mail }
+      end
+      
+      it "should not be empty" do
+        @queue.should_not be_empty
+      end
+      
+      context "when we call :process" do
+        before(:each) do
+          @queue.process
+        end
+        
+        it "should send both mails" do
+          @smtp.sent.length.should == 2
+        end
+        
+        it "should call the mail's respective callbacks" do
+          @verified.length.should == 2
+        end
+        
+        it "should be empty" do
+          @queue.should be_empty
+        end
+      end
+      
+      context "with an additional mail added" do
+        before(:each) do
+          add_mail
+        end
+        
+        it "should have three mails" do
+          @queue.length.should == 3
+        end
+        
+        it "should send three mails when processed" do
+          @queue.process
+          @verified.length.should == 3
+        end
+      end
+    end
+    
+  end
+end

data/spec/emailer/smtp_facade_spec.rb

@@ -0,0 +1,158 @@
+require File.join(File.dirname(__FILE__), "../spec_helper")
+
+module Emailer
+  describe SmtpFacade do
+    
+    MAIL_OPTIONS = {
+        :from => 'from@email.com',
+        :to => 'to@email.com',
+        :subject => 'subject',
+        :body => 'body',
+        :content_type => 'text/plain',
+        :encoding => 'utf-8'
+      }
+    SMTP_OPTIONS = {
+        :host => 'smtp.host.com',
+        :port => 25,
+        :username => 'username',
+        :password => 'password',
+        :authentication => :cram_md5,
+        :domain => 'www.domain.com'
+      }
+      
+      
+    describe :initialize do
+      it "should accept only known options" do
+        lambda do
+          SmtpFacade.new :foobar => 'fail'
+        end.should raise_error
+      end
+      
+      it "should accept all known options" do
+        SmtpFacade.new SMTP_OPTIONS
+      end
+    end
+    
+    describe :clone do
+      it "should return an instance with the same settings" do
+        one = SmtpFacade.new SMTP_OPTIONS
+        two = one.clone
+        
+        two.settings.should == one.settings
+      end
+      it "should not return the same instance" do
+        one = SmtpFacade.new SMTP_OPTIONS
+        two = one.clone
+        
+        two.should_not == one
+      end
+    end
+    
+    context "given an SMTP server's settings" do
+      before(:each) do
+        @smtp = SmtpFacade.new SMTP_OPTIONS
+      end
+      
+      it "should remember these settings" do
+        smtp = SmtpFacade.new SMTP_OPTIONS
+        smtp.settings[:port].should == 25
+        smtp.settings[:username].should == 'username'
+      end
+      
+      describe :get_net_smtp_instance do
+        it "should use :host and :port to initialize connection" do
+          Net::SMTP.should_receive(:new).with('smtp.host.com', 25).and_return nil
+          @smtp.get_net_smtp_instance
+        end
+      end
+      
+      describe :open do
+        before(:each) do
+          @netsmtp = mock('net_smtp').as_null_object
+          @smtp.stub!(:get_net_smtp_instance).and_return @netsmtp
+        end
+        
+        it "should get a connection using :get_net_smtp_instance" do
+          @smtp.should_receive(:get_net_smtp_instance).and_return @netsmtp
+          @smtp.open do
+          end
+        end
+        
+        it "should initialize the connection and authenticate" do
+          @netsmtp.should_receive(:start).with('www.domain.com', 'username', 'password', :cram_md5)
+          @smtp.open do
+          end
+        end
+        
+        it "should close this connection after the block is finished" do
+          @netsmtp.should_receive(:finish)
+          @smtp.open do
+          end
+        end
+      end
+      
+      describe :send_mail do
+        it "should raise an ConnectionNotOpenError unless we're inside :open" do
+          lambda do
+            @smtp.send_mail({})
+          end.should raise_error(ConnectionNotOpenError)
+        end
+        
+        it "should send the mail to the opened connection" do
+          @netsmtp = mock('net_smtp').as_null_object
+          @smtp.should_receive(:get_net_smtp_instance).and_return @netsmtp
+          @netsmtp.should_receive(:sendmail).once
+          
+          @smtp.open do
+            @smtp.send_mail(MAIL_OPTIONS)
+          end
+        end
+        
+        it "should close the connection if it encounters an error" do
+          @netsmtp = mock('net_smtp').as_null_object
+          @smtp.should_receive(:get_net_smtp_instance).and_return @netsmtp
+          @netsmtp.should_receive(:sendmail).once.and_raise(StandardError)
+          
+          lambda do
+            @smtp.open do
+              2.times do
+                @smtp.send_mail(MAIL_OPTIONS).should be_false
+              end
+            end
+          end.should raise_error(ConnectionNotOpenError)
+        end
+      end
+      
+      describe :send_text do
+        it "should delegate to :send_mail with :content_type => 'text/plain' and :encoding => 'utf-8'" do
+          @netsmtp = mock('net_smtp').as_null_object
+          @smtp.should_receive(:get_net_smtp_instance).and_return @netsmtp
+          
+          @smtp.should_receive(:send_mail).once.with(MAIL_OPTIONS.merge(
+              :content_type => 'text/plain',
+              :encoding => 'utf-8'
+            ))
+          @smtp.open do
+            @smtp.send_text MAIL_OPTIONS.reject { |k, _| [:content_type, :encoding].include?(k) }
+          end
+        end
+      end
+      
+      describe :send_html do
+        it "should delegate to :send_mail with :content_type => 'text/html' and :encoding => 'utf-8'" do
+          @netsmtp = mock('net_smtp').as_null_object
+          @smtp.should_receive(:get_net_smtp_instance).and_return @netsmtp
+          
+          @smtp.should_receive(:send_mail).once.with(MAIL_OPTIONS.merge(
+              :content_type => 'text/html',
+              :encoding => 'utf-8'
+            ))
+          @smtp.open do
+            @smtp.send_html MAIL_OPTIONS.reject { |k, _| [:content_type, :encoding].include?(k) }
+          end
+        end
+      end
+      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'emailer'
+require 'emailer/mock_smtp_facade'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: erikhansson-emailer
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Erik Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+    version: 
+description: ""
+email: erik@bits2life.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- emailer.gemspec
+- lib/emailer.rb
+- lib/emailer/authsmtp_facade.rb
+- lib/emailer/mail_queue.rb
+- lib/emailer/mock_smtp_facade.rb
+- lib/emailer/smtp_facade.rb
+- spec/emailer/authsmtp_facade_spec.rb
+- spec/emailer/mail_queue_spec.rb
+- spec/emailer/smtp_facade_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/erikhansson/emailer
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --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: A really simple way to send emails...
+test_files: 
+- spec/emailer/authsmtp_facade_spec.rb
+- spec/emailer/mail_queue_spec.rb
+- spec/emailer/smtp_facade_spec.rb
+- spec/spec_helper.rb