imap-backup 6.0.0.rc2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f9cac7966fac9858fdc380d8e9638c8d479035ee4053444a104b8c3eb5a304c
-  data.tar.gz: 5d9785b5e34d90535c8052d216d9b3dbf46ea743672f05129604729662f42f34
+  metadata.gz: 00576d7b3a0482f2e2ede92e545a5bbebcdf5ab2a688feb8e0c54281a1d9ba9a
+  data.tar.gz: e8bc14ff755f817cb08f4b979b6c689d4ee87c1b9d96acca4d0dc2a8297a40a7
 SHA512:
-  metadata.gz: a4595e4316dcdc20123a8ed2bec524d37c1de95da49281a30484349c317a996cf3c6946617a489880a0c41db41698b2ee862d9aee4f9c9b8fa34d67707ba924c
-  data.tar.gz: ccee268de9cb6225c72fe0cb11a2552fc793f664429d8dfa918e5b4697961c8e5e15e47ed653dac241f377385806443f17683614b8ff76075a8ff2f12e07f98c
+  metadata.gz: 155476a2d92177685b58802d1431a15975161fcee512f43ee79cb332078faba8e0247f81020eb4c92c20fdb308ec6bb1650136cf1d92f468e4ece68142717e67
+  data.tar.gz: ddd269797169fdbc255ef907bb30a9c66775709ad32bc10f2a3d6ec75da441625269db307ed3bfa8e06dd3f076ff313e6124d47be73654c1f2b2cc8202e1f55a

data/imap-backup.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |gem|
   gem.files         += %w[LICENSE README.md]
 
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = Dir.glob("spec/**/*{.rb,.yml}")
   gem.require_paths = ["lib"]
   gem.required_ruby_version = ">= 2.5"
 
@@ -34,4 +33,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec", ">= 3.0.0"
   gem.add_development_dependency "rubocop-rspec"
   gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "yard"
+
+  gem.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
 end

data/lib/cli_coverage.rb

@@ -1,18 +1,18 @@
 class CliCoverage
   def self.conditionally_activate
-    if ENV["COVERAGE"]
-      require "simplecov"
+    return if !ENV["COVERAGE"]
 
-      # Collect coverage separately
-      SimpleCov.command_name "#{ENV['COVERAGE']} #{ARGV.join(' ')} coverage"
+    require "simplecov"
 
-      # Silence output
-      SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter
-      SimpleCov.print_error_status = false
+    # Collect coverage separately
+    SimpleCov.command_name "#{ENV['COVERAGE']} #{ARGV.join(' ')} coverage"
 
-      # Ensure SimpleCov doesn't filter out all out code
-      project_root = File.expand_path("..", __dir__)
-      SimpleCov.root project_root
-    end
+    # Silence output
+    SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter
+    SimpleCov.print_error_status = false
+
+    # Ensure SimpleCov doesn't filter out all out code
+    project_root = File.expand_path("..", __dir__)
+    SimpleCov.root project_root
   end
 end

data/lib/email/provider/base.rb

@@ -3,6 +3,8 @@ class Email::Provider; end
 
 class Email::Provider::Base
   def options
+    # rubocop:disable Naming/VariableNumber
     {port: 993, ssl: {ssl_version: :TLSv1_2}}
+    # rubocop:enable Naming/VariableNumber
   end
 end

data/lib/email/provider/unknown.rb

@@ -6,6 +6,8 @@ class Email::Provider::Unknown < Email::Provider::Base
   end
 
   def options
+    # rubocop:disable Naming/VariableNumber
     {port: 993, ssl: {ssl_version: :TLSv1_2}}
+    # rubocop:enable Naming/VariableNumber
   end
 end

data/lib/email/provider.rb

@@ -7,6 +7,7 @@ module Email; end
 
 class Email::Provider
   def self.for_address(address)
+    # rubocop:disable Lint/DuplicateBranch
     case
     when address.end_with?("@fastmail.com")
       Email::Provider::Fastmail.new
@@ -23,5 +24,6 @@ class Email::Provider
     else
       Email::Provider::Unknown.new
     end
+    # rubocop:enable Lint/DuplicateBranch
   end
 end

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

@@ -0,0 +1,27 @@
+module Imap::Backup
+  class Account; end
+  class Account::Connection; end
+
+  class Account::Connection::BackupFolders
+    attr_reader :account
+    attr_reader :client
+
+    def initialize(client:, account:)
+      @client = client
+      @account = account
+    end
+
+    def run
+      names =
+        if account.folders&.any?
+          account.folders.map { |af| af[:name] }
+        else
+          Account::Connection::FolderNames.new(client: client, account: account).run
+        end
+
+      names.map do |name|
+        Account::Folder.new(account.connection, name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require "retry_on_error"
+
+module Imap::Backup
+  class Account::Connection::ClientFactory
+    include RetryOnError
+
+    LOGIN_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, SocketError].freeze
+
+    attr_reader :account
+
+    def initialize(account:)
+      @account = account
+      @provider = nil
+      @server = nil
+    end
+
+    def run
+      retry_on_error(errors: LOGIN_RETRY_CLASSES) do
+        options = provider_options
+        Logger.logger.debug(
+          "Creating IMAP instance: #{server}, options: #{options.inspect}"
+        )
+        client =
+          if provider.is_a?(Email::Provider::AppleMail)
+            Client::AppleMail.new(server, options)
+          else
+            Client::Default.new(server, options)
+          end
+        Logger.logger.debug "Logging in: #{account.username}/#{masked_password}"
+        client.login(account.username, account.password)
+        Logger.logger.debug "Login complete"
+        client
+      end
+    end
+
+    private
+
+    def masked_password
+      account.password.gsub(/./, "x")
+    end
+
+    def provider
+      @provider ||= Email::Provider.for_address(account.username)
+    end
+
+    def provider_options
+      provider.options.merge(account.connection_options || {})
+    end
+
+    def server
+      @server ||= account.server || provider.host
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Imap::Backup
+  class Account; end
+  class Account::Connection; end
+
+  class Account::Connection::FolderNames
+    attr_reader :account
+    attr_reader :client
+
+    def initialize(client:, account:)
+      @client = client
+      @account = account
+    end
+
+    def run
+      folder_names = client.list
+
+      if folder_names.empty?
+        message = "Unable to get folder list for account #{account.username}"
+        Logger.logger.info message
+        raise message
+      end
+
+      folder_names
+    end
+  end
+end

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

@@ -1,17 +1,15 @@
+require "email/provider"
 require "imap/backup/client/apple_mail"
 require "imap/backup/client/default"
+require "imap/backup/account/connection/backup_folders"
+require "imap/backup/account/connection/client_factory"
+require "imap/backup/account/connection/folder_names"
 require "imap/backup/serializer/directory"
 
-require "retry_on_error"
-
 module Imap::Backup
   class Account; end
 
   class Account::Connection
-    include RetryOnError
-
-    LOGIN_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, SocketError].freeze
-
     attr_reader :account
 
     def initialize(account)
@@ -20,34 +18,12 @@ module Imap::Backup
     end
 
     def folder_names
-      @folder_names ||=
-        begin
-          folder_names = client.list
-
-          if folder_names.empty?
-            message = "Unable to get folder list for account #{account.username}"
-            Imap::Backup::Logger.logger.info message
-            raise message
-          end
-
-          folder_names
-        end
+      @folder_names ||= Account::Connection::FolderNames.new(client: client, account: account).run
     end
 
     def backup_folders
       @backup_folders ||=
-        begin
-          names =
-            if account.folders&.any?
-              account.folders.map { |af| af[:name] }
-            else
-              folder_names
-            end
-
-          names.map do |name|
-            Account::Folder.new(self, name)
-          end
-        end
+        Account::Connection::BackupFolders.new(client: client, account: account).run
     end
 
     def status
@@ -59,14 +35,14 @@ module Imap::Backup
     end
 
     def run_backup
-      Imap::Backup::Logger.logger.debug "Running backup of account: #{account.username}"
+      Logger.logger.debug "Running backup of account: #{account.username}"
       # start the connection so we get logging messages in the right order
       client
       ensure_account_folder
       each_folder do |folder, serializer|
         next if !folder.exist?
 
