imap-backup 4.0.3 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139120639e68abb1555421c5c63f28a6ede222f95767f86a52e3b8d548ceaf99
-  data.tar.gz: ef9ef718e09d4b812085c3e72f374f922ae760d318322fa2237d742aec826e37
+  metadata.gz: 5819f0b50ce3de10cfedb1cdb5381e51f2d94f00dc2bcdd99234f57855c9959d
+  data.tar.gz: a140267c179d6002a7186f8591743abbfea2dca7697b7f1761feaa359fd1521c
 SHA512:
-  metadata.gz: 3d7447ca37c7f2134ea7254fe90640ce3f6db6599a287b5b07796236d614e887cd05614045a57d8fb2b729d9e2da357f4cb42b083303dbfe1c3dc4b92b3b3dbd
-  data.tar.gz: 77ea7b8ba366c8416a6cef3c707b8942d4f3261f138c603b98128d2f43079880e12f241c8672a2f301c035204ccd68bc8a6bbbc6dce8d5d9590ecbd4c490844c
+  metadata.gz: 1b7d49f159df4d29582cf98f01ce105769301bcf94fd019486f1e0b43321eb90594e16861e24fe9d7993a76eeba0c115d6d991b64c1188020b09d04ea8db0714
+  data.tar.gz: 7dacdd3c5c3835e1925cd36a3beaaf7cdf6bf98d4bf7f02bbdd4abe3635512708c03654c3da9dfbfcf35f4e94a46dd43a3fc9e6e4693dd2b943d34d4a9ec8b02

data/lib/email/provider/apple_mail.rb

@@ -1,6 +1,6 @@
-require "email/provider/default"
+require "email/provider/base"
 
-class Email::Provider::AppleMail < Email::Provider::Default
+class Email::Provider::AppleMail < Email::Provider::Base
   def host
     "imap.mail.me.com"
   end

data/lib/email/provider/base.rb

@@ -0,0 +1,8 @@
+module Email; end
+class Email::Provider; end
+
+class Email::Provider::Base
+  def options
+    {port: 993, ssl: {ssl_version: :TLSv1_2}}
+  end
+end

data/lib/email/provider/fastmail.rb

@@ -1,6 +1,6 @@
-require "email/provider/default"
+require "email/provider/base"
 
-class Email::Provider::Fastmail < Email::Provider::Default
+class Email::Provider::Fastmail < Email::Provider::Base
   def host
     "imap.fastmail.com"
   end

data/lib/email/provider/gmail.rb

@@ -1,6 +1,6 @@
-require "email/provider/default"
+require "email/provider/base"
 
-class Email::Provider::GMail < Email::Provider::Default
+class Email::Provider::GMail < Email::Provider::Base
   def host
     "imap.gmail.com"
   end

data/lib/email/provider/{default.rb → unknown.rb}

@@ -1,7 +1,6 @@
-module Email; end
-class Email::Provider; end
+require "email/provider/base"
 
-class Email::Provider::Default
+class Email::Provider::Unknown < Email::Provider::Base
   # We don't know how to guess the IMAP server
   def host
   end

data/lib/email/provider.rb

@@ -1,7 +1,7 @@
-require "email/provider/default"
 require "email/provider/apple_mail"
 require "email/provider/fastmail"
 require "email/provider/gmail"
+require "email/provider/unknown"
 
 module Email; end
 
@@ -21,7 +21,7 @@ class Email::Provider
     when address.end_with?("@me.com")
       Email::Provider::AppleMail.new
     else
-      Email::Provider::Default.new
+      Email::Provider::Unknown.new
     end
   end
 end

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

@@ -4,25 +4,17 @@ require "imap/backup/client/default"
 require "retry_on_error"
 
 module Imap::Backup
-  module Account; end
+  class Account; end
 
   class Account::Connection
     include RetryOnError
 
     LOGIN_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, SocketError].freeze
 
-    attr_reader :connection_options
-    attr_reader :local_path
-    attr_reader :password
-    attr_reader :username
-
-    def initialize(options)
-      @username = options[:username]
-      @password = options[:password]
-      @local_path = options[:local_path]
-      @config_folders = options[:folders]
-      @server = options[:server]
-      @connection_options = options[:connection_options] || {}
+    attr_reader :account
+
+    def initialize(account)
+      @account = account
       @folders = nil
       create_account_folder
     end
@@ -33,7 +25,7 @@ module Imap::Backup
           folders = client.list
 
           if folders.empty?
-            message = "Unable to get folder list for account #{username}"
+            message = "Unable to get folder list for account #{account.username}"
             Imap::Backup.logger.info message
             raise message
           end
