imap-backup 2.2.2 → 3.0.0.rc1

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

@@ -1,13 +1,16 @@
-# rubocop:disable RSpec/NestedGroups
-
 describe Imap::Backup::Configuration::Account do
-  describe "#initialize" do
-    subject { described_class.new(store, account, highline) }
+  ACCOUNT = "account".freeze
+  GMAIL_IMAP_SERVER = "imap.gmail.com".freeze
+  HIGHLINE = "highline".freeze
+  STORE = "store".freeze
+
+  subject { described_class.new(store, account, highline) }
 
-    let(:store) { "store" }
-    let(:account) { "account" }
-    let(:highline) { "highline" }
+  let(:account) { ACCOUNT }
+  let(:highline) { HIGHLINE }
+  let(:store) { STORE }
 
+  describe "#initialize" do
     [:store, :account, :highline].each do |param|
       it "expects #{param}" do
         expect(subject.send(param)).to eq(send(param))
@@ -16,8 +19,6 @@ describe Imap::Backup::Configuration::Account do
   end
 
   describe "#run" do
-    subject { described_class.new(store, account, highline) }
-
     let(:highline_menu_class) do
       Class.new do
         attr_reader :choices
@@ -46,7 +47,7 @@ describe Imap::Backup::Configuration::Account do
     let(:account) do
       {
         username: existing_email,
-        server: existing_server,
+        server: current_server,
         local_path: "/backup/path",
         folders: [{name: "my_folder"}],
         password: existing_password
@@ -60,7 +61,7 @@ describe Imap::Backup::Configuration::Account do
     end
     let(:existing_email) { "user@example.com" }
     let(:new_email) { "foo@example.com" }
-    let(:existing_server) { "imap.example.com" }
+    let(:current_server) { "imap.example.com" }
     let(:existing_password) { "password" }
     let(:other_email) { "other@example.com" }
     let(:other_existing_path) { "/other/existing/path" }
@@ -136,7 +137,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    describe "email" do
+    describe "choosing 'modify email'" do
       before do
         allow(Imap::Backup::Configuration::Asker).
           to receive(:email) { new_email }
@@ -146,7 +147,7 @@ describe Imap::Backup::Configuration::Account do
 
       context "when the server is blank" do
         [
-          ["GMail", "foo@gmail.com", "imap.gmail.com"],
+          ["GMail", "foo@gmail.com", GMAIL_IMAP_SERVER],
           ["Fastmail", "bar@fastmail.fm", "imap.fastmail.com"],
           ["Fastmail", "bar@fastmail.com", "imap.fastmail.com"]
         ].each do |service, email, expected|
@@ -154,7 +155,7 @@ describe Imap::Backup::Configuration::Account do
             let(:new_email) { email }
 
             context "with nil" do
-              let(:existing_server) { nil }
+              let(:current_server) { nil }
 
               it "sets a default server" do
                 expect(account[:server]).to eq(expected)
@@ -162,7 +163,7 @@ describe Imap::Backup::Configuration::Account do
             end
 
             context "with an empty string" do
-              let(:existing_server) { "" }
+              let(:current_server) { "" }
 
               it "sets a default server" do
                 expect(account[:server]).to eq(expected)
@@ -172,7 +173,7 @@ describe Imap::Backup::Configuration::Account do
         end
 
         context "when the domain is unrecognized" do
-          let(:existing_server) { nil }
+          let(:current_server) { nil }
           let(:provider) do
             instance_double(Email::Provider, provider: :default)
           end
@@ -211,12 +212,18 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    describe "password" do
+    describe "choosing 'modify password'" do
       let(:new_password) { "new_password" }
+      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 }
         subject.run
         menu.choices["modify password"].call
       end
@@ -238,9 +245,17 @@ describe Imap::Backup::Configuration::Account do
 
         include_examples "it doesn't flag the account as modified"
       end
+
+      context "when the server is for GMail" do
+        let(:current_server) { GMAIL_IMAP_SERVER }
+
+        it "sets up GMail OAuth2" do
+          expect(gmail_oauth2).to have_received(:run)
+        end
+      end
     end
 
