remailer 0.5.2 → 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c66f7fc5cd78fcb8115342274f77169e4658cfb575d6b2609d2ae07bbd7278a0
+  data.tar.gz: 277347ffde8646bb32f6dc01cddca71be940c21fc46f5cfe32ecb4d02c849065
+SHA512:
+  metadata.gz: 6352a8dddf0f8cf1cd16cb810af0993a7bbd3386fe0ccc28c20fc9d891a9a9d4ae69e98b106f6d3a31933620364bb88f77217c2db1103400607333e9f5bcec71
+  data.tar.gz: 3b935c992a65b812b268cd616353886b104ba7c3cb97009c6234bae1e57d685d381c466219dd357542d6a424ddfe643f9648a8a644797f35806170e166cdfdd8

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org/'
+
+gem 'eventmachine'
+
+group :development do
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'juwelier'
+end

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2019 Scott Tadman, PostageApp Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/{README.rdoc → README.md}

@@ -1,8 +1,8 @@
-= remailer
+# remailer
 
 Client/Server Mail Networking Library for SMTP and IMAP
 
-== Overview
+## Overview
 
 This is an EventMachine Connection implementation of a high-performance
 asynchronous SMTP client. Although EventMachine ships with a built-in SMTP
@@ -10,7 +10,7 @@ client, that version is limited to sending a single email per client,
 and since establishing a client can be the majority of the time required
 to send email, this limits throughput considerably.
 
-== Use
+## Use
 
 The Remailer system consists of the Remailer::Connection class which works
 within the EventMachine environment. To use it, create a client and then
@@ -21,7 +21,7 @@ make one or more requests to send email messages.
       # messages to STDERR.
       client = Remailer::SMTP::Client.open(
         'smtp.google.com',
-        :debug => STDERR
+        debug: STDERR
       )
       
       # Send a single email message through the client at the earliest
@@ -51,7 +51,7 @@ example is given here where the information is simply dumped on STDOUT:
 
     client = Remailer::SMTP::Client.open(
       'smtp.google.com',
-      :debug => lambda { |type, message|
+      debug: lambda { |type, message|
         puts "#{type}> #{message.inspect}"
       }
     )
@@ -90,18 +90,19 @@ server. Success is defined as 250, errors vary:
 
 A status code of nil is sent if the server timed out or the connection failed.
 
-== Tests
+## Tests
 
-In order to run tests, copy `test/config.example.rb` to `test/config.rb` and
+In order to run tests, copy `test/config.example.yml` to `test/config.yml` and
 adjust as required. For obvious reasons, passwords to SMTP test accounts are
-not included in the source code of this library.
+not included in the source code of this library. Any Gmail-type account should
+serve as a useful test target.
 
-== Status
+## Status
 
 This software is currently experimental and is not recommended for production
 use. Many of the internals may change significantly before a proper beta
 release is made.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2010-2012 Scott Tadman, The Working Group
+Copyright (c) 2010-2019 Scott Tadman, PostageApp Ltd.

data/Rakefile

@@ -1,29 +1,39 @@
 require 'rubygems'
 require 'rake'
 
+require 'bundler/setup'
+
+Bundler.require
+
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
+  require 'juwelier'
+
+  Juwelier::Tasks.new do |gem|
     gem.name = "remailer"
     gem.summary = %Q{Reactor-Ready SMTP Mailer}
-    gem.description = %Q{EventMachine SMTP Mail User Agent}
-    gem.email = "scott@twg.ca"
-    gem.homepage = "http://github.com/twg/remailer"
+    gem.description = %Q{EventMachine Mail Agent for SMTP and IMAP}
+    gem.email = "tadman@postageapp.com"
+    gem.homepage = "http://github.com/postageapp/remailer"
     gem.authors = [ "Scott Tadman" ]
-    gem.add_runtime_dependency 'eventmachine'
+
+    gem.files.exclude(
+      '.travis.yml',
+      'test/config.yml.enc'
+    )
   end
-  Jeweler::GemcutterTasks.new
+
+  Juwelier::GemcutterTasks.new
+
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  puts "Juwelier (or a dependency) not available. Install it with: gem install Juwelier"
 end
 
 require 'rake/testtask'
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
 
-task :test => :check_dependencies
-
-task :default => :test
+task default: :test

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.9.1

data/lib/remailer/abstract_connection.rb

@@ -83,7 +83,7 @@ class Remailer::AbstractConnection < EventMachine::Connection
     EventMachine.connect(host_name, host_port, self, options)
 
   rescue EventMachine::ConnectionError => e
-    report_exception(e, options)
+    self.report_exception(e, options)
 
     false
   end
@@ -133,6 +133,14 @@ class Remailer::AbstractConnection < EventMachine::Connection
     @options = options
     @hostname = @options[:hostname] || Socket.gethostname
     @timeout = @options[:timeout] || self.class.default_timeout
+    @timed_out = false
+
+    @active_message = nil
+    @established = false
+    @connected = false
+    @closed = false
+    @unbound = false
+    @connecting_to_proxy = false
 
     @messages = [ ]
   
@@ -151,9 +159,19 @@ class Remailer::AbstractConnection < EventMachine::Connection
     self.after_initialize
     
   rescue Object => e
-    STDERR.puts "#{e.class}: #{e}"
+    self.class.report_exception(e, @options)
+
+    STDERR.puts "#{e.class}: #{e}" rescue nil
   end
-  
+
+  def after_complete(&block)
+    if (block_given?)
+      @options[:after_complete] = block
+    elsif (@options[:after_complete])
+      @options[:after_complete].call
+    end
+  end
+
   # Returns true if the connection requires TLS support, or false otherwise.
   def use_tls?
     !!@options[:use_tls]
@@ -166,9 +184,15 @@ class Remailer::AbstractConnection < EventMachine::Connection
   end
 
   # Returns true if the connection has advertised authentication support, or
-  # false if not availble or could not be detected.
-  def auth_support?
-    !!@auth_support
+  # false if not availble or could not be detected. If type is specified,
+  # returns true only if that type is supported, false otherwise.
+  def auth_support?(type = nil)
+    case (type)
+    when nil
+      !!@auth_support
+    else
+      !!(@auth_support&.include?(type))
+    end
   end
   
   # Returns true if the connection will be using a proxy to connect, false
@@ -229,11 +253,11 @@ class Remailer::AbstractConnection < EventMachine::Connection
 
   # This implements the EventMachine::Connection#receive_data method that
   # is called each time new data is received from the socket.
-  def receive_data(data)
+  def receive_data(data = nil)
     reset_timeout!
 
     @buffer ||= ''
-    @buffer << data
+    @buffer << data if (data)
 
     if (interpreter = @interpreter)
       interpreter.process(@buffer) do |reply|
@@ -244,7 +268,10 @@ class Remailer::AbstractConnection < EventMachine::Connection
     end
     
   rescue Object => e
-    STDERR.puts("[#{e.class}] #{e}")
+    self.class.report_exception(e, @options)
+    STDERR.puts("[#{e.class}] #{e}") rescue nil
+
+    raise e
   end
 
   def post_init
@@ -368,12 +395,6 @@ class Remailer::AbstractConnection < EventMachine::Connection
   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
@@ -399,11 +420,6 @@ class Remailer::AbstractConnection < EventMachine::Connection
     
     reset_timeout!
   end
-
-  # Switches to use the SOCKS5 interpreter for all subsequent communication
-  def use_socks5_interpreter!
-    @interpreter = Remailer::SOCKS5::Client::Interpreter.new(:delegate => self)
-  end
   
   # -- Callbacks and Notifications ------------------------------------------
 

data/lib/remailer/imap/client.rb

@@ -192,7 +192,7 @@ class Remailer::IMAP::Client < Remailer::AbstractConnection
 protected
   # Switches to use the IMAP interpreter for all subsequent communication
   def use_imap_interpreter!
-    @interpreter = Interpreter.new(:delegate => self)
+    @interpreter = Interpreter.new(delegate: self)
   end
 
   def next_tag

data/lib/remailer/interpreter.rb

@@ -19,7 +19,7 @@ class Remailer::Interpreter
   
   # Defines the initial state for objects of this class.
   def self.initial_state
-    @initial_state || :initialized
+    @initial_state ||= :initialized
   end
   
   # Can be used to reassign the initial state for this class. May be easier
@@ -27,21 +27,37 @@ class Remailer::Interpreter
   def self.initial_state=(state)
     @initial_state = state
   end
+
+  def self.config
+    {
+      states: @states,
+      default_interpreter: @default,
+      default_parser: @parser,
+      on_error_handler: @on_error
+    }
+  end
   
+  def self.states_default
+    {
+        :initialized => { },
+        :terminated => { }
+      }
+  end
+
   # Returns the states that are defined as a has with their associated
   # options. The default keys are :initialized and :terminated.
   def self.states
     @states ||=
-      case (superclass.respond_to?(:states))
-      when true
+      if (superclass.respond_to?(:states))
         superclass.states.dup
       else
-        {
-          :initialized => { },
-          :terminated => { }
-        }
+        self.states_default
       end
   end
+
+  def self.states_empty?
+    self.states == self.states_default
+  end
   
   # Returns true if a given state is defined, false otherwise.
   def self.state_defined?(state)
@@ -66,15 +82,15 @@ class Remailer::Interpreter
   end
   
   # This is a method to convert a spec and a block into a proper parser
-  # method. If spec is specified, it should be a Fixnum, or a Regexp. A 
-  # Fixnum defines a minimum size to process, useful for packed binary
+  # method. If spec is specified, it should be a Integer, or a Regexp. A 
+  # Integer defines a minimum size to process, useful for packed binary
   # streams, while a Regexp defines a pattern that must match before the
   # parser is engaged.
   def self.create_parser_for_spec(spec, &block)
     case (spec)
     when nil
       block
-    when Fixnum
+    when Integer
       lambda do |s|
         if (s.length >= spec)
           part = s.slice!(0, spec)
@@ -114,8 +130,7 @@ class Remailer::Interpreter
   # Returns the parser used when no state-specific parser has been defined.
   def self.default_parser
     @parser ||=
-      case (superclass.respond_to?(:default_parser))
-      when true
+      if (superclass.respond_to?(:default_parser))
         superclass.default_parser
       else
         lambda { |s| _s = s.dup; s.replace(''); _s }
@@ -125,8 +140,7 @@ class Remailer::Interpreter
   # Returns the current default_interpreter.
   def self.default_interpreter
     @default ||=
-      case (superclass.respond_to?(:default_interpreter))
-      when true
+      if (superclass.respond_to?(:default_interpreter))
         superclass.default_interpreter
       else
         nil
@@ -136,8 +150,7 @@ class Remailer::Interpreter
   # Returns the defined error handler
   def self.on_error_handler
     @on_error ||=
-      case (superclass.respond_to?(:on_error_handler))
-      when true
+      if (superclass.respond_to?(:on_error_handler))
         superclass.on_error_handler
       else
         nil
@@ -155,6 +168,8 @@ class Remailer::Interpreter
   # before the first state is entered.
   def initialize(options = nil)
     @delegate = (options and options[:delegate])
+    @state = nil
+    @error = nil
     
     yield(self) if (block_given?)
     
@@ -212,8 +227,8 @@ class Remailer::Interpreter
       yield(parsed) if (block_given?)
 
       interpret(*parsed)
-      
-      break if (s.empty?)
+
+      break if (s.empty? or self.finished?)
     end
   end
   
@@ -245,7 +260,7 @@ class Remailer::Interpreter
           match_result = match_result.to_a
         
           if (match_result.length > 1)
-            match_string = match_result.shift
+            match_result.shift
             args[0, 1] = match_result
           else
             args[0].sub!(match_result[0], '')
@@ -290,6 +305,12 @@ class Remailer::Interpreter
   def will_interpret?(proc, args)
     true
   end
+
+  # Should return true if this interpreter no longer wants any data, false
+  # otherwise. Subclasses should implement their own behavior here.
+  def finished?
+    false
+  end
   
   # Returns true if an error has been generated, false otherwise. The error
   # content can be retrived by calling error.

data/lib/remailer/interpreter/state_proxy.rb

@@ -14,7 +14,7 @@ class Remailer::Interpreter::StateProxy
   
   # Defines a parser specification.
   def parse(spec = nil, &block)
-    @options[:parser] = Remailer::Interpreter.parse(spec, &block)
+    @options[:parser] = Remailer::Interpreter.create_parser_for_spec(spec, &block)
   end
   
   # Defines a block that will execute when the state is entered.

data/lib/remailer/smtp/client.rb

@@ -60,6 +60,8 @@ class Remailer::SMTP::Client < Remailer::AbstractConnection
   # Called by AbstractConnection at the end of the initialize procedure
   def after_initialize
     @protocol = :smtp
+    @error = nil
+    @tls_support = nil
 
     if (using_proxy?)
       proxy_connection_initiated!
@@ -69,6 +71,11 @@ class Remailer::SMTP::Client < Remailer::AbstractConnection
     end
   end
 
+  # Switches to use the SOCKS5 interpreter for all subsequent communication
+  def use_socks5_interpreter!
+    @interpreter = Remailer::SOCKS5::Client::Interpreter.new(delegate: self)
+  end
+
   # Closes the connection after all of the queued messages have been sent.
   def close_when_complete!
     @options[:close] = true
@@ -83,10 +90,10 @@ class Remailer::SMTP::Client < Remailer::AbstractConnection
     end
     
     message = {
-      :from => from,
-      :to => to,
-      :data => data,
-      :callback => block
+      from: from,
+      to: to,
+      data: data,
+      callback: block
     }
     
     @messages << message
@@ -108,10 +115,10 @@ class Remailer::SMTP::Client < Remailer::AbstractConnection
     end
     
     message = {
-      :from => from,
-      :to => to,
-      :test => true,
-      :callback => block
+      from: from,
+      to: to,
+      test: true,
+      callback: block
     }
     
     @messages << message
@@ -146,23 +153,6 @@ class Remailer::SMTP::Client < Remailer::AbstractConnection
   def unbound?
     !!@unbound
   end
-
-  # This implements the EventMachine::Connection#receive_data method that
-  # is called each time new data is received from the socket.
-  def receive_data(data)
-    reset_timeout!
-
-    @buffer ||= ''
-    @buffer << data
-
-    if (interpreter = @interpreter)
-      interpreter.process(@buffer) do |reply|
-        debug_notification(:receive, "[#{interpreter.label}] #{reply.inspect}")
-      end
-    else
-      error_notification(:out_of_band, "Receiving data before a protocol has been established.")
-    end
-  end
   
   # Returns the current state of the active interpreter, or nil if no state
   # is assigned.
@@ -227,7 +217,11 @@ class Remailer::SMTP::Client < Remailer::AbstractConnection
   
   # Switches to use the SMTP interpreter for all subsequent communication
   def use_smtp_interpreter!
-    @interpreter = Interpreter.new(:delegate => self)
+    @interpreter = Interpreter.new(delegate: self)
+
+    # Trigger processing using the new interpreter as some SMTP data might
+    # already be buffered by this point.
+    receive_data
   end
 
   # Callback receiver for when the proxy connection has been completed.