imap-backup 1.3.0 → 1.4.0

data/lib/imap/backup/configuration/list.rb

@@ -9,7 +9,7 @@ module Imap::Backup
     end
 
     def setup_logging
-      return if not config_exists?
+      return if !config_exists?
       Imap::Backup.setup_logging config
     end
 
@@ -25,8 +25,9 @@ module Imap::Backup
 
     def config
       return @config if @config
-      if not config_exists?
-        raise ConfigurationNotFound.new("Configuration file '#{Configuration::Store.default_pathname}' not found")
+      if !config_exists?
+        path = Configuration::Store.default_pathname
+        raise ConfigurationNotFound, "Configuration file '#{path}' not found"
       end
       @config = Configuration::Store.new
     end
@@ -36,12 +37,14 @@ module Imap::Backup
     end
 
     def accounts
-      return @accounts if @accounts
-      if required_accounts.nil?
-        @accounts = config.accounts
-      else
-        @accounts = config.accounts.select { |account| required_accounts.include?(account[:username]) }
-      end
+      @accounts ||=
+        if required_accounts.nil?
+          config.accounts
+        else
+          config.accounts.select do |account|
+            required_accounts.include?(account[:username])
+          end
+        end
     end
   end
 end

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

@@ -69,10 +69,10 @@ module Imap::Backup
     end
 
     def default_account_config(username)
-      account = {
+      {
         username: username,
         password: "",
-        local_path: File.join(config.path, username.gsub("@", "_")),
+        local_path: File.join(config.path, username.tr("@", "_")),
         folders: []
       }
     end
@@ -83,7 +83,9 @@ module Imap::Backup
         account = default_account_config(username)
         config.accounts << account
       end
-      Configuration::Account.new(config, account, Configuration::Setup.highline).run
+      Configuration::Account.new(
+        config, account, Configuration::Setup.highline
+      ).run
     end
   end
 end

data/lib/imap/backup/configuration/store.rb

@@ -29,7 +29,7 @@ module Imap::Backup
       remove_modified_flags
       remove_deleted_accounts
       File.open(pathname, "w") { |f| f.write(JSON.pretty_generate(data)) }
-      FileUtils.chmod 0600, pathname
+      FileUtils.chmod 0o600, pathname
     end
 
     def accounts
@@ -53,7 +53,7 @@ module Imap::Backup
     def data
       return @data if @data
       if File.exist?(pathname)
-        Utils.check_permissions pathname, 0600
+        Utils.check_permissions pathname, 0o600
         contents = File.read(pathname)
         @data = JSON.parse(contents, symbolize_names: true)
       else
@@ -76,8 +76,8 @@ module Imap::Backup
       if !File.directory?(path)
         FileUtils.mkdir path
       end
-      if Utils::stat(path) != 0700
-        FileUtils.chmod 0700, path
+      if Utils::stat(path) != 0o700
+        FileUtils.chmod 0o700, path
       end
     end
   end

data/lib/imap/backup/downloader.rb

@@ -13,10 +13,14 @@ module Imap::Backup
       uids.each do |uid|
         message = folder.fetch(uid)
         if message.nil?
-          Imap::Backup.logger.debug "[#{folder.name}] #{uid} - not available - skipped"
+          Imap::Backup.logger.debug(
+            "[#{folder.name}] #{uid} - not available - skipped"
+          )
           next
         end
-        Imap::Backup.logger.debug "[#{folder.name}] #{uid} - #{message["RFC822"].size} bytes"
+        Imap::Backup.logger.debug(
+          "[#{folder.name}] #{uid} - #{message['RFC822'].size} bytes"
+        )
         serializer.save(uid, message)
       end
     end

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

@@ -1,7 +1,7 @@
 module Imap::Backup
   module Serializer
-    DIRECTORY_PERMISSIONS = 0700
-    FILE_PERMISSIONS      = 0600
+    DIRECTORY_PERMISSIONS = 0o700
+    FILE_PERMISSIONS      = 0o600
 
     class Base
       attr_reader :path

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

@@ -17,7 +17,7 @@ module Imap::Backup
       return @uids if @uids
 
       @uids = []
-      return @uids if not exist?
+      return @uids if !exist?
 
       CSV.foreach(imap_pathname) do |row|
         @uids << row[0]
@@ -29,7 +29,9 @@ module Imap::Backup
     def save(uid, message)
       uid = uid.to_s
       if uids.include?(uid)
-        Imap::Backup.logger.debug "[#{folder}] message #{uid} already downloaded - skipping"
+        Imap::Backup.logger.debug(
+          "[#{folder}] message #{uid} already downloaded - skipping"
+        )
         return
       end
 
@@ -42,10 +44,15 @@ module Imap::Backup
       begin
         mbox = File.open(mbox_pathname, "ab")
         imap = File.open(imap_pathname, "ab")
-        mbox.write mboxrd_message.to_s
+        mbox.write mboxrd_message.to_serialized
         imap.write uid + "\n"
       rescue => e
-        Imap::Backup.logger.warn "[#{folder}] failed to save message #{uid}:\n#{body}. #{e}:\n#{e.backtrace.join("\n")}"
+        message = <<-ERROR.gsub(/^\s*/m, "")
+          [#{folder}] failed to save message #{uid}:
+          #{body}. #{e}:
+          #{e.backtrace.join("\n")}"
+        ERROR
+        Imap::Backup.logger.warn message
       ensure
         mbox.close if mbox
         imap.close if imap
@@ -57,14 +64,16 @@ module Imap::Backup
     def assert_files
       mbox = mbox_exist?
       imap = imap_exist?
-      raise ".imap file missing" if mbox && (not imap)
-      raise ".mbox file missing" if imap && (not mbox)
+      raise ".imap file missing" if mbox && (!imap)
+      raise ".mbox file missing" if imap && (!mbox)
     end
 
     def create_containing_directory
       mbox_relative_path = File.dirname(mbox_relative_pathname)
       return if mbox_relative_path == "."
-      Utils.make_folder(path, mbox_relative_path, Serializer::DIRECTORY_PERMISSIONS)
+      Utils.make_folder(
+        path, mbox_relative_path, Serializer::DIRECTORY_PERMISSIONS
+      )
     end
 
     def exist?

data/lib/imap/backup/utils.rb

@@ -5,9 +5,14 @@ module Imap::Backup
     def self.check_permissions(filename, limit)
       actual = stat(filename)
       return nil if actual.nil?
-      mask = ~limit & 0777
+      mask = ~limit & 0o777
       if actual & mask != 0
-        raise format("Permissions on '%s' should be 0%o, not 0%o", filename, limit, actual)
+        message = format(
+          "Permissions on '%<filename>s' " \
+            "should be 0%<limit>o, not 0%<actual>o",
+          filename: filename, limit: limit, actual: actual
+        )
+        raise message
       end
     end
 
@@ -15,7 +20,7 @@ module Imap::Backup
       return nil unless File.exist?(filename)
 
       stat = File.stat(filename)
-      stat.mode & 0777
+      stat.mode & 0o777
     end
 
     def self.make_folder(base_path, path, permissions)

data/lib/imap/backup/version.rb

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

data/spec/features/backup_spec.rb

@@ -0,0 +1,27 @@
+require "features/helper"
+
+RSpec.describe "backup", type: :feature, docker: true do
+  include_context "imap-backup connection"
+  include_context "message-fixtures"
+
+  let(:messages_as_mbox) do
+    message_as_mbox_entry(msg1) + message_as_mbox_entry(msg2)
+  end
+  let(:folder) { "INBOX" }
+
+  before do
+    send_email folder, msg1
+    send_email folder, msg2
+  end
+
+  after do
+    FileUtils.rm_rf local_backup_path
+    delete_emails folder
+  end
+
+  it "downloads messages" do
+    connection.run_backup
+
+    expect(mbox_content(folder)).to eq(messages_as_mbox)
+  end
+end

data/spec/features/helper.rb

@@ -0,0 +1,2 @@
+support_glob = File.expand_path("support/**/*.rb", __dir__)
+Dir[support_glob].each { |f| require f }

data/spec/features/support/backup_directory.rb

@@ -0,0 +1,27 @@
+module BackupDirectoryHelpers
+  def message_as_mbox_entry(options)
+    from = fixture("connection")[:username]
+    subject = options[:subject]
+    body = options[:body]
+    body_and_headers = <<-EOT.gsub("\n", "\r\n")
+From: #{from}
+Subject: #{subject}
+
+#{body}
+    EOT
+
+    "From #{from}\n#{body_and_headers}\n"
+  end
+
+  def mbox_content(name)
+    File.read(mbox_path(name))
+  end
+
+  def mbox_path(name)
+    File.join(local_backup_path, name + ".mbox")
+  end
+end
+
+RSpec.configure do |config|
+  config.include BackupDirectoryHelpers, type: :feature
+end

data/spec/features/support/email_server.rb

@@ -0,0 +1,40 @@
+module EmailServerHelpers
+  REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"]
+
+  def send_email(folder, options)
+    from = options[:from] || "address@example.org"
+    subject = options[:subject]
+    body = options[:body]
+    message = <<-EOT
+From: #{from}
+Subject: #{subject}
+
+#{body}
+    EOT
+
+    imap.append(folder, message, nil, nil)
+  end
+
+  def delete_emails(folder)
+    imap.select(folder)
+    uids = imap.uid_search(["ALL"]).sort
+    imap.store(1 .. uids.size, "+FLAGS", [:Deleted])
+    imap.expunge
+  end
+
+  def imap
+    @imap ||=
+      begin
+        connection = fixture("connection")
+        imap = Net::IMAP.new(
+          connection[:server], connection[:connection_options]
+        )
+        imap.login(connection[:username], connection[:password])
+        imap
+      end
+  end
+end
+
+RSpec.configure do |config|
+  config.include EmailServerHelpers, type: :feature
+end

data/spec/features/support/shared/connection_context.rb

@@ -0,0 +1,12 @@
+shared_context "imap-backup connection" do
+  let(:local_backup_path) { Dir.mktmpdir(nil, "tmp") }
+  let(:default_connection) { fixture("connection") }
+  let(:backup_folders) { nil }
+  let(:connection_options) do
+    default_connection.merge({
+      local_path: local_backup_path,
+      folders: backup_folders
+    })
+  end
+  let(:connection) { Imap::Backup::Account::Connection.new(connection_options) }
+end

data/spec/features/support/shared/message_fixtures.rb

@@ -0,0 +1,6 @@
+shared_context "message-fixtures" do
+  let(:uid1) { 123 }
+  let(:uid2) { 345 }
+  let(:msg1) { {uid: uid1, subject: "Test 1", body: "body 1\nHi"} }
+  let(:msg2) { {uid: uid2, subject: "Test 2", body: "body 2"} }
+end

data/spec/fixtures/connection.yml

@@ -0,0 +1,7 @@
+:server: 'localhost'
+:username: 'address@example.org'
+:password: 'pass'
+:connection_options:
+  :port: 8993
+  :ssl:
+    :verify_mode: 0

data/spec/support/fixtures.rb

@@ -0,0 +1,6 @@
+def fixture(name)
+  spec_root = File.expand_path("..", File.dirname(__FILE__))
+  fixture_path = File.join(spec_root, "fixtures", name + ".yml")
+  fixture = File.read(fixture_path)
+  YAML.load(fixture)
+end

data/spec/unit/account/connection_spec.rb

@@ -9,7 +9,9 @@ describe Imap::Backup::Account::Connection do
     {name: backup_folder}
   end
 
-  let(:imap) { double("Net::IMAP", login: nil, list: imap_folders, disconnect: nil) }
+  let(:imap) do
+    double("Net::IMAP", login: nil, disconnect: nil)
+  end
   let(:imap_folders) { [] }
   let(:options) do
     {
@@ -22,9 +24,15 @@ describe Imap::Backup::Account::Connection do
   let(:local_path) { "local_path" }
   let(:backup_folders) { [self.class.folder_config] }
   let(:username) { "username@gmail.com" }
+  let(:root_info) do
+    instance_double(Net::IMAP::MailboxList, name: root_name)
+  end
+  let(:root_name) { "foo" }
 
   before do
     allow(Net::IMAP).to receive(:new).and_return(imap)
+    allow(imap).to receive(:list).with("", "") { [root_info] }
+    allow(imap).to receive(:list).with(root_name, "*") { imap_folders }
     allow(Imap::Backup::Utils).to receive(:make_folder)
   end
 
@@ -68,9 +76,9 @@ describe Imap::Backup::Account::Connection do
   end
 
   context "#folders" do
-    let(:imap_folders) { ["imap_folder"] }
-
-    before { allow(imap).to receive(:list).and_return(imap_folders) }
+    let(:imap_folders) do
+      [instance_double(Net::IMAP::MailboxList)]
+    end
 
     it "returns the list of folders" do
       expect(subject.folders).to eq(imap_folders)
@@ -80,12 +88,14 @@ describe Imap::Backup::Account::Connection do
   context "#status" do
     let(:folder) { double("folder", uids: [remote_uid]) }
     let(:local_uid) { "local_uid" }
-    let(:serializer) { double("serializer", uids: [local_uid]) }
+    let(:serializer) do
+      instance_double(Imap::Backup::Serializer::Mbox, uids: [local_uid])
+    end
     let(:remote_uid) { "remote_uid" }
 
     before do
       allow(Imap::Backup::Account::Folder).to receive(:new).and_return(folder)
-      allow(Imap::Backup::Serializer::Directory).to receive(:new).and_return(serializer)
+      allow(Imap::Backup::Serializer::Mbox).to receive(:new) { serializer }
     end
 
     it "should return the names of folders" do
@@ -127,7 +137,9 @@ describe Imap::Backup::Account::Connection do
     end
 
     context "without supplied backup_folders" do
-      let(:imap_folders) { [double(name: "foo")] }
+      let(:imap_folders) do
+        [instance_double(Net::IMAP::MailboxList, name: "foo")]
+      end
 
       before do
         allow(Imap::Backup::Account::Folder).to receive(:new).

data/spec/unit/account/folder_spec.rb

@@ -3,9 +3,15 @@ require "spec_helper"
 describe Imap::Backup::Account::Folder do
   let(:imap) { double("Net::IMAP", examine: nil) }
   let(:connection) { double("Imap::Backup::Account::Connection", imap: imap) }
-  let(:missing_mailbox_data) { double("Data", text: "Unknown Mailbox: my_folder") }
-  let(:missing_mailbox_response) { double("Response", data: missing_mailbox_data) }
-  let(:missing_mailbox_error) { Net::IMAP::NoResponseError.new(missing_mailbox_response) }
+  let(:missing_mailbox_data) do
+    double("Data", text: "Unknown Mailbox: my_folder")
+  end
+  let(:missing_mailbox_response) do
+    double("Response", data: missing_mailbox_data)
+  end
+  let(:missing_mailbox_error) do
+    Net::IMAP::NoResponseError.new(missing_mailbox_response)
+  end
 
   subject { described_class.new(connection, "my_folder") }
 
@@ -19,7 +25,9 @@ describe Imap::Backup::Account::Folder do
     end
 
     context "with missing mailboxes" do
-      before { allow(imap).to receive(:examine).and_raise(missing_mailbox_error) }
+      before do
+        allow(imap).to receive(:examine).and_raise(missing_mailbox_error)
+      end
 
       it "returns an empty array" do
         expect(subject.uids).to eq([])
@@ -49,7 +57,9 @@ describe Imap::Backup::Account::Folder do
     end
 
     context "if the mailbox doesn't exist" do
-      before { allow(imap).to receive(:examine).and_raise(missing_mailbox_error) }
+      before do
+        allow(imap).to receive(:examine).and_raise(missing_mailbox_error)
+      end
 
       it "is nil" do
         expect(subject.fetch(123)).to be_nil