mailit 2009.08

data/lib/mailit/mailer.rb

@@ -0,0 +1,131 @@
+module Mailit
+  # The Mailer is an abstraction layer for different SMTP clients, it provides
+  # #send and #defer_send methods
+  #
+  # At the time of writing, Net::SMTP and EventMachine::Protocols::SmtpClient are
+  # supported, it should be trivial to add support for any other client.
+  #
+  # The difference between #send and #defer_send depends on the backend, but
+  # usually #send will block until the mail was sent while #defer_send does it
+  # in the background and allows you to continue execution immediately.
+  #
+  # @example Usage
+  #
+  #   mail = Mailit::Mail.new
+  #   mail.to = 'test@test.com'
+  #   mail.from = 'sender@sender.com'
+  #   mail.subject 'Here are some files for you!'
+  #   mail.text = 'This is what you see with a plaintext mail reader'
+  #   mail.attach('/home/manveru/.vimrc')
+  #
+  #   # Send and wait until sending finished
+  #   Mailit::Mailer.send(mail)
+  #
+  #   # Send in background thread and continue doing other things
+  #   Mailit::Mailer.defer_send(mail)
+  #
+  # The default Mailer backend is Net::SMTP, you can change the
+  # default by including another module into Mailit::mailer
+  #
+  # @example Using Mailt::Mailer::EventMachine by inclusion
+  #
+  #   class Mailit::Mailer
+  #     include Mailit::Mailer::EventMachine
+  #   end
+  #
+  class Mailer
+    OPTIONS = {
+      :server    => 'smtp.localhost',
+      :port      => 25,
+      :domain    => 'localhost',
+      :username  => 'foo',
+      :password  => 'foo',
+      :noop      => false,
+      :auth_type => :login, # :plain, :login, :cram_md5
+      :starttls  => false,  # only useful for EventMachine::SmtpClient
+    }
+
+    def self.send(mail, options = {})
+      new.send(mail, options)
+    end
+
+    def self.defer_send(mail, options = {})
+      new.defer_send(mail, options)
+    end
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = OPTIONS.merge(options)
+    end
+
+    def send(mail, override = {})
+      require 'net/smtp'
+
+      server, port, domain, username, password, auth_type, noop =
+        settings(override, :server, :port, :domain, :username, :password, :auth_type, :noop)
+
+      ::Net::SMTP.start(server, port, domain, username, password, auth_type) do |smtp|
+        return if noop
+        smtp.send_message(mail.to_s, mail.from, mail.to)
+      end
+    end
+
+    def defer_send(mail, override = {})
+      Thread.new{ send(mail, override) }
+    end
+
+    private
+
+    def settings(override, *keys)
+      options.merge(override).values_at(*keys)
+    end
+
+    # Allows you to comfortably use the EventMachine::Protocols::SmtpClient.
+    # In order to use it, you have to first include this module into Mailit::Mailer
+    module EventMachine
+      # This assumes that EventMachine was required and we are inside the
+      # EventMachine::run block.
+      #
+      # Since EM implements some parts of the mail building we'll have to
+      # deconstruct our mail a bit.
+      # On the upside, it seems like it supports STARTTLS (without certificate
+      # options though)
+      def self.included(base)
+        require 'em/protocols/smtpclient'
+        base.module_eval do
+          def send(mail, override = {})
+            server, port, domain, username, password, auth_type =
+              settings(override, :server, :port, :domain, :username, :password, :auth_type)
+
+            mail.construct # prepare headers and body
+
+            em_options = { :port => port, :host => server, :domain => domain,
+              :from => mail.from, :to => mail.to, :header => mail.header_string,
+              :body => mail.body_string }
+
+            if auth_type
+              em_options[:auth] = {
+                :type => auth_type, :username => username, :password => password }
+            end
+
+            email = EM::Protocols::SmtpClient.send(em_options)
+            email.callback &@callback if @callback
+            email.errback &@errback if @errback
+          end
+
+          def callback(proc=nil, &blk)
+            @callback = proc || blk
+          end
+
+          def errback(proc=nil, &blk)
+            @errback = proc || blk
+          end
+          
+          alias defer_send send
+        end
+        
+      end
+    end # module EventMachine
+  end # class Mailer
+end # module Mailit

