imap-backup 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c6ccd7ca7a6f60ae02c24c76c121470372ffbadf268eb6f52b8f6eac633e6d
-  data.tar.gz: d5da356a60a6046301c2e66a990f24948c3dc63f6c7f757ca3da43f62772468d
+  metadata.gz: 1e4037b31fc56dcf88f312506ff2814b1c3fb516ae13cf9dbb4c8a772928b5fa
+  data.tar.gz: 0465b9bf0b7a6a9dadc5c6c35b1a4dd65db058ab1ed37158d9fedf2dc093f777
 SHA512:
-  metadata.gz: 82fc5680a656d79012690e7da5038f0b8e56b1c5b14168142c222cb2c336bf44c0ec5570fbed8c50b2b2c2ea445ec17bed286d452795aa0c692d61c71d497274
-  data.tar.gz: 7eda772c5b9815dfbbe679981a0a281cecd7e3cc970c95345437d35ddc01b40f5fedb25eabef043271bdd7cfc7084bf7caad6bbd037f5926fabee0d23958252a
+  metadata.gz: 459620b79228707291d0b3be5037830e7100da42ecc920a1b5e19797fd1cc9aa9bc8fa667f5a5a7f89cc5d2647f47df5ae7e384a575c62a9bf4a13c25c70dd4b
+  data.tar.gz: 8ac9d67819df8f957ffbc6a93be59aa401bdec704d75fa637c186012d2f15e23c3efa5c68ca8dc8918c97de3d90623ee5627d3cb8107615ee108e76588afd054

data/.rubocop.yml

@@ -1,9 +1,8 @@
 inherit_from:
-  - https://gitlab.com/snippets/1744945/raw
+  - https://raw.githubusercontent.com/leanpanda-com/rubocop/0.89.1/rubocop-rspec.yml
   - .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
   Exclude:
     - "bin/stubs/*"
   DisplayCopNames:
@@ -12,8 +11,10 @@ AllCops:
 RSpec/ContextWording:
   Exclude:
     - "spec/features/**/*"
-RSpec/NestedGroups:
-  Max: 4
+RSpec/LeakyConstantDeclaration:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
 RSpec/ReturnFromStub:
   Enabled: false
 Style/EmptyCaseCondition:

data/.rubocop_todo.yml

@@ -1,24 +1,42 @@
-# Offense count: 8
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-01-09 09:21:34 UTC using RuboCop version 0.89.1.
+# 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: 29
+  Max: 33
 
 # Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 133
+  Max: 138
 
 # Offense count: 2
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 154
+  Max: 167
 
-# Offense count: 11
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 17
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 25
 
-# Offense count: 1
-# Configuration parameters: CountComments.
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 136
+  Max: 141
+
+# Offense count: 200
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 16
+
+# Offense count: 1
+RSpec/NestedGroups:
+  Max: 6

data/.travis.yml

@@ -4,10 +4,10 @@ services:
   - docker
 
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - jruby-19mode
 
 branches:

data/README.md

@@ -16,11 +16,11 @@
 [Rubygem]: http://rubygems.org/gems/imap-backup "Ruby gem at rubygems.org"
 [Continuous Integration]: http://travis-ci.org/joeyates/imap-backup "Build status by Travis-CI"
 
-## Version 2
+## GMail
+
+GMail OAuth2 authentication is supported.
 
-With versions above 2.x, this gems stores IMAP metadata in a
-backwardly-incompatible way. When upgrading, all old backups will be gradually
-deleted to allow for the new file format to be introduced.
+To set it up, [follow the HOWTO](docs/setting-up-gmail.md).
 
 # Installation
 
@@ -115,13 +115,6 @@ Specifically, if you are using a self-signed certificate and get SSL errors, e.g
 }
 ```
 
-## GMail
-
-* Enable IMAP access to your account via the GMail interface (Settings/Forwarding and POP/IMAP),
-* Under 'Sign-in & security', 'Signing in to Google', 'App passwords', generate a password
-  for imap-backup,
-* In imap-backup setup, set the server to imap.gmail.com
-
 # Security
 
 Note that email usernames and passwords are held in plain text
@@ -204,8 +197,8 @@ Integration tests (feature specs) are run against a Docker image
 
 In one shell, run the Docker image:
 
-```
-docker run \
+```sh
+$ docker run \
   --env MAIL_ADDRESS=address@example.org \
   --env MAIL_PASS=pass \
   --env MAILNAME=example.org \
@@ -213,6 +206,10 @@ docker run \
   antespi/docker-imap-devel:latest
 ```
 
+```sh
+$ rake
+```
+
 To exclude Docker-based tests:
 
 ```sh

data/bin/imap-backup

@@ -48,12 +48,15 @@ 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 opts
+  puts parser
   exit
 end
 
@@ -79,7 +82,7 @@ when "folders"
       warn "Unable to list account folders"
       exit 1
     end
-    folders.each { |f| puts "\t" + f.name }
+    folders.each { |f| puts "\t#{f.name}" }
   end
 when "restore"
   configuration.each_connection(&:restore)

data/docs/setting-up-gmail.md

@@ -0,0 +1,166 @@
+# 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.

data/imap-backup.gemspec

@@ -13,17 +13,11 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = [">= 2.3.0"]
+  gem.required_ruby_version = [">= 2.4.0"]
   gem.version = Imap::Backup::VERSION
 
-  gem.post_install_message = <<-MESSAGE.gsub(/^\s{4}/m, "")
-    Note that, when upgrading #{gem.name} 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.
-  MESSAGE
-
+  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/email/mboxrd/message.rb

@@ -10,19 +10,20 @@ module Email::Mboxrd
       cleaned = serialized.gsub(/^>(>*From)/, "\\1")
       # Serialized messages in this format *should* start with a line
       #   From xxx yy zz
+      # rubocop:disable Style/IfUnlessModifier
       if cleaned.start_with?("From ")
         cleaned = cleaned.sub(/^From .*[\r\n]*/, "")
       end
+      # rubocop:enable Style/IfUnlessModifier
       new(cleaned)
     end
 
     def initialize(supplied_body)
       @supplied_body = supplied_body.clone
-      @supplied_body.force_encoding("binary")
     end
 
     def to_serialized
-      "From " + from + "\n" + mboxrd_body
+      "From #{from}\n" + mboxrd_body
     end
 
     def date
@@ -45,7 +46,7 @@ module Email::Mboxrd
       @from ||=
         begin
           from = best_from.dup
-          from << " " + asctime if asctime != ""
+          from << " #{asctime}" if asctime != ""
           from
         end
     end