imap-backup 13.0.0 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff649779fd21a8a5ab2216b21618da22930c171dbe49fd2cf3aada02e3f2f18b
-  data.tar.gz: 7e0ac7d099b71a9404d183cbae3b43b0100ab81c80e69a0485447f7c392b3317
+  metadata.gz: 6ef98e7550571026f402c2fa7c82b37707be3c79ee23bd190dd091d234e9c9e7
+  data.tar.gz: f2f7508af8f492cfd19972ba11e3ca651bc417f69b43dd5f78d511500f5373af
 SHA512:
-  metadata.gz: 8846edccdd5e391d8740533a0a8f1b74b023ed181765e8ff8da4bf7782066b7186449ddf96a765d0a92ced194bf7e5b5f37c30ec2f1ddcab157e1a4b493d53e7
-  data.tar.gz: 064fd1b42bfabfddf9abfe740a21d9f6f5247eb7d58605becaf25a01f2657ea623b37063ca4567715daff684231995e7bd9fde2e5ed72fe68b5e124f3c165787
+  metadata.gz: 7d6bb21bffea6ac0c7dc70c073700fe532d3fe5492ad9fd54f668070b682b17e958c152f07e91807a3c5f6aa8e354c7cdb0ca188cd2398bccc16951b421d4ea0
+  data.tar.gz: 2a1f679f55a047626cb85b2bd8b3b69cadbce20426af6ad278fab2f24758e379276575dc0149265b7783804da18f433731672cbaf34e0bf7c52ee38fa26a258e

data/README.md

@@ -7,6 +7,15 @@
 
 Backup, restore and migrate email accounts.
 
+# Quick Start
+
+```sh
+brew install imap-backup # for macOS
+gem install imap-backup # for Linux
+imap-backup setup
+imap-backup
+```
+
 # Modes
 
 There are two types of backups:
@@ -57,7 +66,9 @@ imap-backup setup
 
 ## GMail
 
-To use imap-backup with GMail, you will need to enable 'App passwords' on your account.
+To use imap-backup with GMail, Office 365 and other services that require
+OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy)
+to handle authentication, and then connect to the proxy on a local port.
 
 # Backup
 

data/lib/cli_coverage.rb

@@ -2,10 +2,9 @@ class CliCoverage
   def self.conditionally_activate
     return if !ENV.key?("COVERAGE")
 
-    require "simplecov"
-
     # Collect coverage separately
-    SimpleCov.command_name "#{ENV.fetch('COVERAGE')} #{ARGV.join(' ')} coverage"
+    ENV["SIMPLECOV_COMMAND_NAME"] = "#{ENV.fetch('COVERAGE')} #{ARGV.join(' ')} coverage"
+    require "simplecov"
 
     # Silence output
     SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter

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

@@ -1,3 +1,5 @@
+require "imap/backup/account/folder"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -137,7 +137,7 @@ module Imap::Backup
     def unseen(uids)
       messages = uids.map(&:to_s).join(",")
       examine
-      client.uid_search([messages, "UNSEEN"])
+      client.uid_search(["UID", messages, "UNSEEN"])
     rescue NoMethodError
       # Apple Mail returns an empty response when searches have no results
       []

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

@@ -2,6 +2,8 @@ require "imap/backup/serializer/delayed_metadata_serializer"
 require "imap/backup/downloader"
 require "imap/backup/flag_refresher"
 require "imap/backup/local_only_message_deleter"
+require "imap/backup/logger"
+require "imap/backup/serializer"
 
 module Imap; end
 

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

@@ -1,4 +1,5 @@
 require "imap/backup/account/serialized_folders"
+require "imap/backup/uploader"
 
 module Imap; end
 

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

@@ -1,4 +1,8 @@
+require "pathname"
+
+require "imap/backup/account/folder"
 require "imap/backup/account/folder_ensurer"
+require "imap/backup/serializer"
 
 module Imap; end
 

data/lib/imap/backup/account.rb

@@ -1,3 +1,5 @@
+require "json"
+
 require "imap/backup/account/client_factory"
 require "imap/backup/account/restore"
 

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

@@ -1,9 +1,15 @@
 require "net/imap"
