imap-backup 3.4.1 → 4.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d29fc2a0bdce3edeeb819767c8c76ab319573ce1391e26cbfcb03df6f7d0b3
-  data.tar.gz: f0c169eb81dff4cdfe793c53dfd5317425c737042fe69c65be30a6df186e5057
+  metadata.gz: ba3f202308a586f7ec54b28d66ea2f9422cf30f706c118ab02f362346351f268
+  data.tar.gz: 585bd29f2d2f836aad27c6ac58855649b7621eff770d5e2b40bfdd3f6aa774f0
 SHA512:
-  metadata.gz: 4007a0ef75a42e3ad327c50bc24613a66ecf1b4f814d9f4cb91b65717199fd6a5521a8518691e56f33e7788007fa3b57a065d9383e7e0ced47d373fd7d1ab955
-  data.tar.gz: 4e04086163be13d87de681d91aa7c1664a11a49fc44d089110e67e8c2d89b22ec6811902d34ee6f00e7a3e41ac21d04ea245997c5a7921c1c5990208e8989bd1
+  metadata.gz: 6270660f55ab52e3a3d8242bdfbb2d044ce7428ccc75daabf25b6753a7c91f9c3f4d8b2be4db517f44fb887663a40e946f128c2bf06f4d1006cd02182d9f477e
+  data.tar.gz: f94af41fee60be97e15e0d2aa3da5a0696b9d8bab5cb03cb42c805881b13e8a38fc5be42ee30efd26576d5cadb10d2f53b0c46c00fc94ca72cf23f94e05d602b

data/.circleci/config.yml

@@ -27,7 +27,7 @@ jobs:
         type: string
     environment:
       BUNDLE_PATH: ./vendor/bundle
-      DOCKER_IMAP_PORT: 993
+      DOCKER_IMAP_SERVER: 993
     docker:
       - image: "cimg/ruby:<< parameters.ruby_version >>"
       - image: antespi/docker-imap-devel:latest

data/.rubocop_todo.yml

@@ -63,7 +63,7 @@ Metrics/AbcSize:
 # Offense count: 3
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 171
+  Max: 172
 
 # Offense count: 19
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [4.0.0.rc1] - 2021-11-17
+
+### Added
+* `local` commands to list accounts, folders and emails and to view single
+  emails.

data/bin/imap-backup

@@ -1,98 +1,8 @@
 #!/usr/bin/env ruby
-require "optparse"
 
 $LOAD_PATH.unshift(File.expand_path("../lib/", __dir__))
-require "imap/backup"
+require "imap/backup/cli"
 
-KNOWN_COMMANDS = [
-  {name: "setup",   help: "Create/edit the configuration file"},
-  {name: "backup",  help: "Do the backup (default)"},
-  {name: "folders", help: "List folders for all (or selected) accounts"},
-  {name: "restore", help: "Restore emails to server"},
-  {name: "status",  help: "List count of non backed-up emails per folder"},
-  {name: "help",    help: "Show usage"}
-].freeze
+Imap::Backup::Configuration::List.new.setup_logging
 
-options = {command: "backup"}
-parser = OptionParser.new do |opts|
-  opts.banner = "Usage: #{$PROGRAM_NAME} [options] COMMAND"
-
-  opts.separator ""
-  opts.separator "Commands:"
-  KNOWN_COMMANDS.each do |command|
-    opts.separator format("\t%- 20<name>s %<help>s", command)
-  end
-  opts.separator ""
-  opts.separator "Common options:"
-
-  opts.on(
-    "-a",
-    "--accounts ACCOUNT1[,ACCOUNT2,...]",
-    Array,
-    "only these accounts"
-  ) do |account|
-    options[:accounts] = account
-  end
-
-  opts.on_tail("-h", "--help", "Show usage") do
-    puts opts
-    exit
-  end
-
-  opts.on_tail("--version", "Show version") do
-    puts Imap::Backup::VERSION
-    exit
-  end
-end
-parser.parse!
-
-options[:command] = ARGV.shift if !ARGV.empty?
-
-# rubocop:disable Style/IfUnlessModifier
-if KNOWN_COMMANDS.find { |c| c[:name] == options[:command] }.nil?
-  raise "Unknown command '#{options[:command]}'"
-end
-
-# rubocop:enable Style/IfUnlessModifier
-
-if options[:command] == "help"
-  puts parser
-  exit
-end
-
-begin
-  configuration = Imap::Backup::Configuration::List.new(options[:accounts])
-rescue Imap::Backup::ConfigurationNotFound
-  Imap::Backup::Configuration::Setup.new.run
-  exit
-end
-
-configuration.setup_logging
-
-case options[:command]
-when "setup"
-  Imap::Backup::Configuration::Setup.new.run
-when "backup"
-  configuration.each_connection(&:run_backup)
-when "folders"
-  configuration.each_connection do |connection|
-    puts connection.username
-    folders = connection.folders
-    if folders.nil?
-      warn "Unable to list account folders"
-      exit 1
-    end
-    folders.each { |f| puts "\t#{f}" }
-  end
-when "restore"
-  configuration.each_connection(&:restore)
-when "status"
-  configuration.each_connection do |connection|
-    puts connection.username
-    folders = connection.status
-    folders.each do |f|
-      missing_locally = f[:remote] - f[:local]
-      puts "#{f[:name]}: #{missing_locally.size}"
-    end
-  end
-end
+Imap::Backup::CLI.start(ARGV)

