imap-backup 14.2.0 → 14.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1da04e15e0f6c66398320aff6a7ce638e50089db3b6470a3aed7c6a4b49f0a66
-  data.tar.gz: '0261943b048d8a97f334ca58f21010ae26799ff0afab23cd611cf4528ac841c7'
+  metadata.gz: 1fa22c1790c4f48592fd5be38af7e23109a1bd170c71a08f2277576ddee8ea7e
+  data.tar.gz: b78e7398359db0707df631ac4c0cbd075a2879f879a4b3155afc9bc98ce8f2a6
 SHA512:
-  metadata.gz: 627bcbbdeab8a9bf8cd68cdfd28ae68fbd0961aeb8ce87703428b4a6c1709c3a08a6b45619fc9455d124e31c677af0423e726bbe2c89ad28abc35ddff1fdf2ad
-  data.tar.gz: ea19474d8dbe419330b96f46860d44ca930d94188492afde2afde4a7a3018e190904b13af6f820c88295540deca0887abee908987abcef8a2d17d7c21fe239db
+  metadata.gz: 9b14acc69aa91010b1ea0cc8fa3257376d63d0accb3e41cfc04910861c2ab8e3d4bcf4035efabd34cfd1ee9ccbda5e26b2f63fb8306534f474deddf3ec83b2a2
+  data.tar.gz: df034a9b5f24fa072506d9cbf858df23bf533fe6e57cedd0845e22e90d6ffbc0962619786af5746e15dec448ed46654337e362d5c26b8a82efc5b72acf5c7b3e

data/README.md

@@ -30,10 +30,49 @@ There are two types of backups:
 * Mirror - make a destination account match the local copy. This action can be repeated.
 * Restore - push the local copy back to the original account.
 
-See below for a [full list of commands](#Commands).
+See below for a [full list of commands](#commands).
 
 # Installation
 
+## Docker or Podman
+
+If you have Docker or Podman installed, the easist way to use imap-backup
+is via the container image.
+
+You'll need to choose a path on your computer where your backups will be saved,
+we'll use `./my-data` here.
+
+If you have just one account, you can do as follows
+
+```sh
+docker run -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
+  imap-backup single backup \
+  --email me@example.com --password mysecret --server imap.example.com \
+  --path /data/me_example.com
+```
+
+Podman will work exactly the same.
+
+If you have multiple accounts, you can create a configuration file.
+
+You'll need to choose a path on your computer where your configuration will be saved,
+we'll use `./my-config` here.
+
+First, run the menu-driven setup program to configure your accounts
+
+```sh
+docker run -ti -v ./my-config:/config -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
+  imap-backup setup -c /config/imap-backup.json
+```
+
+Then, run the backup
+
+```sh
+docker run -v ./my-config:/config -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
+  imap-backup backup -c /config/imap-backup.json
+```
+
+
 ## Homebrew (macOS)
 
 ![Homebrew installs](https://img.shields.io/homebrew/installs/dm/imap-backup?label=Homebrew%20installs)
@@ -76,8 +115,8 @@ you can pass all the necessary parameters directly to the `single backup` comman
 ## GMail
 
 To use imap-backup with GMail, Office 365 and other services that require
-OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy)
-to handle authentication, and then connect to the proxy on a local port.
+OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy).
+See [this blog post about using imap-backup with email-oauth2-proxy](https://joeyates.info/posts/back-up-gmail-accounts-with-imap-backup-using-email-oauth2-proxy/).
 
 # Backup
 
@@ -121,7 +160,7 @@ For more information about a command, run
 imap-backup help COMMAND
 ```
 
-# Performace
+# Performance
 
 There are a couple of performance tweaks that you can use
 to improve backup speed.

data/docs/development.md

@@ -13,35 +13,30 @@ git config --local blame.ignoreRevsFile .git-blame-ignore-revs
 * Restartable - calculate start point based on already downloaded messages
 * Standalone - do not rely on an email client or MTA
 
-# Development
-
-A Dockerfile is available to allow testing with all available Ruby versions,
-see the `dev/container` directory.
-
 # Testing
 
 ## Feature Specs
 
 Specs under `specs/features` are integration specs run against
-two local IMAP servers controlled by Docker Compose.
+two local IMAP servers controlled by Podman (or Docker) Compose.
 
 Start them before running the test suite
 
 ```sh
-$ docker-compose -f dev/docker-compose.yml up -d
+$ podman-compose -f dev/compose.yml up -d
 ```
 
 or, with Podman
 
 ```sh
-$ podman-compose -f dev/docker-compose.yml up -d
+$ podman-compose -f dev/compose.yml up -d
 ```
 
 ```sh
 $ rake
 ```
 
-To exclude Docker-based tests:
+To exclude container-based tests:
 
 ```sh
 rake no-docker
@@ -53,6 +48,11 @@ or
 $ rspec --tag ~docker
 ```
 
+# Older Rubies
+
+A Containerfile is available to allow testing with all available Ruby versions,
+see the README in the `dev` directory.
+
 # Performance Specs
 
 ```sh

data/imap-backup.gemspec

@@ -1,5 +1,4 @@
-$LOAD_PATH.unshift(File.expand_path("lib", __dir__))
-require "imap/backup/version"
+require_relative "lib/imap/backup/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "imap-backup"

data/lib/imap/backup/configuration.rb

@@ -122,27 +122,30 @@ module Imap::Backup
             else
               DEFAULT_STRATEGY
             end
-          if data[:version] == VERSION_2_1
-            dehashify_folders(data)
-          else
-            data
-          end
+          dehashify_folders(data)
         else
           {accounts: [], download_strategy: DEFAULT_STRATEGY}
         end
     end
 
     def dehashify_folders(data)
-      data[:version] = VERSION
-
       data[:accounts].each do |account|
         next if !account.key?(:folders)
 
         folders = account[:folders]
-        names = folders.map { |f| f[:name] }
+        names = folders.map do |f|
+          case f
+          when Hash
+            f[:name]
+          else
+            f
+          end
+        end
         account[:folders] = names
       end
 
+      data[:version] = VERSION
+
       data
     end
 

data/lib/imap/backup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 14.2.0
+  version: 14.4.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline