rumbster 1.0.0

data/README

@@ -0,0 +1,56 @@
+Rumbster README
+===============
+
+  Rumbster is a fake smtp server for email testing in Ruby.
+  Rumbster was developed to as a way to acceptance test email
+  sending applications.
+
+Requirements
+------------
+
+   * Ruby 1.8.2 or later (may work with earlier versions)
+
+License
+-------
+
+  GNU LGPL, Lesser General Public License version 2.1
+  For details of LGPL, see file "COPYING".
+
+Example Usage
+-------------
+
+A good source for usage information is the unit tests in the 
+test directory.   Below is an example of the usage.
+
+class TestEmails < Test::Unit::TestCase
+
+  def setup
+    @rumbster = Rumbster.new(port)
+    @message_observer = MailMessageObserver.new
+
+    @rumbster.add_observer @message_observer
+    @rumbster.add_observer FileMessageObserver.new('some/directory')
+
+    @rumbster.start
+  end
+
+  def teardown
+    @rumbster.stop
+  end
+
+  def test_email_is_sent
+    send_email
+    assert_equal 1, @message_observer.messages.size
+    assert_equal 'junk@junk.com', @message_observer.messages.first.to
+  end
+end
+
+Bug Report
+----------
+
+  Any bug reports are welcome.
+  If you encounter a bug, please email me.
+
+  Adam Esterline
+  adam@esterlines.com
+  http://adamesterline.com

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Default Task"
+task :default => [ :test ]
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+}

data/lib/message_observers.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'vendor'))
+
+require 'fileutils'
+require 'tmail'
+
+class FileMessageObserver
+  include FileUtils
+  
+  def initialize(message_directory, system_time = SystemTime.new)
+    @message_directory = message_directory
+    @system_time = system_time
+    mkdir_p(message_directory)
+  end
+
+  def update(message_string)
+    mail = TMail::Mail.parse(message_string)
+    
+    file_name = File.join(@message_directory, "#{@system_time.current_time_in_seconds}_#{mail.to}.txt")    
+    File.open(file_name, 'w') {|file| file << message_string }
+  end
+end
+
+class MailMessageObserver
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+  
+  def update(message_string)
+    @messages << TMail::Mail.parse(message_string)
+  end
+  
+end
+
+class SystemTime
+  def current_time_in_seconds
+    Time.now.to_i
+  end
+end

data/lib/rumbster.rb

@@ -0,0 +1,24 @@
+require 'gserver'
+require 'smtp_protocol'
+
+class Rumbster < GServer
+  
+  def initialize(port=25, *args)
+    super(port, *args)
+    
+    @observers = []
+  end
+  
+  def serve(io)
+    protocol = SmtpProtocol.create
+    @observers.each do |observer|
+      protocol.add_observer(observer)
+    end
+    protocol.serve(io)
+  end
+  
+  def add_observer(observer)
+    @observers.push(observer)
+  end
+  
+ end

data/lib/smtp_protocol.rb

@@ -0,0 +1,42 @@
+require 'observer'
+require 'smtp_states'
+
+class SmtpProtocol
+  include Observable
+  
+  def SmtpProtocol.create
+    initial_state = :init
+    
+    states = {
+      :init => InitState.new, 
+      :connect => ConnectState.new, 
+      :connected => ConnectedState.new, 
+      :read_mail => ReadMailState.new, 
+      :quit => QuitState.new 
+    }
+    
+    SmtpProtocol.new(initial_state, states)
+  end
+
+  def initialize(initial_state, states)
+    states.each_value { |state| state.protocol = self }
+
+    @states = states
+    @state = @states[initial_state]
+  end
+  
+  def state=(new_state)
+    @state = @states[new_state]
+  end
+  
+  def serve(io)
+    @state.serve(io)
+  end
+  
+  def new_message_received(message)
+    changed
+    notify_observers(message)
+  end
+  
+end
+

data/lib/smtp_states.rb

