imap-backup 4.0.5 → 4.1.2

data/lib/imap/backup/logger.rb

@@ -0,0 +1,42 @@
+require "logger"
+require "singleton"
+
+require "imap/backup/configuration"
+require "imap/backup/sanitizer"
+
+module Imap::Backup
+  class Logger
+    include Singleton
+
+    def self.logger
+      Logger.instance.logger
+    end
+
+    def self.setup_logging(config = Configuration.new)
+      logger.level =
+        if config.debug?
+          ::Logger::Severity::DEBUG
+        else
+          ::Logger::Severity::ERROR
+        end
+      Net::IMAP.debug = config.debug?
+    end
+
+    def self.sanitize_stderr
+      sanitizer = Sanitizer.new($stdout)
+      previous_stderr = $stderr
+      $stderr = sanitizer
+      yield
+    ensure
+      sanitizer.flush
+      $stderr = previous_stderr
+    end
+
+    attr_reader :logger
+
+    def initialize
+      @logger = ::Logger.new($stdout)
+      $stdout.sync = true
+    end
+  end
+end

data/lib/imap/backup/sanitizer.rb

@@ -0,0 +1,42 @@
+module Imap::Backup
+  class Sanitizer
+    attr_reader :output
+
+    def initialize(output)
+      @output = output
+      @current = ""
+    end
+
+    def write(*args)
+      output.write(*args)
+    end
+
+    def print(*args)
+      @current << args.join
+      loop do
+        line, newline, rest = @current.partition("\n")
+        break if newline != "\n"
+        clean = sanitize(line)
+        output.puts clean
+        @current = rest
+      end
+    end
+
+    def flush
+      return if @current == ""
+
+      clean = sanitize(@current)
+      output.puts clean
+    end
+
+    private
+
+    def sanitize(t)
+      # Hide password in Net::IMAP debug output
+      t.gsub(
+        /\A(C: RUBY\d+ LOGIN \S+) \S+/,
+        "\\1 [PASSWORD REDACTED]"
+      )
+    end
+  end
+end

data/lib/imap/backup/serializer/mbox_store.rb

@@ -46,7 +46,7 @@ module Imap::Backup
 
       uid = uid.to_i
       if uids.include?(uid)
-        Imap::Backup.logger.debug(
+        Imap::Backup::Logger.logger.debug(
           "[#{folder}] message #{uid} already downloaded - skipping"
         )
         return
@@ -65,7 +65,7 @@ module Imap::Backup
           #{body}. #{e}:
           #{e.backtrace.join("\n")}"
         ERROR
-        Imap::Backup.logger.warn message
+        Imap::Backup::Logger.logger.warn message
       ensure
         mbox&.close
       end

data/lib/imap/backup/{configuration → setup}/account.rb

@@ -1,8 +1,10 @@
+require "imap/backup/setup/helpers"
+
 module Imap::Backup
-  module Configuration; end
+  class Setup; end
 
-  Configuration::Account = Struct.new(:store, :account, :highline) do
-    def initialize(store, account, highline)
+  Setup::Account = Struct.new(:config, :account, :highline) do
+    def initialize(config, account, highline)
       super
     end
 
@@ -22,78 +24,91 @@ module Imap::Backup
         header menu
         modify_email menu
         modify_password menu
-        modify_server menu
         modify_backup_path menu
         choose_folders menu
+        modify_server menu
+        modify_connection_options menu
         test_connection menu
         delete_account menu
-        menu.choice("return to main menu") { throw :done }
+        menu.choice("(q) return to main menu") { throw :done }
         menu.hidden("quit") { throw :done }
       end
     end
 
     def header(menu)
-      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}
+      modified = account.modified? ? "*" : ""
+      connection_options =
+        if account.connection_options
+          escaped =
+            JSON.generate(account.connection_options).
+            gsub('"', '\"')
+          "\n  connection options #{escaped}"
+        end
+      menu.header = <<~HEADER.chomp
+        #{helpers.title_prefix} Account#{modified}
+
+        email      #{account.username}
+        password   #{masked_password}
+        path       #{account.local_path}
+        folders    #{folders.map { |f| f[:name] }.join(', ')}
+        server     #{account.server}#{connection_options}
+
+        Choose an action
       HEADER
     end
 
     def modify_email(menu)
       menu.choice("modify email") do
-        username = Configuration::Asker.email(username)
+        username = Setup::Asker.email(username)
         Kernel.puts "username: #{username}"
-        other_accounts = store.accounts.reject { |a| a == account }
-        others = other_accounts.map { |a| a[:username] }
+        other_accounts = config.accounts.reject { |a| a == account }
+        others = other_accounts.map { |a| a.username }
         Kernel.puts "others: #{others.inspect}"
         if others.include?(username)
           Kernel.puts(
             "There is already an account set up with that email address"
           )
         else