data/imap-backup

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../lib/", __dir__))
+require "imap/backup/cli"
+
+Imap::Backup::CLI.start(ARGV)
+
+__END__
+

data/imap-backup.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail"
   gem.add_runtime_dependency "rake"
+  gem.add_runtime_dependency "thor", "~> 1.1"
 
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
   if RUBY_ENGINE == "jruby"

data/lib/email/mboxrd/message.rb

@@ -36,12 +36,12 @@ module Email::Mboxrd
       supplied_body.gsub(/(?<!\r)\n/, "\r\n")
     end
 
-    private
-
     def parsed
       @parsed ||= Mail.new(supplied_body)
     end
 
+    private
+
     def from
       @from ||=
         begin

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

@@ -73,6 +73,19 @@ module Imap::Backup
       end
     end
 
+    def local_folders
+      return enum_for(:local_folders) if !block_given?
+
+      glob = File.join(local_path, "**", "*.imap")
+      base = Pathname.new(local_path)
+      Pathname.glob(glob) do |path|
+        name = path.relative_path_from(base).to_s[0..-6]
+        serializer = Serializer::Mbox.new(local_path, name)
+        folder = Account::Folder.new(self, name)
+        yield serializer, folder
+      end
+    end
+
     def restore
       local_folders do |serializer, folder|
         restore_folder serializer, folder
@@ -80,7 +93,7 @@ module Imap::Backup
     end
 
     def disconnect
-      imap.disconnect
+      imap.disconnect if @imap
     end
 
     def reconnect
@@ -174,17 +187,6 @@ module Imap::Backup
         ENV["IMAP_BACKUP_ENABLE_GMAIL_OAUTH2"]
     end
 
-    def local_folders
-      glob = File.join(local_path, "**", "*.imap")
-      base = Pathname.new(local_path)
-      Pathname.glob(glob) do |path|
-        name = path.relative_path_from(base).to_s[0..-6]
-        serializer = Serializer::Mbox.new(local_path, name)
-        folder = Account::Folder.new(self, name)
-        yield serializer, folder
-      end
-    end
-
     def backup_folders
       @backup_folders ||=
         begin

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

@@ -0,0 +1,21 @@
+module Imap::Backup
+  class CLI::Backup < 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|
+          connection.run_backup
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Imap::Backup
+  class CLI::Folders < 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|
+          puts connection.username
+          folders = connection.folders
+          if folders.nil?
+            warn "Unable to list account folders"
+            return false
+          end
+          folders.each { |f| puts "\t#{f}" }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require "imap/backup"
+
+module Imap::Backup::CLI::Helpers
+  def symbolized(options)
+    options.each.with_object({}) { |(k, v), acc| acc[k.intern] = v }
+  end
+
+  def each_connection(names)
+    begin
+      connections = Imap::Backup::Configuration::List.new(names)
+    rescue Imap::Backup::ConfigurationNotFound
+      raise "imap-backup is not configured. Run `imap-backup setup`"
+      return
+    end
+
+    connections.each_connection do |connection|
+      yield connection
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Imap::Backup
+  class CLI::Local < Thor
+    include Thor::Actions
+    include CLI::Helpers
+
+    desc "accounts", "list locally backed-up accounts"
+    def accounts
+      connections = Imap::Backup::Configuration::List.new
+      connections.accounts.each { |a| puts a[:username] }
+    end
+
+    desc "folders EMAIL", "list account folders"
+    def folders(email)
+      connections = Imap::Backup::Configuration::List.new
+      account = connections.accounts.find { |a| a[:username] == email }
+      raise "#{email} is not a configured account" if !account
+
+      account_connection = Imap::Backup::Account::Connection.new(account)
+      account_connection.local_folders.each do |_s, f|
+        puts %("#{f.name}")
+      end
+    end
+
+    desc "emails EMAIL FOLDER", "list emails in a folder"
+    def emails(email, folder_name)
+      connections = Imap::Backup::Configuration::List.new
+      account = connections.accounts.find { |a| a[:username] == email }
+      raise "#{email} is not a configured account" if !account
+
+      account_connection = Imap::Backup::Account::Connection.new(account)
+      folder_serializer, folder = account_connection.local_folders.find do |(_s, f)|
+        f.name == folder_name
+      end
+      raise "Folder '#{folder_name}' not found" if !folder_serializer
+
+      max_subject = 60
+      puts format("%-10<uid>s  %-#{max_subject}<subject>s - %<date>s", {uid: "UID", subject: "Subject", date: "Date"})
+      puts "-" * (12 + max_subject + 28)
+
+      uids = folder_serializer.uids
+
+      folder_serializer.each_message(uids).map do |uid, message|
+        m = {uid: uid, date: message.parsed.date.to_s, subject: message.parsed.subject}
+        if m[:subject].length > max_subject
+          puts format("% 10<uid>u: %.#{max_subject - 3}<subject>s... - %<date>s", m)
+        else
+          puts format("% 10<uid>u: %-#{max_subject}<subject>s - %<date>s", m)
+        end
+      end
+    end
+
+    desc "email EMAIL FOLDER UID", "show an email"
+    def email(email, folder_name, uid)
+      connections = Imap::Backup::Configuration::List.new
+      account = connections.accounts.find { |a| a[:username] == email }
+      raise "#{email} is not a configured account" if !account
+
+      account_connection = Imap::Backup::Account::Connection.new(account)
+      folder_serializer, _folder = account_connection.local_folders.find do |(_s, f)|
+        f.name == folder_name
+      end
+      raise "Folder '#{folder_name}' not found" if !folder_serializer
+
+      loaded_message = folder_serializer.load(uid)
+      raise "Message #{uid} not found in folder '#{folder_name}'" if !loaded_message
+
+      puts loaded_message.supplied_body
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Imap::Backup
+  class CLI::Restore < 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) { |connection| connection.restore }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,26 @@
+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|
+          puts connection.username
+          folders = connection.status
+          folders.each do |f|
+            missing_locally = f[:remote] - f[:local]
+            puts "#{f[:name]}: #{missing_locally.size}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/imap/backup/cli.rb

@@ -0,0 +1,87 @@
+require "thor"
+
+class Imap::Backup::CLI < Thor
+  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"
+  autoload :Setup, "imap/backup/cli/setup"
+  autoload :Status, "imap/backup/cli/status"
+
+  include Helpers
+
+  default_task :backup
+
+  def self.exit_on_failure?
+    true
+  end
+
+  def self.accounts_option
+    method_option(
+      "accounts",
+      type: :string,
+      banner: "a comma-separated list of accounts (defaults to all configured accounts)",
+      aliases: ["-a"]
+    )
+  end
+
+  desc "backup [OPTIONS]", "Run the backup"
+  long_desc <<~DESC
+    Downloads any emails not yet present locally.
+    Runs the backup for each configured account,
+    or for those requested via the --accounts option.
+    By default all folders, are backed up.
+    The setup tool can be used to choose a specific list of folders to back up.
+  DESC
+  accounts_option
+  def backup
+    Backup.new(symbolized(options)).run
+  end
+
+  desc "folders [OPTIONS]", "This command is deprecated, use `imap-backup remote folders ACCOUNT`"
+  long_desc <<~DESC
+    Lists all folders of all configured accounts.
+    This command is deprecated.
+    Instead, use a combination of `imap-backup local accounts` to get the list of accounts,
+    and `imap-backup remote folders ACCOUNT` to get the folder list.
+  DESC
+  accounts_option
+  def folders
+    Folders.new(symbolized(options)).run
+  end
+
+  desc "restore [OPTIONS]", "This command is deprecated, use `imap-backup restore 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.
+  DESC
+  accounts_option
+  def restore
+    Restore.new(symbolized(options)).run
+  end
+
+  desc "setup", "Configure imap-backup"
+  long_desc <<~DESC
+    A menu-driven command-line application used to configure imap-backup.
+    Configure email accounts to back up.
+  DESC
+  def setup
+    Setup.new().run
+  end
+
+  desc "status", "Show backup status"
+  long_desc <<~DESC
+    For each configured account and folder, lists the number of emails yet to be downloaded.
+  DESC
+  accounts_option
+  def status
+    Status.new(symbolized(options)).run
+  end
+
+  desc "local subcommand ...ARGS", "View local info"
+  subcommand "local", Local
+end

