rgrove-larch 0.0.1.4 → 1.0.0

data/bin/larch

@@ -26,14 +26,15 @@ EOS
 
     # opt :dry_run,          "Don't actually do anything.", :short => '-n'
     opt :fast_scan,        "Use a faster (but less accurate) method to scan mailboxes. This may result in messages being re-copied.", :short => :none
-    opt :from_folder,      "Source folder to copy from.", :short => :none, :default => 'INBOX'
-    opt :from_pass,        "Source server password (Default: prompt).", :short => :none, :type => :string
-    opt :from_user,        "Source server username (Default: prompt).", :short => :none, :type => :string
-    opt :no_create_folder, "Don't create destination folders that don't already exist.", :short => :none
-    opt :to_folder,        "Destination folder to copy to.", :short => :none, :default => 'INBOX'
-    opt :to_pass,          "Destination server password (Default: prompt).", :short => :none, :type => :string
-    opt :to_user,          "Destination server username (Default: prompt).", :short => :none, :type => :string
-    opt :verbosity,        "Output verbosity: debug, info, warn, error, or fatal.", :short => '-V', :default => 'info'
+    opt :from_folder,      "Source folder to copy from", :short => :none, :default => 'INBOX'
+    opt :from_pass,        "Source server password (Default: prompt)", :short => :none, :type => :string
+    opt :from_user,        "Source server username (Default: prompt)", :short => :none, :type => :string
+    opt :max_retries,      "Maximum number of times to retry after a recoverable error", :short => :none, :default => 3
+    opt :no_create_folder, "Don't create destination folders that don't already exist", :short => :none
+    opt :to_folder,        "Destination folder to copy to", :short => :none, :default => 'INBOX'
+    opt :to_pass,          "Destination server password (Default: prompt)", :short => :none, :type => :string
+    opt :to_user,          "Destination server username (Default: prompt)", :short => :none, :type => :string
+    opt :verbosity,        "Output verbosity: debug, info, warn, error, or fatal", :short => '-V', :default => 'info'
   end
 
   # Validate command-line options.
@@ -74,11 +75,13 @@ EOS
   init(options[:verbosity])
 
   source = IMAP.new(options[:from], options[:from_user], options[:from_pass],
-      :fast_scan => options[:fast_scan])
+      :fast_scan   => options[:fast_scan],
+      :max_retries => options[:max_retries])
 
   dest = IMAP.new(options[:to], options[:to_user], options[:to_pass],
       :create_mailbox => !options[:no_create_folder],
-      :fast_scan => options[:fast_scan])
+      :fast_scan      => options[:fast_scan],
+      :max_retries    => options[:max_retries])
 
   for sig in [:SIGINT, :SIGQUIT, :SIGTERM]
     trap(sig) { @log.fatal "Interrupted (#{sig})"; summary; exit }

data/lib/larch.rb

@@ -34,7 +34,7 @@ module Larch
       raise ArgumentError, "source must be a Larch::IMAP instance" unless source.is_a?(IMAP)
       raise ArgumentError, "dest must be a Larch::IMAP instance" unless dest.is_a?(IMAP)
 
-      msgq  = SizedQueue.new(32)
+      msgq  = SizedQueue.new(8)
       mutex = Mutex.new
 
       @copied    = 0
@@ -64,7 +64,9 @@ module Larch
             begin
               msgq << source.peek(id)
             rescue Larch::IMAP::Error => e
+              # TODO: Keep failed message envelopes in a buffer for later output?
               mutex.synchronize { @failed += 1 }
+              @log.error e.message
               next
             end
           end

data/lib/larch/imap.rb

@@ -4,7 +4,7 @@ module Larch
 #
 # This class borrows heavily from Sup, the source code of which should be
 # required reading if you're doing anything with IMAP in Ruby:
-# http://sup.rubyforge.org/
+# http://sup.rubyforge.org
 class IMAP
 
   # Recoverable connection errors.
@@ -36,17 +36,20 @@ class IMAP
   #
   # The following options may also be specified:
   #
-  # [+create_mailbox+]
+  # [:create_mailbox]
   #   If +true+, the specified mailbox will be created if necessary.
   #
-  # [+fast_scan+]
+  # [:fast_scan]
   #   If +true+, a faster but less accurate method will be used to scan
   #   mailboxes. This will speed up the initial mailbox scan, but will also
-  #   reduce the effectiveness of the message unique id generator.
+  #   reduce the effectiveness of the message unique id generator. This is
+  #   probably acceptable when copying a very large mailbox to an empty mailbox,
+  #   but if the destination already contains messages, using this option is not
+  #   advised.
   #
-  #   This is probably acceptable when copying a very large mailbox to an empty
-  #   mailbox, but if the destination already contains messages, using this
-  #   option is not advised.
+  # [:max_retries]
+  #   After a recoverable error occurs, retry the operation up to this many
+  #   times. Default is 3.
   #
   def initialize(uri, username, password, options = {})
     raise ArgumentError, "not an IMAP URI: #{uri}" unless uri.is_a?(URI) || uri =~ REGEX_URI
@@ -56,7 +59,7 @@ class IMAP
     @uri      = uri.is_a?(URI) ? uri : URI(uri)
     @username = username
     @password = password
-    @options  = options
+    @options  = {:max_retries => 3}.merge(options)
 
     @ids         = {}
     @imap        = nil
@@ -148,7 +151,7 @@ class IMAP
     imap_uid_fetch([uid], 'ENVELOPE').first.attr['ENVELOPE']
   end
 
-  # Fetches a Larch::Message instance representing the message with the
+  # Fetches a Larch::IMAP::Message struct representing the message with the
   # specified Larch message id.
   def fetch(message_id, peek = false)
     scan_mailbox
@@ -171,6 +174,7 @@ class IMAP
     @ids.has_key?(message_id)
   end
 
+  # Gets the IMAP hostname.
   def host
     @uri.host
   end
@@ -182,20 +186,22 @@ class IMAP
   end
   alias size length
 
+  # Gets the IMAP mailbox.
+  def mailbox
+    mb = @uri.path[1..-1]
+    mb.nil? || mb.empty? ? 'INBOX' : CGI.unescape(mb)
+  end
+
   # Same as fetch, but doesn't mark the message as seen.
   def peek(message_id)
     fetch(message_id, true)
   end
 
+  # Gets the IMAP port number.
   def port
     @uri.port || (ssl? ? 993 : 143)
   end
 
-  def mailbox
-    mb = @uri.path[1..-1]
-    mb.nil? || mb.empty? ? 'INBOX' : CGI.unescape(mb)
-  end
-
   # Fetches message headers from the current mailbox.
   def scan_mailbox
     return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
@@ -244,10 +250,12 @@ class IMAP
   end
   synchronized :scan_mailbox
 
+  # Gets the SSL status.
   def ssl?
     @uri.scheme == 'imaps'
   end
 
+  # Gets the IMAP URI.
   def uri
     @uri.to_s
   end
@@ -333,10 +341,10 @@ class IMAP
       unsafe_connect unless @imap
     rescue *RECOVERABLE_ERRORS => e
       info "#{e.class.name}: #{e.message} (will retry)"
-      raise unless (retries += 1) <= 3
+      raise unless (retries += 1) <= @options[:max_retries]
 
       @imap = nil
-      sleep 2 * retries
+      sleep 1 * retries
       retry
     end
 
@@ -346,9 +354,9 @@ class IMAP
       yield
     rescue *RECOVERABLE_ERRORS => e
       info "#{e.class.name}: #{e.message} (will retry)"
-      raise unless (retries += 1) <= 3
+      raise unless (retries += 1) <= @options[:max_retries]
 
-      sleep 2 * retries
+      sleep 1 * retries
       retry
     end
 

data/lib/larch/util.rb

@@ -1,7 +1,8 @@
 class Module
 
   # Java-style whole-method synchronization, shamelessly stolen from Sup:
-  # http://sup.rubyforge.org/. Assumes the existence of a @mutex variable.
+  # http://sup.rubyforge.org. Assumes the existence of a <tt>@mutex</tt>
+  # variable.
   def synchronized(*methods)
     methods.each do |method|
       class_eval <<-EOF

data/lib/larch/version.rb

@@ -1,6 +1,6 @@
 module Larch
   APP_NAME      = 'Larch'
-  APP_VERSION   = '0.0.1'
+  APP_VERSION   = '1.0.0'
   APP_AUTHOR    = 'Ryan Grove'
   APP_EMAIL     = 'ryan@wonko.com'
   APP_URL       = 'http://github.com/rgrove/larch/'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rgrove-larch
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.4
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ryan Grove
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.12"
+        version: "1.13"
     version: 
 description: 
 email: ryan@wonko.com