+require "thor"
+
 require "imap/backup/account/backup"
+require "imap/backup/cli/helpers"
+require "imap/backup/logger"
 
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::Backup < Thor
     include Thor::Actions
     include CLI::Helpers

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

@@ -1,6 +1,14 @@
+require "thor"
+require "pathname"
+
+require "imap/backup/account/folder"
+require "imap/backup/serializer"
+
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::FolderEnumerator
     attr_reader :destination
     attr_reader :destination_delimiter

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

@@ -1,8 +1,12 @@
-require "imap/backup"
+require "thor"
+
+require "imap/backup/configuration"
 
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   module CLI::Helpers
     def self.included(base)
       base.class_eval do

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

@@ -1,3 +1,9 @@
+require "thor"
+
+require "imap/backup/account/serialized_folders"
+require "imap/backup/cli/helpers"
+require "imap/backup/serializer/integrity_checker"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -1,9 +1,14 @@
+require "thor"
+
 require "imap/backup/account/serialized_folders"
+require "imap/backup/cli/helpers"
 require "imap/backup/cli/local/check"
 
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::Local < Thor
     include Thor::Actions
     include CLI::Helpers

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

@@ -1,8 +1,13 @@
+require "thor"
+
+require "imap/backup/cli/helpers"
 require "imap/backup/logger"
 
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::Remote < Thor
     include Thor::Actions
     include CLI::Helpers

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

@@ -1,6 +1,12 @@
+require "thor"
+
+require "imap/backup/cli/helpers"
+
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::Restore < Thor
     include Thor::Actions
     include CLI::Helpers

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

@@ -1,6 +1,13 @@
+require "thor"
+
+require "imap/backup/cli/helpers"
+require "imap/backup/setup"
+
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::Setup < Thor
     include Thor::Actions
     include CLI::Helpers

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

@@ -1,4 +1,5 @@
 require "imap/backup/account/backup_folders"
+require "imap/backup/serializer"
 
 module Imap; end
 

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

@@ -1,6 +1,7 @@
 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"
 

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

@@ -1,10 +1,18 @@
+require "thor"
+require "thunderbird/profiles"
+
 require "imap/backup/account/backup_folders"
 require "imap/backup/account/serialized_folders"
+require "imap/backup/cli/helpers"
+require "imap/backup/logger"
+require "imap/backup/serializer"
 require "imap/backup/thunderbird/mailbox_exporter"
 
 module Imap; end
 
 module Imap::Backup
+  class CLI < Thor; end
+
   class CLI::Utils < Thor
     include Thor::Actions
     include CLI::Helpers

data/lib/imap/backup/cli.rb

@@ -1,4 +1,5 @@
 require "thor"
+
 require "imap/backup/logger"
 
 module Imap; end
@@ -8,7 +9,6 @@ module Imap::Backup
     require "imap/backup/cli/helpers"
 
     autoload :Backup, "imap/backup/cli/backup"
-    autoload :Folders, "imap/backup/cli/folders"
     autoload :Local, "imap/backup/cli/local"
     autoload :Remote, "imap/backup/cli/remote"
     autoload :Restore, "imap/backup/cli/restore"
@@ -234,7 +234,7 @@ module Imap::Backup
     verbose_option
     def setup
       non_logging_options = Imap::Backup::Logger.setup_logging(options)
-      Setup.new(non_logging_options).run
+      CLI::Setup.new(non_logging_options).run
     end
 
     desc "stats EMAIL [OPTIONS]", "Print stats for each account folder"

data/lib/imap/backup/client/default.rb

@@ -1,6 +1,8 @@
 require "forwardable"
 require "net/imap"
 
+require "imap/backup/logger"
+
 module Imap; end
 
 module Imap::Backup

data/lib/imap/backup/configuration_not_found.rb

@@ -0,0 +1,5 @@
+module Imap; end
+
+module Imap::Backup
+  class ConfigurationNotFound < StandardError; end
+end

data/lib/imap/backup/logger.rb

@@ -1,7 +1,6 @@
 require "logger"
 require "singleton"
 
-require "imap/backup/configuration"
 require "text/sanitizer"
 
 module Imap; end

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

