imap-backup 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8155050ded00ceecc4a76cf608612f7ba1ef32a51c3985441ad00a247e170140
-  data.tar.gz: f91b55a88b6dc3eeddccd3bfa515e7056896dd166f2760d4c337256fbbd50d64
+  metadata.gz: 4665c4dcce3e9de07be72563f7f52045789d1da30120462e290ae5c3207598db
+  data.tar.gz: 3f455617d7b7a0d392856b74adb0aa75e528037e8716469a72e3a8b9aa405841
 SHA512:
-  metadata.gz: 24d3ee8534b607abbb10e1345205ca8142e3701190ef8d8ef79128f0bfe6d620c2f275dc58b4e3dc39a0ebae3c1ea48c634ddff48d2d8dbed3ef85f2ad736abc
-  data.tar.gz: 8ff7e5f6c757e4866b93ba2621941d38bbaa809cb4be7a08c7307dfdcc4d47b6a59bacd30dfd62c6f294a3fd6b9237cdc91c752a8c1cba3e077a62cbaee013e6
+  metadata.gz: 57ef0a8b879f915630ba3d3ecbf339973ecf11a0eb0ae30b1e520bd346a9daaaab501fc90c509e0f1ad5d4b0fbee6cf6a4424da3b10caeb72bc52b96663bc9cf
+  data.tar.gz: f834d433145dcdc60ece0b3e03e973d36c0bb884060e13378922a886310e9362f92db901a4a9882e7a31a300594253377c7450085a5af66097646c6480cd2ed7

data/.gitignore

@@ -5,3 +5,4 @@ coverage
 pkg
 .rbenv-version
 vendor
+/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--tag ~docker

data/.rubocop.yml

@@ -1,6 +1,7 @@
-inherit_from: https://gist.githubusercontent.com/joeyates/4763b79425cf903fc70df3bc8fccda36/raw/356fa04037feedb212735d4e7002cbd8778a33e8/.rubocop.yaml
+inherit_from: https://gitlab.com/snippets/1744945/raw
 
 AllCops:
+  TargetRubyVersion: 2.1
   Exclude:
     - "bin/stubs/*"
   DisplayCopNames:

data/.travis.yml

@@ -11,4 +11,4 @@ branches:
 before_install:
   - gem update --system
   - gem update bundler
-script: "bundle exec rake spec"
+script: "bundle exec rspec --tag ~docker"

data/README.md

@@ -186,6 +186,18 @@ $ imap-backup status
 * https://github.com/rgrove/larch - copies between IMAP servers
 * https://github.com/OfflineIMAP/offlineimap
 
+# Testing
+
+## Integration Tests
+
+Integration tests are run against a Docker image
+(antespi/docker-imap-devel:latest).
+
+Currently, the integration tests with Docker are excluded from the CI run.
+
+The image has a pre-existing user:
+`address@example.org` with password `pass`
+
 ## Contributing
 
 1. Fork it

data/bin/imap-backup

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require "optparse"
 
-$LOAD_PATH.unshift(File.expand_path("../../lib/", __FILE__))
+$LOAD_PATH.unshift(File.expand_path("../lib/", __dir__))
 require "imap/backup"
 
 KNOWN_COMMANDS = [
@@ -10,21 +10,26 @@ KNOWN_COMMANDS = [
   {name: "folders", help: "List folders for all (or selected) accounts"},
   {name: "status",  help: "List count of non backed-up emails per folder"},
   {name: "help",    help: "Show usage"}
-]
+].freeze
 
 options = {command: "backup"}
-opts = OptionParser.new do |opts|
+parser = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options] COMMAND"
 
   opts.separator ""
   opts.separator "Commands:"
   KNOWN_COMMANDS.each do |command|
-    opts.separator "\t%- 20s %s" % [command[:name], command[:help]]
+    opts.separator format("\t%- 20<name>s %<help>s", command)
   end
   opts.separator ""
   opts.separator "Common options:"
 
