imap-backup 4.0.0.rc4 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a4ee81a7f56f357e7cce1b3b51a3e3123376af66ea726eb9c11efe91989a32f
-  data.tar.gz: 6400e827ae35b2f9afe639e84087104e5725076fb1395f9c265fdac30a664c78
+  metadata.gz: 97ae9089aa19dee6fcf7a1c211091671a6befe882d5b664654a25d6d10e81704
+  data.tar.gz: 2677746ed662c457a738033224da11a40a76367e4031e7636b33391d51ee4659
 SHA512:
-  metadata.gz: e61c2bdbb366beca94ee2943eb802cadb4c07fee561c3a34798feb1659dc81f39a8ff7c15a9e0f366a879e034e39da59bf696345d24c061eed4a578a67382379
-  data.tar.gz: 79c116c218ae79e1ef73f295e5b24976afb841f7ecf7840a9574eec692ca7377e3d957e2d72724a4e6b2fe514b121c9f36869933ac40a77c4fda5bcf253f8ec1
+  metadata.gz: 5e97ba8ab64e27924166609c1cb80e52dbfa8136b4248324a7589e143d64ebddbb415ad6c4c7a0e472732db55c717d14e08be47c7640efcb36029c80b10938ef
+  data.tar.gz: 2fd74f2b86946b79d07a1354a55b00444022838fcd4968a6a2f0dc15494f4c2d80d0ea06b1e0290b921e7f2242566a56fb8e9bd6bf03b5a88595871c91d08604

data/README.md

@@ -16,10 +16,6 @@
 [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
-
-To use imap-backup with GMail, you will need to enable 'App passwords' on your account.
-
 # Installation
 
 ```shell
@@ -51,6 +47,10 @@ Run:
 $ imap-backup setup
 ```
 
+## GMail
+
+To use imap-backup with GMail, you will need to enable 'App passwords' on your account.
+
 ## Folders
 
 By default, all folders are backed-up. You can override this by choosing
@@ -178,6 +178,7 @@ If you have problems:
   "debug": true
 }
 ```
+
 # Restore
 
 All missing messages are pushed to the IMAP server.
@@ -206,48 +207,7 @@ $ imap-backup status
 * Restartable - calculate start point based on already downloaded messages
 * Standalone - do not rely on an email client or MTA
 
-# Similar Software
-
-* https://github.com/OfflineIMAP/offlineimap
-
-# Testing
-
-## Integration Tests
-
-Integration tests (feature specs) are run against a Docker image
-(antespi/docker-imap-devel:latest).
-
-In one shell, run the Docker image:
-
-```sh
-$ docker run \
-  --env MAIL_ADDRESS=address@example.org \
-  --env MAIL_PASS=pass \
-  --env MAILNAME=example.org \
-  --publish 8993:993 \
-  antespi/docker-imap-devel:latest
-```
-
-```sh
-$ rake
-```
-
-To exclude Docker-based tests:
-
-```sh
-rake no-docker
-```
-
-or
-
-```sh
-$ rspec --tag ~docker
-```
-
-## Contributing
+# Documentation
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* [Development](./docs/development.md)
+* [Restore](./docs/restore.md)

data/docs/development.md

@@ -0,0 +1,60 @@
+# Testing
+
+## Integration Tests
+
+Integration tests (feature specs) are run against a Docker image
+(antespi/docker-imap-devel:latest).
+
+In one shell, run the Docker image:
+
+```sh
+$ docker run \
+  --env MAIL_ADDRESS=address@example.org \
+  --env MAIL_PASS=pass \
+  --env MAILNAME=example.org \
+  --publish 8993:993 \
+  antespi/docker-imap-devel:latest
+```
+
+```sh
+$ rake
+```
+
+To exclude Docker-based tests:
+
+```sh
+rake no-docker
+```
+
+or
+
+```sh
+$ rspec --tag ~docker
+```
+
+## Access Docker imap server
+
+```ruby
+require "net/imap"
+
+imap = Net::IMAP.new("localhost", {port: 8993, ssl: {verify_mode: 0}})
+username = "address@example.org"
+imap.login(username, "pass")
+
+message = "From: #{username}\nSubject: Some Subject\n\nHello!\n"
+response = imap.append("INBOX", message, nil, nil)
+
+imap.examine("INBOX")
+uids = imap.uid_search(["ALL"]).sort
+
+REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"].freeze
+fetch_data_items = imap.uid_fetch(uids, REQUESTED_ATTRIBUTES)
+```
+
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/docs/restore.md

@@ -0,0 +1,30 @@
+# FAQ
+
+# How does restore work?
+
+Backed-up emails are pushed to the IMAP server.
+If there are clashes, folders are renamed.
+
+# What are all these 'INBOX.12345' files?
+
+If, when the backup is launched, the IMAP server contains a folder with
+the same name, but different history to the local backup, the local
+emails cannot simply be added to the existing folder.
+
+In this case, a numeric suffix is added to the **local** folder,
+before it is restored.
+
+In this way, old and new emails are kept separate.
+
+# Will my email get overwritten?
+
+No.
+
+Emails are identified by folder and a specific email id. Any email that
+is already on the server is skipped.
+
+## How do I restore to a different service?
+
+1. Run setup and add the new server, (but don't run any backups),
+2. Rename of the existing backup directory to match the new email address,
+3. Run the restore.

data/docs/setup.md

@@ -0,0 +1,5 @@
+# HOWTOs
+
+## Set the server for a Google Apps account
+
+Use imap.gmail.com

data/imap-backup.gemspec

@@ -8,13 +8,23 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Joe Yates"]
   gem.email         = ["joe.g.yates@gmail.com"]
   gem.homepage      = "https://github.com/joeyates/imap-backup"
+  gem.licenses      = ["MIT"]
+  gem.version       = Imap::Backup::VERSION
+
+  gem.files         = %w[bin/imap-backup]
+  gem.files         += Dir.glob("docs/*.md")
+  gem.files         += Dir.glob("lib/**/*.rb")
+  gem.files         += %w[imap-backup.gemspec]
+  gem.files         += %w[LICENSE README.md]
+
+  gem.extra_rdoc_files += Dir.glob("README.md")
+  gem.extra_rdoc_files += Dir.glob("docs/*.md")
+  gem.rdoc_options = ["--main", "README.md"]
 
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.test_files    = Dir.glob("spec/**/*{.rb,.yml}")
   gem.require_paths = ["lib"]
   gem.required_ruby_version = ">= 2.5"
-  gem.version = Imap::Backup::VERSION
 
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail"

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

@@ -10,7 +10,6 @@ module Imap::Backup::CLI::Helpers
       connections = Imap::Backup::Configuration::List.new(names)
     rescue Imap::Backup::ConfigurationNotFound
       raise "imap-backup is not configured. Run `imap-backup setup`"
-      return
     end
 
     connections.each_connection do |connection|

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

@@ -21,14 +21,14 @@ module Imap::Backup
       end
     end
 
-    desc "emails EMAIL FOLDER", "List emails in a folder"
-    def emails(email, folder_name)
+    desc "list EMAIL FOLDER", "List emails in a folder"
+    def list(email, folder_name)
       connections = Imap::Backup::Configuration::List.new
       account = connections.accounts.find { |a| a[:username] == email }
       raise "#{email} is not a configured account" if !account
 
       account_connection = Imap::Backup::Account::Connection.new(account)
-      folder_serializer, folder = account_connection.local_folders.find do |(_s, f)|
+      folder_serializer, _folder = account_connection.local_folders.find do |(_s, f)|
         f.name == folder_name
       end
       raise "Folder '#{folder_name}' not found" if !folder_serializer
@@ -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,8 +53,13 @@ module Imap::Backup
       end
     end
 
-    desc "email EMAIL FOLDER UID", "Show an email"
-    def email(email, folder_name, uid)
+    desc "show EMAIL FOLDER UID[,UID]", "Show one or more emails"
+    long_desc <<~DESC
+      Prints out the requested emails.
+      If more than one UID is given, they are separated by a header indicating
+      the UID.
+    DESC
+    def show(email, folder_name, uids)
       connections = Imap::Backup::Configuration::List.new
       account = connections.accounts.find { |a| a[:username] == email }
       raise "#{email} is not a configured account" if !account
@@ -61,10 +70,17 @@ module Imap::Backup
       end
       raise "Folder '#{folder_name}' not found" if !folder_serializer
 
-      loaded_message = folder_serializer.load(uid)
-      raise "Message #{uid} not found in folder '#{folder_name}'" if !loaded_message
-
-      puts loaded_message.supplied_body
+      uid_list = uids.split(",")
+      folder_serializer.each_message(uid_list).each do |uid, message|
+        if uid_list.count > 1
+          puts <<~HEADER
+            #{'-' * 80}
+            #{format('| UID: %-71s |', uid)}
+            #{'-' * 80}
+          HEADER
+        end
+        puts message.supplied_body
+      end
     end
   end
 end

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

@@ -1,7 +1,7 @@
 class Imap::Backup::CLI::Setup < Thor
   include Thor::Actions
 
-  def initialize()
+  def initialize
     super([])
   end
 

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

@@ -0,0 +1,41 @@
+module Imap::Backup
+  class CLI::Utils < Thor
+    include Thor::Actions
+
+    FAKE_EMAIL = "fake@email.com"
+
+    desc "ignore-history EMAIL", "Skip downloading emails up to today for all configured folders"
+    def ignore_history(email)
+      connections = Imap::Backup::Configuration::List.new
+      account = connections.accounts.find { |a| a[:username] == email }
+      raise "#{email} is not a configured account" if !account
+
+      connection = Imap::Backup::Account::Connection.new(account)
+
+      connection.local_folders.each do |_s, f|
+        next if !folder.exist?
+        do_ignore_folder_history(connection, folder)
+      end
+    end
+
+    no_commands do
+      def do_ignore_folder_history(connection, folder)
+        serializer = Imap::Backup::Serializer::Mbox.new(connection.local_path, folder.name)
+        uids = folder.uids - serializer.uids
+        Imap::Backup.logger.info "Folder '#{folder.name}' - #{uids.length} messages"
+
+        serializer.apply_uid_validity(folder.uid_validity)
+
+        uids.each do |uid|
+          message = <<~MESSAGE
+            From: #{FAKE_EMAIL}
+            Subject: Message #{uid} not backed up
+            Skipped #{uid}
+          MESSAGE
+
+          serializer.save(uid, message)
+        end
+      end
+    end
+  end
+end

data/lib/imap/backup/cli.rb

@@ -13,6 +13,7 @@ module Imap::Backup
     autoload :Restore, "imap/backup/cli/restore"
     autoload :Setup, "imap/backup/cli/setup"
     autoload :Status, "imap/backup/cli/status"
+    autoload :Utils, "imap/backup/cli/utils"
 
     include Helpers
 
@@ -73,7 +74,7 @@ module Imap::Backup
       Configure email accounts to back up.
     DESC
     def setup
-      Setup.new().run
+      Setup.new.run
     end
 
     desc "status", "Show backup status"
@@ -87,5 +88,8 @@ module Imap::Backup
 
     desc "local SUBCOMMAND [OPTIONS]", "View local info"
     subcommand "local", Local
+
+    desc "utils SUBCOMMAND [OPTIONS]", "Various utilities"
+    subcommand "utils", Utils
   end
 end

data/lib/imap/backup/downloader.rb

@@ -22,7 +22,8 @@ module Imap::Backup
         Imap::Backup.logger.debug(
           "#{log_prefix} #{message['RFC822'].size} bytes"
         )
-        serializer.save(uid, message)
+        body = message["RFC822"]
+        serializer.save(uid, body)
       end
     end
   end

data/lib/imap/backup/serializer/mbox_store.rb

@@ -40,7 +40,7 @@ module Imap::Backup
       @uids || []
     end
 
-    def add(uid, message)
+    def add(uid, body)
       do_load if !loaded
       raise "Can't add messages without uid_validity" if !uid_validity
 
@@ -52,7 +52,6 @@ module Imap::Backup
         return
       end
 
-      body = message["RFC822"]
       mboxrd_message = Email::Mboxrd::Message.new(body)
       mbox = nil
       begin
@@ -84,7 +83,8 @@ module Imap::Backup
     def each_message(required_uids)
       return enum_for(:each_message, required_uids) if !block_given?
 
-      indexes = required_uids.each.with_object({}) do |uid, acc|
+      indexes = required_uids.each.with_object({}) do |uid_maybe_string, acc|
+        uid = uid_maybe_string.to_i
         index = uids.find_index(uid)
         acc[index] = uid if index
       end

data/lib/imap/backup/version.rb

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

data/spec/spec_helper.rb

@@ -15,5 +15,6 @@ SimpleCov.start do
 end
 
 require "imap/backup"
+require "imap/backup/cli"
 
 silence_logging

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

@@ -2,7 +2,8 @@ describe Imap::Backup::Downloader do
   describe "#run" do
     subject { described_class.new(folder, serializer) }
 
-    let(:message) { {"RFC822" => "blah"} }
+    let(:body) { "blah" }
+    let(:message) { {"RFC822" => body} }
     let(:folder) do
       instance_double(
         Imap::Backup::Account::Folder,
@@ -18,7 +19,7 @@ describe Imap::Backup::Downloader do
 
     context "with fetched messages" do
       specify "are saved" do
-        expect(serializer).to receive(:save).with("111", message)
+        expect(serializer).to receive(:save).with("111", body)
 
         subject.run
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc4
+  version: 4.0.1
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -156,23 +156,18 @@ email:
 executables:
 - imap-backup
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- docs/setup.md
+- docs/restore.md
+- docs/development.md
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rspec"
-- ".rspec-all"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/imap-backup
-- docker-compose.yml
-- docs/docker-imap.md
-- imap-backup
+- docs/development.md
+- docs/restore.md
+- docs/setup.md
 - imap-backup.gemspec
 - lib/email/mboxrd/message.rb
 - lib/email/provider.rb
@@ -187,6 +182,7 @@ files:
 - lib/imap/backup/cli/restore.rb
 - lib/imap/backup/cli/setup.rb
 - lib/imap/backup/cli/status.rb
+- lib/imap/backup/cli/utils.rb
 - lib/imap/backup/configuration/account.rb
 - lib/imap/backup/configuration/asker.rb
 - lib/imap/backup/configuration/connection_tester.rb
@@ -235,12 +231,14 @@ files:
 - spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
 - spec/unit/imap/backup_spec.rb
-- tmp/.gitkeep
 homepage: https://github.com/joeyates/imap-backup
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -250,44 +248,44 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files:
-- spec/features/backup_spec.rb
-- spec/features/helper.rb
-- spec/features/restore_spec.rb
-- spec/features/support/backup_directory.rb
-- spec/features/support/email_server.rb
-- spec/features/support/shared/connection_context.rb
-- spec/features/support/shared/message_fixtures.rb
-- spec/fixtures/connection.yml
-- spec/gather_rspec_coverage.rb
 - spec/spec_helper.rb
-- spec/support/fixtures.rb
-- spec/support/higline_test_helpers.rb
-- spec/support/shared_examples/account_flagging.rb
-- spec/support/silence_logging.rb
-- spec/unit/email/mboxrd/message_spec.rb
-- spec/unit/email/provider_spec.rb
-- spec/unit/imap/backup/account/connection_spec.rb
-- spec/unit/imap/backup/account/folder_spec.rb
+- spec/unit/imap/backup_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/list_spec.rb
+- spec/unit/imap/backup/configuration/connection_tester_spec.rb
 - spec/unit/imap/backup/configuration/setup_spec.rb
+- spec/unit/imap/backup/configuration/asker_spec.rb
+- spec/unit/imap/backup/configuration/folder_chooser_spec.rb
 - spec/unit/imap/backup/configuration/store_spec.rb
-- spec/unit/imap/backup/downloader_spec.rb
-- spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
 - spec/unit/imap/backup/serializer/mbox_spec.rb
 - spec/unit/imap/backup/serializer/mbox_store_spec.rb
+- spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
+- spec/unit/imap/backup/downloader_spec.rb
 - spec/unit/imap/backup/uploader_spec.rb
+- spec/unit/imap/backup/account/folder_spec.rb
+- spec/unit/imap/backup/account/connection_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
-- spec/unit/imap/backup_spec.rb
+- spec/unit/email/mboxrd/message_spec.rb
+- spec/unit/email/provider_spec.rb
+- spec/features/backup_spec.rb
+- spec/features/helper.rb
+- spec/features/restore_spec.rb
+- spec/features/support/email_server.rb
+- spec/features/support/backup_directory.rb
+- spec/features/support/shared/connection_context.rb
+- spec/features/support/shared/message_fixtures.rb
+- spec/support/fixtures.rb
+- spec/support/silence_logging.rb
+- spec/support/higline_test_helpers.rb
+- spec/support/shared_examples/account_flagging.rb
+- spec/fixtures/connection.yml
+- spec/gather_rspec_coverage.rb

data/.circleci/config.yml

@@ -1,51 +0,0 @@
-version: 2.1
-
-orbs:
-  ruby: circleci/ruby@1.1.2
-
-references:
-  restore: &restore
-    restore_cache:
-      keys:
-        - 'imap.backup.<< parameters.ruby_version >>.{{checksum "imap-backup.gemspec"}}'
-  bundle: &bundle
-    run:
-      name: Install Ruby dependencies
-      command: |
-        bundle install
-        bundle clean
-  save: &save
-    save_cache:
-      key: 'imap.backup.<< parameters.ruby_version >>.{{checksum "imap-backup.gemspec"}}'
-      paths:
-        - vendor/bundle
-
-jobs:
-  test:
-    parameters:
-      ruby_version:
-        type: string
-    environment:
-      BUNDLE_PATH: ./vendor/bundle
-      DOCKER_IMAP_SERVER: 993
-    docker:
-      - image: "cimg/ruby:<< parameters.ruby_version >>"
-      - image: antespi/docker-imap-devel:latest
-        environment:
-          MAIL_ADDRESS: address@example.org
-          MAIL_PASS: pass
-          MAILNAME: example.org
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *save
-      - ruby/rspec-test
-
-workflows:
-  all-tests:
-    jobs:
-      - test:
-          matrix:
-            parameters:
-              ruby_version: ["2.5", "2.6", "2.7"]

data/.gitignore

@@ -1,8 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-coverage
-pkg
-.rbenv-version
-vendor
-/tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rspec-all

@@ -1,4 +0,0 @@
---color
---format documentation
---order random
---require spec_helper

data/.rubocop.yml

@@ -1,21 +0,0 @@
-inherit_from:
-  - https://raw.githubusercontent.com/leanpanda-com/rubocop/0.89.1/rubocop-rspec.yml
-  - .rubocop_todo.yml
-
-AllCops:
-  Exclude:
-    - "bin/stubs/*"
-  DisplayCopNames:
-    Enabled: true
-
-RSpec/ContextWording:
-  Exclude:
-    - "spec/features/**/*"
-RSpec/LeakyConstantDeclaration:
-  Enabled: false
-RSpec/MessageSpies:
-  Enabled: false
-RSpec/ReturnFromStub:
-  Enabled: false
-Style/EmptyCaseCondition:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,129 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# 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: 1
-# Cop supports --auto-correct.
-Layout/ElseAlignment:
-  Exclude:
-    - 'lib/imap/backup/configuration/gmail_oauth2.rb'
-
-# Offense count: 2
-# 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: 172
-
-# Offense count: 19
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 26
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ModuleLength:
-  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: 209
-# Configuration parameters: AllowSubject.
-RSpec/MultipleMemoizedHelpers:
-  Max: 16
-
-# 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/CHANGELOG.md

@@ -1,19 +0,0 @@
-# Change Log
-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/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,18 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "spec/**/*_spec.rb"
-end
-
-desc "Run RSpec examples, excluding ones relying on Docker IMAP"
-RSpec::Core::RakeTask.new("no-docker") do |t|
-  t.pattern = "spec/**/*_spec.rb"
-  t.rspec_opts = "--tag ~docker"
-end
-
-RuboCop::RakeTask.new
-
-task default: :spec
-task default: :rubocop

data/docker-compose.yml

@@ -1,15 +0,0 @@
-# This file adapted from github.com/antespi/docker-imap-devel
-version: "3"
-
-services:
-  imap:
-    image: antespi/docker-imap-devel:latest
-    container_name: imap
-    ports:
-    - "8025:25"
-    - "8143:143"
-    - "8993:993"
-    environment:
-    - MAILNAME=example.org
-    - MAIL_ADDRESS=address@example.org
-    - MAIL_PASS=pass

data/docs/docker-imap.md

@@ -1,18 +0,0 @@
-# Access Docker imap server
-
-```ruby
-require "net/imap"
-
-imap = Net::IMAP.new("localhost", {port: 8993, ssl: {verify_mode: 0}})
-username = "address@example.org"
-imap.login(username, "pass")
-
-message = "From: #{username}\nSubject: Some Subject\n\nHello!\n"
-response = imap.append("INBOX", message, nil, nil)
-
-imap.examine("INBOX")
-uids = imap.uid_search(["ALL"]).sort
-
-REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"].freeze
-fetch_data_items = imap.uid_fetch(uids, REQUESTED_ATTRIBUTES)
-```

data/imap-backup

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift(File.expand_path("../lib/", __dir__))
-require "imap/backup/cli"
-
-Imap::Backup::CLI.start(ARGV)
-
-__END__
-