-    describe "server" do
+    describe "choosing 'modify server'" do
       let(:server) { "server" }
 
       before do
@@ -258,7 +273,7 @@ describe Imap::Backup::Configuration::Account do
       include_examples "it flags the account as modified"
     end
 
-    describe "backup_path" do
+    describe "choosing 'modify backup path'" do
       let(:new_backup_path) { "/new/path" }
 
       before do
@@ -296,7 +311,7 @@ describe Imap::Backup::Configuration::Account do
       include_examples "it flags the account as modified"
     end
 
-    describe "folders" do
+    describe "choosing 'choose backup folders'" do
       let(:chooser) do
         instance_double(Imap::Backup::Configuration::FolderChooser, run: nil)
       end
@@ -313,7 +328,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    describe "connection test" do
+    describe "choosing 'test connection'" do
       before do
         allow(Imap::Backup::Configuration::ConnectionTester).
           to receive(:test) { "All fine" }
@@ -328,7 +343,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    describe "deletion" do
+    describe "choosing 'delete'" do
       let(:confirmed) { true }
 
       before do
@@ -355,5 +370,3 @@ describe Imap::Backup::Configuration::Account do
     end
   end
 end
-
-# rubocop:enable RSpec/NestedGroups

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

@@ -0,0 +1,84 @@
+describe Imap::Backup::Configuration::GmailOauth2 do
+  include HighLineTestHelpers
+
+  subject { described_class.new(account) }
+
+  let(:authorization_url) { "some long authorization_url" }
+  let(:credentials) { "credentials" }
+  let(:json_token) { '{"sentinel":"foo"}' }
+  let!(:highline_streams) { prepare_highline }
+  let(:highline) { Imap::Backup::Configuration::Setup.highline }
+  let(:input) { highline_streams[0] }
+  let(:output) { highline_streams[1] }
+  let(:account) { {} }
+
+  let(:authorizer) do
+    instance_double(
+      Google::Auth::UserAuthorizer,
+      get_authorization_url: authorization_url,
+      get_and_store_credentials_from_code: credentials
+    )
+  end
+  let(:token_store) do
+    instance_double(
+      Google::Auth::Stores::InMemoryTokenStore,
+      load: json_token
+    )
+  end
+
+  before do
+    allow(Google::Auth::UserAuthorizer).
+      to receive(:new) { authorizer }
+    allow(Google::Auth::Stores::InMemoryTokenStore).
+      to receive(:new) { token_store }
+
+    allow(highline).to receive(:ask).and_call_original
+
+    allow(Kernel).to receive(:system)
+    allow(Kernel).to receive(:puts)
+
+    allow(input).to receive(:gets).and_return(
+      "my_client_id\n",
+      "my_secret\n",
+      "my_code\n"
+    )
+  end
+
+  describe "#run" do
+    let!(:result) { subject.run }
+
+    it "clears the screen" do
+      expect(Kernel).to have_received(:system).with("clear")
+    end
+
+    it "requests client_id" do
+      expect(highline).to have_received(:ask).with("client_id: ")
+    end
+
+    it "requests client_secret" do
+      expect(highline).to have_received(:ask).with("client_secret: ")
+    end
+
+    it "displays the authorization URL" do
+      expect(Kernel).
+        to have_received(:puts).
+        with(/#{authorization_url}/)
+    end
+
+    it "requests the success code" do
+      expect(highline).to have_received(:ask).with("success code: ")
+    end
+
+    it "requests an access_token via the code" do
+      expect(authorizer).to have_received(:get_and_store_credentials_from_code)
+    end
+
+    it "returns the credentials" do
+      expect(result).to match('"sentinel":"foo"')
+    end
+
+    it "includes the client_secret in the credentials" do
+      expect(result).to match('"client_secret":"my_secret"')
+    end
+  end
+end

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

@@ -1,8 +1,28 @@
-# rubocop:disable RSpec/NestedGroups
-
 describe Imap::Backup::Configuration::Setup do
   include HighLineTestHelpers
 
+  subject { described_class.new }
+
+  let(:normal) { {username: "account@example.com"} }
+  let(:accounts) { [normal] }
+  let(:store) do
+    instance_double(
+      Imap::Backup::Configuration::Store,
+      "accounts": accounts,
+      "path": "/base/path",
+      "save": nil,
+      "debug?": debug,
+      "debug=": nil,
+      "modified?": modified
+    )
+  end
+  let(:debug) { false }
+  let(:modified) { false }
+  let!(:highline_streams) { prepare_highline }
+  let(:input) { highline_streams[0] }
+  let(:output) { highline_streams[1] }
+  let(:gmail_imap_server) { "imap.gmail.com" }
+
   describe "#initialize" do
     context "without a config file" do
       it "works" do
@@ -12,27 +32,6 @@ describe Imap::Backup::Configuration::Setup do
   end
 
   describe "#run" do
-    subject { described_class.new }
-
-    let(:normal) { {username: "account@example.com"} }
-    let(:accounts) { [normal] }
-    let(:store) do
-      instance_double(
-        Imap::Backup::Configuration::Store,
-        "accounts": accounts,
-        "path": "/base/path",
-        "save": nil,
-        "debug?": debug,
-        "debug=": nil,
-        "modified?": modified
-      )
-    end
-    let(:debug) { false }
-    let(:modified) { false }
-    let!(:highline_streams) { prepare_highline }
-    let(:input) { highline_streams[0] }
-    let(:output) { highline_streams[1] }
-
     before do
       allow(Imap::Backup::Configuration::Store).to receive(:new) { store }
       allow(Imap::Backup).to receive(:setup_logging)
@@ -112,28 +111,51 @@ describe Imap::Backup::Configuration::Setup do
     context "when adding accounts" do
       let(:blank_account) do
         {
-          username: "new@example.com",
+          username: added_email,
           password: "",
-          local_path: "/base/path/new_example.com",
+          local_path: local_path,
           folders: []
         }
       end
       let(:account) do
         instance_double(Imap::Backup::Configuration::Account, run: nil)
       end
+      let(:added_email) { "new@example.com" }
+      let(:local_path) { "/base/path/new_example.com" }
 
       before do
         allow(input).to receive(:gets).and_return("add\n", "exit\n")
         allow(Imap::Backup::Configuration::Asker).to receive(:email).
-          with(no_args) { "new@example.com" }
+          with(no_args) { added_email }
         allow(Imap::Backup::Configuration::Account).to receive(:new).
-          with(store, blank_account, anything) { account }
+          with(store, anything, anything) { account }
 
         subject.run
       end
 
-      it "adds account data" do
-        expect(accounts[1]).to eq(blank_account)
+      it "sets username" do
+        expect(accounts[1][:username]).to eq(added_email)
+      end
+
+      it "sets blank password" do
+        expect(accounts[1][:password]).to eq("")
+      end
+
+      it "sets local_path" do
+        expect(accounts[1][:local_path]).to eq(local_path)
+      end
+
+      it "sets folders" do
+        expect(accounts[1][:folders]).to eq([])
+      end
+
+      context "when the account is a GMail account" do
+        let(:added_email) { "new@gmail.com" }
+        let(:local_path) { "/base/path/new_gmail.com" }
+
+        it "sets the server" do
+          expect(accounts[1][:server]).to eq(gmail_imap_server)
+        end
       end
 
       it "doesn't flag the unedited account as modified" do
@@ -248,5 +270,3 @@ describe Imap::Backup::Configuration::Setup do
     end
   end
 end
-
-# rubocop:enable RSpec/NestedGroups

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-01-09 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
@@ -142,10 +170,38 @@ 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.md
 - 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
@@ -153,6 +209,7 @@ 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
@@ -180,12 +237,15 @@ 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
@@ -200,11 +260,7 @@ files:
 homepage: https://github.com/joeyates/imap-backup
 licenses: []
 metadata: {}
-post_install_message: |
-  Note that, when upgrading imap-backup from version 1.x to 2.x,
-  the metadata storage method has changed (from flat file to JSON).
-   As a result, on the first run after an upgrade, old backup folders will be
-  **deleted** and a full new backup created.
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -215,9 +271,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 
@@ -240,12 +296,15 @@ 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