imap-backup 2.0.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 334bd1417efce8e604aedbe1878d09bf2c79fce40c8efd3d2d70f2fa66a261bc
-  data.tar.gz: e217a9925ea2a8afeb7d3d26d72e644bbb58a0012c06b6f2b01c4595d24c2ae6
+  metadata.gz: 726ef170419a3bcdc1a39517cdd81640ca0674f5d5f5452f8bc97ef819d74031
+  data.tar.gz: 8fc24ed36537a68899a45e22afa3fcf1dee90c27e8432853c2d88e5b4d5c5325
 SHA512:
-  metadata.gz: b374fe448bf88411f2681c7c07159f34c06ed8c537f1dc8c18b41c60ca7c690693d0b1c672e7a31e85d38c0b50afbc9e1004344359273ef17f0ca148909a095f
-  data.tar.gz: 9be2593d7b380bd0c3d1af1a85a79d9a3662de74d078d0564fff08884c336325f1bb33c08f10582e48e0728178d80cc6a8633a26782641ee66861ca313eec9cc
+  metadata.gz: e2b59fa22614c634169104d75ad6214a0d8c788da712a8c3545281e98666b4d23b17e1a10cc1744fcf615966bd63616daa3241f7e932d2af4d10fd4508391583
+  data.tar.gz: 9e73290e3684aadc443f449f870c7ed8d23506408439bb69dc41b57613e8e439e32a4017f8dbfaf462ea5dac5fd029a0d4691c861600d4aaeeaff290e94e9215

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---tag ~docker

data/.rspec-all

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

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -0,0 +1,58 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-24 16:30:54 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: 10
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 133
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 167
+
+# Offense count: 14
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 136
+
+# Offense count: 181
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 19
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/imap/backup.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'bin/imap-backup'
+    - 'lib/email/mboxrd/message.rb'
+    - 'lib/imap/backup/configuration/account.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantRegexpEscape:
+  Exclude:
+    - 'spec/features/backup_spec.rb'

data/.travis.yml

@@ -1,12 +1,25 @@
 language: ruby
+
+services:
+  - docker
+
 rvm:
-  - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7
+  - jruby-19mode
+
 branches:
   only:
     - master
+
 before_install:
   - gem update --system
   - gem update bundler
