.DS_Store doc/classes/Mailtrap/LogParser.html doc/classes/Mailtrap/LogParser.src/M000005.html doc/files/lib/mailtrap/log_parser_rb.html lib/mailtrap/log_parser.rb spec/mailtrap/log_parser_spec.rb spec/mailtrap/sample_logs/sample.log spec/mailtrap/sample_logs/sample_empty.log spec/spec.opts @@ -4,3 +4,13 @@ README.txt Rakefile bin/mailtrap lib/mailtrap.rb +lib/mailtrap/log_parser.rb +spec +spec/mailtrap +spec/mailtrap/log_parser_spec.rb +spec/mailtrap/sample_logs +spec/mailtrap/sample_logs/sample.log +spec/mailtrap/sample_logs/sample_empty.log +spec/spec.opts +test +test/test_mailtrap.rb Manifest.txt @@ -2,7 +2,9 @@ require 'rubygems' require 'hoe' -require './lib/mailtrap.rb' +require 'spec' +require 'spec/rake/spectask' +require './lib/mailtrap' Hoe.new('mailtrap', Mailtrap::VERSION ) do |p| p.rubyforge_name = 'simplyruby' @@ -15,6 +17,30 @@ Hoe.new('mailtrap', Mailtrap::VERSION ) do |p| p.remote_rdoc_dir = 'mailtrap' p.extra_deps << ['daemons','>= 1.0.8'] p.extra_deps << ['trollop','>= 1.7'] + p.extra_deps << ['tmail','>= 1.2.2'] end +namespace :spec do + desc "Run the specs under spec" + Spec::Rake::SpecTask.new('all') do |t| + t.spec_opts = ['--options', "spec/spec.opts"] + t.spec_files = FileList['spec/**/*_spec.rb'] + end + + desc "Run the specs under spec in specdoc format" + Spec::Rake::SpecTask.new('doc') do |t| + t.spec_opts = ['--format', "specdoc"] + t.spec_files = FileList['spec/**/*_spec.rb'] + end + + desc "Run the specs in HTML format" + Spec::Rake::SpecTask.new('html') do |t| + t.spec_opts = ['--format', "html"] + t.spec_files = FileList['spec/**/*_spec.rb'] + end +end + +desc "Run the default spec task" +task :spec => :"spec:all" + # vim: syntax=Ruby Rakefile @@ -59,6 +59,10 @@ lib/mailtrap.rb </a> + <a href="../files/lib/mailtrap/log_parser_rb.html"> + lib/mailtrap/log_parser.rb + </a> + </td> </tr> @@ -80,10 +84,11 @@ <div id="description"> -<a href="Mailtrap.html">Mailtrap</a> 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 to read a <a href="Mailtrap.html">Mailtrap</a> log file and extract +the emails, returning them as TMail objects. (Interim solution until we can +get <a href="Mailtrap.html">Mailtrap</a> outputting structured log files.) +— hacked together by Ashley Moran +<ashley.moran@patchspace.co.uk> 06-Apr-2008 </div> @@ -109,6 +114,12 @@ to disk. <div id="section"> + <div id="class-list"> + <h3 class="section-bar">Classes and Modules</h3> + + Class <a href="Mailtrap/LogParser.html" class="link">Mailtrap::LogParser</a> + + </div> <div id="constants-list"> <h3 class="section-bar">Constants</h3> @@ -118,7 +129,7 @@ to disk. <tr class="top-aligned-row context-row"> <td class="context-item-name">VERSION</td> <td>=</td> - <td class="context-item-value">'0.1.0'</td> + <td class="context-item-value">'0.2.1'</td> </tr> </table> </div> @@ -139,7 +150,7 @@ to disk. <div class="method-heading"> <a href="Mailtrap.src/M000001.html" target="Code" class="method-signature" onclick="popupCode('Mailtrap.src/M000001.html');return false;"> - new( host, port, once, msgdir ) + new( host, port, once, msgfile ) </a> </div> doc/classes/Mailtrap.html @@ -10,14 +10,17 @@ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> </head> <body class="standalone-code"> - <pre># File lib/mailtrap.rb, line 18 - def initialize( host, port, once, msgdir ) + <pre># File lib/mailtrap.rb, line 19 + def initialize( host, port, once, msgfile ) @host = host @port = port @once = once - @msgdir = msgdir + @msgfile = msgfile + + File.open( @msgfile, "a" ) do |file| + file.puts "\n* Mailtrap started at #{@host}:#{port}\n" + end - puts "Mailtrap starting at #{@host}:#{port} and writing to #{@msgdir}" service = TCPServer.new( @host, @port ) accept( service ) end</pre> doc/classes/Mailtrap.src/M000001.html @@ -10,7 +10,7 @@ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> </head> <body class="standalone-code"> - <pre># File lib/mailtrap.rb, line 30 + <pre># File lib/mailtrap.rb, line 34 def accept( service ) while session = service.accept doc/classes/Mailtrap.src/M000002.html @@ -10,27 +10,21 @@ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> </head> <body class="standalone-code"> - <pre># File lib/mailtrap.rb, line 54 + <pre># File lib/mailtrap.rb, line 58 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*/, "" ) } - # Figure out what the file name should be - 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| + # Append to the end of the messages file + File.open( @msgfile, "a" ) do |file| + file.puts "* Message begins" file.puts "From: #{from}" file.puts "To: #{to_list.join(", ")}" file.puts "Body:" file.puts message + file.puts "\n* Message ends" end end</pre> doc/classes/Mailtrap.src/M000003.html @@ -10,7 +10,7 @@ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> </head> <body class="standalone-code"> - <pre># File lib/mailtrap.rb, line 80 + <pre># File lib/mailtrap.rb, line 78 def serve( connection ) connection.puts( "220 #{@host} MailTrap ready ESTMP" ) helo = connection.get_line # whoever they are doc/classes/Mailtrap.src/M000004.html @@ -1 +1 @@ -Thu, 04 Oct 2007 11:17:30 +0100 +Sun, 06 Apr 2008 19:24:06 +0100 doc/created.rid @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Wed Oct 03 17:12:32 +0100 2007</td> + <td>Sun Apr 06 18:32:54 +0100 2008</td> </tr> </table> </div> doc/files/History_txt.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Oct 04 10:55:14 +0100 2007</td> + <td>Sun Apr 06 18:32:54 +0100 2008</td> </tr> </table> </div> @@ -88,14 +88,13 @@ ActionMailer to successfully deliver its message. <a href="../classes/Mailtrap.html">Mailtrap</a> makes no attempt to -actually deliver messages and, instead, writes them into sequentially -numbered files on disk (hence the name Mail_trap_). +actually deliver messages and, instead, writes them into a file (hence the +name Mail_trap_). Handy tip: use tail -f to see emails being received. 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. +/var/tmp/mailtrap.log). <h2>FEATURES/PROBLEMS:</h2> <ul> @@ -113,6 +112,29 @@ smtp0002.msg, and so on. </li> </ul> <h2>SYNOPSIS:</h2> + +To use the defaults host:localhost, port:2525, file:/var/log/mailtrap.log + +<ul> +<li>mailtrap start + +</li> +</ul> + +Customise startup: + +<ul> +<li>sudo mailtrap start —host my.host —port 25 —once +—file=/var/log/messages.txt + +</li> +</ul> + +(sudo because you want to use restricted port 25) + + +For more info: + <ul> <li>mailtrap —help (to see Daemonization options) @@ -121,14 +143,13 @@ smtp0002.msg, and so on. href="../classes/Mailtrap.html">Mailtrap</a> options) </li> -<li>mailtrap start —host localhost —port 8025 —once -—msgdir=/var/tmp - -</li> </ul> <h2>REQUIREMENTS:</h2> <ul> -<li>Rubygems +<li>Hoe rubygem + +</li> +<li>Rubygems rubygem </li> <li>Daemons rubygem @@ -138,6 +159,9 @@ href="../classes/Mailtrap.html">Mailtrap</a> options) </li> </ul> + +All these are automatically installed if you use gem install -y + <h2>INSTALL:</h2> <ul> <li>sudo gem install -y mailtrap doc/files/README_txt.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Wed Oct 03 20:58:33 +0100 2007</td> + <td>Sun Apr 06 18:32:54 +0100 2008</td> </tr> </table> </div> doc/files/bin/mailtrap.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Oct 04 11:17:27 +0100 2007</td> + <td>Sun Apr 06 19:17:41 +0100 2008</td> </tr> </table> </div> doc/files/lib/mailtrap_rb.html @@ -21,6 +21,7 @@ <h1 class="section-bar">Classes</h1> <div id="index-entries"> <a href="classes/Mailtrap.html">Mailtrap</a> + <a href="classes/Mailtrap/LogParser.html">Mailtrap::LogParser</a> </div> </div> </body> doc/fr_class_index.html @@ -24,6 +24,7 @@ <a href="files/README_txt.html">README.txt</a> <a href="files/bin/mailtrap.html">bin/mailtrap</a> <a href="files/lib/mailtrap_rb.html">lib/mailtrap.rb</a> + <a href="files/lib/mailtrap/log_parser_rb.html">lib/mailtrap/log_parser.rb</a> </div> </div> </body> doc/fr_file_index.html @@ -22,6 +22,7 @@ <div id="index-entries"> <a href="classes/Mailtrap.html#M000002">accept (Mailtrap)</a> <a href="classes/Mailtrap.html#M000001">new (Mailtrap)</a> + <a href="classes/Mailtrap/LogParser.html#M000005">parse (Mailtrap::LogParser)</a> <a href="classes/Mailtrap.html#M000004">serve (Mailtrap)</a> <a href="classes/Mailtrap.html#M000003">write (Mailtrap)</a> </div> doc/fr_method_index.html @@ -5,12 +5,12 @@  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> - <title> rubymatt's mailtrap-0.1.0 Documentation</title> + <title> simplyruby's mailtrap-0.2.1 Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> </head> <frameset rows="20%, 80%"> doc/index.html @@ -1,9 +1,10 @@ - require 'rubygems' require 'daemons' require 'socket' require 'trollop' +$:.unshift File.expand_path(File.join(File.dirname(__FILE__))) + # # 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 lib/mailtrap.rb 248d8efd9e55242d2b5da06fe873c9c13f03b671 Ashley Moran ashley.moran@patchspace.co.uk http://github.com/ashleymoran/mailtrap/commit/fa975934c38f737f4ea2fd7219bacc9d8649b636 fa975934c38f737f4ea2fd7219bacc9d8649b636

2008-04-06T11:24:34-07:00

Added Mailtrap::LogParser for turning Mailtrap log files into an array of TMail::Mail objects - useful for inspecting the file for testing purposes. d01b659063df9848ad7c26e923d3491f9b8bbb66 Ashley Moran ashley.moran@patchspace.co.uk