data/lib/mailit/mime.rb

@@ -0,0 +1,49 @@
+module Mailit
+  module Mime
+    module_function
+
+    def mime_for(filename)
+      detect_handler unless defined?(@mime_handler)
+      send(@mime_handler, filename)
+    end
+
+    def detect_handler
+      try_require('rubygems')
+
+      if try_require('mime/types')
+        @mime_handler = :from_mime_types
+      elsif try_require('rack') and try_require('rack/mime')
+        @mime_handler = :from_rack
+      else
+        require 'webrick/httputils'
+        @webrick_types = WEBrick::HTTPUtils::DefaultMimeTypes.dup
+        try_extend_webrick('/etc/mime.types')
+        @mime_handler = :from_webrick
+      end
+    end
+
+    def from_mime_types(filename)
+      MIME::Types.type_for(filename) || 'application/octet-stream'
+    end
+
+    def from_rack(filename)
+      Rack::Mime.mime_type(File.extname(filename))
+    end
+
+    def from_webrick(filename)
+      WEBrick::HTTPUtils.mime_type(filename, @webrick_types)
+    end
+
+    def try_extend_webrick(file)
+      hash = WEBrick::HTTPUtils.load_mime_types(file)
+      @webrick_types.merge!(hash)
+    rescue
+    end
+
+    def try_require(lib)
+      require lib
+      true
+    rescue LoadError
+    end
+  end
+end

data/lib/mailit/version.rb

@@ -0,0 +1,3 @@
+module Mailit
+  VERSION = "2009.08"
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Mailit
+  VERSION = '2009.08.25'
+end

