imap-backup 7.0.2 → 8.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb709e6431c47afc24c55d39ef7d9213fc0c27b42929c0692843a254cfd83c1d
-  data.tar.gz: 702d93af210afa826e64c0b5b1a4d1e16780c6078201e4a8db13dd4703ac62d3
+  metadata.gz: 6f852c0552212ba77c4e4dda834b8727860a788ea73ecf395255c248b9f728e4
+  data.tar.gz: 1a33b9e2efd04d4e9dcd4e48b401d7001330de8950477947aa4547d15c9554e8
 SHA512:
-  metadata.gz: 04a0c173fea0dd80e87443db040383402eb9eacbc7f557b4db8339cfd16c20153b068da8f4ade84d82643e3e9d3b9a76f04d654cbbc931620ef197546b24492a
-  data.tar.gz: e3cb1c12f73c421a66e41016b826ecdf3d199fd5920f9e5cbb04e0ef41619984791c8ce436283a91e6264707b04db7ecef94703f5df9af4c64cbcbb75c0fd7d7
+  metadata.gz: 10ec5bf1f6426652d8b1875e1dbc4150ac7191aea988fbe2235d9966cb3394df1a6353d541f1de0c65a13c15a3b01d3502d4c36634427831244f2996a80d5bf6
+  data.tar.gz: eba30293362b4bc0c79e3a389cf56d3d218addec339fbc802aa245df8ef8f6f0f7b0588f6ee7ec1b5def04dbdddff39bea91370718d0dab0026cf2189474e82d

data/README.md

@@ -80,7 +80,6 @@ Alternatively, add it to your crontab.
 * [remote folders](docs/commands/remote-folders.md)
 * [restore](docs/commands/restore.md)
 * [setup](docs/commands/setup.md)
-* [status](docs/commands/status.md)
 * [utils export-to-thunderbird](docs/commands/utils-export-to-thunderbird.md)
 * [utils ignore-history](docs/commands/utils-ignore-history.md)
 

data/docs/configuration.md

@@ -1,6 +1,6 @@
 Configuration is stored in a JSON file.
 
-The format is documented [here](./docs/files/config.json).
+The format is documented [here](files/config.md).
 
 # Folders
 
@@ -11,6 +11,8 @@ specific folders.
 
 You can override the parameters passed to `Net::IMAP` with `connection_options`.
 
