mailtrap 0.1.0 → 0.2.0

data/README.txt

@@ -4,23 +4,27 @@ mailtrap
 
 == DESCRIPTION:
 
-Mailtrap is a mock SMTP server for use in Rails development. Mailtrap waits for
-a client to connect and talks just enough SMTP for ActionMailer to send its message
-which Mailtrap will write into a file for you to inspect. Mailtrap makes no
-attempt to actually deliver anything (hence the name Mail*trap*).
-
-You can configure the hostname (default: localhost) and port (default: 1025)
-for the server and also where the messages get written (default: /tmp). Messages
-will get written to files named smtp0001.msg, smtp0002.msg, and so on.
+Mailtrap is a mock SMTP server for use in Rails development.
+
+Mailtrap waits on your choosen port for a client to connect and talks _just enough_ SMTP protocol for ActionMailer to successfully deliver its message.
+
+Mailtrap makes *no* attempt to actually deliver messages and, instead, writes them into sequentially numbered files on disk (hence the name 	Mail_trap_).
+
+You can configure the hostname (default: localhost) and port (default: 2525) for the server and also where the messages get written (default: /var/tmp). Messages will get written to files named smtp0001.msg, smtp0002.msg, and so on.
 	
 == FEATURES/PROBLEMS:
 
-* Test with ActionMailer's SMTP delivery method
-* Very, very, dumb ... might not work with an arbitrary Mail client
+* Lightweight, no setup
+* Runs as a daemon with start, stop, etc..
+* Tested with ActionMailer's SMTP delivery method
+* Very, very, dumb ... might not work with an arbitrary SMTP client
 
 == SYNOPSIS:
 
-mailtrap --host localhost --port 8025 --once
+* mailtrap --help (to see Daemonization options)
+* mailtrap start --help (to see Mailtrap options)
+
+* mailtrap start --host localhost --port 8025 --once --msgdir=/var/tmp
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'hoe'
 require './lib/mailtrap.rb'
 
-Hoe.new('mailtrap', Mailtrap::VERSION) do |p|
+Hoe.new('mailtrap', Mailtrap::VERSION ) do |p|
   p.rubyforge_name = 'rubymatt'
   p.author = 'Matt Mower'
   p.email = 'self@mattmower.com'

data/bin/mailtrap

@@ -11,7 +11,7 @@ opts = Trollop::options do
   opt :host, "The host SMTP clients will connect to", :default => 'localhost'
   opt :port, "The port SMTP clients will connect to", :default => 2525
   opt :once, "Whether to terminate after serving the first client", :default => false
-  opt :msgdir, "Where messages get stored", :default => "/var/tmp"
+  opt :file, "File where messages get written", :default => "/var/tmp/mailtrap.log"
 end
 
 options = {
@@ -24,5 +24,5 @@ options = {
 }
 
 Daemons.run_proc( 'mailtrap', options ) do
-  Mailtrap.new( opts[:host], opts[:port], opts[:once], opts[:msgdir] )
+  Mailtrap.new( opts[:host], opts[:port], opts[:once], opts[:file] )
 end

data/lib/mailtrap.rb

@@ -4,20 +4,29 @@ require 'daemons'
 require 'socket'
 require 'trollop'
 
+#
+# Mailtrap creates a TCP server that listens on a specified port for SMTP
+# clients. Accepts the connection and talks just enough of the SMTP protocol
+# for them to deliver a message which it writes to disk.
+#
 class Mailtrap
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   
-  def initialize( host, port, once, msgdir )
+  # Create a new Mailtrap on the specified host:port. If once it true it
+  # will listen for one message then exit. Specify the msgdir where messages
+  # are written.
+  def initialize( host, port, once, msgfile )
     @host = host
     @port = port
     @once = once
-    @msgdir = msgdir
+    @msgfile = msgfile
     
-    puts "Mailtrap starting at #{@host}:#{port} and writing to #{@msgdir}"
+    puts "Mailtrap starting at #{@host}:#{port} and writing to #{@msgfile}"
     service = TCPServer.new( @host, @port )
     accept( service )
   end
   
+  # Service one or more SMTP client connections
   def accept( service )
     while session = service.accept
       
@@ -39,30 +48,28 @@ class Mailtrap
     end    
   end
   
+  # Write a plain text dump of the incoming email to a text
+  # file. The file will be in the @msgdir folder and will
+  # be called smtp0001.msg, smtp0002.msg, and so on.
   def write( from, to_list, message )
     
+    # Strip SMTP commands from To: and From:
     from.gsub!( /MAIL FROM:\s*/, "" )
     to_list = to_list.map { |to| to.gsub( /RCPT TO:\s*/, "" ) }
     
-    n = 1
-    Dir.chdir( @msgdir ) do
-      files = Dir.glob( "smtp*.msg" )
-      if files.length > 0
-        n = 1 + Integer( files.last.gsub( /smtp(\d+)\.msg/, '\1' ) )
-      end
-    end
-        
-    File.open( File.join( @msgdir, "smtp%04d.msg" % n ), "w" ) do |file|
-      file.puts "FROM: #{from}"
-      to_list.each do |to|
-        file.puts "TO: #{to}"
-      end
-      file.puts "----"
+    # Append to the end of the messages file
+    File.open( @msgfile, "a" ) do |file|
+      file.puts "****************************************"
+      file.puts "From: #{from}"
+      file.puts "To: #{to_list.join(", ")}"
+      file.puts "Body:"
       file.puts message
     end
 
   end
   
+  # Talk pidgeon-SMTP to the client to get them to hand over the message
+  # and go away.
   def serve( connection )
     connection.puts( "220 #{@host} MailTrap ready ESTMP" )
     helo = connection.get_line # whoever they are
@@ -74,12 +81,14 @@ class Mailtrap
       connection.puts "250 HELP"
     end
     
+    # Accept MAIL FROM:
     from = connection.get_line
     connection.puts( "250 OK" )
     puts "From: #{from}"
     
     to_list = []
     
+    # Accept RCPT TO: until we see DATA
     loop do
       to = connection.get_line
       break if to.nil?
@@ -94,26 +103,22 @@ class Mailtrap
       end
     end
     
-    puts "We know who we're sending to."
-    
+    # Capture the message body terminated by <CR>.<CR>
     lines = []
-    
     loop do
       line = connection.get_line
       break if line.nil? || line == "."
       lines << line
       puts "+ #{line}"
     end
-    
-    puts "Message read"
+
+    # We expect the client will go away now
     connection.puts( "250 OK" )
-    
     connection.gets # Quit
     connection.puts "221 Seeya"
-    
     connection.close
     puts "And we're done with that bozo!"
-    
+
     write( from, to_list, lines.join( "\n" ) )
     
   end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: mailtrap
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 date: 2007-10-04 00:00:00 +01:00
 summary: Mailtrap is a mock SMTP server for use in Rails development
 require_paths: 
@@ -11,7 +11,7 @@ require_paths:
 email: self@mattmower.com
 homepage: "    by Matt Mower <self@mattmower.com>"
 rubyforge_project: rubymatt
-description: "Mailtrap is a mock SMTP server for use in Rails development. Mailtrap waits for a client to connect and talks just enough SMTP for ActionMailer to send its message which Mailtrap will write into a file for you to inspect. Mailtrap makes no attempt to actually deliver anything (hence the name Mail*trap*).  You can configure the hostname (default: localhost) and port (default: 1025) for the server and also where the messages get written (default: /tmp). Messages will get written to files named smtp0001.msg, smtp0002.msg, and so on.  == FEATURES/PROBLEMS:  * Test with ActionMailer's SMTP delivery method * Very, very, dumb ... might not work with an arbitrary Mail client  == SYNOPSIS:"
+description: "Mailtrap is a mock SMTP server for use in Rails development.  Mailtrap waits on your choosen port for a client to connect and talks _just enough_ SMTP protocol for ActionMailer to successfully deliver its message.  Mailtrap makes *no* attempt to actually deliver messages and, instead, writes them into sequentially numbered files on disk (hence the name \tMail_trap_).  You can configure the hostname (default: localhost) and port (default: 2525) for the server and also where the messages get written (default: /var/tmp). Messages will get written to files named smtp0001.msg, smtp0002.msg, and so on.  == FEATURES/PROBLEMS:"
 autorequire: 
 default_executable: 
 bindir: bin