mailcatcher 0.1.6 → 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/LICENSE

@@ -1,19 +1,20 @@
-Copyright (c) 2010 Samuel Cochran <sj26@sj26.com>
+Copyright (c) 2010 Samuel Cochran
 
-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:
+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 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.
+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.md

@@ -32,9 +32,13 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
 * Forward mail to rendering service, maybe CampaignMonitor?
 * Package as an app? Native interfaces?
 
-## License
+## Thanks
 
-MailCatcher is released under the MIT License. See LICENSE.
+MailCatcher is just a mishmash of other people's hard work. Thank you so much to the people who have built the wonderful guts on which this project relies.
+
+## Copyright
+
+Copyright (c) 2010 Samuel Cochran. See LICENSE for details.
 
 ## Dreams
 

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mailcatcher"
+    gem.summary = %Q{Runs an SMTP server, catches and displays email in a web interface.}
+    gem.description = <<-EOD
+      MailCatcher runs a super simple SMTP server which catches any
+      message sent to it to display in a web interface. Run
+      mailcatcher, set your favourite app to deliver to
+      smtp://127.0.0.1:1025 instead of your default SMTP server,
+      then check out http://127.0.0.1:1080 to see the mail.
+    EOD
+    gem.email = "sj26@sj26.com"
+    gem.homepage = "http://github.com/sj26/mailcatcher"
+    gem.authors = ["Samuel Cochran"]
+    
+    gem.add_dependency 'eventmachine'
+    gem.add_dependency 'mail'
+    gem.add_dependency 'i18n'
+    gem.add_dependency 'sqlite3-ruby'
+    gem.add_dependency 'thin'
+    gem.add_dependency 'skinny'
+    gem.add_dependency 'haml'
+    gem.add_dependency 'json'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "MailCatcher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/mail_catcher.rb

@@ -1,215 +1,12 @@
-require 'rubygems'
 require 'eventmachine'
-require 'json'
-require 'ostruct'
-require 'mail'
 require 'thin'
-require 'sqlite3'
-require 'sinatra/base'
-require 'sunshowers'
-
-# Monkey-patch Sinatra to use Sunshowers
-class Sinatra::Request < Rack::Request
-  include Sunshowers::WebSocket
-end
 
 module MailCatcher
-  def self.db
-    @@__db ||= begin
-      SQLite3::Database.new(':memory:', :results_as_hash => true, :type_translation => true).tap do |db|
-        begin
-          db.execute(<<-SQL)
-            CREATE TABLE mail (
-              id INTEGER PRIMARY KEY ASC,
-              sender TEXT,
-              recipients TEXT,
-              subject TEXT,
-              source BLOB,
-              size TEXT,
-              created_at DATETIME DEFAULT CURRENT_DATETIME
-            )
-          SQL
-          db.execute(<<-SQL)
-            CREATE TABLE part (
-              id INTEGER PRIMARY KEY ASC,
-              mail_id INTEGER NOT NULL,
-              cid TEXT,
-              type TEXT,
-              is_attachment INTEGER,
-              filename TEXT,
-              body BLOB,
-              size INTEGER,
-              created_at DATETIME DEFAULT CURRENT_DATETIME
-            )
-          SQL
-        rescue SQLite3::SQLException
-        end
-      end
-    end
-  end
-  
-  def self.subscribers
-    @@subscribers ||= []
-  end
+  autoload :Events, 'mail_catcher/events'
+  autoload :Mail, 'mail_catcher/mail'
+  autoload :Smtp, 'mail_catcher/smtp'
+  autoload :Web, 'mail_catcher/web'
   