@@ -0,0 +1,159 @@
+class NotInitializedError < RuntimeError; end
+
+module State
+  attr_accessor :protocol
+  
+  def serve(io)
+    raise NotInitializedError.new if @protocol.nil?
+    
+    service_request(io)
+    @protocol.state = @next_state
+    @protocol.serve(io)
+  end  
+end
+
+module Messages
+  
+  def greeting(io)
+    io.puts '220 ruby ESMTP'
+  end
+  
+  def helo_response(io)
+    io.puts '250 ruby'
+  end
+  
+  def ok(io)
+    io.puts '250 ok'
+  end
+  
+  def go_ahead(io)
+    io.puts '354 go ahead'
+  end
+  
+  def goodbye(io)
+    io.puts '221 ruby goodbye'
+  end
+  
+end
+
+class InitState
+  
+  include State, Messages
+  
+  def initialize(protocol = nil, next_state = :connect)
+    @protocol = protocol
+    @next_state = next_state
+  end
+  
+  private
+    
+  def service_request(io)
+    greeting(io)
+  end
+  
+end
+
+class ConnectState
+  
+  include State, Messages
+
+  def initialize(protocol = nil, next_state = :connected)
+    @protocol = protocol
+    @next_state = next_state
+  end
+    
+  private
+  
+  def service_request(io)
+    read_client_helo(io)
+    helo_response(io)
+  end
+  
+  def read_client_helo(io)
+    io.readline
+  end
+  
+end
+
+class ConnectedState
+  
+  include State, Messages
+  
+  def initialize(protocol = nil)
+    @protocol = protocol
+    @next_state = :connected
+  end
+  
+  private
+  
+  def service_request(io)
+    request = io.readline
+    
+    if request.strip.eql? "DATA"
+      @next_state = :read_mail
+      go_ahead(io)
+    else
+      ok(io)
+    end
+  end
+  
+end
+
+class ReadMailState
+  
+  include State, Messages
+  
+  def initialize(protocol = nil)
+    @protocol = protocol
+    @next_state = :quit
+  end
+  
+  private
+  
+  def service_request(io)
+    message = read_message(io)
+    @protocol.new_message_received(message)
+    ok(io)
+  end
+  
+  def not_end_of_message(line)
+    not line.strip.eql?('.')
+  end
+  
+  def read_message(io)
+    message = ''
+    
+    line = io.readline
+    while not_end_of_message(line)
+      message << line
+      line = io.readline
+    end
+    
+    message
+  end
+  
+end
+
+class QuitState
+  
+  include Messages
+  attr_accessor :protocol
+  
+  def initialize(protocol = nil)
+    @protocol = protocol
+  end
+  
+  def serve(io)
+    raise NotInitializedError.new if @protocol.nil?
+    
+    read_quit(io)
+    goodbye(io)
+  end
+  
+  private
+  
+  def read_quit(io)
+    io.readline    
+  end
+  
+end

data/test/message_observers_test.rb

@@ -0,0 +1,102 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'test/unit'
+require 'fileutils'
+require 'message_observers'
+
+class MessageObserversTest < Test::Unit::TestCase
+  
+  include FileUtils
+  
+  def setup
+    @directory = File.join(File.dirname(__FILE__), '..', 'messages')
+  end
+  
+  def teardown
+    rm_r(@directory) if File.exists?(@directory)
+  end
+  
+  def test_directory_is_created_when_directory_is_not_present
+    file_observer = FileMessageObserver.new(@directory)
+    
+    assert File.exists?(@directory)
+  end
+  
+  def test_if_directory_is_already_present_observer_can_still_be_created
+    mkdir_p(@directory)
+
+    assert File.exists?(@directory)
+    assert_not_nil FileMessageObserver.new(@directory)
+  end
+  
+  def test_message_received_is_saved_to_message_directory
+    file_observer = FileMessageObserver.new(@directory)
+    file_observer.update "To: junk@junk.com\nFrom: junk2@junk2.com\nSubject: What's up\n\nHi"
+    
+    assert_one_new_file_added_to @directory
+  end
+  
+  def test_message_is_saved_in_a_file_named_time_stamp_underscore_to_dot_txt
+    file_observer = FileMessageObserver.new(@directory, TestSystemTime.new(1))
+    file_observer.update "To: junk@junk.com\nFrom: junk2@junk2.com\nSubject: What's up\n\nHi"
+    
+    expected_file_name = File.join(@directory, "1_junk@junk.com.txt")
+    
+    assert File.exists?(expected_file_name)
+  end
+  
+  def test_message_contents_are_saved_to_the_file
+    message = "To: junk@junk.com\nFrom: junk2@junk2.com\nSubject: What's up\n\nHi"
+
+    file_observer = FileMessageObserver.new(@directory, TestSystemTime.new(1))
+    file_observer.update message
+    
+    expected_file_name = File.join(@directory, "1_junk@junk.com.txt")
+    
+    assert_equal read_file_contents_into_a_string(expected_file_name), message
+  end
+  
+  def test_messages_are_saved_for_later_inspection
+    message = "To: junk@junk.com\nFrom: junk2@junk2.com\nSubject: What's up\n\nHi"
+
+    mail_observer = MailMessageObserver.new
+    mail_observer.update message
+    mail_observer.update message
+    
+    assert_equal 2, mail_observer.messages.size
+  end
+  
+  def test_message_is_converted_to_tmail
+    message = "To: junk@junk.com\nFrom: junk2@junk2.com\nSubject: What's up\n\nHi"
+
+    mail_observer = MailMessageObserver.new
+    mail_observer.update message
+    
+    assert_equal 'What\'s up', mail_observer.messages.first.subject
+  end
+  
+  private
+  
+  def read_file_contents_into_a_string(file_name)
+    File.open(file_name) {|file| file.readlines.join }
+  end
+  
+  
+  def assert_one_new_file_added_to(directory)
+    number_of_dot_and_dot_dot_entries_in_a_directory_when_it_is_first_created = 2
+    number_of_entries_with_one_file = number_of_dot_and_dot_dot_entries_in_a_directory_when_it_is_first_created + 1
+    
+    assert_equal number_of_entries_with_one_file, Dir.entries(@directory).size
+  end
+end
+
+class TestSystemTime
+  def initialize(time)
+    @time = time
+  end
+  
+  def current_time_in_seconds
+    @time
+  end
+  
+end

data/test/rumbster_test.rb

@@ -0,0 +1,69 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'test/unit'
+require 'rumbster'
+require 'net/smtp'
+require 'gserver'
+
+
+class RumbsterTest < Test::Unit::TestCase
+  
+  def setup
+    @observer = RumbsterObserver.new
+    @server = Rumbster.new(10025)
+    @server.add_observer(@observer)
+    
+    @server.start
+  end
+  
+  def teardown
+    @server.stop
+  end
+  
+  def test_single_receiver_message_sent_by_client_is_received_by_listener
+    message = "From: <junk@junkster.com>\r\nTo: junk@junk.com\r\nSubject: hi\r\n\r\nThis is a test\r\n"
+    to = 'his_address@example.com'
+    send_message to, message 
+        
+    assert_equal message, @observer.message
+  end
+  
+  def test_multiple_receiver_message_sent_by_client_is_received_by_listener
+    message = "From: <junk@junkster.com>\r\nTo: junk@junk.com\r\nSubject: hi\r\n\r\nThis is a test\r\n"
+    to = ['his_address@example.com', 'her_address@example.com']
+    send_message to, message 
+        
+    assert_equal message, @observer.message
+  end
+
+  def test_multiple_receiver_messages_sent_by_client_are_received_by_listener
+    message_1 = "From: <junk_1@junkster.com>\r\nTo: junk_1@junk.com\r\nSubject: hi\r\n\r\nThis is a test_1\r\n"
+    to_1 = ['his_address_1@example.com', 'her_address_1@example.com']
+    send_message to_1, message_1 
+
+    assert_equal message_1, @observer.message
+
+    message_2 = "From: <junk_2@junkster.com>\r\nTo: junk_2@junk.com\r\nSubject: hi\r\n\r\nThis is a test_2\r\n"
+    to_2 = ['his_address_2@example.com', 'her_address_2@example.com']
+    send_message to_2, message_2 
+        
+    assert_equal message_2, @observer.message
+  end
+  
+  private
+
+  def send_message(to, message)
+    Net::SMTP.start('localhost', 10025) do |smtp|
+      smtp.send_message message, 'your@mail.address', to
+    end
+  end
+  
+end
+
+class RumbsterObserver
+  attr_accessor :message
+  
+  def update(message)
+    @message = message
+  end
+end