-script: "bundle exec rspec --tag ~docker"
+
+script:
+  - docker pull antespi/docker-imap-devel:latest
+  - docker run -d --env MAIL_ADDRESS=address@example.org --env MAIL_PASS=pass --env MAILNAME=example.org --publish 8993:993 antespi/docker-imap-devel:latest
+  - sleep 10
+  - bundle exec rake

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.png)][Continuous Integration]
+[![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.svg)][Continuous Integration]
 [![Source Analysis](https://codeclimate.com/github/joeyates/imap-backup/badges/gpa.svg)](https://codeclimate.com/github/joeyates/imap-backup)
 [![Test Coverage](https://codeclimate.com/github/joeyates/imap-backup/badges/coverage.svg)](https://codeclimate.com/github/joeyates/imap-backup/coverage)
 
@@ -46,12 +46,13 @@ specific folders.
 
 ## Configuration file
 
-`setup` creates ~/.imap-backup directory and configuration file. E.g.:
+`setup` creates the file `~/.imap-backup/config.json`
+
+E.g.:
 
 ```json
 {
-  "accounts":
-  [
+  "accounts": [
     {
       "username": "my.user@gmail.com",
       "password": "secret",
@@ -70,8 +71,7 @@ It connects to GMail by default, but you can also specify a server:
 
 ```json
 {
-  "accounts":
-  [
+  "accounts": [
     {
       "username": "my.user@gmail.com",
       "password": "secret",
@@ -96,8 +96,7 @@ Specifically, if you are using a self-signed certificate and get SSL errors, e.g
 
 ```json
 {
-  "accounts":
-  [
+  "accounts": [
     {
       "username": "my.user@gmail.com",
       "password": "secret",
@@ -194,9 +193,6 @@ $ imap-backup status
 
 # Similar Software
 
-* https://github.com/thefloweringash/gmail-imap-backup
-* https://github.com/mleonhard/imapbackup
-* https://github.com/rgrove/larch - copies between IMAP servers
 * https://github.com/OfflineIMAP/offlineimap
 
 # Testing
@@ -208,8 +204,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 \
@@ -217,18 +213,14 @@ docker run \
   antespi/docker-imap-devel:latest
 ```
 
-Currently, the integration tests with Docker are excluded from the CI run.
-
-To run **just** the Docker-based tests:
-
-```
-rspec -t docker
+```sh
+$ rake
 ```
 
-To run **all** specs, including the integration tests, do the following:
+To exclude Docker-based tests:
 
-```
-rspec -O .rspec-all
+```sh
+$ rspec --tag ~docker
 ```
 
 ## Contributing

data/Rakefile

@@ -1,9 +1,12 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
-task default: :spec
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
 end
+
+RuboCop::RakeTask.new
+
+task default: :spec
+task default: :rubocop

data/bin/imap-backup

@@ -46,16 +46,14 @@ parser = OptionParser.new do |opts|
 end
 parser.parse!
 
-if ARGV.size > 0
-  options[:command] = ARGV.shift
-end
+options[:command] = ARGV.shift if !ARGV.empty?
 
 if KNOWN_COMMANDS.find { |c| c[:name] == options[:command] }.nil?
   raise "Unknown command '#{options[:command]}'"
 end
 
 if options[:command] == "help"
-  puts opts
+  puts parser
   exit
 end
 
@@ -72,9 +70,7 @@ case options[:command]
 when "setup"
   Imap::Backup::Configuration::Setup.new.run
 when "backup"
-  configuration.each_connection do |connection|
-    connection.run_backup
-  end
+  configuration.each_connection(&:run_backup)
 when "folders"
   configuration.each_connection do |connection|
     puts connection.username
@@ -83,12 +79,10 @@ 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 do |connection|
-    connection.restore
-  end
+  configuration.each_connection(&:restore)
 when "status"
   configuration.each_connection do |connection|
     puts connection.username

data/imap-backup.gemspec

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+$LOAD_PATH.unshift(File.expand_path("lib", __dir__))
 require "imap/backup/version"
 
 Gem::Specification.new do |gem|
@@ -9,12 +9,12 @@ Gem::Specification.new do |gem|
   gem.email         = ["joe.g.yates@gmail.com"]
   gem.homepage      = "https://github.com/joeyates/imap-backup"
 
-  gem.files         = `git ls-files`.split($\)
+  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"]
-  gem.required_ruby_version = [">= 2.2.0"]
-  gem.version       = Imap::Backup::VERSION
+  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,
@@ -24,12 +24,16 @@ Gem::Specification.new do |gem|
     **deleted** and a full new backup created.
   MESSAGE
 
-  gem.add_runtime_dependency "rake"
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail"
+  gem.add_runtime_dependency "rake"
 
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
-  gem.add_development_dependency "pry-byebug"
+  if RUBY_ENGINE == "jruby"
+    gem.add_development_dependency "pry-debugger-jruby"
+  else
+    gem.add_development_dependency "pry-byebug"
+  end
   gem.add_development_dependency "rspec", ">= 3.0.0"
   gem.add_development_dependency "rubocop-rspec"
   gem.add_development_dependency "simplecov"

data/lib/email/mboxrd/message.rb

@@ -18,16 +18,15 @@ module Email::Mboxrd
 
     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
       parsed.date
-    rescue
+    rescue StandardError
       nil
     end
 
@@ -41,27 +40,28 @@ module Email::Mboxrd
       @parsed ||= Mail.new(supplied_body)
     end
 
-    def best_from
-      if parsed.from.is_a?(Enumerable)
-        parsed.from.each do |addr|
-          return addr if addr
+    def from
+      @from ||=
+        begin
+          from = best_from.dup
+          from << " #{asctime}" if asctime != ""
+          from
         end
-      end
+    end
 
+    def best_from
+      return first_from if first_from
       return parsed.sender if parsed.sender
       return parsed.envelope_from if parsed.envelope_from
       return parsed.return_path if parsed.return_path
 
-      return ""
+      ""
     end
 
-    def from
-      @from ||=
-        begin
-          from = best_from.dup
-          from << " " + asctime if asctime != ""
-          from
-        end
+    def first_from
+      return nil if !parsed.from.is_a?(Enumerable)
+
+      parsed.from.find { |from| from }
     end
 
     def mboxrd_body

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

@@ -10,7 +10,8 @@ module Imap::Backup
     attr_reader :username
 
     def initialize(options)
-      @username, @password = options[:username], options[:password]
+      @username = options[:username]
+      @password = options[:password]
       @local_path = options[:local_path]
       @backup_folders = options[:folders]
       @server = options[:server]
@@ -46,33 +47,17 @@ module Imap::Backup
       # start the connection so we get logging messages in the right order
       imap
       each_folder do |folder, serializer|
+        next if !folder.exist?
+
         Imap::Backup.logger.debug "[#{folder.name}] running backup"
-        serializer.set_uid_validity(folder.uid_validity)
+        serializer.apply_uid_validity(folder.uid_validity)
         Downloader.new(folder, serializer).run
       end
     end
 
     def restore
       local_folders do |serializer, folder|
-        exists = folder.exist?
-        if exists
-          new_name = serializer.set_uid_validity(folder.uid_validity)
-          old_name = serializer.folder
-          if new_name
-            Imap::Backup.logger.debug "Backup '#{old_name}' renamed and restored to '#{new_name}'"
-            new_serializer = Serializer::Mbox.new(local_path, new_name)
-            new_folder = Account::Folder.new(self, new_name)
-            new_folder.create
-            new_serializer.force_uid_validity(new_folder.uid_validity)
-            Uploader.new(new_folder, new_serializer).run
-          else
-            Uploader.new(folder, serializer).run
-          end
-        else
-          folder.create
-          serializer.force_uid_validity(folder.uid_validity)
-          Uploader.new(folder, serializer).run
-        end
+        restore_folder serializer, folder
       end
     end
 
@@ -87,6 +72,7 @@ module Imap::Backup
 
     def imap
       return @imap unless @imap.nil?
+
       options = provider_options
       Imap::Backup.logger.debug(
         "Creating IMAP instance: #{server}, options: #{options.inspect}"
@@ -108,6 +94,33 @@ module Imap::Backup
       end
     end
 
+    def restore_folder(serializer, folder)
+      existing_uids = folder.uids
+      if existing_uids.any?
+        Imap::Backup.logger.debug(
+          "There's already a '#{folder.name}' folder with emails"
+        )
+        new_name = serializer.apply_uid_validity(folder.uid_validity)
+        old_name = serializer.folder
+        if new_name
+          Imap::Backup.logger.debug(
+            "Backup '#{old_name}' renamed and restored to '#{new_name}'"
+          )
+          new_serializer = Serializer::Mbox.new(local_path, new_name)
+          new_folder = Account::Folder.new(self, new_name)
+          new_folder.create
+          new_serializer.force_uid_validity(new_folder.uid_validity)
+          Uploader.new(new_folder, new_serializer).run
+        else
+          Uploader.new(folder, serializer).run
+        end
+      else
+        folder.create
+        serializer.force_uid_validity(folder.uid_validity)
+        Uploader.new(folder, serializer).run
+      end
+    end
+
     def create_account_folder
       Utils.make_folder(
         File.dirname(local_path),
@@ -121,7 +134,8 @@ module Imap::Backup
     end
 
     def backup_folders
-      return @backup_folders if @backup_folders && (@backup_folders.size > 0)
+      return @backup_folders if @backup_folders && !@backup_folders.empty?
+
       (folders || []).map { |f| {name: f.name} }
     end
 
@@ -143,6 +157,7 @@ module Imap::Backup
     def server
       return @server if @server
       return nil if provider.nil?
+
       @server = provider.host
     end
 
@@ -156,6 +171,7 @@ module Imap::Backup
     # in the reference.
     def provider_root
       return @provider_root if @provider_root
+
       root_info = imap.list("", "")[0]
       @provider_root = root_info.name
     end