@@ -1,3 +1,5 @@
+require "json"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -1,3 +1,5 @@
+require "email/mboxrd/message"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -1,3 +1,4 @@
+require "email/mboxrd/message"
 require "imap/backup/serializer/imap"
 require "imap/backup/serializer/mbox"
 require "imap/backup/serializer/transaction"

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

@@ -1,5 +1,6 @@
 require "os"
 
+require "imap/backup/file_mode"
 require "imap/backup/serializer/folder_maker"
 
 module Imap; end

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

@@ -1,6 +1,7 @@
 require "json"
 
 require "imap/backup/serializer/message"
+require "imap/backup/serializer/mbox"
 require "imap/backup/serializer/transaction"
 
 module Imap; end

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

@@ -1,3 +1,5 @@
+require "imap/backup/file_mode"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -1,3 +1,5 @@
+require "imap/backup/serializer"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -1,5 +1,7 @@
 require "json"
 
+require "imap/backup/serializer/imap"
+
 module Imap; end
 
 module Imap::Backup

data/lib/imap/backup/serializer.rb

@@ -1,8 +1,10 @@
 require "forwardable"
 
 require "email/mboxrd/message"
+require "imap/backup/logger"
 require "imap/backup/naming"
 require "imap/backup/serializer/appender"
+require "imap/backup/serializer/directory"
 require "imap/backup/serializer/integrity_checker"
 require "imap/backup/serializer/imap"
 require "imap/backup/serializer/mbox"

data/lib/imap/backup/setup/account/header.rb

@@ -1,3 +1,5 @@
+require "json"
+
 require "imap/backup/setup/helpers"
 
 module Imap; end

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

@@ -1,6 +1,8 @@
 require "imap/backup/setup/account/header"
 require "imap/backup/setup/backup_path"
+require "imap/backup/setup/connection_tester"
 require "imap/backup/setup/email"
+require "imap/backup/setup/folder_chooser"
 
 module Imap; end
 

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

@@ -11,7 +11,7 @@ module Imap::Backup
     end
 
     def test
-      account.client
+      account.client.login
       "Connection successful"
     rescue Net::IMAP::NoResponseError
       "No response"

data/lib/imap/backup/setup.rb

@@ -2,6 +2,8 @@ require "highline"
 
 require "email/provider"
 require "imap/backup/account"
+require "imap/backup/setup/account"
+require "imap/backup/setup/asker"
 require "imap/backup/setup/global_options"
 require "imap/backup/setup/helpers"
 

data/lib/imap/backup/thunderbird/mailbox_exporter.rb

@@ -1,5 +1,6 @@
 require "thunderbird/local_folder"
-require "thunderbird/profiles"
+
+require "imap/backup/logger"
 
 module Imap; end
 

data/lib/imap/backup/uploader.rb

@@ -1,3 +1,7 @@
+require "imap/backup/account/folder"
+require "imap/backup/logger"
+require "imap/backup/serializer"
+
 module Imap; end
 
 module Imap::Backup

data/lib/imap/backup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 13.2.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-30 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -146,7 +146,6 @@ files:
 - lib/email/provider/gmail.rb
 - lib/email/provider/purelymail.rb
 - lib/email/provider/unknown.rb
-- lib/imap/backup.rb
 - lib/imap/backup/account.rb
 - lib/imap/backup/account/backup.rb
 - lib/imap/backup/account/backup_folders.rb
@@ -173,6 +172,7 @@ files:
 - lib/imap/backup/client/automatic_login_wrapper.rb
 - lib/imap/backup/client/default.rb
 - lib/imap/backup/configuration.rb
+- lib/imap/backup/configuration_not_found.rb
 - lib/imap/backup/downloader.rb
 - lib/imap/backup/file_mode.rb
 - lib/imap/backup/flag_refresher.rb

data/lib/imap/backup.rb

@@ -1,18 +0,0 @@
-require "imap/backup/account/folder"
-require "imap/backup/configuration"
-require "imap/backup/downloader"
-require "imap/backup/logger"
-require "imap/backup/uploader"
-require "imap/backup/serializer"
-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"
-
-module Imap; end
-
-module Imap::Backup
-  class ConfigurationNotFound < StandardError; end
-end