-  opts.on("-a", "--accounts ACCOUNT1[,ACCOUNT2,...]", Array, "only these accounts") do |account|
+  opts.on(
+    "-a",
+    "--accounts ACCOUNT1[,ACCOUNT2,...]",
+    Array,
+    "only these accounts"
+  ) do |account|
     options[:accounts] = account
   end
 
@@ -38,7 +43,7 @@ opts = OptionParser.new do |opts|
     exit
   end
 end
-opts.parse!
+parser.parse!
 
 if ARGV.size > 0
   options[:command] = ARGV.shift

data/docker-compose.yml

@@ -0,0 +1,15 @@
+# This file adapted from github.com/antespi/docker-imap-devel
+version: "3"
+
+services:
+  imap:
+    image: antespi/docker-imap-devel:latest
+    container_name: imap
+    ports:
+    - "8025:25"
+    - "8143:143"
+    - "8993:993"
+    environment:
+    - MAILNAME=example.org
+    - MAIL_ADDRESS=address@example.org
+    - MAIL_PASS=pass

data/imap-backup.gemspec

@@ -3,8 +3,8 @@ require "imap/backup/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "imap-backup"
-  gem.description   = %q{Backup GMail, or any other IMAP email service, to disk.}
-  gem.summary       = %q{Backup GMail (or other IMAP) accounts to disk}
+  gem.description   = "Backup GMail, or any other IMAP email service, to disk."
+  gem.summary       = "Backup GMail (or other IMAP) accounts to disk"
   gem.authors       = ["Joe Yates"]
   gem.email         = ["joe.g.yates@gmail.com"]
   gem.homepage      = "https://github.com/joeyates/imap-backup"
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "mail"
 
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
+  gem.add_development_dependency "pry-byebug"
   gem.add_development_dependency "rspec", ">= 3.0.0"
   gem.add_development_dependency "rubocop-rspec"
   gem.add_development_dependency "simplecov"

data/lib/email/mboxrd/message.rb

@@ -6,12 +6,22 @@ module Email::Mboxrd
   class Message
     attr_reader :supplied_body
 
+    def self.from_serialized(serialized)
+      cleaned = serialized.gsub(/^>(>*From)/, "\\1")
+      # Serialized messages in this format *should* start with a line
+      #   From xxx yy zz
+      if cleaned.start_with?("From ")
+        cleaned = cleaned.sub(/^From .*[\r\n]*/, "")
+      end
+      new(cleaned)
+    end
+
     def initialize(supplied_body)
       @supplied_body = supplied_body.clone
       @supplied_body.force_encoding("binary")
     end
 
-    def to_s
+    def to_serialized
       "From " + from + "\n" + mboxrd_body + "\n"
     end
 
@@ -36,24 +46,40 @@ module Email::Mboxrd
     end
 
     def from
-      best_from + " " + asctime
+      @from ||=
+        begin
+          from = best_from
+          from << " " + asctime if asctime != ""
+          from
+        end
     end
 
     def mboxrd_body
       @mboxrd_body ||=
         begin
-          @mboxrd_body = supplied_body.gsub(/\n(>*From)/, "\n>\\1")
+          @mboxrd_body = add_extra_quote(supplied_body)
           @mboxrd_body += "\n" if !@mboxrd_body.end_with?("\n")
           @mboxrd_body
         end
     end
 
+    def add_extra_quote(body)
+      # The mboxrd format requires that lines starting with 'From'
+      # be prefixed with a '>' so that any remaining lines which start with
+      # 'From ' can be taken as the beginning of messages.
+      # http://www.digitalpreservation.gov/formats/fdd/fdd000385.shtml
+      # Here we add an extra '>' before any "From" or ">From".
+      body.gsub(/\n(>*From)/, "\n>\\1")
+    end
+
     def asctime
-      date ? date.asctime : ""
+      @asctime ||= date ? date.asctime : ""
     end
 
     def date
       parsed.date
+    rescue
+      nil
     end
   end
 end

