imap-backup 4.0.6 → 4.2.0

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
 
@@ -28,34 +30,38 @@ module Imap::Backup
         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)
+      modified = account.modified? ? "*" : ""
       connection_options =
         if account.connection_options
           escaped =
             JSON.generate(account.connection_options).
             gsub('"', '\"')
-          "\n  connection options: #{escaped}"
+          "\n  connection options #{escaped}"
         end
-      menu.header = <<~HEADER
-        Account:
-          email:    #{account.username}
-          password: #{masked_password}
-          path:     #{account.local_path}
-          folders:  #{folders.map { |f| f[:name] }.join(', ')}
-          server:   #{account.server}#{connection_options}
+      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 }
+        other_accounts = config.accounts.reject { |a| a == account }
         others = other_accounts.map { |a| a.username }
         Kernel.puts "others: #{others.inspect}"
         if others.include?(username)
@@ -76,7 +82,7 @@ module Imap::Backup
 
     def modify_password(menu)
       menu.choice("modify password") do
-        password = Configuration::Asker.password
+        password = Setup::Asker.password
 
         account.password = password if !password.nil?
       end
@@ -97,7 +103,7 @@ module Imap::Backup
     end
 
     def path_modification_validator(path)
-      same = store.accounts.find do |a|
+      same = config.accounts.find do |a|
         a.username != account.username && a.local_path == path
       end
       if same
@@ -112,7 +118,7 @@ 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 = Setup::Asker.backup_path(
           account.local_path, ->(path) { path_modification_validator(path) }
         )
       end
@@ -120,13 +126,13 @@ module Imap::Backup
 
     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
@@ -163,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
@@ -99,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,18 +1,16 @@
 require "highline"
 
 require "imap/backup/account"
+require "imap/backup/setup/helpers"
 
 module Imap::Backup
-  module Configuration; end
-
-  class Configuration::Setup
+  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")
@@ -25,16 +23,22 @@ 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
@@ -53,7 +57,7 @@ module Imap::Backup
 
     def add_account_item(menu)
       menu.choice("add account") do
-        username = Configuration::Asker.email
+        username = Asker.email
         edit_account username
       end
     end
@@ -63,12 +67,12 @@ 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)
@@ -89,9 +93,11 @@ module Imap::Backup
         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/thunderbird/mailbox_exporter.rb

@@ -40,7 +40,16 @@ module Imap::Backup
         end
       end
 
-      FileUtils.cp serializer.mbox_pathname, local_folder.full_path
+      File.open(local_folder.full_path, "w") do |f|
+        enumerator = Serializer::MboxEnumerator.new(serializer.mbox_pathname)
+        enumerator.each.with_index do |raw, i|
+          clean = Email::Mboxrd::Message.clean_serialized(raw)
+          timestamp = Time.now.strftime("%a %b %d %H:%M:%S %Y")
+          thunderbird_fom_line = "From - #{timestamp}"
+          output = "#{thunderbird_fom_line}\n#{clean}\n"
+          f.write output
+        end
+      end
 
       true
     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 = 6
+  MINOR    = 2
+  REVISION = 0
   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

data/lib/retry_on_error.rb

@@ -5,7 +5,7 @@ module RetryOnError
   rescue *errors => e
     if tries < limit
       message = "#{e}, attempt #{tries} of #{limit}"
-      Imap::Backup.logger.debug message
+      Imap::Backup::Logger.logger.debug message
       tries += 1
       retry
     end

data/lib/thunderbird/subdirectory.rb

@@ -77,17 +77,14 @@ class Thunderbird::Subdirectory
 
   def check
     case
-    when placeholder.exists? && !exists?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{placeholder.path}' exists, but '#{full_path}' is missing"
-      false
     when exists? && !placeholder.exists?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{full_path}' exists, but '#{placeholder.path}' is missing"
+      Kernel.puts "Can't set up folder '#{full_path}': '#{full_path}' exists, but '#{placeholder.path}' is missing"
       false
     when placeholder.exists? && !placeholder.regular?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{placeholder.path}' exists, but it is not a regular file"
+      Kernel.puts "Can't set up folder '#{full_path}': '#{placeholder.path}' exists, but it is not a regular file"
       false
     when exists? && !directory?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{full_path}' exists, but it is not a directory"
+      Kernel.puts "Can't set up folder '#{full_path}': '#{full_path}' exists, but it is not a directory"
       false
     else
       true

data/spec/features/backup_spec.rb

@@ -58,6 +58,7 @@ RSpec.describe "backup", type: :feature, docker: true do
         email3
         original_folder_uid_validity
         connection.run_backup
+        connection.disconnect
         server_rename_folder folder, new_name
       end
       let(:renamed_folder) { "#{folder}.#{original_folder_uid_validity}" }

data/spec/features/status_spec.rb

@@ -0,0 +1,43 @@
+require "features/helper"
+require "imap/backup/cli/status"
+
+RSpec.describe "status", type: :feature, docker: true do
+  include_context "imap-backup connection"
+  include_context "message-fixtures"
+
+  context "when there are non-backed-up messages" do
+    let(:options) do
+      {accounts: "address@example.org"}
+    end
+    let(:folder) { "my-stuff" }
+    let(:backup_folders) { [{name: folder}] }
+    let(:email1) { send_email folder, msg1 }
+    let(:output) { StringIO.new }
+
+    before do
+      allow(Imap::Backup::CLI::Accounts).to receive(:new) { [account] }
+      server_create_folder folder
+      email1
+    end
+
+    around do |example|
+      stdout = $stdout
+      $stdout = output
+      example.run
+      $stdout = stdout
+    end
+
+    after do
+      FileUtils.rm_rf local_backup_path
+      delete_emails folder
+      server_delete_folder folder
+      connection.disconnect
+    end
+
+    it "prints the number" do
+      Imap::Backup::CLI::Status.new(options).run
+
+      expect(output.string).to eq("address@example.org\nmy-stuff: 1\n")
+    end
+  end
+end

data/spec/features/support/email_server.rb

@@ -63,11 +63,14 @@ module EmailServerHelpers
   end
 
   def server_folders
-    root_info = imap.list("", "")[0]
-    root = root_info.name
     imap.list(root, "*")
   end
 
+  def root
+    root_info = imap.list("", "")[0]
+    root_info.name
+  end
+
   def server_create_folder(folder)
     imap.create(folder)
     imap.disconnect

data/spec/support/higline_test_helpers.rb

@@ -2,7 +2,7 @@ module HighLineTestHelpers
   def prepare_highline
     @input = instance_double(IO, eof?: false, gets: "q\n")
     @output = StringIO.new
-    Imap::Backup::Configuration::Setup.highline = HighLine.new(@input, @output)
+    Imap::Backup::Setup.highline = HighLine.new(@input, @output)
     [@input, @output]
   end
 end

data/spec/support/silence_logging.rb

@@ -1,7 +1,7 @@
 def silence_logging
   RSpec.configure do |config|
     config.before(:suite) do
-      Imap::Backup.logger.level = Logger::UNKNOWN
+      Imap::Backup::Logger.logger.level = Logger::UNKNOWN
     end
   end
 end

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -5,6 +5,7 @@ describe Imap::Backup::Account::Connection do
   FOLDER_CONFIG = {name: BACKUP_FOLDER}.freeze
   FOLDER_NAME = "my_folder".freeze
   GMAIL_IMAP_SERVER = "imap.gmail.com".freeze
+  IMAP_FOLDER = "imap_folder".freeze
   LOCAL_PATH = "local_path".freeze
   LOCAL_UID = "local_uid".freeze
   PASSWORD = "secret".freeze
@@ -101,19 +102,23 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  describe "#folders" do
+  describe "#folder_names" do
     let(:imap_folders) do
-      [BACKUP_FOLDER]
+      [IMAP_FOLDER]
     end
 
     it "returns the list of folders" do
-      expect(subject.folders).to eq([BACKUP_FOLDER])
+      expect(subject.folder_names).to eq([IMAP_FOLDER])
     end
   end
 
   describe "#status" do
     let(:folder) do
-      instance_double(Imap::Backup::Account::Folder, uids: [remote_uid])
+      instance_double(
+        Imap::Backup::Account::Folder,
+        uids: [remote_uid],
+        name: IMAP_FOLDER
+      )
     end
     let(:remote_uid) { "remote_uid" }
 
@@ -123,7 +128,7 @@ describe Imap::Backup::Account::Connection do
     end
 
     it "returns the names of folders" do
-      expect(subject.status[0][:name]).to eq(BACKUP_FOLDER)
+      expect(subject.status[0][:name]).to eq(IMAP_FOLDER)
     end
 
     it "returns local message uids" do
@@ -139,7 +144,7 @@ describe Imap::Backup::Account::Connection do
     let(:folder) do
       instance_double(
         Imap::Backup::Account::Folder,
-        name: "folder",
+        name: IMAP_FOLDER,
         exist?: exists,
         uid_validity: uid_validity
       )
@@ -150,11 +155,11 @@ describe Imap::Backup::Account::Connection do
 
     before do
       allow(Imap::Backup::Downloader).
-        to receive(:new).with(folder, serializer) { downloader }
+        to receive(:new).with(folder, serializer, anything) { downloader }
       allow(Imap::Backup::Account::Folder).to receive(:new).
         with(subject, BACKUP_FOLDER) { folder }
       allow(Imap::Backup::Serializer::Mbox).to receive(:new).
-        with(LOCAL_PATH, BACKUP_FOLDER) { serializer }
+        with(LOCAL_PATH, IMAP_FOLDER) { serializer }
     end
 
     context "with supplied config_folders" do
@@ -248,7 +253,7 @@ describe Imap::Backup::Account::Connection do
         Imap::Backup::Account::Folder,
         create: nil,
         uids: uids,
-        name: FOLDER_NAME,
+        name: IMAP_FOLDER,
         uid_validity: uid_validity
       )
     end