imap-backup 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3446b53604f5895cb09b109cbe663bc4ac131daeb63989b09ae8985c480464b
-  data.tar.gz: 8c3b6a7176dbda814f208505c49ed63f27d650f683dad7941734e8dbd4018601
+  metadata.gz: 44a7f8e8754461ed51afdbd5711ba809ad6b0ed68c0f40ff95a42688d85881b9
+  data.tar.gz: a70019109a179506f520b969bb03de78fa67fca66001b182af99427b7a02ecdd
 SHA512:
-  metadata.gz: 6926f54cb421029116f0e63533e1a3c3151937c9572b2c5b2143cab08e3c1aef81cba6ae3dcc2c799f77e37f3b983c4adee73f6fa90f585cddf030cff8fffd9d
-  data.tar.gz: 1ed5e647c1ef08049f928293295cb564d7e87b592dd499dc903bab74717892fffc2aa19d4f214824757dcb80f46356c12864a7cf8332b3f25512c1af637f1aff
+  metadata.gz: 5055eea6a69b674f02f2b50c0423df197a4c312171aa04a19b183ce784047699815ac603d8550d28f78ada6f2aa4a904d74d5b7bef8f6ea10633de68752f7a65
+  data.tar.gz: 7849285c5b94136b7d5f620eac770630ea4e7cf988b42cc7079021dac95163c271f5fd68d5b620ac9d36326be142557c617459ba890755920c181110cf99531a

data/.rubocop_todo.yml

@@ -1,42 +1,129 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-01-09 09:21:34 UTC using RuboCop version 0.89.1.
+# on 2021-09-21 15:30:34 UTC using RuboCop version 1.21.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 11
-# Configuration parameters: IgnoredMethods.
-Metrics/AbcSize:
-  Max: 33
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/ElseAlignment:
+  Exclude:
+    - 'lib/imap/backup/configuration/gmail_oauth2.rb'
 
 # Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 138
+# Cop supports --auto-correct.
+# Configuration parameters: EmptyLineBetweenMethodDefs, EmptyLineBetweenClassDefs, EmptyLineBetweenModuleDefs, AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/google/auth/stores/in_memory_token_store.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/imap/backup/configuration/gmail_oauth2.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/imap/backup/configuration/gmail_oauth2.rb'
+
+# Offense count: 34
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'lib/imap/backup/configuration/asker.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/gmail_oauth2_spec.rb'
 
 # Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowComments.
+Lint/UselessMethodDefinition:
+  Exclude:
+    - 'lib/imap/backup/configuration/account.rb'
+    - 'lib/imap/backup/configuration/asker.rb'
+
+# Offense count: 11
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 33
+
+# Offense count: 3
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 167
+  Max: 171
 
-# Offense count: 17
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# Offense count: 19
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 25
+  Max: 26
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 141
+  Max: 145
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
+Naming/VariableNumber:
+  Exclude:
+    - 'lib/email/provider.rb'
+    - 'spec/unit/email/provider_spec.rb'
 
-# Offense count: 200
+# Offense count: 209
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 16
 
-# Offense count: 1
+# Offense count: 49
 RSpec/NestedGroups:
   Max: 6
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/email/mboxrd/message.rb'
+    - 'lib/imap/backup/downloader.rb'
+    - 'lib/imap/backup/serializer.rb'
+    - 'lib/imap/backup/serializer/mbox.rb'
+    - 'lib/imap/backup/serializer/mbox_enumerator.rb'
+    - 'lib/imap/backup/serializer/mbox_store.rb'
+    - 'lib/imap/backup/uploader.rb'
+    - 'lib/imap/backup/utils.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/imap/backup/account/connection.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  EnforcedStyle: percent
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 133

data/README.md

@@ -16,11 +16,19 @@
 [Rubygem]: http://rubygems.org/gems/imap-backup "Ruby gem at rubygems.org"
 [Continuous Integration]: https://circleci.com/gh/joeyates/imap-backup "Build status by CirceCI"
 
-## GMail
+# GMail
 
-GMail OAuth2 authentication is supported.
+To use imap-backup with GMail, you will need to enable 'App passwords' on your account.
 
-To set it up, [follow the HOWTO](docs/setting-up-gmail.md).
+## GMail OAuth2
+
+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.
+
+You will need to set the environment variable IMAP_BACKUP_ENABLE_GMAIL_OAUTH2.
+
+To set it up, [follow the HOWTO](docs/setting-up-gmail-with-oauth2.md).
 
 # Installation
 

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