data/lib/email/provider.rb

@@ -2,7 +2,7 @@ module Email; end
 
 class Email::Provider
   def self.for_address(address)
-    case 
+    case
     when address.end_with?("@gmail.com")
       new(:gmail)
     when address.end_with?("@fastmail.fm")
@@ -21,7 +21,7 @@ class Email::Provider
   def options
     case provider
     when :gmail
-      {port: 993, ssl: true}
+      {port: 993, ssl: {ssl_version: :TLSv1_2}}
     when :fastmail
       {port: 993, ssl: true}
     else

data/lib/imap/backup.rb

@@ -12,7 +12,6 @@ require "imap/backup/configuration/setup"
 require "imap/backup/configuration/store"
 require "imap/backup/downloader"
 require "imap/backup/serializer/base"
-require "imap/backup/serializer/directory"
 require "imap/backup/serializer/mbox"
 require "imap/backup/version"
 require "email/provider"

data/lib/imap/backup/account/connection.rb

@@ -4,9 +4,10 @@ module Imap::Backup
   module Account; end
 
   class Account::Connection
-    attr_reader :username
-    attr_reader :local_path
     attr_reader :connection_options
+    attr_reader :local_path
+    attr_reader :password
+    attr_reader :username
 
     def initialize(options)
       @username, @password = options[:username], options[:password]
@@ -19,18 +20,23 @@ module Imap::Backup
     end
 
     def folders
-      return @folders if @folders
-      @folders = imap.list("", "*")
-      if @folders.nil?
-        Imap::Backup.logger.warn "Unable to get folder list for account #{username}"
-      end
-      @folders
+      @folders ||=
+        begin
+          root = provider_root
+          @folders = imap.list(root, "*")
+          if @folders.nil?
+            Imap::Backup.logger.warn(
+              "Unable to get folder list for account #{username}"
+            )
+          end
+          @folders
+        end
     end
 
     def status
       backup_folders.map do |folder|
         f = Account::Folder.new(self, folder[:name])
-        s = Serializer::Directory.new(local_path, folder[:name])
+        s = Serializer::Mbox.new(local_path, folder[:name])
         {name: folder[:name], local: s.uids, remote: f.uids}
       end
     end
@@ -52,7 +58,9 @@ module Imap::Backup
     def imap
       return @imap unless @imap.nil?
       options = provider_options
-      Imap::Backup.logger.debug "Creating IMAP instance: #{server}, options: #{options.inspect}"
+      Imap::Backup.logger.debug(
+        "Creating IMAP instance: #{server}, options: #{options.inspect}"
+      )
       @imap = Net::IMAP.new(server, options)
       Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
       @imap.login(username, password)
@@ -78,14 +86,10 @@ module Imap::Backup
       )
     end
 
-    def password
-      @password
-    end
-
     def masked_password
       password.gsub(/./, "x")
     end
-    
+
     def backup_folders
       return @backup_folders if @backup_folders && (@backup_folders.size > 0)
       (folders || []).map { |f| {name: f.name} }
@@ -104,5 +108,15 @@ module Imap::Backup
     def provider_options
       provider.options.merge(connection_options)
     end
+
+    # 6.3.8. LIST Command
+    # An empty ("" string) mailbox name argument is a special request to
+    # return the hierarchy delimiter and the root name of the name given
+    # in the reference.
+    def provider_root
+      return @provider_root if @provider_root
+      root_info = imap.list("", "")[0]
+      @provider_root = root_info.name
+    end
   end
 end

data/lib/imap/backup/account/folder.rb

@@ -6,7 +6,7 @@ module Imap::Backup
   class Account::Folder
     extend Forwardable
 
-    REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"]
+    REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"].freeze
 
     attr_reader :connection
     attr_reader :name
@@ -25,7 +25,7 @@ module Imap::Backup
     def uids
       imap.examine(name)
       imap.uid_search(["ALL"]).sort
-    rescue Net::IMAP::NoResponseError => e
+    rescue Net::IMAP::NoResponseError
       Imap::Backup.logger.warn "Folder '#{name}' does not exist"
       []
     end
@@ -38,7 +38,7 @@ module Imap::Backup
       attributes = fetch_data_item.attr
       attributes["RFC822"].force_encoding("utf-8")
       attributes
-    rescue Net::IMAP::NoResponseError => e
+    rescue Net::IMAP::NoResponseError
       Imap::Backup.logger.warn "Folder '#{name}' does not exist"
       nil
     end

data/lib/imap/backup/configuration/account.rb

@@ -33,21 +33,22 @@ module Imap::Backup
     end
 
     def header(menu)
-      menu.header = <<-EOT
-Account:
-  email:    #{account[:username]}
-  server:   #{account[:server]}
-  path:     #{account[:local_path]}
-  folders:  #{folders.map { |f| f[:name] }.join(', ')}
-  password: #{masked_password}
-      EOT
+      menu.header = <<-HEADER.gsub(/^\s{8}/m, "")
+        Account:
+          email:    #{account[:username]}
+          server:   #{account[:server]}
+          path:     #{account[:local_path]}
+          folders:  #{folders.map { |f| f[:name] }.join(', ')}
+          password: #{masked_password}
+      HEADER
     end
 
     def modify_email(menu)
       menu.choice("modify email") do
         username = Configuration::Asker.email(username)
         puts "username: #{username}"
-        others = store.accounts.select { |a| a != account }.map { |a| a[:username] }
+        other_accounts = store.accounts.reject { |a| a == account }
+        others = other_accounts.map { |a| a[:username] }
         puts "others: #{others.inspect}"
         if others.include?(username)
           puts "There is already an account set up with that email address"
@@ -83,19 +84,21 @@ Account:
 
     def modify_backup_path(menu)
       menu.choice("modify backup path") do
-        validator = lambda do |p|
+        validator = ->(p) do
           same = store.accounts.find do |a|
             a[:username] != account[:username] && a[:local_path] == p
           end
           if same
-            puts "The path '#{p}' is used to backup the account '#{same[:username]}'"
+            puts "The path '#{p}' is used to backup " \
+              "the account '#{same[:username]}'"
             false
           else
             true
           end
         end
         existing = account[:local_path].clone
-        account[:local_path] = Configuration::Asker.backup_path(account[:local_path], validator)
+        account[:local_path] =
+          Configuration::Asker.backup_path(account[:local_path], validator)
         account[:modified] = true if existing != account[:local_path]
       end
     end

data/lib/imap/backup/configuration/asker.rb

@@ -21,7 +21,9 @@ module Imap::Backup
       password     = highline.ask("password: ")        { |q| q.echo = false }
       confirmation = highline.ask("repeat password: ") { |q| q.echo = false }
       if password != confirmation
-        return nil unless highline.agree("the password and confirmation did not match.\nContinue? (y/n) ")
+        return nil if !highline.agree(
+          "the password and confirmation did not match.\nContinue? (y/n) "
+        )
         return self.password
       end
       password

data/lib/imap/backup/configuration/folder_chooser.rb

@@ -52,7 +52,9 @@ module Imap::Backup
     end
 
     def is_selected?(folder_name)
-      account[:folders].find { |f| f[:name] == folder_name }
+      backup_folders = account[:folders]
+      return false if backup_folders.nil?
+      backup_folders.find { |f| f[:name] == folder_name }
     end
 
     def toggle_selection(folder_name)
@@ -60,6 +62,7 @@ module Imap::Backup
         changed = account[:folders].reject! { |f| f[:name] == folder_name }
         account[:modified] = true if changed
       else
+        account[:folders] ||= []
         account[:folders] << {name: folder_name}
         account[:modified] = true
       end
@@ -67,7 +70,7 @@ module Imap::Backup
 
     def connection
       @connection ||= Account::Connection.new(account)
-    rescue => e
+    rescue
       nil
     end