-        Imap::Backup::Logger.logger.debug "[#{folder.name}] running backup"
+        Logger.logger.debug "[#{folder.name}] running backup"
         serializer.apply_uid_validity(folder.uid_validity)
         begin
           Downloader.new(
@@ -95,7 +71,7 @@ module Imap::Backup
 
     def restore
       local_folders do |serializer, folder|
-        restore_folder serializer, folder
+        Uploader.new(folder, serializer).run
       end
     end
 
@@ -112,32 +88,11 @@ module Imap::Backup
       @backup_folders = nil
       @client = nil
       @folder_names = nil
-      @provider = nil
-      @server = nil
     end
 
+    # TODO: make this private
     def client
-      @client ||=
-        retry_on_error(errors: LOGIN_RETRY_CLASSES) do
-          options = provider_options
-          Imap::Backup::Logger.logger.debug(
-            "Creating IMAP instance: #{server}, options: #{options.inspect}"
-          )
-          client =
-            if provider.is_a?(Email::Provider::AppleMail)
-              Client::AppleMail.new(server, options)
-            else
-              Client::Default.new(server, options)
-            end
-          Imap::Backup::Logger.logger.debug "Logging in: #{account.username}/#{masked_password}"
-          client.login(account.username, account.password)
-          Imap::Backup::Logger.logger.debug "Login complete"
-          client
-        end
-    end
-
-    def server
-      @server ||= account.server || provider.host
+      @client ||= Account::Connection::ClientFactory.new(account: account).run
     end
 
     private
@@ -149,33 +104,6 @@ module Imap::Backup
       end
     end
 
-    def restore_folder(serializer, folder)
-      existing_uids = folder.uids
-      if existing_uids.any?
-        Imap::Backup::Logger.logger.debug(
-          "There's already a '#{folder.name}' folder with emails"
-        )
-        new_name = serializer.apply_uid_validity(folder.uid_validity)
-        old_name = serializer.folder
-        if new_name
-          Imap::Backup::Logger.logger.debug(
-            "Backup '#{old_name}' renamed and restored to '#{new_name}'"
-          )
-          new_serializer = Serializer.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)
-          Uploader.new(new_folder, new_serializer).run
-        else
-          Uploader.new(folder, serializer).run
-        end
-      else
-        folder.create
-        serializer.force_uid_validity(folder.uid_validity)
-        Uploader.new(folder, serializer).run
-      end
-    end
-
     def ensure_account_folder
       Utils.make_folder(
         File.dirname(account.local_path),
@@ -183,17 +111,5 @@ module Imap::Backup
         Serializer::Directory::DIRECTORY_PERMISSIONS
       )
     end
-
-    def masked_password
-      account.password.gsub(/./, "x")
-    end
-
-    def provider
-      @provider ||= Email::Provider.for_address(account.username)
-    end
-
-    def provider_options
-      provider.options.merge(account.connection_options || {})
-    end
   end
 end

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

@@ -12,7 +12,8 @@ module Imap::Backup
     include RetryOnError
 
     BODY_ATTRIBUTE = "BODY[]".freeze
-    UID_FETCH_RETRY_CLASSES = [EOFError].freeze
+    UID_FETCH_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, IOError].freeze
+    APPEND_RETRY_CLASSES = [Net::IMAP::BadResponseError].freeze
 
     attr_reader :connection
     attr_reader :name
@@ -64,7 +65,7 @@ module Imap::Backup
         in `search_internal` in stdlib net/imap.rb.
         This is caused by `@responses["SEARCH"] being unset/undefined
       MESSAGE
-      Imap::Backup::Logger.logger.warn message
+      Logger.logger.warn message
       []
     end
 
@@ -91,8 +92,10 @@ module Imap::Backup
     def append(message)
       body = message.imap_body
       date = message.date&.to_time
-      response = client.append(utf7_encoded_name, body, nil, date)
-      extract_uid(response)
+      retry_on_error(errors: APPEND_RETRY_CLASSES, limit: 3) do
+        response = client.append(utf7_encoded_name, body, nil, date)
+        extract_uid(response)
+      end
     end
 
     def clear
@@ -108,12 +111,12 @@ module Imap::Backup
     def examine
       client.examine(utf7_encoded_name)
     rescue Net::IMAP::NoResponseError
-      Imap::Backup::Logger.logger.warn "Folder '#{name}' does not exist on server"
+      Logger.logger.warn "Folder '#{name}' does not exist on server"
       raise FolderNotFound, "Folder '#{name}' does not exist on server"
     end
 
     def extract_uid(response)
-      @uid_validity, uid = response.data.code.data.split(" ").map(&:to_i)
+      @uid_validity, uid = response.data.code.data.split.map(&:to_i)
       uid
     end
 

data/lib/imap/backup/account.rb

@@ -47,10 +47,7 @@ module Imap::Backup
     end
 
     def to_h
-      h = {
-        username: @username,
-        password: @password,
-      }
+      h = {username: @username, password: @password}
       h[:local_path] = @local_path if @local_path
       h[:folders] = @folders if @folders
       h[:server] = @server if @server
@@ -73,6 +70,7 @@ module Imap::Backup
 
     def folders=(value)
       raise "folders must be an Array" if !value.is_a?(Array)
+
       update(:folders, value)
     end
 
@@ -113,7 +111,7 @@ module Imap::Backup
         end
       else
         current = instance_variable_get(key)
-        changes[field] = {from: current, to: value}
+        changes[field] = {from: current, to: value} if value != current
       end
 
       instance_variable_set(key, value)

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

@@ -12,9 +12,7 @@ module Imap::Backup
 
     no_commands do
       def run
-        each_connection(account_names) do |connection|
-          connection.run_backup
-        end
+        each_connection(account_names, &:run_backup)
       end
     end
   end

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

@@ -1,35 +1,37 @@
 require "imap/backup"
 require "imap/backup/cli/accounts"
 
-module Imap::Backup::CLI::Helpers
-  def symbolized(options)
-    options.each.with_object({}) do |(k, v), acc|
-      key = k.gsub("-", "_").intern
-      acc[key] = v
+module Imap::Backup
+  module CLI::Helpers
+    def symbolized(options)
+      options.each.with_object({}) do |(k, v), acc|
+        key = k.gsub("-", "_").intern
+        acc[key] = v
+      end
     end
-  end
 
-  def account(email)
-    accounts = Imap::Backup::CLI::Accounts.new
-    account = accounts.find { |a| a.username == email }
-    raise "#{email} is not a configured account" if !account
+    def account(email)
+      accounts = CLI::Accounts.new
+      account = accounts.find { |a| a.username == email }
+      raise "#{email} is not a configured account" if !account
 
-    account
-  end
+      account
+    end
 
-  def connection(email)
-    account = account(email)
+    def connection(email)
+      account = account(email)
 
-    Imap::Backup::Account::Connection.new(account)
-  end
+      Account::Connection.new(account)
+    end
 
-  def each_connection(names)
-    accounts = Imap::Backup::CLI::Accounts.new(names)
+    def each_connection(names)
+      accounts = CLI::Accounts.new(names)
 
-    accounts.each do |account|
-      yield account.connection
+      accounts.each do |account|
+        yield account.connection
+      end
+    rescue ConfigurationNotFound
+      raise "imap-backup is not configured. Run `imap-backup setup`"
     end
-  rescue Imap::Backup::ConfigurationNotFound
-    raise "imap-backup is not configured. Run `imap-backup setup`"
   end
 end

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

@@ -5,6 +5,8 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
+    MAX_SUBJECT = 60
+
     desc "accounts", "List locally backed-up accounts"
     def accounts
       accounts = CLI::Accounts.new
@@ -29,26 +31,16 @@ module Imap::Backup
       end
       raise "Folder '#{folder_name}' not found" if !folder_serializer
 
-      max_subject = 60
       Kernel.puts format(
-        "%-10<uid>s  %-#{max_subject}<subject>s - %<date>s",
+        "%-10<uid>s  %-#{MAX_SUBJECT}<subject>s - %<date>s",
         {uid: "UID", subject: "Subject", date: "Date"}
       )
-      Kernel.puts "-" * (12 + max_subject + 28)
+      Kernel.puts "-" * (12 + MAX_SUBJECT + 28)
 
       uids = folder_serializer.uids
 
       folder_serializer.each_message(uids).map do |uid, message|
-        m = {
-          uid: uid,
-          date: message.date.to_s,
-          subject: message.subject || ""
-        }
-        if m[:subject].length > max_subject
-          Kernel.puts format("% 10<uid>u: %.#{max_subject - 3}<subject>s... - %<date>s", m)
-        else
-          Kernel.puts format("% 10<uid>u: %-#{max_subject}<subject>s - %<date>s", m)
-        end
+        list_message uid, message
       end
     end
 
@@ -78,5 +70,20 @@ module Imap::Backup
         Kernel.puts message.supplied_body
       end
     end
+
+    no_commands do
+      def list_message(uid, message)
+        m = {
+          uid: uid,
+          date: message.date.to_s,
+          subject: message.subject || ""
+        }
+        if m[:subject].length > MAX_SUBJECT
+          Kernel.puts format("% 10<uid>u: %.#{MAX_SUBJECT - 3}<subject>s... - %<date>s", m)
+        else
+          Kernel.puts format("% 10<uid>u: %-#{MAX_SUBJECT}<subject>s - %<date>s", m)
+        end
+      end
+    end
   end
 end

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

@@ -38,13 +38,9 @@ module Imap::Backup
           raise "Source and destination accounts cannot be the same!"
         end
 
-        if !destination_account
-          raise "Account '#{destination_email}' does not exist"
-        end
+        raise "Account '#{destination_email}' does not exist" if !destination_account
 
-        if !source_account
-          raise "Account '#{source_email}' does not exist"
-        end
+        raise "Account '#{source_email}' does not exist" if !source_account
       end
 
       def config
@@ -69,16 +65,14 @@ module Imap::Backup
 
       def folder_for(source_folder)
         no_source_prefix =
-          if source_prefix != "" &&
-              source_folder.start_with?(source_prefix)
+          if source_prefix != "" && source_folder.start_with?(source_prefix)
             source_folder.delete_prefix(source_prefix)
           else
             source_folder.to_s
           end
 
         with_destination_prefix =
-          if destination_prefix &&
-              destination_prefix != ""
+          if destination_prefix && destination_prefix != ""
             destination_prefix + no_source_prefix
           else
             no_source_prefix

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

@@ -7,11 +7,9 @@ module Imap::Backup
     attr_reader :account_names
 
     def initialize(email = nil, options)
+      super([])
       @email = email
-      @account_names =
-        if options.key?(:accounts)
-          options[:accounts].split(",")
-        end
+      @account_names = options[:accounts].split(",") if options.key?(:accounts)
     end
 
     no_commands do
@@ -22,12 +20,15 @@ module Imap::Backup
           connection.restore
         when !email && !account_names
           Logger.logger.info "Calling restore without an EMAIL parameter is deprecated"
-          each_connection([]) { |connection| connection.restore }
+          each_connection([], &:restore)
         when email && account_names.any?
           raise "Pass either an email or the --accounts option, not both"
         when account_names.any?
-          Logger.logger.info "Calling restore with the --account option is deprected, please pass a single EMAIL argument"
-          each_connection(account_names) { |connection| connection.restore }
+          Logger.logger.info(
+            "Calling restore with the --account option is deprected, " \
+            "please pass a single EMAIL argument"
+          )
+          each_connection(account_names, &:restore)
         end
       end
     end

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

@@ -1,13 +1,15 @@
-class Imap::Backup::CLI::Setup < Thor
-  include Thor::Actions
+module Imap::Backup
+  class CLI::Setup < Thor
+    include Thor::Actions
 
-  def initialize
-    super([])
-  end
+    def initialize
+      super([])
+    end
 
-  no_commands do
-    def run
-      Imap::Backup::Setup.new.run
+    no_commands do
+      def run
+        Setup.new.run
+      end
     end
   end
 end