@@ -45,13 +37,13 @@ module Imap::Backup
     def status
       backup_folders.map do |backup_folder|
         f = Account::Folder.new(self, backup_folder[:name])
-        s = Serializer::Mbox.new(local_path, backup_folder[:name])
+        s = Serializer::Mbox.new(account.local_path, backup_folder[:name])
         {name: backup_folder[:name], local: s.uids, remote: f.uids}
       end
     end
 
     def run_backup
-      Imap::Backup.logger.debug "Running backup of account: #{username}"
+      Imap::Backup.logger.debug "Running backup of account: #{account.username}"
       # start the connection so we get logging messages in the right order
       client
       each_folder do |folder, serializer|
@@ -71,11 +63,11 @@ module Imap::Backup
     def local_folders
       return enum_for(:local_folders) if !block_given?
 
-      glob = File.join(local_path, "**", "*.imap")
-      base = Pathname.new(local_path)
+      glob = File.join(account.local_path, "**", "*.imap")
+      base = Pathname.new(account.local_path)
       Pathname.glob(glob) do |path|
         name = path.relative_path_from(base).to_s[0..-6]
-        serializer = Serializer::Mbox.new(local_path, name)
+        serializer = Serializer::Mbox.new(account.local_path, name)
         folder = Account::Folder.new(self, name)
         yield serializer, folder
       end
@@ -109,15 +101,15 @@ module Imap::Backup
             else
               Client::Default.new(server, options)
             end
-          Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
-          client.login(username, password)
+          Imap::Backup.logger.debug "Logging in: #{account.username}/#{masked_password}"
+          client.login(account.username, account.password)
           Imap::Backup.logger.debug "Login complete"
           client
         end
     end
 
     def server
-      @server ||= provider.host
+      @server ||= account.server || provider.host
     end
 
     private
@@ -125,7 +117,7 @@ module Imap::Backup
     def each_folder
       backup_folders.each do |backup_folder|
         folder = Account::Folder.new(self, backup_folder[:name])
-        serializer = Serializer::Mbox.new(local_path, backup_folder[:name])
+        serializer = Serializer::Mbox.new(account.local_path, backup_folder[:name])
         yield folder, serializer
       end
     end
@@ -142,7 +134,7 @@ module Imap::Backup
           Imap::Backup.logger.debug(
             "Backup '#{old_name}' renamed and restored to '#{new_name}'"
           )
-          new_serializer = Serializer::Mbox.new(local_path, new_name)
+          new_serializer = Serializer::Mbox.new(account.local_path, new_name)
           new_folder = Account::Folder.new(self, new_name)
           new_folder.create
           new_serializer.force_uid_validity(new_folder.uid_validity)
@@ -159,21 +151,21 @@ module Imap::Backup
 
     def create_account_folder
       Utils.make_folder(
-        File.dirname(local_path),
-        File.basename(local_path),
+        File.dirname(account.local_path),
+        File.basename(account.local_path),
         Serializer::DIRECTORY_PERMISSIONS
       )
     end
 
     def masked_password
-      password.gsub(/./, "x")
+      account.password.gsub(/./, "x")
     end
 
     def backup_folders
       @backup_folders ||=
         begin
-          if @config_folders&.any?
-            @config_folders
+          if account.folders&.any?
+            account.folders
           else
             folders.map { |name| {name: name} }
           end
@@ -181,11 +173,11 @@ module Imap::Backup
     end
 
     def provider
-      @provider ||= Email::Provider.for_address(username)
+      @provider ||= Email::Provider.for_address(account.username)
     end
 
     def provider_options
-      provider.options.merge(connection_options)
+      provider.options.merge(account.connection_options || {})
     end
   end
 end

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

@@ -3,7 +3,7 @@ require "forwardable"
 require "retry_on_error"
 
 module Imap::Backup
-  module Account; end
+  class Account; end
 
   class FolderNotFound < StandardError; end
 

data/lib/imap/backup/account.rb