-  class SmtpServer < EventMachine::Protocols::SmtpServer
-    def insert_message
-      @@insert_message ||= MailCatcher.db.prepare("INSERT INTO mail (sender, recipients, subject, source, size, created_at) VALUES (?, ?, ?, ?, ?, datetime('now'))")
-    end
-    
-    def insert_part
-      @@insert_part ||= MailCatcher.db.prepare("INSERT INTO part (mail_id, cid, type, is_attachment, filename, body, size, created_at) VALUES (?, ?, ?, ?, ?, ?, ?, datetime('now'))")
-    end
-    
-    def current_message
-      @current_message ||= OpenStruct.new
-    end
-    
-    def receive_reset
-      @current_message = nil
-      true
-    end
-    
-    def receive_sender(sender)
-      current_message.sender = sender
-      true
-    end
-    
-    def receive_recipient(recipient)
-      current_message.recipients ||= []
-      current_message.recipients << recipient
-      true
-    end
-    
-    def receive_data_chunk(lines)
-      current_message.source ||= ""
-      current_message.source += lines.join("\n")
-      true
-    end
-
-    def receive_message
-      MailCatcher.db.transaction do
-        mail = Mail.new(current_message.source)
-        result = insert_message.execute(current_message.sender, current_message.recipients.inspect, mail.subject, current_message.source, current_message.source.length)
-        mail_id = MailCatcher.db.last_insert_row_id
-        if mail.multipart?
-          mail.all_parts.each do |part|
-            body = part.body.to_s
-            insert_part.execute(mail_id, part.cid, part.mime_type, part.attachment? ? 1 : 0, part.filename, body, body.length)
-          end
-        else
-          body = mail.body.to_s
-          insert_part.execute(mail_id, nil, mail.mime_type, 0, mail.filename, body, body.length)
-        end
-        puts "==> SMTP: Received message '#{mail.subject}' from '#{current_message.sender}'"
-        true
-      end
-    rescue
-      puts "*** Error receiving message: #{current_message.inspect}"
-      puts "    Exception: #{$!}"
-      puts "    Backtrace:"
-      $!.backtrace.each do |line|
-        puts "       #{line}"
-      end
-      puts "    Please submit this as an issue at http://github.com/sj26/mailcatcher/issues"
-    ensure
-      @current_message = nil
-    end
-  end
-  
-  class WebApp < Sinatra::Base
-    set :views, File.expand_path(File.join(File.dirname(__FILE__), '..', 'views'))
-    set :haml, {:format => :html5 }
-
-    get '/' do
-      haml :index
-    end
-    
-    get '/mail' do
-      if latest = MailCatcher.db.query('SELECT created_at FROM mail ORDER BY created_at DESC LIMIT 1').next
-        last_modified latest["created_at"]
-      end 
-      MailCatcher.db.query('SELECT id, sender, recipients, subject, size, created_at FROM mail ORDER BY created_at DESC').to_a.to_json
-    end
-    
-    get '/mail/:id.json' do
-      mail_id = params[:id].to_i
-      message = MailCatcher.db.query('SELECT * FROM mail WHERE id = ? LIMIT 1', mail_id).to_a.first
-      if message
-        last_modified message["created_at"]
-        message["formats"] = ['eml']
-        message["formats"] << 'html' if MailCatcher.db.query('SELECT id FROM part WHERE mail_id = ? AND type = "text/html" LIMIT 1', mail_id).next
-        message["formats"] << 'txt' if MailCatcher.db.query('SELECT id FROM part WHERE mail_id = ? AND type = "text/plain" LIMIT 1', mail_id).next
-        message["attachments"] = MailCatcher.db.query('SELECT cid, type, filename, size FROM part WHERE mail_id = ? AND is_attachment = 1 ORDER BY filename ASC', mail_id).to_a.map do |attachment|
-          attachment.merge({"href" => "/mail/#{escape(params[:id])}/#{escape(attachment['cid'])}"})
-        end
-        message.to_json
-      else
-        not_found
-      end
-    end
-    
-    get '/mail/:id.html' do
-      mail_id = params[:id].to_i
-      part = MailCatcher.db.query('SELECT body, created_at FROM part WHERE mail_id = ? AND type = "text/html" LIMIT 1', mail_id).to_a.first
-      if part
-        content_type 'text/html'
-        last_modified part["created_at"]
-        part["body"].gsub(/cid:([^'"> ]+)/, "#{mail_id}/\\1")
-      else
-        not_found
-      end
-    end
-    
-    get '/mail/:id.txt' do
-      part = MailCatcher.db.query('SELECT body, created_at FROM part WHERE mail_id = ? AND type = "text/plain" LIMIT 1', params[:id].to_i).to_a.first
-      if part
-        content_type 'text/plain'
-        last_modified part["created_at"]
-        part["body"]
-      else
-        not_found
-      end
-    end
-    
-    get '/mail/:id.eml' do
-      content_type 'text/plain'
-      message = MailCatcher.db.query('SELECT source, created_at FROM mail WHERE id = ? ORDER BY created_at DESC LIMIT 1', params[:id].to_i).to_a.first
-      if message
-        last_modified message["created_at"]
-        message["source"]
-      else
-        not_found
-      end
-    end
-    
-    get '/mail/:id/:cid' do
-      result = MailCatcher.db.query('SELECT * FROM part WHERE mail_id = ?', params[:id].to_i)
-      part = result.find { |part| part["cid"] == params[:cid] }
-      if part
-        content_type part["type"]
-        attachment part["filename"] if part["is_attachment"] == 1
-        last_modified part["created_at"]
-        body part["body"].to_s
-      else
-        not_found
-      end
-    end
-    
-    get '/mail/subscribe' do
-      return head 400 unless request.ws?
-      
-      request.ws_handshake!
-      request.ws_io.each do |message|
-        ws_quit! if message == "goodbye"
-      end
-    end
-    
-    not_found do
-      "<html><body><h1>No Dice</h1><p>The message you were looking for does not exist, or doesn't have content of this type.</p></body></html>"
-    end
-  end
-
   def self.run(options = {})
     options[:smtp_ip] ||= '127.0.0.1'
     options[:smtp_port] ||= 1025
@@ -221,9 +18,9 @@ module MailCatcher
     puts "==> http://#{options[:http_ip]}:#{options[:http_port]}"
 
     Thin::Logging.silent = true
-    EM.run do
-      EM.start_server options[:smtp_ip], options[:smtp_port], SmtpServer
-      Thin::Server.start WebApp, options[:http_ip], options[:http_port]
+    EventMachine.run do
+      EventMachine.start_server options[:smtp_ip], options[:smtp_port], Smtp
+      Thin::Server.start options[:http_ip], options[:http_port], Web
     end
   end
 end

data/lib/mail_catcher/events.rb

@@ -0,0 +1,7 @@
+require 'eventmachine'
+
+module MailCatcher
+  module Events
+    MessageAdded = EventMachine::Channel.new
+  end
+end

data/lib/mail_catcher/mail.rb

@@ -0,0 +1,119 @@
+require 'mail'
+require 'sqlite3'
+require 'eventmachine'
+
+module MailCatcher::Mail
+  class << self
+    def db
+      @@__db ||= begin
+        SQLite3::Database.new(':memory:', :results_as_hash => true, :type_translation => true).tap do |db|
+          db.execute(<<-SQL)
+            CREATE TABLE message (
+              id INTEGER PRIMARY KEY ASC,
+              sender TEXT,
+              recipients TEXT,
+              subject TEXT,
+              source BLOB,
+              size TEXT,
+              created_at DATETIME DEFAULT CURRENT_DATETIME
+            )
+          SQL
+          db.execute(<<-SQL)
+            CREATE TABLE message_part (
+              id INTEGER PRIMARY KEY ASC,
+              message_id INTEGER NOT NULL,
+              cid TEXT,
+              type TEXT,
+              is_attachment INTEGER,
+              filename TEXT,
+              charset TEXT,
+              body BLOB,
+              size INTEGER,
+              created_at DATETIME DEFAULT CURRENT_DATETIME
+            )
+          SQL
+        end
+      end
+    end
+    
+    def add_message(message)
+      @@add_message_query ||= db.prepare("INSERT INTO message (sender, recipients, subject, source, size, created_at) VALUES (?, ?, ?, ?, ?, datetime('now'))")
+      
+      mail = Mail.new(message[:source])
+      result = @@add_message_query.execute(message[:sender], message[:recipients].inspect, mail.subject, message[:source], message[:source].length)
+      message_id = db.last_insert_row_id
+      (mail.all_parts || [mail]).each do |part|
+        body = part.body.to_s
+        add_message_part(message_id, part.cid, part.mime_type || 'text/plain', part.attachment? ? 1 : 0, part.filename, part.charset, body, body.length)
+      end
+      
+      EventMachine.next_tick do
+        message = MailCatcher::Mail.message message_id
+        MailCatcher::Events::MessageAdded.push message
+      end
+    end
+
+    def add_message_part(*args)
+      @@add_message_part_query ||= db.prepare "INSERT INTO message_part (message_id, cid, type, is_attachment, filename, charset, body, size, created_at) VALUES (?, ?, ?, ?, ?, ?, ?, ?, datetime('now'))"
+      @@add_message_part_query.execute(*args)
+    end
+    
+    def latest_created_at
+      @@latest_created_at_query ||= db.prepare "SELECT created_at FROM message ORDER BY created_at DESC LIMIT 1"
+      @@latest_created_at_query.execute.next
+    end
+    
+    def messages
+      @@messages_query ||= db.prepare "SELECT id, sender, recipients, subject, size, created_at FROM message ORDER BY created_at DESC"
+      @@messages_query.execute.to_a
+    end
+    
+    def message(id)
+      @@message_query ||= db.prepare "SELECT * FROM message WHERE id = ? LIMIT 1"
+      @@message_query.execute(id).next
+    end
+    
+    def message_has_html?(id)
+      @@message_has_html_query ||= db.prepare "SELECT 1 FROM message_part WHERE message_id = ? AND is_attachment = 0 AND type = 'text/html' LIMIT 1"
+      !!@@message_has_html_query.execute(id).next
+    end
+    
+    def message_has_plain?(id)
+      @@message_has_html_query ||= db.prepare "SELECT 1 FROM message_part WHERE message_id = ? AND is_attachment = 0 AND type = 'text/plain' LIMIT 1"
+      !!@@message_has_html_query.execute(id).next
+    end
+    
+    def message_parts(id)
+      @@message_parts_query ||= db.prepare "SELECT cid, type, filename, size FROM message_part WHERE message_id = ? ORDER BY filename ASC"
+      @@message_parts_query.execute(id).to_a
+    end
+    
+    def message_attachments(id)
+      @@message_parts_query ||= db.prepare "SELECT cid, type, filename, size FROM message_part WHERE message_id = ? AND is_attachment = 1 ORDER BY filename ASC"
+      @@message_parts_query.execute(id).to_a
+    end
+    
+    def message_part(message_id, part_id)
+      @@message_part_query ||= db.prepare "SELECT * FROM message_part WHERE message_id = ? AND id = ? LIMIT 1"
+      @@message_part_query.execute(message_id, part_id).next
+    end
+    
+    def message_part_type(message_id, part_type)
+      @@message_part_type_query ||= db.prepare "SELECT * FROM message_part WHERE message_id = ? AND type = ? AND is_attachment = 0 LIMIT 1"
+      @@message_part_type_query.execute(message_id, part_type).next
+    end
+    
+    def message_part_html(message_id)
+      message_part_type message_id, "text/html"
+    end
+    
+    def message_part_plain(message_id)
+      message_part_type message_id, "text/plain"
+    end
+    
+    def message_part_cid(message_id, cid)
+      @@message_part_cid_query ||= db.prepare 'SELECT * FROM message_part WHERE message_id = ?'
+      @@message_part_cid_query.execute(message_id).find { |part| part["cid"] == cid }
+    end
+  end
+end