-          account[:username] = username
+          account.username = username
           # rubocop:disable Style/IfUnlessModifier
-          if account[:server].nil? || (account[:server] == "")
-            account[:server] = default_server(username)
+          default = default_server(username)
+          if default && (account.server.nil? || (account.server == ""))
+            account.server = default
           end
           # rubocop:enable Style/IfUnlessModifier
-          account[:modified] = true
         end
       end
     end
 
     def modify_password(menu)
       menu.choice("modify password") do
-        password = Configuration::Asker.password
+        password = Setup::Asker.password
 
-        if !password.nil?
-          account[:password] = password
-          account[:modified] = true
-        end
+        account.password = password if !password.nil?
       end
     end
 
     def modify_server(menu)
       menu.choice("modify server") do
         server = highline.ask("server: ")
-        if !server.nil?
-          account[:server] = server
-          account[:modified] = true
-        end
+        account.server = server if !server.nil?
+      end
+    end
+
+    def modify_connection_options(menu)
+      menu.choice("modify connection options") do
+        connection_options = highline.ask("connections options (as JSON): ")
+        account.connection_options = connection_options if !connection_options.nil?
       end
     end
 
     def path_modification_validator(path)
-      same = store.accounts.find do |a|
-        a[:username] != account[:username] && a[:local_path] == path
+      same = config.accounts.find do |a|
+        a.username != account.username && a.local_path == path
       end
       if same
         Kernel.puts "The path '#{path}' is used to backup " \
-          "the account '#{same[:username]}'"
+          "the account '#{same.username}'"
         false
       else
         true
@@ -102,23 +117,22 @@ module Imap::Backup
 
     def modify_backup_path(menu)
       menu.choice("modify backup path") do
-        existing = account[:local_path].clone
-        account[:local_path] = Configuration::Asker.backup_path(
-          account[:local_path], ->(path) { path_modification_validator(path) }
+        existing = account.local_path.clone
+        account.local_path = Setup::Asker.backup_path(
+          account.local_path, ->(path) { path_modification_validator(path) }
         )
-        account[:modified] = true if existing != account[:local_path]
       end
     end
 
     def choose_folders(menu)
       menu.choice("choose backup folders") do
-        Configuration::FolderChooser.new(account).run
+        Setup::FolderChooser.new(account).run
       end
     end
 
     def test_connection(menu)
       menu.choice("test connection") do
-        result = Configuration::ConnectionTester.test(account)
+        result = Setup::ConnectionTester.new(account).test
         Kernel.puts result
         highline.ask "Press a key "
       end
@@ -127,21 +141,21 @@ module Imap::Backup
     def delete_account(menu)
       menu.choice("delete") do
         if highline.agree("Are you sure? (y/n) ")
-          account[:delete] = true
+          account.mark_for_deletion!
           throw :done
         end
       end
     end
 
     def folders
-      account[:folders] || []
+      account.folders || []
     end
 
     def masked_password
-      if (account[:password] == "") || account[:password].nil?
+      if (account.password == "") || account.password.nil?
         "(unset)"
       else
-        account[:password].gsub(/./, "x")
+        account.password.gsub(/./, "x")
       end
     end
 
@@ -155,5 +169,9 @@ module Imap::Backup
 
       provider.host
     end
+
+    def helpers
+      Setup::Helpers.new
+    end
   end
 end

data/lib/imap/backup/{configuration → setup}/asker.rb

@@ -1,7 +1,7 @@
 module Imap::Backup
-  module Configuration; end
+  class Setup; end
 
-  Configuration::Asker = Struct.new(:highline) do
+  Setup::Asker = Struct.new(:highline) do
     EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
 
     def initialize(highline)
@@ -40,15 +40,15 @@ module Imap::Backup
     end
 
     def self.email(default = "")
-      new(Configuration::Setup.highline).email(default)
+      new(Setup.highline).email(default)
     end
 
     def self.password
-      new(Configuration::Setup.highline).password
+      new(Setup.highline).password
     end
 
     def self.backup_path(default, validator)
-      new(Configuration::Setup.highline).backup_path(default, validator)
+      new(Setup.highline).backup_path(default, validator)
     end
   end
 end

data/lib/imap/backup/setup/connection_tester.rb

@@ -0,0 +1,26 @@
+module Imap::Backup
+  class Setup; end
+
+  class Setup::ConnectionTester
+    attr_reader :account
+
+    def initialize(account)
+      @account = account
+    end
+
+    def test
+      connection.client
+      "Connection successful"
+    rescue Net::IMAP::NoResponseError
+      "No response"
+    rescue StandardError => e
+      "Unexpected error: #{e}"
+    end
+
+    private
+
+    def connection
+      Account::Connection.new(account)
+    end
+  end
+end

data/lib/imap/backup/{configuration → setup}/folder_chooser.rb

@@ -1,7 +1,9 @@
+require "imap/backup/setup/helpers"
+
 module Imap::Backup
-  module Configuration; end
+  class Setup; end
 
-  class Configuration::FolderChooser
+  class Setup::FolderChooser
     attr_reader :account
 
     def initialize(account)
@@ -10,13 +12,13 @@ module Imap::Backup
 
     def run
       if connection.nil?
-        Imap::Backup.logger.warn "Connection failed"
+        Imap::Backup::Logger.logger.warn "Connection failed"
         highline.ask "Press a key "
         return
       end
 
       if imap_folders.nil?
-        Imap::Backup.logger.warn "Unable to get folder list"
+        Imap::Backup::Logger.logger.warn "Unable to get folder list"
         highline.ask "Press a key "
         return
       end
@@ -35,10 +37,14 @@ module Imap::Backup
 
     def show_menu
       highline.choose do |menu|
-        menu.header = "Add/remove folders"
+        menu.header = <<~MENU.chomp
+          #{helpers.title_prefix} Add/remove folders
+
+          Select a folder (toggles)
+        MENU
         menu.index = :number
         add_folders menu
-        menu.choice("return to the account menu") { throw :done }
+        menu.choice("(q) return to the account menu") { throw :done }
         menu.hidden("quit") { throw :done }
       end
     end
@@ -53,7 +59,7 @@ module Imap::Backup
     end
 
     def selected?(folder_name)
-      config_folders = account[:folders]
+      config_folders = account.folders
       return false if config_folders.nil?
 
       config_folders.find { |f| f[:name] == folder_name }
@@ -62,7 +68,7 @@ module Imap::Backup
     def remove_missing
       removed = []
       config_folders = []
-      account[:folders].each do |f|
+      account.folders.each do |f|
         found = imap_folders.find { |folder| folder == f[:name] }
         if found
           config_folders << f
@@ -73,8 +79,7 @@ module Imap::Backup
 
       return if removed.empty?
 
-      account[:folders] = config_folders
-      account[:modified] = true
+      account.folders = config_folders
 
       Kernel.puts <<~MESSAGE
         The following folders have been removed: #{removed.join(', ')}
@@ -85,12 +90,11 @@ module Imap::Backup
 
     def toggle_selection(folder_name)
       if selected?(folder_name)
-        changed = account[:folders].reject! { |f| f[:name] == folder_name }
-        account[:modified] = true if changed
+        new_list = account.folders.select { |f| f[:name] != folder_name }
+        account.folders = new_list
       else
-        account[:folders] ||= []
-        account[:folders] << {name: folder_name}
-        account[:modified] = true
+        existing = account.folders || []
+        account.folders = existing + [{name: folder_name}]
       end
     end
 
@@ -101,11 +105,15 @@ module Imap::Backup
     end
 
     def imap_folders
-      @imap_folders ||= connection.folders
+      @imap_folders ||= connection.folder_names
     end
 
     def highline
-      Configuration::Setup.highline
+      Setup.highline
+    end
+
+    def helpers
+      Setup::Helpers.new
     end
   end
 end

data/lib/imap/backup/setup/helpers.rb

@@ -0,0 +1,15 @@
+require "imap/backup/version"
+
+module Imap::Backup
+  class Setup; end
+
+  class Setup::Helpers
+    def title_prefix
+      "imap-backup –"
+    end
+
+    def version
+      Version::VERSION
+    end
+  end
+end

data/lib/imap/backup/{configuration/setup.rb → setup.rb}

@@ -1,16 +1,16 @@
 require "highline"
 
-module Imap::Backup
-  module Configuration; end
+require "imap/backup/account"
+require "imap/backup/setup/helpers"
 
-  class Configuration::Setup
+module Imap::Backup
+  class Setup
     class << self
       attr_accessor :highline
     end
     self.highline = HighLine.new
 
     def run
-      Imap::Backup.setup_logging config
       catch :done do
         loop do
           Kernel.system("clear")
@@ -23,35 +23,41 @@ module Imap::Backup
 
     def show_menu
       self.class.highline.choose do |menu|
-        menu.header = "Choose an action"
+        menu.header = <<~MENU.chomp
+          #{helpers.title_prefix} Main Menu
+
+          Choose an action
+        MENU
         account_items menu
         add_account_item menu
         toggle_logging_item menu
-        menu.choice("save and exit") do
-          config.save
-          throw :done
-        end
-        menu.choice("exit without saving changes") do
-          throw :done
+        if config.modified?
+          menu.choice("save and exit") do
+            config.save
+            throw :done
+          end
+          menu.choice("exit without saving changes")  { throw :done }
+        else
+          menu.choice("quit") { throw :done }
         end
       end
     end
 
     def account_items(menu)
       config.accounts.each do |account|
-        next if account[:delete]
+        next if account.marked_for_deletion?
 
-        item = account[:username].clone
-        item << " *" if account[:modified]
+        item = account.username.clone
+        item << " *" if account.modified?
         menu.choice(item) do
-          edit_account account[:username]
+          edit_account account.username
         end
       end
     end
 
     def add_account_item(menu)
       menu.choice("add account") do
-        username = Configuration::Asker.email
+        username = Asker.email
         edit_account username
       end
     end
@@ -61,35 +67,37 @@ module Imap::Backup
       new_setting = !config.debug?
       menu.choice(menu_item) do
         config.debug = new_setting
-        Imap::Backup.setup_logging config
+        Imap::Backup::Logger.setup_logging(config)
       end
     end
 
     def config
-      @config ||= Configuration::Store.new
+      @config ||= Configuration.new
     end
 
     def default_account_config(username)
-      {
+      ::Imap::Backup::Account.new(
         username: username,
         password: "",
         local_path: File.join(config.path, username.tr("@", "_")),
         folders: []
-      }.tap do |c|
+      ).tap do |a|
         server = Email::Provider.for_address(username)
-        c[:server] = server.host if server.host
+        a.server = server.host if server.host
       end
     end
 
     def edit_account(username)
-      account = config.accounts.find { |a| a[:username] == username }
+      account = config.accounts.find { |a| a.username == username }
       if account.nil?
         account = default_account_config(username)
         config.accounts << account
       end
-      Configuration::Account.new(
-        config, account, Configuration::Setup.highline
-      ).run
+      Account.new(config, account, Setup.highline).run
+    end
+
+    def helpers
+      Helpers.new
     end
   end
 end

data/lib/imap/backup/uploader.rb

@@ -12,12 +12,12 @@ module Imap::Backup
       count = missing_uids.count
       return if count.zero?
 
-      Imap::Backup.logger.debug "[#{folder.name}] #{count} to restore"
+      Imap::Backup::Logger.logger.debug "[#{folder.name}] #{count} to restore"
       serializer.each_message(missing_uids).with_index do |(uid, message), i|
         next if message.nil?
 
         log_prefix = "[#{folder.name}] uid: #{uid} (#{i + 1}/#{count}) -"
-        Imap::Backup.logger.debug(
+        Imap::Backup::Logger.logger.debug(
           "#{log_prefix} #{message.supplied_body.size} bytes"
         )
 

data/lib/imap/backup/version.rb

@@ -2,8 +2,8 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 4
-  MINOR    = 0
-  REVISION = 5
+  MINOR    = 1
+  REVISION = 2
   PRE      = nil
   VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")
 end

data/lib/imap/backup.rb

@@ -3,46 +3,20 @@ module Imap; end
 require "imap/backup/utils"
 require "imap/backup/account/connection"
 require "imap/backup/account/folder"
-require "imap/backup/configuration/account"
-require "imap/backup/configuration/asker"
-require "imap/backup/configuration/connection_tester"
-require "imap/backup/configuration/folder_chooser"
-require "imap/backup/configuration/list"
-require "imap/backup/configuration/setup"
-require "imap/backup/configuration/store"
+require "imap/backup/configuration"
 require "imap/backup/downloader"
+require "imap/backup/logger"
 require "imap/backup/uploader"
 require "imap/backup/serializer"
 require "imap/backup/serializer/mbox"
+require "imap/backup/setup"
+require "imap/backup/setup/account"
+require "imap/backup/setup/asker"
+require "imap/backup/setup/connection_tester"
+require "imap/backup/setup/folder_chooser"
 require "imap/backup/version"
 require "email/provider"
 
-require "logger"
-
 module Imap::Backup
   class ConfigurationNotFound < StandardError; end
-
-  class Logger
-    include Singleton
-
-    attr_reader :logger
-
-    def initialize
-      @logger = ::Logger.new($stdout)
-      $stdout.sync = true
-    end
-  end
-
-  def self.logger
-    Logger.instance.logger
-  end
-
-  def self.setup_logging(config)
-    logger.level =
-      if config.debug?
-        ::Logger::Severity::DEBUG
-      else
-        ::Logger::Severity::ERROR
-      end
-  end
 end