@@ -0,0 +1,98 @@
+module Imap::Backup
+  class Account
+    attr_reader :username
+    attr_reader :password
+    attr_reader :local_path
+    attr_reader :folders
+    attr_reader :server
+    attr_reader :connection_options
+    attr_reader :changes
+    attr_reader :marked_for_deletion
+
+    def initialize(options)
+      @username = options[:username]
+      @password = options[:password]
+      @local_path = options[:local_path]
+      @folders = options[:folders]
+      @server = options[:server]
+      @connection_options = options[:connection_options]
+      @changes = {}
+      @marked_for_deletion = false
+    end
+
+    def valid?
+      username && password
+    end
+
+    def modified?
+      changes.any?
+    end
+
+    def clear_changes!
+      @changes = {}
+    end
+
+    def mark_for_deletion!
+      @marked_for_deletion = true
+    end
+
+    def marked_for_deletion?
+      @marked_for_deletion
+    end
+
+    def to_h
+      h = {
+        username: @username,
+        password: @password,
+      }
+      h[:local_path] = @local_path if @local_path
+      h[:folders] = @folders if @folders
+      h[:server] = @server if @server
+      h[:connection_options] = @connection_options if @connection_options
+      h
+    end
+
+    def username=(value)
+      update(:username, value)
+    end
+
+    def password=(value)
+      update(:password, value)
+    end
+
+    def local_path=(value)
+      update(:local_path, value)
+    end
+
+    def folders=(value)
+      raise "folders must be an Array" if !value.is_a?(Array)
+      update(:folders, value)
+    end
+
+    def server=(value)
+      update(:server, value)
+    end
+
+    def connection_options=(value)
+      parsed = JSON.parse(value)
+      update(:connection_options, parsed)
+    end
+
+    private
+
+    def update(field, value)
+      if changes[field]
+        change = changes[field]
+        changes.delete(field) if change[:from] == value
+      end
+      set_field!(field, value)
+    end
+
+    def set_field!(field, value)
+      key = :"@#{field}"
+      current = instance_variable_get(key)
+      changes[field] = {from: current, to: value}
+      instance_variable_set(key, value)
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Imap::Backup::CLI::Helpers
 
   def account(email)
     connections = Imap::Backup::Configuration::List.new
-    account = connections.accounts.find { |a| a[:username] == email }
+    account = connections.accounts.find { |a| a.username == email }
     raise "#{email} is not a configured account" if !account
 
     account

data/lib/imap/backup/cli/local.rb

@@ -6,7 +6,7 @@ module Imap::Backup
     desc "accounts", "List locally backed-up accounts"
     def accounts
       connections = Imap::Backup::Configuration::List.new
-      connections.accounts.each { |a| Kernel.puts a[:username] }
+      connections.accounts.each { |a| Kernel.puts a.username }
     end
 
     desc "folders EMAIL", "List account folders"

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

@@ -22,9 +22,10 @@ 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 }
@@ -33,13 +34,20 @@ module Imap::Backup
     end
 
     def header(menu)
-      menu.header = <<-HEADER.gsub(/^\s{8}/m, "")
+      connection_options =
+        if account.connection_options
+          escaped =
+            JSON.generate(account.connection_options).
+            gsub('"', '\"')
+          "\n  connection options: #{escaped}"
+        end
+      menu.header = <<~HEADER
         Account:
-          email:    #{account[:username]}
-          server:   #{account[:server]}
-          path:     #{account[:local_path]}
-          folders:  #{folders.map { |f| f[:name] }.join(', ')}
+          email:    #{account.username}
           password: #{masked_password}
+          path:     #{account.local_path}
+          folders:  #{folders.map { |f| f[:name] }.join(', ')}
+          server:   #{account.server}#{connection_options}
       HEADER
     end
 
@@ -48,20 +56,20 @@ module Imap::Backup
         username = Configuration::Asker.email(username)
         Kernel.puts "username: #{username}"
         other_accounts = store.accounts.reject { |a| a == account }
-        others = other_accounts.map { |a| a[:username] }
+        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
@@ -70,30 +78,31 @@ module Imap::Backup
       menu.choice("modify password") do
         password = Configuration::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
+        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,11 +111,10 @@ 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 = Configuration::Asker.backup_path(
+          account.local_path, ->(path) { path_modification_validator(path) }
         )
-        account[:modified] = true if existing != account[:local_path]
       end
     end
 
@@ -127,28 +135,28 @@ 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
 
     def default_server(username)
       provider = Email::Provider.for_address(username)
 
-      if provider.is_a?(Email::Provider::Default)
+      if provider.is_a?(Email::Provider::Unknown)
         Kernel.puts "Can't decide provider for email address '#{username}'"
         return nil
       end

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

@@ -53,7 +53,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 +62,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 +73,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 +84,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
 

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

@@ -29,7 +29,7 @@ module Imap::Backup
           config.accounts
         else
           config.accounts.select do |account|
-            required_accounts.include?(account[:username])
+            required_accounts.include?(account.username)
           end
         end
     end

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

@@ -1,5 +1,7 @@
 require "highline"
 
+require "imap/backup/account"
+
 module Imap::Backup
   module Configuration; end
 
@@ -39,12 +41,12 @@ module Imap::Backup
 
     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
@@ -70,19 +72,19 @@ module Imap::Backup
     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