data/mailit.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mailit}
+  s.version = "2009.08"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Berry"]
+  s.date = %q{2009-08-25}
+  s.description = %q{The Mailit library, by Kevin Berry}
+  s.email = %q{kevinberry@nrs.us}
+  s.files = ["AUTHORS", "CHANGELOG", "MANIFEST", "README.md", "Rakefile", "lib/mailit.rb", "lib/mailit/mail.rb", "lib/mailit/mailer.rb", "lib/mailit/mime.rb", "lib/mailit/version.rb", "lib/version.rb", "mailit.gemspec", "spec/helper.rb", "spec/mailit/mail.rb", "spec/mailit/mailer.rb", "tasks/authors.rake", "tasks/bacon.rake", "tasks/changelog.rake", "tasks/copyright.rake", "tasks/gem.rake", "tasks/gem_installer.rake", "tasks/install_dependencies.rake", "tasks/manifest.rake", "tasks/rcov.rake", "tasks/release.rake", "tasks/reversion.rake", "tasks/setup.rake", "tasks/yard.rake"]
+  s.homepage = %q{http://github.com/manveru/mailit}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{The Mailit library, by Kevin Berry}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path("#{__FILE__}/../../lib/mailit")
+require 'bacon'
+
+Bacon.summary_on_exit

data/spec/mailit/mail.rb

@@ -0,0 +1,108 @@
+# Encoding: UTF-8
+require 'spec/helper'
+
+# The specs are translated from the Test::Unit tests of MailFactory.
+#
+# TODO:
+# * test_attach_as
+# * test_email
+
+describe Mailit::Mail do
+  should 'set and get headers' do
+    mail = Mailit::Mail.new
+
+    mail.set_header('arbitrary', 'some value')
+    mail.get_header('arbitrary').should == ['some value']
+
+    mail.set_header('arbitrary-header', 'some _ value')
+    mail.get_header('arbitrary-header').should == ['some _ value']
+  end
+
+  should 'generate valid boundaries' do
+    50.times do
+      boundary = Mailit::Mail.generate_boundary
+      boundary.should =~ /^----=_NextPart_[a-zA-Z0-9_.]{25}$/
+    end
+  end
+
+  should 'make mail with recipient' do
+    mail = Mailit::Mail.new
+
+    mail.to = 'test@test.com'
+    mail.to.should == 'test@test.com'
+
+    mail.to = 'test@test2.com'
+    mail.to.should == 'test@test2.com'
+
+    mail.headers.size.should == 1 # make sure the previous was deleted
+  end
+
+  should 'make mail with sender' do
+    mail = Mailit::Mail.new
+
+    mail.from = 'test@test.com'
+    mail.from.should == 'test@test.com'
+
+    mail.from = 'test@test2.com'
+    mail.from.should == 'test@test2.com'
+
+    mail.headers.size.should == 1 # make sure the previous was deleted
+  end
+
+  should 'set correct subject' do
+    mail = Mailit::Mail.new
+
+    mail.subject = 'Test Subject'
+    mail.subject.should == '=?utf-8?Q?Test_Subject?='
+
+    mail.subject = 'A Different Subject'
+    mail.subject.should == '=?utf-8?Q?A_Different_Subject?='
+
+    mail.headers.size.should == 1 # make sure the previous was deleted
+  end
+
+  should 'use quoted printable with instruction' do
+    mail = Mailit::Mail.new
+
+    mail.to = 'test@test.com'
+    mail.from = 'test@othertest.com'
+		mail.subject = "My email subject has a ? in it and also an = and a _ too... Also some non-quoted junk ()!@\#\{\$\%\}"
+    mail.text = "This is a test message with\na few\n\nlines."
+
+    mail.subject.should == "=?utf-8?Q?My_email_subject_has_a_=3F_in_it_and_also_an_=3D_and_a_=5F_too..._Also_some_non-quoted_junk_()!@\#\{\$\%\}?="
+  end
+
+  should 'use subject quoting for scandinavian string' do
+    mail = Mailit::Mail.new
+
+    mail.to = "test@test.com"
+    mail.from = "test@othertest.com"
+    # Three a with dots and three o with dots.
+    mail.subject = "\303\244\303\244\303\244\303\266\303\266\303\266"
+    mail.text = "This is a test message with\na few\n\nlines."
+
+    mail.subject.should == "=?utf-8?Q?=C3=A4=C3=A4=C3=A4=C3=B6=C3=B6=C3=B6?="
+  end
+
+  should 'use subject quoting for utf-8 string' do
+    mail = Mailit::Mail.new
+
+    mail.to = "test@test.com"
+    mail.from = "test@othertest.com"
+    mail.subject = "My email subject has a à which is utf8."
+    mail.text = "This is a test message with\na few\n\nlines."
+
+    mail.subject.should == "=?utf-8?Q?My_email_subject_has_a_=C3=83_which_is_utf8.?="
+  end
+
+  should 'encode html as quoted printable' do
+    mail = Mailit::Mail.new
+
+    mail.to = "test@test.com"
+    mail.from = "test@othertest.com"
+    mail.subject = "some html"
+    mail.html = "<a href=\"http://google.com\">click here</a>"
+
+    mail.to_s.should.include('<a href=3D"http://google.com">click here</a>')
+  end
+end

data/spec/mailit/mailer.rb

@@ -0,0 +1,48 @@
+require 'spec/helper'
+
+class MockSMTP
+  INSTANCES = []
+
+  def self.start(*args, &block)
+    INSTANCES << new(*args, &block)
+  end
+
+  attr_reader :start_args, :result, :send_message_args
+
+  def initialize(*args, &block)
+    @start_args = args
+    yield(self)
+  end
+
+  def send_message(*args)
+    @send_message_args = args
+  end
+end
+
+Mailit::Mail::OPTIONS[:message_id] = lambda{|mail| '1234' }
+
+describe Mailit::Mailer do
+  it 'sends a mail' do
+    mail = Mailit::Mail.new(
+      :to => 'test@example.com',
+      :from => 'sender@example.com',
+      :subject => 'Here are some files for you!',
+      :text => 'Some text about that')
+
+    mailer = Mailit::Mailer.new
+
+    mailer.send(mail, :server => 'smtp.example.com', :port => 25,
+                :domain => 'example.com', :password => 'foo',
+                :mailer => MockSMTP)
+
+    mock = MockSMTP::INSTANCES.last
+    mock.start_args.should == [
+      'smtp.example.com', 25,
+      'example.com',
+      'sender@example.com',
+      'foo',
+      :cram_md5
+    ]
+    mock.send_message_args.should == [mail.to_s, mail.from, mail.to]
+  end
+end

data/tasks/authors.rake

@@ -0,0 +1,33 @@
+# Once git has a fix for the glibc in handling .mailmap and another fix for
+# allowing empty mail address to be mapped in .mailmap we won't have to handle
+# them manually.
+
+desc 'Update AUTHORS'
+task :authors do
+  authors = Hash.new(0)
+
+  `git shortlog -nse`.scan(/(\d+)\s(.+)\s<(.*)>$/) do |count, name, email|
+    # Examples of mappping, replace with your own or comment this out/delete it
+    case name
+    when /^(?:bougyman$|TJ Vanderpoel)/
+      name, email = "TJ Vanderpoel", "tj@rubyists.com"
+    when /^(?:manveru$|Michael Fellinger)/
+      name, email = "Michael Fellinger", "mf@rubyists.com"
+    when /^(?:deathsyn$|Kevin Berry)/
+      name, email = "Kevin Berry", "kb@rubyists.com"
+    when /^(?:(?:jayson|thedonvaughn|jvaughn)$|Jayson Vaughn)/
+      name, email = "Jayson Vaughn", "jv@rubyists.com"
+    end
+
+    authors[[name, email]] += count.to_i
+  end
+
+  File.open('AUTHORS', 'w+') do |io|
+    io.puts "Following persons have contributed to #{GEMSPEC.name}."
+    io.puts '(Sorted by number of submitted patches, then alphabetically)'
+    io.puts ''
+    authors.sort_by{|(n,e),c| [-c, n.downcase] }.each do |(name, email), count|
+      io.puts("%6d %s <%s>" % [count, name, email])
+    end
+  end
+end

data/tasks/bacon.rake

@@ -0,0 +1,70 @@
+desc 'Run all bacon specs with pretty output'
+task :bacon => :install_dependencies do
+  require 'open3'
+  require 'scanf'
+  require 'matrix'
+
+  specs = PROJECT_SPECS
+
+  some_failed = false
+  specs_size = specs.size
+  if specs.size == 0
+    $stderr.puts "You have no specs!  Put a spec in spec/ before running this task"
+    exit 1
+  end
+  len = specs.map{|s| s.size }.sort.last
+  total_tests = total_assertions = total_failures = total_errors = 0
+  totals = Vector[0, 0, 0, 0]
+
+  red, yellow, green = "\e[31m%s\e[0m", "\e[33m%s\e[0m", "\e[32m%s\e[0m"
+  left_format = "%4d/%d: %-#{len + 11}s"
+  spec_format = "%d specifications (%d requirements), %d failures, %d errors"
+
+  specs.each_with_index do |spec, idx|
+    print(left_format % [idx + 1, specs_size, spec])
+
+    Open3.popen3(RUBY, spec) do |sin, sout, serr|
+      out = sout.read.strip
+      err = serr.read.strip
+
+      # this is conventional, see spec/innate/state/fiber.rb for usage
+      if out =~ /^Bacon::Error: (needed .*)/
+        puts(yellow % ("%6s %s" % ['', $1]))
+      else
+        total = nil
+
+        out.each_line do |line|
+          scanned = line.scanf(spec_format)
+
+          next unless scanned.size == 4
+
+          total = Vector[*scanned]
+          break
+        end
+
+        if total
+          totals += total
+          tests, assertions, failures, errors = total_array = total.to_a
+
+          if tests > 0 && failures + errors == 0
+            puts((green % "%6d passed") % tests)
+          else
+            some_failed = true
+            puts(red % "       failed")
+            puts out unless out.empty?
+            puts err unless err.empty?
+          end
+        else
+          some_failed = true
+          puts(red % "       failed")
+          puts out unless out.empty?
+          puts err unless err.empty?
+        end
+      end
+    end
+  end
+
+  total_color = some_failed ? red : green
+  puts(total_color % (spec_format % totals.to_a))
+  exit 1 if some_failed
+end