remailer 0.3.4 → 0.3.6

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.6

data/lib/remailer/connection.rb

@@ -27,6 +27,7 @@ class Remailer::Connection < EventMachine::Connection
   
   # == Properties ===========================================================
   
+  attr_accessor :active_message
   attr_accessor :remote, :max_size, :protocol, :hostname
   attr_accessor :pipelining, :tls_support, :auth_support
   attr_accessor :timeout
@@ -51,6 +52,7 @@ class Remailer::Connection < EventMachine::Connection
   # * error => Where to send errors (IO or Proc)
   # * on_connect => Called upon successful connection (Proc)
   # * on_error => Called upon connection error (Proc)
+  # * on_disconnect => Called when connection is closed (Proc)
   # A block can be supplied in which case it will stand in as the :connect
   # option. The block will recieve a first argument that is the status of
   # the connection, and an optional second that is a diagnostic message.
@@ -130,6 +132,7 @@ class Remailer::Connection < EventMachine::Connection
     STDERR.puts "#{e.class}: #{e}"
   end
   
+  # Returns true if the connection requires TLS support, or false otherwise.
   def use_tls?
     !!@options[:use_tls]
   end
@@ -195,12 +198,6 @@ class Remailer::Connection < EventMachine::Connection
     end
   end
   
-  # Returns the details of the active message being sent, or nil if no message
-  # is being sent.
-  def active_message
-    @active_message
-  end
-  
   # Reassigns the timeout which is specified in seconds. Values equal to
   # or less than zero are ignored and a default is used instead.
   def timeout=(value)
@@ -218,12 +215,14 @@ class Remailer::Connection < EventMachine::Connection
   # a connection closed event.
   def unbind
     @interpreter = nil
-    
+
     if (@active_message)
       if (callback = @active_message[:callback])
         callback.call(nil)
       end
     end
+
+    send_callback(:on_disconnect)
   end
 
   # This implements the EventMachine::Connection#receive_data method that
@@ -244,15 +243,25 @@ class Remailer::Connection < EventMachine::Connection
   end
 
   def post_init
-    EventMachine.add_periodic_timer(1) do
+    @timer = EventMachine.add_periodic_timer(1) do
       check_for_timeouts!
     end
   end
   
+  #
+  def detach
+    @timer.cancel
+    super
+  end
+  
+  # Returns the current state of the active interpreter, or nil if no state
+  # is assigned.
   def state
     @interpreter and @interpreter.state
   end
 
+  # Sends a single line to the remote host with the appropriate CR+LF
+  # delmiter at the end.
   def send_line(line = '')
     reset_timeout!
 
@@ -274,13 +283,18 @@ class Remailer::Connection < EventMachine::Connection
     nil
   end
 
+  # Resets the timeout time. Returns the time at which a timeout will occur.
   def reset_timeout!
     @timeout_at = Time.now + @timeout
   end
   
+  # Checks for a timeout condition, and if one is detected, will close the
+  # connection and send appropriate callbacks.
   def check_for_timeouts!
     return if (!@timeout_at or Time.now < @timeout_at)
 
+    @timeout_at = nil
+
     error_notification(:timeout, "Connection timed out")
     debug_notification(:timeout, "Connection timed out")
     message_callback(:timeout, "Connection timed out before send could complete")
@@ -293,42 +307,54 @@ class Remailer::Connection < EventMachine::Connection
     close_connection
   end
   
+  # Returns true if pipelining support has been detected on the connection,
+  # false otherwise.
   def pipelining?
     !!@pipelining
   end
 
+  # Returns true if pipelining support has been detected on the connection,
+  # false otherwise.
   def tls_support?
     !!@tls_support
   end
   
+  # Returns true if the connection has been closed, false otherwise.
   def closed?
     !!@closed
   end
   
+  # Returns true if an error has occurred, false otherwise.
   def error?
     !!@error
   end
-
+  
+  # EventMachine: Enables TLS support on the connection.
   def start_tls
     debug_notification(:tls, "Started")
     super
   end
-  
+
+  # EventMachine: Closes down the connection.
   def close_connection
+    send_callback(:on_disconnect)
     debug_notification(:closed, "Connection closed")
     super
     @closed = true
   end
   alias_method :close, :close_connection
 
+  # Switches to use the SOCKS5 interpreter for all subsequent communication
   def use_socks5_interpreter!
     @interpreter = Remailer::Connection::Socks5Interpreter.new(:delegate => self)
   end
 
+  # Switches to use the SMTP interpreter for all subsequent communication
   def use_smtp_interpreter!
     @interpreter = Remailer::Connection::SmtpInterpreter.new(:delegate => self)
   end
 
+  # Callback receiver for when the proxy connection has been completed.
   def after_proxy_connected
     use_smtp_interpreter!
   end

data/lib/remailer/connection/smtp_interpreter.rb

@@ -161,7 +161,7 @@ class Remailer::Connection::SmtpInterpreter < Remailer::Interpreter
   
   state :mail_from do
     enter do
-      delegate.send_line("MAIL FROM:#{delegate.active_message[:from]}")
+      delegate.send_line("MAIL FROM:<#{delegate.active_message[:from]}>")
     end
 
     interpret(250) do
@@ -171,7 +171,7 @@ class Remailer::Connection::SmtpInterpreter < Remailer::Interpreter
   
   state :rcpt_to do
     enter do
-      delegate.send_line("RCPT TO:#{delegate.active_message[:to]}")
+      delegate.send_line("RCPT TO:<#{delegate.active_message[:to]}>")
     end
     
     interpret(250) do
@@ -253,7 +253,7 @@ class Remailer::Connection::SmtpInterpreter < Remailer::Interpreter
   end
   
   on_error do |reply_code, reply_message|
-    delegate.send_callback(reply_code, reply_message)
+    delegate.message_callback(reply_code, reply_message)
     delegate.debug_notification(:error, "[#{@state}] #{reply_code} #{reply_message}")
     delegate.error_notification(reply_code, reply_message)
     

data/remailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{remailer}
-  s.version = "0.3.4"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Tadman"]
-  s.date = %q{2010-12-16}
+  s.date = %q{2010-12-17}
   s.description = %q{EventMachine capable SMTP engine}
   s.email = %q{scott@twg.ca}
   s.extra_rdoc_files = [

data/test/unit/remailer_connection_smtp_interpreter_test.rb

@@ -192,13 +192,13 @@ class RemailerConnectionSmtpInterpreterTest < Test::Unit::TestCase
     
     assert_equal :mail_from, interpreter.state
     
-    assert_equal 'MAIL FROM:from@example.com', delegate.read
+    assert_equal 'MAIL FROM:<from@example.com>', delegate.read
     
     interpreter.process("250 OK\r\n")
     
     assert_equal :rcpt_to, interpreter.state
 
-    assert_equal 'RCPT TO:to@example.com', delegate.read
+    assert_equal 'RCPT TO:<to@example.com>', delegate.read
     
     interpreter.process("250 Accepted\r\n")
     

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Scott Tadman
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -05:00
+date: 2010-12-17 00:00:00 -05:00
 default_executable: 
 dependencies: []