data/lib/imap/backup/configuration/list.rb

@@ -4,7 +4,7 @@ module Imap::Backup
   class Configuration::List
     attr_reader :required_accounts
 
-    def initialize(required_accounts = nil)
+    def initialize(required_accounts = [])
       @required_accounts = required_accounts
     end
 
@@ -23,6 +23,17 @@ module Imap::Backup
       end
     end
 
+    def accounts
+      @accounts ||=
+        if required_accounts.empty?
+          config.accounts
+        else
+          config.accounts.select do |account|
+            required_accounts.include?(account[:username])
+          end
+        end
+    end
+
     private
 
     def config
@@ -38,16 +49,5 @@ module Imap::Backup
     def config_exists?
       Configuration::Store.exist?
     end
-
-    def accounts
-      @accounts ||=
-        if required_accounts.nil?
-          config.accounts
-        else
-          config.accounts.select do |account|
-            required_accounts.include?(account[:username])
-          end
-        end
-    end
   end
 end

data/lib/imap/backup/version.rb

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

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -433,24 +433,49 @@ describe Imap::Backup::Account::Connection do
   end
 
   describe "#reconnect" do
-    it "disconnects from the server" do
-      expect(imap).to receive(:disconnect)
+    context "when the IMAP connection has been used" do
+      before { subject.imap }
 
-      subject.reconnect
+      it "disconnects from the server" do
+        expect(imap).to receive(:disconnect)
+
+        subject.reconnect
+      end
+    end
+
+    context "when the IMAP connection has not been used" do
+      it "does not disconnect from the server" do
+        expect(imap).to_not receive(:disconnect)
+
+        subject.reconnect
+      end
     end
 
     it "causes reconnection on future access" do
       expect(Net::IMAP).to receive(:new)
 
       subject.reconnect
+      subject.imap
     end
   end
 
   describe "#disconnect" do
-    it "disconnects from the server" do
-      expect(imap).to receive(:disconnect)
+    context "when the IMAP connection has been used" do
+      it "disconnects from the server" do
+        subject.imap
+
+        expect(imap).to receive(:disconnect)
 
-      subject.disconnect
+        subject.disconnect
+      end
+    end
+
+    context "when the IMAP connection has not been used" do
+      it "does not disconnect from the server" do
+        expect(imap).to_not receive(:disconnect)
+
+        subject.disconnect
+      end
     end
   end
 end

data/spec/unit/imap/backup/configuration/list_spec.rb

@@ -35,6 +35,7 @@ describe Imap::Backup::Configuration::List do
       allow(Imap::Backup::Configuration::Store).
         to receive(:exist?) { config_exists }
       allow(Imap::Backup).to receive(:setup_logging)
+      allow(store).to receive(:debug?)
     end
 
     it "sets global logging level" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 4.0.0.rc1
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gmail_xoauth
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,7 @@ files:
 - ".rspec-all"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -211,6 +226,7 @@ files:
 - docs/27-success.png
 - docs/docker-imap.md
 - docs/setting-up-gmail-with-oauth2.md
+- imap-backup
 - imap-backup.gemspec
 - lib/email/mboxrd/message.rb
 - lib/email/provider.rb
@@ -219,6 +235,14 @@ files:
 - lib/imap/backup.rb
 - lib/imap/backup/account/connection.rb
 - lib/imap/backup/account/folder.rb
+- lib/imap/backup/cli.rb
+- lib/imap/backup/cli/backup.rb
+- lib/imap/backup/cli/folders.rb
+- lib/imap/backup/cli/helpers.rb
+- lib/imap/backup/cli/local.rb
+- lib/imap/backup/cli/restore.rb
+- lib/imap/backup/cli/setup.rb
+- lib/imap/backup/cli/status.rb
 - lib/imap/backup/configuration/account.rb
 - lib/imap/backup/configuration/asker.rb
 - lib/imap/backup/configuration/connection_tester.rb
@@ -286,9 +310,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: