imap-backup 3.4.0 → 4.0.0.rc3

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
 
@@ -12,6 +12,7 @@ module Imap::Backup
       return if !config_exists?
 
       Imap::Backup.setup_logging config
+      Net::IMAP.debug = config.debug?
     end
 
     def each_connection
@@ -22,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
@@ -37,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
+  MAJOR    = 4
+  MINOR    = 0
   REVISION = 0
-  PRE      = nil
+  PRE      = "rc3"
   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
 
@@ -433,24 +388,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
+      end
+    end
 
-      subject.disconnect
+    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/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" }
 

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,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0.rc3
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 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
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mail
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -178,52 +164,33 @@ files:
 - ".rspec-all"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - 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
+- 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
 - 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
@@ -252,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
@@ -283,12 +247,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      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: 
@@ -311,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

data/docs/setting-up-gmail-with-oauth2.md

@@ -1,166 +0,0 @@
-# Setting up GMail Authentication for imap-backup
-
-# Create a Google project
-
-Go to https://console.developers.google.com
-
-Select "Credentials".
-
-![Credential screen](01-credentials-screen.png)
-
-Select "CREATE PROJECT".
-
-![New project](02-new-project.png)
-
-Set or accept the "Project name",
-
-And optionally do the same with the "Project ID",
-
-Leave "Location" on "No organization",
-
-Click "CREATE".
-
-![Initial project credentials](03-initial-credentials-for-project.png)
-
-Click "+ CREATE CREDENTIALS".
-
-![Credential type selection](04-credential-type-selection.png)
-
-Select "OAuth client ID".
-
-![Can't create credentials before setting up the consent screen](05-cant-create-without-consent-setup.png)
-
-Click "CONFIGURE CONSENT SCREEN".
-
-![User type selection](06-user-type-selection.png)
-
-Select "External",
-
-Click "CREATE".
-
-![Consent screen form](07-consent-screen-form.png)
-
-Fill in "App name",
-
-Select your email as "User support email",
-
-Type in your email at the bottom under "Developer contact information",
-
-Click "SAVE AND CONTINUE".
-
-![App scopes](08-app-scopes.png)
-
-Click "ADD OR REMOVE SCOPES".
-
-![Scope selection](09-scope-selection.png)
-
-Under "Manually add scopes", type "https://mail.google.com/",
-
-Click "ADD TO TABLE",
-
-Click "UPDATE".
-
-![Updated app scopes](10-updated-app-scopes.png)
-
-Click "SAVE AND CONTINUE".
-
-![Test users](11-test-users.png)
-
-Click "+ ADD USERS".
-
-![Add users](12-add-users.png)
-
-Type in your email,
-
-Click "SAVE AND CONTINUE",
-
-Click "BACK TO DASHBOARD",
-
-Click "Credentials" in the menu
-
-And then click "+ CREATE CREDENTIALS" again,
-
-And select "OAuth client ID" again.
-
-![Create OAuth client](13-create-oauth-client.png)
-
-This time you will be able to proceed.
-
-![Application details](14-application-details.png)
-
-Select "TVs and limited input devices",
-
-Click "CREATE",
-
-Copy both "Your Client ID"
-
-And "Your Client Secret".
-
-# Set up imap-backup
-
-Run `imap-backup setup`.
-
-![Initial imap-backup menu](16-initial-menu.png)
-
-Choose 'add account'.
-
-![Type in your email address](17-inputting-the-email-address.png)
-
-Type in your GMail address.
-
-Note: if you have a custom domain (GSuite) address,
-e.g. "me@mycompany.com", you now need to
-choose 'server' and
-type in 'imap.gmail.com'.
-
-![Choose password](18-choose-password.png)
-
-Choose `password`.
-
-![Supply client info](19-supply-client-info.png)
-
-Type your "Client ID" and "Client Secret",
-
-Next you will be shown a URL to open in your browser.
-
-![Choose GMail account](20-choose-gmail-account.png)
-
-If you have more than one GMail account you will need to choose which
-you are configuring.
-
-![Accept warnings](21-accept-warnings.png)
-
-As the project "app" is in test mode,
-you'll need to accept to ignore this warning.
-
-Click "Advanced",
-
-Then click "Go to XXXYYYZZZ (unsafe)"
-
-![Grant access](22-grant-access.png)
-
-Choose "Allow".
-
-![Confirm choices](24-confirm-choices.png)
-
-Choose "Allow".
-
-![Success code screen](25-success-code.png)
-
-Click on the copy logo to copy the success code.
-
-![Paste the code](26-type-code-into-imap_backup.png)
-
-Paste the success code into imap-backup.
-
-Finally, choose 'test connection'.
-
-If all has gone well you should see this:
-
-![Connection successful](27-success.png)
-
-Now choose 'return to main menu',
-
-Then 'save and exit'.
-
-Your imap-backup is now configured to back up your GMail.