remailer 0.4.21 → 0.5.0

data/lib/remailer/smtp/server/interpreter.rb

@@ -0,0 +1,237 @@
+class Remailer::SMTP::Server::Interpreter < Remailer::Interpreter
+  # == State Definitions ====================================================
+  
+  default do |error|
+    delegate.send_line("500 Invalid command")
+  end
+  
+  state :initialized do
+    enter do
+      self.send_banner
+      
+      enter_state(:reset)
+    end
+  end
+  
+  state :reset do
+    enter do
+      self.reset_transaction!
+      
+      enter_state(:ready)
+    end
+  end
+  
+  state :ready do
+    interpret(/^\s*EHLO\s+(\S+)\s*$/) do |remote_host|
+      delegate.validate_hostname(remote_host) do |valid|
+        if (valid)
+          delegate.log(:debug, "#{delegate.remote_ip}:#{delegate.remote_port} to #{delegate.local_ip}:#{delegate.local_port} Accepting connection from #{remote_host}")
+          @remote_host = remote_host
+
+          delegate.send_line("250-#{delegate.server_name} Hello #{delegate.remote_host} [#{delegate.remote_ip}]")
+          delegate.send_line("250-AUTH PLAIN")
+          delegate.send_line("250-SIZE 35651584")
+          delegate.send_line("250-STARTTLS") if (delegate.tls?)
+          delegate.send_line("250 OK")
+        else
+          delegate.log(:debug, "#{delegate.remote_ip}:#{delegate.remote_port} to #{delegate.local_ip}:#{delegate.local_port} Rejecting connection from #{remote_host} because of invalid FQDN")
+          delegate.send_line("504 Need fully qualified hostname")
+        end
+      end
+    end
+
+    interpret(/^\s*HELO\s+(\S+)\s*$/) do |remote_host|
+      delegate.validate_hostname(remote_host) do |valid|
+        if (valid)
+          delegate.log(:debug, "#{delegate.remote_ip}:#{delegate.remote_port} to #{delegate.local_ip}:#{delegate.local_port} Accepting connection from #{remote_host}")
+          @remote_host = remote_host
+
+          delegate.send_line("250 #{delegate.server_name} Hello #{delegate.remote_host} [#{delegate.remote_ip}]")
+        else
+          delegate.log(:debug, "#{delegate.remote_ip}:#{delegate.remote_port} to #{delegate.local_ip}:#{delegate.local_port} Rejecting connection from #{remote_host} because of invalid FQDN")
+          delegate.send_line("504 Need fully qualified hostname")
+        end
+      end
+    end
+    
+    interpret(/^\s*MAIL\s+FROM:\s*<([^>]+)>\s*/) do |address|
+      if (Remailer::EmailAddress.valid?(address))
+        accept, message = will_accept_sender(address)
+
+        if (accept)
+          @transaction.sender = address
+        end
+
+        delegate.send_line(message)
+      else
+        delegate.send_line("501 Email address is not RFC compliant")
+      end
+    end
+
+    interpret(/^\s*RCPT\s+TO:\s*<([^>]+)>\s*/) do |address|
+      if (@transaction.sender)
+        if (Remailer::EmailAddress.valid?(address))
+          accept, message = will_accept_recipient(address)
+
+          if (accept)
+            @transaction.recipients ||= [ ]
+            @transaction.recipients << address
+          end
+
+          delegate.send_line(message)
+        else
+          delegate.send_line("501 Email address is not RFC compliant")
+        end
+      else
+        delegate.send_line("503 Sender not specified")
+      end
+    end
+    
+    interpret(/^\s*AUTH\s+PLAIN\s+(.*)\s*$/) do |auth|
+      # 235 2.7.0 Authentication successful
+      delegate.send("235 whatever")
+    end
+
+    interpret(/^\s*AUTH\s+PLAIN\s*$/) do
+      # Multi-line authentication method
+      enter_state(:auth_plain)
+    end
+    
+    interpret(/^\s*STARTTLS\s*$/) do
+      if (@tls_started)
+        delegate.send_line("454 TLS already started")
+      elsif (delegate.tls?)
+        delegate.send_line("220 TLS ready to start")
+        delegate.start_tls(
+          :private_key_file => Remailer::SMTP::Server.private_key_path,
+          :cert_chain_file => Remailer::SMTP::Server.ssl_cert_path
+        )
+        
+        @tls_started = true
+      else
+        delegate.send_line("421 TLS not supported")
+      end
+    end
+    
+    interpret(/^\s*DATA\s*$/) do
+      if (@transaction.sender)
+      else
+        delegate.send_line("503 valid RCPT command must precede DATA")
+      end
+      
+      enter_state(:data)
+      delegate.send_line("354 Supply message data")
+    end
+
+    interpret(/^\s*NOOP\s*$/) do |remote_host|
+      delegate.send_line("250 OK")
+    end
+
+    interpret(/^\s*RSET\s*$/) do |remote_host|
+      delegate.send_line("250 Reset OK")
+      
+      enter_state(:reset)
+    end
+    
+    interpret(/^\s*QUIT\s*$/) do
+      delegate.send_line("221 #{delegate.server_name} closing connection")
+
+      delegate.close_connection(true)
+    end
+  end
+  
+  state :data do
+    interpret(/^\.$/) do
+      accept, message = will_accept_transaction(@transaction)
+      
+      if (accept)
+        accept, message = delegate.receive_transaction(@transaction)
+        
+        delegate.send_line(message)
+      else
+        delegate.send_line(message)
+      end
+
+      self.reset_transaction!
+
+      enter_state(:ready)
+    end
+    
+    default do |line|
+      # RFC5321 4.5.2 - Leading dot is removed if line has content
+      
+      @transaction.data << (line.sub(/^\./, '') + Remailer::Constants::CRLF)
+    end
+  end
+  
+  state :auth_plain do
+    # Receive a single line of authentication
+    # ...
+  end
+  
+  state :reply do
+    enter do
+      # Random delay if required
+      delegate.send_line(@reply)
+    end
+    
+    default do
+      delegate.send_line("554 SMTP Synchronization Error")
+      enter_state(:ready)
+    end
+  end
+
+  state :timeout do
+    enter do
+      delegate.send_line("420 Idle connection closed")
+
+      delegate.close_connection(true)
+    end
+  end
+
+  # == Instance Methods =====================================================
+
+  def reset_transaction!
+    @transaction = Remailer::SMTP::Server::Transaction.new
+  end
+
+  def send_banner
+    delegate.send_line("220 #{delegate.server_name} Remailer ESMTP Server Ready")
+  end
+
+  def reset_ttl!
+    @timeout_at = Time.now + self.connection_ttl
+  end
+
+  def enter_state(state)
+    self.reset_ttl!
+    
+    super(state)
+  end
+
+  def connection_ttl
+    10
+  end
+  
+  def ttl_expired?
+    @timeout_at ? (Time.now > @timeout_at) : false
+  end
+  
+  def check_for_timeout!
+    if (self.ttl_expired?)
+      enter_state(:timeout)
+    end
+  end
+  
+  def will_accept_sender(sender)
+    [ true, "250 Accepted" ]
+  end
+  
+  def will_accept_recipient(recipient)
+    [ true, "250 Accepted" ]
+  end
+  
+  def will_accept_transaction(transaction)
+    [ true, "250 Accepted" ]
+  end
+end

data/lib/remailer/smtp/server/transaction.rb

@@ -0,0 +1,29 @@
+class Remailer::SMTP::Server::Transaction
+  # == Constants ============================================================
+  
+  ATTRIBUTES = [ :sender, :recipients, :data ].freeze
+
+  # == Properties ===========================================================
+  
+  attr_accessor *ATTRIBUTES
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(options = nil)
+    case (options)
+    when Remailer::SMTP::Server::Transaction
+      ATTRIBUTES.each do |attribute|
+        instance_variable_set("@#{attribute}", options.send(attribute))
+      end
+    when Hash
+      ATTRIBUTES.each do |attr|
+        instance_variable_set("@#{attribute}", options[attribute])
+      end
+    end
+    
+    self.recipients = [ self.recipients ].compact.flatten
+    self.data ||= ''
+  end
+end

data/lib/remailer/socks5.rb

@@ -0,0 +1,5 @@
+module Remailer::SOCKS5
+  # == Submodules ===========================================================
+  
+  autoload(:Client, 'remailer/socks5/client')
+end

data/lib/remailer/socks5/client.rb

@@ -0,0 +1,5 @@
+module Remailer::SOCKS5::Client
+  # == Submodules ===========================================================
+  
+  autoload(:Interpreter, 'remailer/socks5/client/interpreter')
+end

data/lib/remailer/{connection/socks5_interpreter.rb → socks5/client/interpreter.rb}

@@ -1,6 +1,7 @@
-class Remailer::Connection::Socks5Interpreter < Remailer::Interpreter
+class Remailer::SOCKS5::Client::Interpreter < Remailer::Interpreter
   # == Constants ============================================================
 
+  # RFC1928 and RFC1929 define these values
   SOCKS5_VERSION = 5
 
   SOCKS5_METHOD = {
@@ -44,7 +45,7 @@ class Remailer::Connection::Socks5Interpreter < Remailer::Interpreter
         socks_methods << SOCKS5_METHOD[:username_password]
       end
       
-      proxy_options[:port] ||= Remailer::Connection::SOCKS5_PORT
+      proxy_options[:port] ||= Remailer::Constants::SOCKS5_PORT
 
       delegate.debug_notification(:proxy, "Initiating proxy connection through #{proxy_options[:host]}:#{proxy_options[:port]}")
 

data/lib/remailer/support.rb

@@ -0,0 +1,5 @@
+module Remailer::Support
+  def quoted(string)
+    string.to_s.inspect
+  end
+end

data/remailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "remailer"
-  s.version = "0.4.21"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Tadman"]
-  s.date = "2011-11-03"
+  s.date = "2012-03-19"
   s.description = "EventMachine SMTP Mail User Agent"
   s.email = "scott@twg.ca"
   s.extra_rdoc_files = [
@@ -21,24 +21,42 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/remailer.rb",
-    "lib/remailer/connection.rb",
-    "lib/remailer/connection/smtp_interpreter.rb",
-    "lib/remailer/connection/socks5_interpreter.rb",
+    "lib/remailer/abstract_connection.rb",
+    "lib/remailer/constants.rb",
+    "lib/remailer/email_address.rb",
+    "lib/remailer/imap.rb",
+    "lib/remailer/imap/client.rb",
+    "lib/remailer/imap/client/interpreter.rb",
+    "lib/remailer/imap/server.rb",
+    "lib/remailer/imap/server/interpreter.rb",
     "lib/remailer/interpreter.rb",
     "lib/remailer/interpreter/state_proxy.rb",
+    "lib/remailer/smtp.rb",
+    "lib/remailer/smtp/client.rb",
+    "lib/remailer/smtp/client/interpreter.rb",
+    "lib/remailer/smtp/server.rb",
+    "lib/remailer/smtp/server/interpreter.rb",
+    "lib/remailer/smtp/server/transaction.rb",
+    "lib/remailer/socks5.rb",
+    "lib/remailer/socks5/client.rb",
+    "lib/remailer/socks5/client/interpreter.rb",
+    "lib/remailer/support.rb",
     "remailer.gemspec",
     "test/config.example.rb",
     "test/helper.rb",
-    "test/unit/remailer_connection_smtp_interpreter_test.rb",
-    "test/unit/remailer_connection_socks5_interpreter_test.rb",
-    "test/unit/remailer_connection_test.rb",
+    "test/unit/remailer_imap_client_interpreter_test.rb",
+    "test/unit/remailer_imap_client_test.rb",
     "test/unit/remailer_interpreter_state_proxy_test.rb",
     "test/unit/remailer_interpreter_test.rb",
+    "test/unit/remailer_smtp_client_interpreter_test.rb",
+    "test/unit/remailer_smtp_client_test.rb",
+    "test/unit/remailer_smtp_server_test.rb",
+    "test/unit/remailer_socks5_client_interpreter_test.rb",
     "test/unit/remailer_test.rb"
   ]
   s.homepage = "http://github.com/twg/remailer"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.17"
   s.summary = "Reactor-Ready SMTP Mailer"
 
   if s.respond_to? :specification_version then

data/test/unit/remailer_imap_client_interpreter_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.join(*%w[ .. helper ]), File.dirname(__FILE__))
+
+class RemailerIMAPClientInterpreterTest < Test::Unit::TestCase
+  def test_split_list_definition
+    assert_mapping(
+      '(\HasChildren \HasNoChildren) "/" "[Gmail]/All Mail"' =>
+        [ %w[ \HasChildren \HasNoChildren ], "/", "[Gmail]/All Mail" ],
+      '(\HasNoChildren) "/" "INBOX"' =>
+        [ %w[ \HasNoChildren ], "/", "INBOX" ]
+    ) do |string|
+      Remailer::IMAP::Client::Interpreter.split_list_definition(string)
+    end
+  end
+end

data/test/unit/remailer_imap_client_test.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.join(*%w[ .. helper ]), File.dirname(__FILE__))
+
+class RemailerIMAPClientTest < Test::Unit::TestCase
+  def setup
+    STDERR.sync = true
+  end
+  
+  def test_connect
+    engine do
+      debug = { }
+      
+      client = Remailer::IMAP::Client.open(
+        TestConfig.imap_server[:host],
+        :debug => STDERR, 
+        :connect => lambda { |success, host| connected_host = host }
+      )
+      
+      assert client
+      
+      assert_eventually(30) do
+        client.connected?
+      end
+      
+      capabilities = nil
+      
+      client.capability do |list|
+        capabilities = list
+      end
+      
+      assert_eventually(10) do
+        capabilities
+      end
+      
+      assert_equal %w[ IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN X-GM-EXT-1 XYZZY SASL-IR AUTH=XOAUTH ], capabilities
+      
+      # -- LOGIN ------------------------------------------------------------
+      
+      login_status = nil
+      
+      client.login(TestConfig.smtp_server[:username], TestConfig.smtp_server[:password]) do |status, message|
+        login_status = status
+      end
+      
+      assert_eventually(10) do
+        login_status
+      end
+      
+      assert_equal 'OK', login_status
+      
+      # -- LIST -------------------------------------------------------------
+
+      list = nil
+    
+      client.list do |status, message, additional|
+        list = additional
+      end
+
+      assert_eventually(10) do
+        list
+      end
+    
+      assert list.find { |i| i[0] == 'INBOX' }
+      
+      # -- EXAMINE -----------------------------------------------------------
+      
+      examine_status = nil
+
+      client.examine('INBOX') do |status, message, additional|
+        examine_status = status
+      end
+      
+      assert_eventually(10) do
+        examine_status
+      end
+      
+      assert_equal 'OK', examine_status
+
+      # -- SELECT -----------------------------------------------------------
+      
+      select_status = nil
+
+      client.select('INBOX') do |status, message, additional|
+        select_status = status
+      end
+      
+      assert_eventually(10) do
+        select_status
+      end
+      
+      assert_equal 'OK', select_status
+      
+      # -- IDLE ------------------------------------------------------------
+      
+      idle_status = nil
+      
+      idle = client.idle do |status|
+        idle_status = status
+      end
+      
+      assert_equal nil, idle_status
+      
+      idle.call
+      
+      assert_eventually(5) do
+        idle_status
+      end
+      
+      assert_equal 'OK', idle_status
+
+      # -- FETCH -----------------------------------------------------------
+      
+      fetch_status = nil
+
+      client.fetch(2..5) do |status, message, additional|
+        fetch_status = status
+      end
+      
+      assert_eventually(10) do
+        fetch_status
+      end
+      
+      assert_equal 'OK', fetch_status
+    end
+  end
+end