+See the Ruby Standard Library documentation for `Net::IMAP` of details of [supported parameters](https://ruby-doc.org/stdlib-3.1.2/libdoc/net-imap/rdoc/Net/IMAP.html#method-c-new).
+
 Specifically, if you are using a self-signed certificate and get SSL errors, e.g.
 `certificate verify failed`, you can choose to not verify the TLS connection.
 

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

@@ -27,14 +27,6 @@ module Imap::Backup
         Account::Connection::BackupFolders.new(client: client, account: account).run
     end
 
-    def status
-      ensure_account_folder
-      backup_folders.map do |folder|
-        s = Serializer.new(account.local_path, folder.name)
-        {name: folder.name, local: s.uids, remote: folder.uids}
-      end
-    end
-
     def run_backup(refresh: false)
       Logger.logger.info "Running backup of account: #{account.username}"
       # start the connection so we get logging messages in the right order

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

@@ -3,21 +3,28 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    attr_reader :account_names
-    attr_reader :refresh
+    attr_reader :options
 
     def initialize(options)
       super([])
-      @account_names = (options[:accounts] || "").split(",")
-      @refresh = options.key?(:refresh) ? !!options[:refresh] : false
+      @options = options
     end
 
     no_commands do
       def run
-        each_connection(account_names) do |connection|
+        config = load_config(**options)
+        each_connection(config, emails) do |connection|
           connection.run_backup(refresh: refresh)
         end
       end
+
+      def emails
+        (options[:accounts] || "").split(",")
+      end
+
+      def refresh
+        options.key?(:refresh) ? !!options[:refresh] : false
+      end
     end
   end
 end

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

@@ -3,16 +3,18 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    attr_reader :account_names
+    attr_reader :emails
+    attr_reader :options
 
     def initialize(options)
       super([])
-      @account_names = (options[:accounts] || "").split(",")
+      @options = options
     end
 
     no_commands do
       def run
-        each_connection(account_names) do |connection|
+        config = load_config(**options)
+        each_connection(config, emails) do |connection|
           Kernel.puts connection.account.username
           # TODO: Make folder_names private once this command
           # has been removed.
@@ -24,6 +26,10 @@ module Imap::Backup
           folders.each { |f| Kernel.puts "\t#{f}" }
         end
       end
+
+      def emails
+        (options[:accounts] || "").split(",")
+      end
     end
   end
 end

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

@@ -1,10 +1,18 @@
 require "imap/backup"
-require "imap/backup/cli/accounts"
 
 module Imap::Backup
   module CLI::Helpers
     def self.included(base)
       base.class_eval do
+        def self.config_option
+          method_option(
+            "config",
+            type: :string,
+            desc: "supply the configuration file path (default: ~/.imap-backup/config.json)",
+            aliases: ["-c"]
+          )
+        end
+
         def self.verbose_option
           method_option(
             "verbose",
@@ -25,31 +33,49 @@ module Imap::Backup
       end
     end
 
+    def load_config(**options)
+      opts = symbolized(options)
+      path = opts[:config]
+      require_exists = opts.key?(:require_exists) ? opts[:require_exists] : true
+      if require_exists
+        exists = Configuration.exist?(path: path)
+        if !exists
+          expected = path || Configuration.default_pathname
+          raise ConfigurationNotFound, "Configuration file '#{expected}' not found"
+        end
+      end
+      Configuration.new(path: path)
+    end
+
     def symbolized(options)
       options.each.with_object({}) do |(k, v), acc|
-        key = k.gsub("-", "_").intern
+        key =
+          if k.is_a?(String)
+            k.gsub("-", "_").intern
+          else
+            k
+          end
         acc[key] = v
       end
     end
 
-    def account(email)
-      accounts = CLI::Accounts.new
-      account = accounts.find { |a| a.username == email }
+    def account(config, email)
+      account = config.accounts.find { |a| a.username == email }
       raise "#{email} is not a configured account" if !account
 
       account
     end
 
-    def connection(email)
-      account = account(email)
+    def connection(config, email)
+      account = account(config, email)
 
       Account::Connection.new(account)
     end
 
-    def each_connection(names)
-      accounts = CLI::Accounts.new(names)
+    def each_connection(config, names)
+      config.accounts.each do |account|
+        next if names.any? && !names.include?(account.username)
 
-      accounts.each do |account|
         yield account.connection
       end
     rescue ConfigurationNotFound

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

@@ -1,5 +1,3 @@
-require "imap/backup/cli/accounts"
-
 module Imap::Backup
   class CLI::Local < Thor
     include Thor::Actions
@@ -8,14 +6,17 @@ module Imap::Backup
     MAX_SUBJECT = 60
 
     desc "accounts", "List locally backed-up accounts"
+    config_option
     def accounts
-      accounts = CLI::Accounts.new
-      accounts.each { |a| Kernel.puts a.username }
+      config = load_config(**symbolized(options))
+      config.accounts.each { |a| Kernel.puts a.username }
     end
 
     desc "folders EMAIL", "List backed up folders"
+    config_option
     def folders(email)
-      connection = connection(email)
+      config = load_config(**symbolized(options))
+      connection = connection(config, email)
 
       connection.local_folders.each do |_s, f|
         Kernel.puts %("#{f.name}")
@@ -23,8 +24,10 @@ module Imap::Backup
     end
 
     desc "list EMAIL FOLDER", "List emails in a folder"
+    config_option
     def list(email, folder_name)
-      connection = connection(email)
+      config = load_config(**symbolized(options))
+      connection = connection(config, email)
 
       folder_serializer, _folder = connection.local_folders.find do |(_s, f)|
         f.name == folder_name
@@ -50,8 +53,10 @@ module Imap::Backup
       If more than one UID is given, they are separated by a header indicating
       the UID.
     DESC
+    config_option
     def show(email, folder_name, uids)
-      connection = connection(email)
+      config = load_config(**symbolized(options))
+      connection = connection(config, email)
 
       folder_serializer, _folder = connection.local_folders.find do |(_s, f)|
         f.name == folder_name

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

@@ -3,9 +3,11 @@ require "imap/backup/migrator"
 module Imap::Backup
   class CLI::Migrate < Thor
     include Thor::Actions
+    include CLI::Helpers
 
     attr_reader :destination_email
     attr_reader :destination_prefix
+    attr_reader :config_path
     attr_reader :reset
     attr_reader :source_email
     attr_reader :source_prefix
@@ -13,6 +15,7 @@ module Imap::Backup
     def initialize(
       source_email,
       destination_email,
+      config: nil,
       destination_prefix: "",
       reset: false,
       source_prefix: ""
@@ -20,6 +23,7 @@ module Imap::Backup
       super([])
       @destination_email = destination_email
       @destination_prefix = destination_prefix
+      @config_path = config
       @reset = reset
       @source_email = source_email
       @source_prefix = source_prefix
@@ -44,7 +48,7 @@ module Imap::Backup
       end
 
       def config
-        Configuration.new
+        @config ||= load_config(config: config_path)
       end
 
       def destination_account

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

@@ -3,21 +3,25 @@ require "imap/backup/mirror"
 module Imap::Backup
   class CLI::Mirror < Thor
     include Thor::Actions
+    include CLI::Helpers
 
     attr_reader :destination_email
     attr_reader :destination_prefix
+    attr_reader :config_path
     attr_reader :source_email
     attr_reader :source_prefix
 
     def initialize(
       source_email,
       destination_email,
+      config: nil,
       destination_prefix: "",
       source_prefix: ""
     )
       super([])
       @destination_email = destination_email
       @destination_prefix = destination_prefix
+      @config_path = config
       @source_email = source_email
       @source_prefix = source_prefix
     end
@@ -27,7 +31,7 @@ module Imap::Backup
         check_accounts!
         warn_if_source_account_is_not_in_mirror_mode
 
-        CLI::Backup.new(accounts: source_email).run
+        CLI::Backup.new(config: config_path, accounts: source_email).run
 
         folders.each do |serializer, folder|
           Mirror.new(serializer, folder).run
@@ -54,7 +58,7 @@ module Imap::Backup
       end
 
       def config
-        Configuration.new
+        @config = load_config(config: config_path)
       end
 
       def destination_account

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

@@ -4,8 +4,12 @@ module Imap::Backup
     include CLI::Helpers
 
     desc "folders EMAIL", "List account folders"
+    config_option
+    verbose_option
+    quiet_option
     def folders(email)
-      connection = connection(email)
+      config = load_config(**symbolized(options))
+      connection = connection(config, email)
 
       connection.folder_names.each do |name|
         Kernel.puts %("#{name}")

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

@@ -4,33 +4,38 @@ module Imap::Backup
     include CLI::Helpers
 
     attr_reader :email
-    attr_reader :account_names
+    attr_reader :options
 
     def initialize(email = nil, options)
       super([])
       @email = email
-      @account_names = options[:accounts].split(",") if options.key?(:accounts)
+      @options = options
     end
 
     no_commands do
       def run
+        config = load_config(**options)
         case
-        when email && !account_names
-          connection = connection(email)
+        when email && !emails
+          connection = connection(config, email)
           connection.restore
-        when !email && !account_names
+        when !email && !emails
           Logger.logger.info "Calling restore without an EMAIL parameter is deprecated"
-          each_connection([], &:restore)
-        when email && account_names.any?
+          each_connection(config, [], &:restore)
+        when email && emails.any?
           raise "Pass either an email or the --accounts option, not both"
-        when account_names.any?
+        when emails.any?
           Logger.logger.info(
             "Calling restore with the --account option is deprected, " \
             "please pass a single EMAIL argument"
           )
-          each_connection(account_names, &:restore)
+          each_connection(config, emails, &:restore)
         end
       end
+
+      def emails
+        @emails ||= options[:accounts].split(",") if options.key?(:accounts)
+      end
     end
   end
 end

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

@@ -1,14 +1,19 @@
 module Imap::Backup
   class CLI::Setup < Thor
     include Thor::Actions
+    include CLI::Helpers
 
-    def initialize
+    attr_reader :options
+
+    def initialize(options)
       super([])
+      @options = options
     end
 
     no_commands do
       def run
-        Setup.new.run
+        config = load_config(**options, require_exists: false)
+        Setup.new(config: config).run
       end
     end
   end

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

@@ -14,7 +14,7 @@ module Imap::Backup
     attr_reader :email
     attr_reader :options
 
-    def initialize(email, options = {})
+    def initialize(email, options)
       super([])
       @email = email
       @options = options
@@ -31,7 +31,8 @@ module Imap::Backup
       end
 
       def stats
-        connection = connection(email)
+        config = load_config(**options)
+        connection = connection(config, email)
 
         connection.backup_folders.map do |folder|
           next if !folder.exist?

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

@@ -11,8 +11,10 @@ module Imap::Backup
     verbose_option
     quiet_option
     def ignore_history(email)
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      connection = connection(email)
+      opts = symbolized(options)
+      Imap::Backup::Logger.setup_logging opts
+      config = load_config(**opts)
+      connection = connection(config, email)
 
       connection.backup_folders.each do |folder|
         next if !folder.exist?
@@ -49,7 +51,8 @@ module Imap::Backup
       force = opts.key?(:force) ? opts[:force] : false
       profile_name = opts[:profile]
 
-      connection = connection(email)
+      config = load_config(**opts)
+      connection = connection(config, email)
       profile = thunderbird_profile(profile_name)
 
       if !profile

data/lib/imap/backup/cli.rb

@@ -16,7 +16,6 @@ module Imap::Backup
     autoload :Restore, "imap/backup/cli/restore"
     autoload :Setup, "imap/backup/cli/setup"
     autoload :Stats, "imap/backup/cli/stats"
-    autoload :Status, "imap/backup/cli/status"
     autoload :Utils, "imap/backup/cli/utils"
 
     include Helpers
@@ -45,6 +44,7 @@ module Imap::Backup
       The setup tool can be used to choose a specific list of folders to back up.
     DESC
     accounts_option
+    config_option
     verbose_option
     quiet_option
     method_option(
@@ -66,6 +66,7 @@ module Imap::Backup
       and `imap-backup remote folders ACCOUNT` to get the folder list.
     DESC
     accounts_option
+    config_option
     def folders
       Folders.new(symbolized(options)).run
     end
@@ -96,6 +97,7 @@ module Imap::Backup
       use the `--reset` option. In this case, all existing emails are
       deleted before uploading the migrated emails.
     DESC
+    config_option
     verbose_option
     quiet_option
     method_option(
@@ -141,6 +143,7 @@ module Imap::Backup
       This file has a '.mirror' extension. This file contains a mapping of
       the known UIDs on the source account to those on the destination account.
     DESC
+    config_option
     verbose_option
     quiet_option
     method_option(
@@ -169,6 +172,7 @@ module Imap::Backup
       their original server.
     DESC
     accounts_option
+    config_option
     verbose_option
     quiet_option
     def restore(email = nil)
@@ -181,11 +185,12 @@ module Imap::Backup
       A menu-driven command-line application used to configure imap-backup.
       Configure email accounts to back up.
     DESC
+    config_option
     verbose_option
     quiet_option
     def setup
       Imap::Backup::Logger.setup_logging symbolized(options)
-      Setup.new.run
+      Setup.new(symbolized(options)).run
     end
 
     desc "stats EMAIL [OPTIONS]", "Print stats for each account folder"
@@ -194,6 +199,9 @@ module Imap::Backup
       are downloaded (exist on server and locally) "both" and those which
       are only present in the backup (as they have been deleted on the server) "local".
     DESC
+    config_option
+    verbose_option
+    quiet_option
     method_option(
       "format",
       type: :string,
@@ -201,19 +209,10 @@ module Imap::Backup
       aliases: ["-f"]
     )
     def stats(email)
+      Imap::Backup::Logger.setup_logging symbolized(options)
       Stats.new(email, symbolized(options)).run
     end
 
-    desc "status", "This command is deprecated, use `imap-backup stats ACCOUNT`"
-    long_desc <<~DESC
-      For each configured account and folder, lists the number of emails yet to be downloaded.
-      This command is deprecated.
-    DESC
-    accounts_option
-    def status
-      Status.new(symbolized(options)).run
-    end
-
     desc "utils SUBCOMMAND [OPTIONS]", "Various utilities"
     subcommand "utils", Utils
   end

data/lib/imap/backup/configuration.rb

@@ -14,12 +14,12 @@ module Imap::Backup
       File.join(CONFIGURATION_DIRECTORY, "config.json")
     end
 
-    def self.exist?(pathname = default_pathname)
-      File.exist?(pathname)
+    def self.exist?(path: nil)
+      File.exist?(path || default_pathname)
     end
 
-    def initialize(pathname = self.class.default_pathname)
-      @pathname = pathname
+    def initialize(path: nil)
+      @pathname = path || self.class.default_pathname
     end
 
     def path

data/lib/imap/backup/setup.rb

@@ -11,6 +11,12 @@ module Imap::Backup
     end
     self.highline = HighLine.new
 
+    attr_accessor :config
+
+    def initialize(config:)
+      @config = config
+    end
+
     def run
       catch :done do
         loop do
@@ -62,10 +68,6 @@ module Imap::Backup
       end
     end
 
-    def config
-      @config ||= Configuration.new
-    end
-
     def default_account_config(username)
       Imap::Backup::Account.new(
         username: username,

data/lib/imap/backup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 7.0.2
+  version: 8.0.0.rc1
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -239,7 +239,6 @@ files:
 - lib/imap/backup/account/connection/folder_names.rb
 - lib/imap/backup/account/folder.rb
 - lib/imap/backup/cli.rb
-- lib/imap/backup/cli/accounts.rb
 - lib/imap/backup/cli/backup.rb
 - lib/imap/backup/cli/folders.rb
 - lib/imap/backup/cli/helpers.rb
@@ -250,7 +249,6 @@ files:
 - lib/imap/backup/cli/restore.rb
 - lib/imap/backup/cli/setup.rb
 - lib/imap/backup/cli/stats.rb
-- lib/imap/backup/cli/status.rb
 - lib/imap/backup/cli/utils.rb
 - lib/imap/backup/client/apple_mail.rb
 - lib/imap/backup/client/default.rb
@@ -302,9 +300,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key:

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

@@ -1,43 +0,0 @@
-module Imap::Backup
-  class CLI; end
-
-  class CLI::Accounts
-    include Enumerable
-
-    attr_reader :required_accounts
-
-    def initialize(required_accounts = [])
-      @required_accounts = required_accounts
-    end
-
-    def each(&block)
-      return enum_for(:each) if !block
-
-      accounts.each(&block)
-    end
-
-    private
-
-    def accounts
-      @accounts ||=
-        if required_accounts.empty?
-          config.accounts
-        else
-          config.accounts.select do |account|
-            required_accounts.include?(account.username)
-          end
-        end
-    end
-
-    def config
-      @config ||= begin
-        exists = Configuration.exist?
-        if !exists
-          path = Configuration.default_pathname
-          raise ConfigurationNotFound, "Configuration file '#{path}' not found"
-        end
-        Configuration.new
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-module Imap::Backup
-  class CLI::Status < Thor
-    include Thor::Actions
-    include CLI::Helpers
-
-    attr_reader :account_names
-
-    def initialize(options)
-      super([])
-      @account_names = (options[:accounts] || "").split(",")
-    end
-
-    no_commands do
-      def run
-        each_connection(account_names) do |connection|
-          Kernel.puts connection.account.username
-          folders = connection.status
-          folders.each do |f|
-            missing_locally = f[:remote] - f[:local]
-            Kernel.puts "#{f[:name]}: #{missing_locally.size}"
-          end
-        end
-      end
-    end
-  end
-end