@@ -96,7 +96,7 @@ module Imap::Backup
             "Creating IMAP instance: #{server}, options: #{options.inspect}"
           )
           imap = Net::IMAP.new(server, options)
-          if gmail? && Gmail::Authenticator.refresh_token?(password)
+          if use_gmail_oauth2? && Gmail::Authenticator.refresh_token?(password)
             authenticator = Gmail::Authenticator.new(email: username, token: password)
             credentials = authenticator.credentials
             raise InvalidGmailOauth2RefreshToken if !credentials
@@ -168,8 +168,10 @@ module Imap::Backup
       password.gsub(/./, "x")
     end
 
-    def gmail?
-      server == Email::Provider::GMAIL_IMAP_SERVER
+    def use_gmail_oauth2?
+      # TODO: test use of ENV
+      server == Email::Provider::GMAIL_IMAP_SERVER &&
+        ENV["IMAP_BACKUP_ENABLE_GMAIL_OAUTH2"]
     end
 
     def local_folders

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

@@ -69,7 +69,7 @@ module Imap::Backup
     def modify_password(menu)
       menu.choice("modify password") do
         password =
-          if account[:server] == Email::Provider::GMAIL_IMAP_SERVER
+          if use_gmail_oauth2?(account)
             Configuration::GmailOauth2.new(account).run
           else
             Configuration::Asker.password
@@ -82,6 +82,11 @@ 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/configuration/gmail_oauth2.rb

@@ -8,7 +8,7 @@ module Imap::Backup
       You need to authorize imap_backup to get access to your email.
       To do so, please follow the instructions here:
 
-      https://github.com/joeyates/imap-backup/blob/main/docs/setting-up-gmail.md
+      https://github.com/joeyates/imap-backup/blob/main/docs/setting-up-gmail-with-oauth2.md
 
     BANNER
 

data/lib/imap/backup/version.rb

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

data/spec/fixtures/connection.yml

@@ -2,6 +2,6 @@
 :username: 'address@example.org'
 :password: 'pass'
 :connection_options:
-  :port: <%= ENV.fetch("DOCKER_IMAP_SERVER", 993) %>
+  :port: <%= ENV.fetch("DOCKER_IMAP_SERVER", 8993) %>
   :ssl:
     :verify_mode: 0

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

@@ -111,7 +111,15 @@ describe Imap::Backup::Account::Connection do
             with(email: USERNAME, token: PASSWORD) { authenticator }
       end
 
-      context "when the password is our copy of a GMail refresh token" do
+      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
 

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

@@ -214,16 +214,10 @@ describe Imap::Backup::Configuration::Account 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
@@ -245,14 +239,49 @@ describe Imap::Backup::Configuration::Account do
 
         include_examples "it doesn't flag the account as modified"
       end
+    end
 
-      context "when the server is for GMail" do
-        let(:current_server) { GMAIL_IMAP_SERVER }
+    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

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

@@ -43,7 +43,7 @@ describe Imap::Backup::Configuration::Setup do
     describe "main menu" do
       before { subject.run }
 
-      %w(add\ account save\ and\ exit exit\ without\ saving).each do |choice|
+      ["add account", "save and exit", "exit without saving"].each do |choice|
         it "includes #{choice}" do
           expect(output.string).to include(choice)
         end

data/spec/unit/imap/backup/utils_spec.rb

@@ -12,7 +12,6 @@ describe Imap::Backup::Utils do
   describe ".check_permissions" do
     let(:requested) { 0o345 }
 
-    # rubocop:disable RSpec/EmptyExampleGroup
     context "with existing files" do
       [
         [0o100, "less than the limit", true],
@@ -37,7 +36,6 @@ describe Imap::Backup::Utils do
         end
       end
     end
-    # rubocop:enable RSpec/EmptyExampleGroup
 
     context "with non-existent files" do
       let(:exists) { false }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gmail_xoauth
@@ -210,7 +210,7 @@ files:
 - docs/26-type-code-into-imap-backup.png
 - docs/27-success.png
 - docs/docker-imap.md
-- docs/setting-up-gmail.md
+- docs/setting-up-gmail-with-oauth2.md
 - imap-backup.gemspec
 - lib/email/mboxrd/message.rb
 - lib/email/provider.rb
@@ -290,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk