imap-backup 4.0.0.rc3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956fde3bc96dc3acd872d51905a88fa9478d9b5cd7022cf55f8e73db769d8ef7
-  data.tar.gz: 28d653dc4e1cfebaed0a730c0231ec13a3c3c04e1a8514352183b11f152db065
+  metadata.gz: 85e081f686a106384d27ffc91cb21965832edd629da671261bda69b668776d5e
+  data.tar.gz: 8253587491a279e76ebed2268a66b60d9aab4f517cdafadb8c9494e7c3f3648b
 SHA512:
-  metadata.gz: 75643fb06176ab9017d0a7673bb428df4907e1350075cf4e3429702b42f03f8a6ef8a2be1095af3b6f4032ebd682d165e05d94b2e3930397ecb31ad95b2be665
-  data.tar.gz: e703041a7ed4e38ced9ef1b762fb3f2ebaf178cd7beb88a204624f6dd7fc53c8f9b9635942018c0f02abfa664db90e52c17eccf3278251e23395072153fe99da
+  metadata.gz: e2b3806cedfe124c286477f50690781c4593db1f3b12d53281c666d3d5771f9a42aa4cc24851fb88f9205a2f11a8e299c74a331a606de1aab056e56b753e3cf1
+  data.tar.gz: fc96edce37dd33793d04da272f2aea087ad7a16aa409726c83d6cf453bd386e3673a75b8d4e0eee90f352fc1e9168d611865dd87f79c05ff0cf132278bf59df3

data/docs/restore.md

@@ -0,0 +1,13 @@
+# FAQ
+
+# How does restore work?
+
+# What are all these 'INBOX.12345' files?
+
+# Will my email get overwritten?
+
+## 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

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.expand_path("lib", __dir__))
 require "imap/backup/version"
+require "rake/file_list"
 
 Gem::Specification.new do |gem|
   gem.name          = "imap-backup"
@@ -8,8 +9,17 @@ 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"]
+
+  # Build list of files manually, see also
+  # https://github.com/rubygems/rubygems/blob/master/bundler/bundler.gemspec#L37
+  gem.files         = %w[bin/imap-backup]
+  gem.files         += Dir.glob("docs/*{.png,.md}")
+  gem.files         += Dir.glob("lib/**/*.rb")
+  gem.files         += Dir.glob("spec/**/*{.rb,.yml}")
+  gem.files         += %w[imap-backup.gemspec]
+  gem.files         += %w[LICENSE 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.require_paths = ["lib"]

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

@@ -21,8 +21,8 @@ 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
@@ -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.rb

@@ -1,5 +1,7 @@
 require "thor"
 
+module Imap; end
+
 module Imap::Backup
   class CLI < Thor
     require "imap/backup/cli/helpers"

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

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

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.rc3
+  version: 4.0.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -158,21 +158,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 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/restore.md
+- docs/setup.md
 - imap-backup.gemspec
 - lib/email/mboxrd/message.rb
 - lib/email/provider.rb
@@ -235,9 +226,9 @@ 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: []
@@ -250,9 +241,9 @@ 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: 

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/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__
-