imap-backup 14.5.1 → 14.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff8bf4fdd37e57e1fd9cef8abc4485813eeb48752768a3f463df3afac3dc4d6
-  data.tar.gz: 831899f082fff0997acd46d1e341004ac43cf53a2883358e67ab095b88a26bf7
+  metadata.gz: 80b99aa3b4c713e6a88c9dbe504186fd64065a1d03d50d2d47a79de6ab14902f
+  data.tar.gz: c7a7d6f52b36819de9f660c488a8b4dfcf75794affa56547e197aab79c56cf7b
 SHA512:
-  metadata.gz: d826d98de67625935c73a0ae01f2896717428dc3357ba899f5edee47a8b458064c932eea98a7331b0c6678f233329ae71001d7038cfaf1dd22aa5ea5f19d723e
-  data.tar.gz: 9570a8070e6ab390c65dfb1a395a69f5b26aa501a777acb8e1cd58956adddd76b0c6e6bdd828b26f29c375ff671adcb31a91fdd85839be363d99179bea92bf9f
+  metadata.gz: 75e98d37c675dab0d44fe98f2689f3dd36cf30eb2968f3c6260268e733122fccf212b0e91024b4031bc2b8243011e240a8370c03681dca4b21e8a155262292f5
+  data.tar.gz: 46ca660ed4f2f87a3285db448b6e77e052df7628e512c57d7600876abca390b5e872529c76ef1f01b4ae35035d08a4941e24dd298d3db5850f44968ccbda25c2

data/lib/imap/backup/{cli/folder_enumerator.rb → account/folder_mapper.rb}

@@ -7,22 +7,22 @@ require "imap/backup/serializer"
 module Imap; end
 
 module Imap::Backup
-  class CLI < Thor; end
+  class Account; end
 
   # Implements a folder enumerator for backed-up accounts
-  class CLI::FolderEnumerator
+  class Account::FolderMapper
     def initialize(
+      account:,
       destination:,
-      source:,
       destination_delimiter: "/",
       destination_prefix: "",
       source_delimiter: "/",
       source_prefix: ""
     )
+      @account = account
       @destination = destination
       @destination_delimiter = destination_delimiter
       @destination_prefix = destination_prefix
-      @source = source
       @source_delimiter = source_delimiter
       @source_prefix = source_prefix
     end
@@ -48,7 +48,7 @@ module Imap::Backup
 
     attr_reader :destination
     attr_reader :destination_delimiter
-    attr_reader :source
+    attr_reader :account
     attr_reader :source_delimiter
 
     def destination_prefix_clipped
@@ -94,7 +94,7 @@ module Imap::Backup
     end
 
     def source_local_path
-      source.local_path
+      account.local_path
     end
 
     def source_folder_name(imap_pathname)

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

@@ -1,4 +1,4 @@
-require "imap/backup/account/serialized_folders"
+require "imap/backup/account/folder_mapper"
 require "imap/backup/uploader"
 
 module Imap; end
@@ -8,15 +8,16 @@ module Imap::Backup
 
   # Restores all backed up folders to the server
   class Account::Restore
-    def initialize(account:)
+    def initialize(account:, delimiter: "/", prefix: "")
       @account = account
+      @destination_delimiter = delimiter
+      @destination_prefix = prefix
     end
 
     # Runs the restore operation
     # @return [void]
     def run
-      serialized_folders = Account::SerializedFolders.new(account: account)
-      serialized_folders.each do |serializer, folder|
+      folders.each do |serializer, folder|
         Uploader.new(folder, serializer).run
       end
     end
@@ -24,5 +25,20 @@ module Imap::Backup
     private
 
     attr_reader :account
+    attr_reader :destination_delimiter
+    attr_reader :destination_prefix
+
+    def enumerator_options
+      {
+        account: account,
+        destination: account,
+        destination_delimiter: destination_delimiter,
+        destination_prefix: destination_prefix
+      }
+    end
+
+    def folders
+      Account::FolderMapper.new(**enumerator_options)
+    end
   end
 end

data/lib/imap/backup/account.rb

@@ -1,7 +1,6 @@
 require "json"
 
 require "imap/backup/account/client_factory"
-require "imap/backup/account/restore"
 
 module Imap; end
 
@@ -98,14 +97,6 @@ module Imap::Backup
       client.capability
     end
 
-    # Restore the local backup to the server
-    #
-    # @return [void]
-    def restore
-      restore = Account::Restore.new(account: self)
-      restore.run
-    end
-
     # Indicates whether the account has been configured, and is ready
     # to be used
     #

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

@@ -15,7 +15,7 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    desc "accounts", "List locally backed-up accounts"
+    desc "accounts [OPTIONS]", "List locally backed-up accounts"
     config_option
     format_option
     quiet_option
@@ -34,7 +34,7 @@ module Imap::Backup
     end
 
     desc(
-      "check",
+      "check [OPTIONS]",
       "Check the integrity of backups for all accounts (or the selected account(s))"
     )
     method_option(
@@ -54,7 +54,7 @@ module Imap::Backup
       Check.new(non_logging_options).run
     end
 
-    desc "folders EMAIL", "List backed up folders"
+    desc "folders EMAIL [OPTIONS]", "List backed up folders"
     config_option
     format_option
     quiet_option
@@ -76,7 +76,7 @@ module Imap::Backup
       end
     end
 
-    desc "list EMAIL FOLDER", "List emails in a folder"
+    desc "list EMAIL FOLDER [OPTIONS]", "List emails in a folder"
     config_option
     format_option
     quiet_option
@@ -101,7 +101,7 @@ module Imap::Backup
       end
     end
 
-    desc "show EMAIL FOLDER UID[,UID]", "Show one or more emails"
+    desc "show EMAIL FOLDER UID[,UID] [OPTIONS]", "Show one or more emails"
     long_desc <<~DESC
       Prints out the requested emails.
       If more than one UID is given, they are separated by a header indicating

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

@@ -13,7 +13,7 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    desc "folders EMAIL", "List account folders"
+    desc "folders EMAIL [OPTIONS]", "List account folders"
     config_option
     format_option
     quiet_option
@@ -31,7 +31,7 @@ module Imap::Backup
       end
     end
 
-    desc "capabilities EMAIL", "List server capabilities"
+    desc "capabilities EMAIL [OPTIONS]", "List server capabilities"
     long_desc <<~DESC
       Lists the IMAP capabilities supported by the IMAP server.
     DESC
@@ -49,7 +49,7 @@ module Imap::Backup
       Kernel.puts capabilities.join(", ")
     end
 
-    desc "namespaces EMAIL", "List account namespaces"
+    desc "namespaces EMAIL [OPTIONS]", "List account namespaces"
     long_desc <<~DESC
       Lists namespaces defined for an email account.
 

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

@@ -1,5 +1,6 @@
 require "thor"
 
+require "imap/backup/account/restore"
 require "imap/backup/cli/helpers"
 require "imap/backup/logger"
 
@@ -28,18 +29,18 @@ module Imap::Backup
         case
         when email && !options.key?(:accounts)
           account = account(config, email)
-          account.restore
+          restore(account, **restore_options)
         when !email && !options.key?(:accounts)
           Logger.logger.info "Calling restore without an EMAIL parameter is deprecated"
-          config.accounts.map(&:restore)
+          config.accounts.each { |a| restore(a) }
         when email && options.key?(:accounts)
           raise "Missing EMAIL parameter"
         when !email && options.key?(:accounts)
           Logger.logger.info(
-            "Calling restore with the --account option is deprected, " \
+            "Calling restore with the --account option is deprecated, " \
             "please pass a single EMAIL parameter"
           )
-          requested_accounts(config).each(&:restore)
+          requested_accounts(config).each { |a| restore(a) }
         end
       end
     end
@@ -48,5 +49,14 @@ module Imap::Backup
 
     attr_reader :email
     attr_reader :options
+
+    def restore(account, **options)
+      restore = Account::Restore.new(account: account, **options)
+      restore.run
+    end
+
+    def restore_options
+      options.slice(:delimiter, :prefix)
+    end
   end
 end

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

@@ -14,7 +14,7 @@ module Imap::Backup
   class CLI::Single < Thor
     include CLI::Helpers
 
-    desc "backup", "Backup a single email account based on command-line parameters"
+    desc "backup [OPTIONS]", "Backup a single email account based on command-line parameters"
     long_desc <<~DESC
       This is a "stand-alone" backup command that doesn't require
       a configuration file.
@@ -104,9 +104,12 @@ module Imap::Backup
       "path",
       type: "string",
       desc: "the path of the directory where backups are to be saved. " \
-            "If the directory does not exists, it will be created. " \
+            "If the directory does not exist, it will be created. " \
             "If not set, this is set to a diretory under the current path " \
-            "which is derived from the username, by replacing '@' with '_'.",
+            "which is derived from the username, by replacing '@' with '_'." \
+            "If this path parameter is not indicated, " \
+            "the default is the current directory plus the email " \
+            "with '@' replaced by '_'.",
       aliases: ["-P"]
     )
     method_option(

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

@@ -1,6 +1,6 @@
+require "imap/backup/account/folder_mapper"
 require "imap/backup/cli/backup"
 require "imap/backup/cli/helpers"
-require "imap/backup/cli/folder_enumerator"
 require "imap/backup/logger"
 require "imap/backup/migrator"
 require "imap/backup/mirror"
@@ -9,15 +9,13 @@ module Imap; end
 
 module Imap::Backup
   # Implements migration and mirroring
-  class CLI::Transfer < Thor
-    include Thor::Actions
+  class CLI::Transfer
     include CLI::Helpers
 
-    # The possible vaues for the action parameter
+    # The possible values for the action parameter
     ACTIONS = %i(migrate mirror).freeze
 
     def initialize(action, source_email, destination_email, options)
-      super([])
       @action = action
       @source_email = source_email
       @destination_email = destination_email
@@ -35,22 +33,20 @@ module Imap::Backup
     #   @raise [RuntimeError] if the indicated action is unknown,
     #     or the source and destination accounts are the same,
     #     or either of the accounts is not configured,
-    #     or incompatible namespace/delimter parameters have been supplied
+    #     or incompatible namespace/delimiter parameters have been supplied
     #   @return [void]
-    no_commands do
-      def run
-        raise "Unknown action '#{action}'" if !ACTIONS.include?(action)
-
-        process_options!
-        prepare_mirror if action == :mirror
-
-        folders.each do |serializer, folder|
-          case action
-          when :migrate
-            Migrator.new(serializer, folder, reset: reset).run
-          when :mirror
-            Mirror.new(serializer, folder).run
-          end
+    def run
+      raise "Unknown action '#{action}'" if !ACTIONS.include?(action)
+
+      process_options!
+      prepare_mirror if action == :mirror
+
+      folders.each do |serializer, folder|
+        case action
+        when :migrate
+          Migrator.new(serializer, folder, reset: reset).run
+        when :mirror
+          Mirror.new(serializer, folder).run
         end
       end
     end
@@ -148,17 +144,17 @@ module Imap::Backup
 
     def enumerator_options
       {
+        account: source_account,
         destination: destination_account,
         destination_delimiter: destination_delimiter,
         destination_prefix: destination_prefix,
-        source: source_account,
         source_delimiter: source_delimiter,
         source_prefix: source_prefix
       }
     end
 
     def folders
-      CLI::FolderEnumerator.new(**enumerator_options)
+      Account::FolderMapper.new(**enumerator_options)
     end
 
     def destination_account

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

@@ -18,7 +18,10 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    desc "ignore-history EMAIL", "Skip downloading emails up to today for all configured folders"
+    desc(
+      "ignore-history EMAIL [OPTIONS]",
+      "Skip downloading emails up to today for all configured folders"
+    )
     config_option
     quiet_option
     verbose_option

data/lib/imap/backup/cli.rb

@@ -30,7 +30,7 @@ module Imap::Backup
       In these cases there are two choices.
 
       You can use the `--automatic-namespaces` option.
-      This wil query the source and detination servers for their
+      This will query the source and detination servers for their
       namespace configuration and will adapt paths accordingly.
       This option requires that both the source and destination
       servers are available and work with the provided parameters
@@ -220,7 +220,7 @@ module Imap::Backup
     desc "remote SUBCOMMAND [OPTIONS]", "View info about online accounts"
     subcommand "remote", Remote
 
-    desc "restore EMAIL", "Restores a single account"
+    desc "restore EMAIL [OPTIONS]", "Restores a single account"
     long_desc <<~DESC
       Restores all backed-up emails for the supplied account to
       their original server.
@@ -229,14 +229,25 @@ module Imap::Backup
     config_option
     quiet_option
     verbose_option
-    # Restores backed up meails to an account
+    method_option(
+      "delimiter",
+      type: :string,
+      desc: "the delimiter for folder names"
+    )
+    method_option(
+      "prefix",
+      type: :string,
+      desc: "a prefix (namespace) to add to folder names",
+      aliases: ["-d"]
+    )
+    # Restores backed up emails to an account
     # @return [void]
     def restore(email = nil)
       non_logging_options = Imap::Backup::Logger.setup_logging(options)
       Restore.new(email, non_logging_options).run
     end
 
-    desc "setup", "Configure imap-backup"
+    desc "setup [OPTIONS]", "Configure imap-backup"
     long_desc <<~DESC
       A menu-driven command-line application used to configure imap-backup.
       Configure email accounts to back up.

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

@@ -8,6 +8,8 @@ require "imap/backup/serializer/transaction"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Wraps the Serializer, delaying metadata appends
   class Serializer::DelayedMetadataSerializer
     extend Forwardable

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

@@ -7,6 +7,8 @@ require "imap/backup/serializer/transaction"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Stores message metadata
   class Serializer::Imap
     # The version number to store in the metadata file

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

@@ -3,6 +3,8 @@ require "imap/backup/serializer/transaction"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Stores messages
   class Serializer::Mbox
     # @return [String] The path of the mailbox file, without the '.mbox' extension

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

@@ -5,6 +5,8 @@ require "imap/backup/email/mboxrd/message"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Represents a stored message
   class Serializer::Message
     # @return [Array[Symbol]] the message's flags

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

@@ -1,6 +1,8 @@
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Enumerates over a list of stores messages
   class Serializer::MessageEnumerator
     # @param imap [Serializer::Imap] the metadata serializer for the folder

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

@@ -3,6 +3,8 @@ require "imap/backup/file_mode"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Ensures a file has the desired permissions
   class Serializer::PermissionChecker
     # @param filename [String] the file name

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

@@ -1,6 +1,8 @@
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Stores data during a transaction
   class Serializer::Transaction
     # @return the transaction's stored data

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

@@ -3,6 +3,8 @@ require "imap/backup/serializer"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Finds a name that can be used to rename a serialized folder
   class Serializer::UnusedNameFinder
     # @param serializer [Serializer] a folder serializer

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

@@ -5,6 +5,8 @@ require "imap/backup/serializer/imap"
 module Imap; end
 
 module Imap::Backup
+  class Serializer; end
+
   # Migrates serialized folder metadata from the version 2 format to the version 3 format
   class Serializer::Version2Migrator
     # @param folder_path [String] the base pathv(without extension) of the folder backup

data/lib/imap/backup/serializer.rb

@@ -102,8 +102,10 @@ module Imap::Backup
         @validated = true
         return true
       end
-      Logger.logger.info("Metadata file '#{imap.pathname}' is invalid") if !imap_valid
-      Logger.logger.info("Mailbox '#{mbox.pathname}' is invalid") if !mbox_valid
+      warn_imap = !imap_valid && imap.exist?
+      Logger.logger.info("Metadata file '#{imap.pathname}' is invalid") if warn_imap
+      warn_mbox = !mbox_valid && mbox.exist?
+      Logger.logger.info("Mailbox '#{mbox.pathname}' is invalid") if warn_mbox
 
       delete
 

data/lib/imap/backup/version.rb

@@ -4,9 +4,9 @@ module Imap::Backup
   # @private
   MAJOR    = 14
   # @private
-  MINOR    = 5
+  MINOR    = 6
   # @private
-  REVISION = 1
+  REVISION = 0
   # @private
   PRE      = nil
   # The application version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 14.5.1
+  version: 14.6.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -144,12 +144,12 @@ files:
 - lib/imap/backup/account/folder.rb
 - lib/imap/backup/account/folder_backup.rb
 - lib/imap/backup/account/folder_ensurer.rb
+- lib/imap/backup/account/folder_mapper.rb
 - lib/imap/backup/account/local_only_folder_deleter.rb
 - lib/imap/backup/account/restore.rb
 - lib/imap/backup/account/serialized_folders.rb
 - lib/imap/backup/cli.rb
 - lib/imap/backup/cli/backup.rb
-- lib/imap/backup/cli/folder_enumerator.rb
 - lib/imap/backup/cli/helpers.rb
 - lib/imap/backup/cli/local.rb
 - lib/imap/backup/cli/local/check.rb
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk