imap-backup 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16911b1cea1983b844c3bbf7f74c03ff7436990fb5aa4d5b49fa18f03ae2e229
-  data.tar.gz: 265f63995e70ba3f68b98ec72d3a12b3e95100f7e6b320026b18bcc156888a92
+  metadata.gz: 59babb556b2f47a07590debff15dcd5456f1e61454c3aba2e504610ce4322647
+  data.tar.gz: 89909077444746e44fe3955070df6b590942da0d44da58c9b08b282e694000d5
 SHA512:
-  metadata.gz: 4a541a7830ddab458f2366bdad4924f3e6cbc3ba858651839e6dcd1a530acbbeb01e2c59a44331af73a2d77f606f2d6b39eacd2b5a705d78ec20e93d2c2f2527
-  data.tar.gz: 7b60170e3d29e9882f3bcbf13b04daa162434944d59311a5a03a4b1c1022a7a9501b292c3eb929d6e07039c47cc433316a338e062ced4e8a6b7ea424e6c0678b
+  metadata.gz: ea00bb55bb853cef73ec12171a4bdde9b0b5ef88a914065bbe307f48712db3329e8c8f1712cfa48b4a49102d20fb38cc465dc463c2d3ea9e0caba000a184766b
+  data.tar.gz: 24d368c209c11db4ae7f05a93b9cf4e0435b65eef0cffd7e58f8c669e634ca735aa3187b6a6506b7b10ba3bec961d3aa9d7387df40d4880f1bed73df7f24bbb9

data/imap-backup.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "os"
   gem.add_runtime_dependency "rake"
   gem.add_runtime_dependency "thor", "~> 1.1"
+  gem.add_runtime_dependency "thunderbird", ">= 0.0.0"
 
   gem.add_development_dependency "aruba", ">= 0.0.0"
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"

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

@@ -3,16 +3,32 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
+    attr_reader :email
     attr_reader :account_names
 
-    def initialize(options)
-      super([])
-      @account_names = (options[:accounts] || "").split(",")
+    def initialize(email = nil, options)
+      @email = email
+      @account_names =
+        if options.key?(:accounts)
+          options[:accounts].split(",")
+        end
     end
 
     no_commands do
       def run
-        each_connection(account_names) { |connection| connection.restore }
+        case
+        when email && !account_names
+          connection = connection(email)
+          connection.restore
+        when !email && !account_names
+          Logger.logger.info "Calling restore without an EMAIL parameter is deprecated"
+          each_connection([]) { |connection| 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 }
+        end
       end
     end
   end

data/lib/imap/backup/cli.rb

@@ -106,15 +106,14 @@ module Imap::Backup
     desc "remote SUBCOMMAND [OPTIONS]", "View info about online accounts"
     subcommand "remote", Remote
 
-    desc "restore [OPTIONS]", "This command is deprecated, use `imap-backup restore ACCOUNT`"
+    desc "restore EMAIL", "Restores a single account"
     long_desc <<~DESC
-      By default, restores all local emails to their respective servers.
-      This command is deprecated.
-      Instead, use `imap-backup restore ACCOUNT` to restore a single account.
+      Restores all backed-up emails for the supplied account to
+      their original server.
     DESC
     accounts_option
-    def restore
-      Restore.new(symbolized(options)).run
+    def restore(email = nil)
+      Restore.new(email, symbolized(options)).run
     end
 
     desc "setup", "Configure imap-backup"

data/lib/imap/backup/version.rb

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

data/spec/features/backup_spec.rb

@@ -1,28 +1,28 @@
 require "features/helper"
 
-RSpec.describe "backup", type: :feature, docker: true do
+RSpec.describe "backup", type: :aruba, docker: true do
   include_context "imap-backup connection"
   include_context "message-fixtures"
 
+  let(:local_backup_path) { File.expand_path("~/backup") }
+  let(:backup_folders) { [{name: folder}] }
+  let(:folder) { "my-stuff" }
   let(:messages_as_mbox) do
     message_as_mbox_entry(msg1) + message_as_mbox_entry(msg2)
   end
-  let(:folder) { "my-stuff" }
-  let(:email1) { send_email folder, msg1 }
-  let(:email2) { send_email folder, msg2 }
+
   let!(:pre) {}
   let!(:setup) do
     server_create_folder folder
-    email1
-    email2
-    connection.run_backup
+    send_email folder, msg1
+    send_email folder, msg2
+    create_config(accounts: [account.to_h])
+
+    run_command_and_stop("imap-backup backup")
   end
 
   after do
-    FileUtils.rm_rf local_backup_path
-    delete_emails folder
     server_delete_folder folder
