imap-backup 4.0.0.rc1 → 4.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba3f202308a586f7ec54b28d66ea2f9422cf30f706c118ab02f362346351f268
-  data.tar.gz: 585bd29f2d2f836aad27c6ac58855649b7621eff770d5e2b40bfdd3f6aa774f0
+  metadata.gz: f6b754ca94002e528fff72fa9bfbe6316281d3325796843d312303c4956cd03f
+  data.tar.gz: dc7230bd742a4db2dfe24a358c6bac1508433578c1eb108130bbd5d89e41b60c
 SHA512:
-  metadata.gz: 6270660f55ab52e3a3d8242bdfbb2d044ce7428ccc75daabf25b6753a7c91f9c3f4d8b2be4db517f44fb887663a40e946f128c2bf06f4d1006cd02182d9f477e
-  data.tar.gz: f94af41fee60be97e15e0d2aa3da5a0696b9d8bab5cb03cb42c805881b13e8a38fc5be42ee30efd26576d5cadb10d2f53b0c46c00fc94ca72cf23f94e05d602b
+  metadata.gz: 3b8cbc016eb22fe70240bad350ad2d9e009800af15db493f798aa33367e7b67ae0725ce6f8d97666c0f0ad46101fe793f2447d241199ffdc983a17d60c47a852
+  data.tar.gz: 0f3c5a5a4e8e257dca263c25ac004e7d697908dfaccc9a82e354b5dfa8164f61e8671feb20afc8a4afd55bc3e79337bf723c715f61ce758d3a6e7ba1f8448677

data/CHANGELOG.md

@@ -4,8 +4,16 @@ 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.rc2] - 2021-11-18
+
+### Removed
+
+* GMail OAuth2 support. Tokens only last a few days, so this authentication
+  method is not usable for automated backups.
+
 ## [4.0.0.rc1] - 2021-11-17
 
 ### Added
+
 * `local` commands to list accounts, folders and emails and to view single
   emails.

data/README.md

@@ -20,20 +20,24 @@
 
 To use imap-backup with GMail, you will need to enable 'App passwords' on your account.
 
-## GMail OAuth2
+# Installation
+
+```shell
+$ gem install 'imap-backup'
+```
 
-GMail OAuth2 authentication is supported, but as GMail's policy requires
-users to set up an application specific to their account, the feature
-is disabled by default.
+# Commands
 
-You will need to set the environment variable IMAP_BACKUP_ENABLE_GMAIL_OAUTH2.
+For a full list, run
 
-To set it up, [follow the HOWTO](docs/setting-up-gmail-with-oauth2.md).
+```
+$ imap-backup help
+```
 
-# Installation
+For more information about a command, run
 
 ```shell
-$ gem install 'imap-backup'
+$ imap-backup help COMMAND
 ```
 
 # Setup
@@ -148,6 +152,16 @@ Each folder is saved to an mbox file.
 Alongside each mbox is a file with extension '.imap', which lists the source IMAP
 UIDs to allow a full restore.
 
+# Local commands
+
+There a various commands for viewing local backup status.
+
+To view the list, use
+
+```shell
+$ imap_backup help local
+```
+
 # Troubleshooting
 
 If you have problems:

data/imap-backup.gemspec

@@ -16,8 +16,6 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.5"
   gem.version = Imap::Backup::VERSION
 
-  gem.add_runtime_dependency "gmail_xoauth"
-  gem.add_runtime_dependency "googleauth"
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail"
   gem.add_runtime_dependency "rake"

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

@@ -1,15 +1,11 @@
 require "net/imap"
-require "gmail_xoauth"
 
-require "gmail/authenticator"
 require "retry_on_error"
 
 module Imap::Backup
   module Account; end
 
   class Account::Connection
-    class InvalidGmailOauth2RefreshToken < StandardError; end
-
     include RetryOnError
 
     LOGIN_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, SocketError].freeze
@@ -109,17 +105,8 @@ module Imap::Backup
             "Creating IMAP instance: #{server}, options: #{options.inspect}"
           )
           imap = Net::IMAP.new(server, options)
-          if use_gmail_oauth2? && Gmail::Authenticator.refresh_token?(password)
-            authenticator = Gmail::Authenticator.new(email: username, token: password)
-            credentials = authenticator.credentials
-            raise InvalidGmailOauth2RefreshToken if !credentials
-
-            Imap::Backup.logger.debug "Logging in with OAuth2 token: #{username}"
-            imap.authenticate("XOAUTH2", username, credentials.access_token)
-          else
-            Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
-            imap.login(username, password)
-          end
+          Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
+          imap.login(username, password)
           Imap::Backup.logger.debug "Login complete"
           imap
         end
@@ -181,12 +168,6 @@ module Imap::Backup
       password.gsub(/./, "x")
     end
 
-    def use_gmail_oauth2?
-      # TODO: test use of ENV
-      server == Email::Provider::GMAIL_IMAP_SERVER &&
-        ENV["IMAP_BACKUP_ENABLE_GMAIL_OAUTH2"]
-    end
-
     def backup_folders
       @backup_folders ||=
         begin

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

@@ -3,13 +3,13 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    desc "accounts", "list locally backed-up accounts"
+    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"
+    desc "folders EMAIL", "List account folders"
     def folders(email)
       connections = Imap::Backup::Configuration::List.new
       account = connections.accounts.find { |a| a[:username] == email }
@@ -21,7 +21,7 @@ module Imap::Backup
       end
     end
 
-    desc "emails EMAIL FOLDER", "list emails in a folder"
+    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 }
@@ -40,7 +40,11 @@ module Imap::Backup
       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}
+        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
@@ -49,7 +53,7 @@ module Imap::Backup
       end
     end
 
-    desc "email EMAIL FOLDER UID", "show an email"
+    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 }

data/lib/imap/backup/cli.rb

@@ -1,87 +1,91 @@
 require "thor"
 
-class Imap::Backup::CLI < Thor
-  require "imap/backup/cli/helpers"
+module Imap; end
 
-  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"
+module Imap::Backup
+  class CLI < Thor
+    require "imap/backup/cli/helpers"
 
-  include 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"
 
-  default_task :backup
+    include Helpers
 
-  def self.exit_on_failure?
-    true
-  end
+    default_task :backup
 
-  def self.accounts_option
-    method_option(
-      "accounts",
-      type: :string,
-      banner: "a comma-separated list of accounts (defaults to all configured accounts)",
-      aliases: ["-a"]
-    )
-  end
+    def self.exit_on_failure?
+      true
+    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
+    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 "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 "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 "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 "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 "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 "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 "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 "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 "local subcommand ...ARGS", "View local info"
-  subcommand "local", Local
+    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 [OPTIONS]", "View local info"
+    subcommand "local", Local
+  end
 end

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

@@ -68,12 +68,7 @@ module Imap::Backup
 
     def modify_password(menu)
       menu.choice("modify password") do
-        password =
-          if use_gmail_oauth2?(account)
-            Configuration::GmailOauth2.new(account).run
-          else
-            Configuration::Asker.password
-          end
+        password = Configuration::Asker.password
 
         if !password.nil?
           account[:password] = password
@@ -82,11 +77,6 @@ module Imap::Backup
       end
     end
 
-    def use_gmail_oauth2?(account)
-      account[:server] == Email::Provider::GMAIL_IMAP_SERVER &&
-        ENV["IMAP_BACKUP_ENABLE_GMAIL_OAUTH2"]
-    end
-
     def modify_server(menu)
       menu.choice("modify server") do
         server = highline.ask("server: ")

data/lib/imap/backup/version.rb

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

data/lib/imap/backup.rb

@@ -7,7 +7,6 @@ require "imap/backup/configuration/account"
 require "imap/backup/configuration/asker"
 require "imap/backup/configuration/connection_tester"
 require "imap/backup/configuration/folder_chooser"
-require "imap/backup/configuration/gmail_oauth2"
 require "imap/backup/configuration/list"
 require "imap/backup/configuration/setup"
 require "imap/backup/configuration/store"

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

@@ -90,56 +90,11 @@ describe Imap::Backup::Account::Connection do
     end
 
     context "with the GMail IMAP server" do
-      ACCESS_TOKEN = "access_token".freeze
-
       let(:server) { GMAIL_IMAP_SERVER }
       let(:refresh_token) { true }
       let(:result) { nil }
-      let(:authenticator) do
-        instance_double(
-          Gmail::Authenticator,
-          credentials: credentials
-        )
-      end
-      let(:credentials) { OpenStruct.new(access_token: ACCESS_TOKEN) }
-
-      before do
-        allow(Gmail::Authenticator).
-          to receive(:refresh_token?) { refresh_token }
-        allow(Gmail::Authenticator).
-          to receive(:new).
-            with(email: USERNAME, token: PASSWORD) { authenticator }
-      end
-
-      context "when the password is our copy of a GMail refresh token and  the environment IMAP_BACKUP_ENABLE_GMAIL_OAUTH2 is set" do
-        before do
-          ENV["IMAP_BACKUP_ENABLE_GMAIL_OAUTH2"] = "1"
-        end
-
-        after do
-          ENV.delete("IMAP_BACKUP_ENABLE_GMAIL_OAUTH2")
-        end
-
-        it "uses the OAuth2 access_token to authenticate" do
-          subject.imap
-
-          expect(imap).to have_received(:authenticate).with(
-            "XOAUTH2", USERNAME, ACCESS_TOKEN
-          )
-        end
-
-        context "when the refresh token is invalid" do
-          let(:credentials) { nil }
-
-          it "raises" do
-            expect { subject.imap }.to raise_error(String)
-          end
-        end
-      end
 
       context "when the password is not our copy of a GMail refresh token" do
-        let(:refresh_token) { false }
-
         it "uses the password" do
           subject.imap
 

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

@@ -241,49 +241,6 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    describe "choosing 'modify password' when the server is for GMail" do
-      let(:new_password) { "new_password" }
-      let(:current_server) { GMAIL_IMAP_SERVER }
-      let(:gmail_oauth2) do
-        instance_double(Imap::Backup::Configuration::GmailOauth2, run: nil)
-      end
-
-      before do
-        allow(Imap::Backup::Configuration::Asker).
-          to receive(:password) { new_password }
-        allow(Imap::Backup::Configuration::GmailOauth2).
-          to receive(:new).
-            with(account) { gmail_oauth2 }
-      end
-
-      context "when the environment IMAP_BACKUP_ENABLE_GMAIL_OAUTH2 is set" do
-        before do
-          ENV["IMAP_BACKUP_ENABLE_GMAIL_OAUTH2"] = "1"
-          subject.run
-          menu.choices["modify password"].call
-        end
-
-        after do
-          ENV.delete("IMAP_BACKUP_ENABLE_GMAIL_OAUTH2")
-        end
-
-        it "sets up GMail OAuth2" do
-          expect(gmail_oauth2).to have_received(:run)
-        end
-      end
-
-      context "when the environment IMAP_BACKUP_ENABLE_GMAIL_OAUTH2 is not set" do
-        before do
-          subject.run
-          menu.choices["modify password"].call
-        end
-
-        it "sets up GMail OAuth2" do
-          expect(gmail_oauth2).to_not have_received(:run)
-        end
-      end
-    end
-
     describe "choosing 'modify server'" do
       let(:server) { "server" }
 

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc1
+  version: 4.0.0.rc5
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: gmail_xoauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: googleauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -199,39 +171,11 @@ files:
 - Rakefile
 - bin/imap-backup
 - docker-compose.yml
-- docs/01-credentials-screen.png
-- docs/02-new-project.png
-- docs/03-initial-credentials-for-project.png
-- docs/04-credential-type-selection.png
-- docs/05-cant-create-without-consent-setup.png
-- docs/06-user-type-selection.png
-- docs/07-consent-screen-form.png
-- docs/08-app-scopes.png
-- docs/09-scope-selection.png
-- docs/10-updated-app-scopes.png
-- docs/11-test-users.png
-- docs/12-add-users.png
-- docs/13-create-oauth-client.png
-- docs/14-application-details.png
-- docs/16-initial-menu.png
-- docs/17-inputting-the-email-address.png
-- docs/18-choose-password.png
-- docs/19-supply-client-info.png
-- docs/20-choose-gmail-account.png
-- docs/21-accept-warnings.png
-- docs/22-grant-access.png
-- docs/24-confirm-choices.png
-- docs/25-success-code.png
-- docs/26-type-code-into-imap-backup.png
-- 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
-- lib/gmail/authenticator.rb
-- lib/google/auth/stores/in_memory_token_store.rb
 - lib/imap/backup.rb
 - lib/imap/backup/account/connection.rb
 - lib/imap/backup/account/folder.rb
@@ -247,7 +191,6 @@ files:
 - lib/imap/backup/configuration/asker.rb
 - lib/imap/backup/configuration/connection_tester.rb
 - lib/imap/backup/configuration/folder_chooser.rb
-- lib/imap/backup/configuration/gmail_oauth2.rb
 - lib/imap/backup/configuration/list.rb
 - lib/imap/backup/configuration/setup.rb
 - lib/imap/backup/configuration/store.rb
@@ -276,15 +219,12 @@ files:
 - spec/support/silence_logging.rb
 - spec/unit/email/mboxrd/message_spec.rb
 - spec/unit/email/provider_spec.rb
-- spec/unit/gmail/authenticator_spec.rb
-- spec/unit/google/auth/stores/in_memory_token_store_spec.rb
 - spec/unit/imap/backup/account/connection_spec.rb
 - spec/unit/imap/backup/account/folder_spec.rb
 - spec/unit/imap/backup/configuration/account_spec.rb
 - spec/unit/imap/backup/configuration/asker_spec.rb
 - spec/unit/imap/backup/configuration/connection_tester_spec.rb
 - spec/unit/imap/backup/configuration/folder_chooser_spec.rb
-- spec/unit/imap/backup/configuration/gmail_oauth2_spec.rb
 - spec/unit/imap/backup/configuration/list_spec.rb
 - spec/unit/imap/backup/configuration/setup_spec.rb
 - spec/unit/imap/backup/configuration/store_spec.rb
@@ -335,15 +275,12 @@ test_files:
 - spec/support/silence_logging.rb
 - spec/unit/email/mboxrd/message_spec.rb
 - spec/unit/email/provider_spec.rb
-- spec/unit/gmail/authenticator_spec.rb
-- spec/unit/google/auth/stores/in_memory_token_store_spec.rb
 - spec/unit/imap/backup/account/connection_spec.rb
 - spec/unit/imap/backup/account/folder_spec.rb
 - spec/unit/imap/backup/configuration/account_spec.rb
 - spec/unit/imap/backup/configuration/asker_spec.rb
 - spec/unit/imap/backup/configuration/connection_tester_spec.rb
 - spec/unit/imap/backup/configuration/folder_chooser_spec.rb
-- spec/unit/imap/backup/configuration/gmail_oauth2_spec.rb
 - spec/unit/imap/backup/configuration/list_spec.rb
 - spec/unit/imap/backup/configuration/setup_spec.rb
 - spec/unit/imap/backup/configuration/store_spec.rb