-    connection.disconnect
   end
 
   it "downloads messages" do
@@ -51,11 +51,10 @@ RSpec.describe "backup", type: :feature, docker: true do
 
     context "when uid_validity does not match" do
       let(:new_name) { "NEWNAME" }
-      let(:email3) { send_email folder, msg3 }
       let(:original_folder_uid_validity) { server_uid_validity(folder) }
       let!(:pre) do
         server_create_folder folder
-        email3
+        send_email folder, msg3
         original_folder_uid_validity
         connection.run_backup
         connection.disconnect
@@ -78,6 +77,7 @@ RSpec.describe "backup", type: :feature, docker: true do
       context "when a renamed local backup exists" do
         let!(:pre) do
           super()
+          create_directory local_backup_path
           File.write(imap_path(renamed_folder), "existing imap")
           File.write(mbox_path(renamed_folder), "existing mbox")
         end
@@ -91,6 +91,7 @@ RSpec.describe "backup", type: :feature, docker: true do
 
     context "when an unversioned .imap file is found" do
       let!(:pre) do
+        create_directory local_backup_path
         File.open(imap_path(folder), "w") { |f| f.write "old format imap" }
         File.open(mbox_path(folder), "w") { |f| f.write "old format emails" }
       end

data/spec/features/restore_spec.rb

@@ -1,9 +1,11 @@
 require "features/helper"
 
-RSpec.describe "restore", type: :feature, docker: true do
+RSpec.describe "restore", type: :aruba, docker: true do
   include_context "imap-backup connection"
   include_context "message-fixtures"
 
+  let(:local_backup_path) { File.expand_path("~/backup") }
+  let(:folder) { "my-stuff" }
   let(:messages_as_mbox) do
     message_as_mbox_entry(msg1) + message_as_mbox_entry(msg2)
   end
@@ -12,19 +14,19 @@ RSpec.describe "restore", type: :feature, docker: true do
   end
   let(:message_uids) { [msg1[:uid], msg2[:uid]] }
   let(:existing_imap_content) { imap_data(uid_validity, message_uids).to_json }
-  let(:folder) { "my-stuff" }
   let(:uid_validity) { 1234 }
 
   let!(:pre) {}
   let!(:setup) do
+    create_directory local_backup_path
     File.write(imap_path(folder), existing_imap_content)
     File.write(mbox_path(folder), messages_as_mbox)
-    connection.restore
+    create_config(accounts: [account.to_h])
+
+    run_command_and_stop("imap-backup restore #{account.username}")
   end
   let(:cleanup) do
-    FileUtils.rm_rf local_backup_path
     server_delete_folder folder
-    connection.disconnect
   end
 
   after { cleanup }

data/spec/features/support/aruba.rb

@@ -1,7 +1,10 @@
 require "aruba/rspec"
 
+require_relative "backup_directory"
+
 Aruba.configure do |config|
   config.home_directory = File.expand_path("./tmp/home")
+  config.allow_absolute_paths = true
 end
 
 module ConfigurationHelpers
@@ -58,6 +61,7 @@ end
 RSpec.configure do |config|
   config.include ConfigurationHelpers, type: :aruba
   config.include StoreHelpers, type: :aruba
+  config.include BackupDirectoryHelpers, type: :aruba
 
   config.before(:suite) do
     FileUtils.rm_rf "./tmp/home"

data/spec/features/support/backup_directory.rb

@@ -41,7 +41,3 @@ module BackupDirectoryHelpers
     JSON.parse(imap_content(name), symbolize_names: true)
   end
 end
-
-RSpec.configure do |config|
-  config.include BackupDirectoryHelpers, type: :feature
-end

data/spec/features/support/email_server.rb

@@ -87,7 +87,6 @@ module EmailServerHelpers
     imap.delete folder
     imap.disconnect
   rescue StandardError => e
-    puts e.to_s
   ensure
     @imap = nil
   end

data/spec/spec_helper.rb

@@ -3,10 +3,9 @@ require "rspec"
 
 CodeClimate::TestReporter.start
 
-spec_path = File.dirname(__FILE__)
-$LOAD_PATH << File.expand_path("../lib", spec_path)
+$LOAD_PATH << File.expand_path("../lib", __dir__)
 
-support_glob = File.join(spec_path, "support", "**", "*.rb")
+support_glob = File.join(__dir__, "support", "**", "*.rb")
 Dir[support_glob].sort.each { |f| require f }
 
 require "simplecov"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: thunderbird
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -238,13 +252,6 @@ files:
 - lib/imap/backup/utils.rb
 - lib/imap/backup/version.rb
 - lib/retry_on_error.rb
-- lib/thunderbird.rb
-- lib/thunderbird/install.rb
-- lib/thunderbird/local_folder.rb
-- lib/thunderbird/profile.rb
-- lib/thunderbird/profiles.rb
-- lib/thunderbird/subdirectory.rb
-- lib/thunderbird/subdirectory_placeholder.rb
 - spec/features/backup_spec.rb
 - spec/features/configuration/minimal_configuration.rb
 - spec/features/configuration/missing_configuration.rb
@@ -264,7 +271,6 @@ files:
 - spec/features/support/shared/connection_context.rb
 - spec/features/support/shared/message_fixtures.rb
 - spec/fixtures/connection.yml
-- spec/gather_rspec_coverage.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/higline_test_helpers.rb
@@ -370,4 +376,3 @@ test_files:
 - spec/support/silence_logging.rb
 - spec/support/higline_test_helpers.rb
 - spec/fixtures/connection.yml
-- spec/gather_rspec_coverage.rb

data/lib/thunderbird/install.rb

@@ -1,16 +0,0 @@
-require "thunderbird/profiles"
-
-class Thunderbird::Install
-  attr_reader :title
-  attr_reader :entries
-
-  # entries are lines from profile.ini
-  def initialize(title, entries)
-    @title = title
-    @entries = entries
-  end
-
-  def default
-    Thunderbird::Profiles.new.profile_for_path(entries[:Default])
-  end
-end

data/lib/thunderbird/local_folder.rb

@@ -1,65 +0,0 @@
-require "thunderbird/profile"
-require "thunderbird/subdirectory"
-
-# A local folder is a file containing emails
-class Thunderbird::LocalFolder
-  attr_reader :path
-  attr_reader :profile
-
-  def initialize(profile, path)
-    @profile = profile
-    @path = path
-  end
-
-  def set_up
-    return if path_elements.empty?
-
-    return true if !in_subdirectory?
-
-    subdirectory.set_up
-  end
-
-  def full_path
-    if in_subdirectory?
-      File.join(subdirectory.full_path, folder_name)
-    else
-      folder_name
-    end
-  end
-
-  def exists?
-    File.exist?(full_path)
-  end
-
-  def msf_path
-    "#{path}.msf"
-  end
-
-  def msf_exists?
-    File.exist?(msf_path)
-  end
-
-  private
-
-  def in_subdirectory?
-    path_elements.count > 1
-  end
-
-  def subdirectory
-    return nil if !in_subdirectory?
-
-    Thunderbird::Subdirectory.new(profile, subdirectory_path)
-  end
-
-  def path_elements
-    path.split(File::SEPARATOR)
-  end
-
-  def subdirectory_path
-    File.join(path_elements[0..-2])
-  end
-
-  def folder_name
-    path_elements[-1]
-  end
-end

data/lib/thunderbird/profile.rb

@@ -1,30 +0,0 @@
-require "thunderbird"
-
-class Thunderbird::Profile
-  attr_reader :title
-  attr_reader :entries
-
-  # entries are lines from profile.ini
-  def initialize(title, entries)
-    @title = title
-    @entries = entries
-  end
-
-  def root
-    if relative?
-      File.join(Thunderbird.new.data_path, entries[:Path])
-    else
-      entries[:Path]
-    end
-  end
-
-  def local_folders_path
-    File.join(root, "Mail", "Local Folders")
-  end
-
-  private
-
-  def relative?
-    entries[:IsRelative] == "1"
-  end
-end

data/lib/thunderbird/profiles.rb

@@ -1,71 +0,0 @@
-require "thunderbird"
-require "thunderbird/install"
-require "thunderbird/profile"
-
-# http://kb.mozillazine.org/Profiles.ini_file
-class Thunderbird::Profiles
-  def profile_for_path(path)
-    title, entries = blocks.find { |_name, entries| entries[:Path] == path }
-
-    Thunderbird::Profile.new(title, entries) if title
-  end
-
-  def profile(name)
-    title, entries = blocks.find { |_name, entries| entries[:Name] == name }
-
-    Thunderbird::Profile.new(title, entries) if title
-  end
-
-  def installs
-    @installs ||= begin
-      pairs = blocks.filter { |name, _entries| name.start_with?("Install") }
-      pairs.map { |title, entries| Thunderbird::Install.new(title, entries) }
-    end
-  end
-
-  private
-
-  # Parse profiles.ini.
-  # Blocks start with a title, e.g. '[Abc]'
-  # and are followed by a number of lines
-  def blocks
-    @blocks ||= begin
-      blocks = {}
-      File.open(profiles_ini_path, "rb") do |f|
-        title = nil
-        entries = nil
-
-        loop do
-          line = f.gets
-          if !line
-            blocks[title] = entries if title
-            break
-          end
-
-          line.chomp!
-
-          # Is this line the start of a new block
-          match = line.match(/\A\[([A-Za-z0-9]+)\]\z/)
-          if match
-            # Store what we got before this title as a new block
-            blocks[title] = entries if title
-
-            # Start a new block
-            title = match[1]
-            entries = {}
-          elsif line != ""
-            # Collect entries until we get to the next title
-            key, value = line.split("=")
-            entries[key.to_sym] = value
-          end
-        end
-      end
-
-      blocks
-    end
-  end
-
-  def profiles_ini_path
-    File.join(Thunderbird.new.data_path, "profiles.ini")
-  end
-end

data/lib/thunderbird/subdirectory.rb

@@ -1,93 +0,0 @@
-require "thunderbird/subdirectory_placeholder"
-
-class Thunderbird::Subdirectory
-  # `path` is the UI path, it doesn't have the '.sbd' extensions
-  # that are present in the real, file system path
-  attr_reader :path
-  attr_reader :profile
-
-  def initialize(profile, path)
-    @profile = profile
-    @path = path
-  end
-
-  def set_up
-    raise "Cannot create a subdirectory without a path" if !sub_directory?
-
-    if sub_sub_directory?
-      parent_ok = parent.set_up
-      return false if !parent_ok
-    end
-
-    ok = check
-    return false if !ok
-
-    FileUtils.mkdir_p full_path
-    placeholder.touch
-
-    true
-  end
-
-  # subdirectory relative path is 'Foo.sbd/Bar.sbd/Baz.sbd'
-  def full_path
-    relative_path = File.join(subdirectories)
-    File.join(profile.local_folders_path, relative_path)
-  end
-
-  private
-
-  def sub_directory?
-    path_elements.any?
-  end
-
-  def sub_sub_directory?
-    path_elements.count > 1
-  end
-
-  def parent
-    return nil if !sub_sub_directory?
-
-    self.class.new(profile, File.join(path_elements[0..-2]))
-  end
-
-  # placeholder relative path is 'Foo.sbd/Bar.sbd/Baz'
-  def placeholder
-    @placeholder = begin
-      relative_path = File.join(subdirectories[0..-2], path_elements[-1])
-      path = File.join(profile.local_folders_path, relative_path)
-      Thunderbird::SubdirectoryPlaceholder.new(path)
-    end
-  end
-
-  def path_elements
-    path.split(File::SEPARATOR)
-  end
-
-  def exists?
-    File.exist?(full_path)
-  end
-
-  def directory?
-    File.directory?(full_path)
-  end
-
-  def subdirectories
-    path_elements.map { |p| "#{p}.sbd" }
-  end
-
-  def check
-    case
-    when exists? && !placeholder.exists?
-      Kernel.puts "Can't set up folder '#{full_path}': '#{full_path}' exists, but '#{placeholder.path}' is missing"
-      false
-    when placeholder.exists? && !placeholder.regular?
-      Kernel.puts "Can't set up folder '#{full_path}': '#{placeholder.path}' exists, but it is not a regular file"
-      false
-    when exists? && !directory?
-      Kernel.puts "Can't set up folder '#{full_path}': '#{full_path}' exists, but it is not a directory"
-      false
-    else
-      true
-    end
-  end
-end

data/lib/thunderbird/subdirectory_placeholder.rb

@@ -1,21 +0,0 @@
-# Each subdirectory is "accompanied" by a blank
-# file of the same name (without the '.sbd' extension)
-class Thunderbird::SubdirectoryPlaceholder
-  attr_reader :path
-
-  def initialize(path)
-    @path = path
-  end
-
-  def exists?
-    File.exist?(path)
-  end
-
-  def regular?
-    File.file?(path)
-  end
-
-  def touch
-    FileUtils.touch path
-  end
-end

data/lib/thunderbird.rb

@@ -1,14 +0,0 @@
-require "os"
-
-class Thunderbird
-  def data_path
-    case
-    when OS.linux?
-      File.join(Dir.home, ".thunderbird")
-    when OS.mac?
-      File.join(Dir.home, "Library", "Thunderbird")
-    when OS.windows?
-      File.join(ENV["APPDATA"].gsub("\\", "/"), "Thunderbird")
-    end
-  end
-end

data/spec/gather_rspec_coverage.rb

@@ -1 +0,0 @@
-GATHER_RSPEC_COVERAGE = 1