imap-backup 6.0.0.rc2 → 6.1.0

data/spec/unit/email/mboxrd/message_spec.rb

@@ -1,177 +0,0 @@
-msg_no_from = <<~NO_FROM
-  Delivered-To: you@example.com
-  From: example <www.example.com>
-  To: FirstName LastName <you@example.com>
-  Subject: Re: no subject
-NO_FROM
-
-msg_bad_from = <<~BAD_FROM
-  Delivered-To: you@example.com
-  from: "FirstName LastName (TEXT)" <"TEXT*" <no-reply@example.com>>
-  To: FirstName LastName <you@example.com>
-  Subject: Re: no subject
-BAD_FROM
-
-msg_no_from_but_return_path = <<~RETURN_PATH
-  Delivered-To: you@example.com
-  From: example <www.example.com>
-  To: FirstName LastName <you@example.com>
-  Return-Path: <me@example.com>
-  Subject: Re: no subject
-RETURN_PATH
-
-msg_no_from_but_sender = <<~NOT_SENDER
-  Delivered-To: you@example.com
-  To: FirstName LastName <you@example.com>
-  Subject: Re: no subject
-  Sender: FistName LastName <me@example.com>
-NOT_SENDER
-
-describe Email::Mboxrd::Message do
-  subject { described_class.new(message_body) }
-
-  let(:from) { "me@example.com" }
-  let(:date) { DateTime.new(2012, 12, 13, 18, 23, 45) }
-  let(:message_body) do
-    instance_double(String, clone: cloned_message_body, force_encoding: nil)
-  end
-  let(:cloned_message_body) do
-    "Foo\nBar\nFrom at the beginning of the line\n>>From quoted"
-  end
-  let(:msg_good) do
-    <<~GOOD
-      Delivered-To: you@example.com
-      From: Foo <foo@example.com>
-      To: FirstName LastName <you@example.com>
-      Date: #{date.rfc822}
-      Subject: Re: no subject
-    GOOD
-  end
-
-  let(:msg_bad_date) do
-    <<~BAD
-      Delivered-To: you@example.com
-      From: Foo <foo@example.com>
-      To: FirstName LastName <you@example.com>
-      Date: Mon,5 May 2014 08:97:99 GMT
-      Subject: Re: no subject
-    BAD
-  end
-
-  describe ".from_serialized" do
-    let(:serialized_message) { "From foo@a.com\n#{imap_message}" }
-    let(:imap_message) { "Delivered-To: me@example.com\nFrom Me\n" }
-    let!(:result) { described_class.from_serialized(serialized_message) }
-
-    it "returns the message" do
-      expect(result).to be_a(described_class)
-    end
-
-    it "removes one level of > before From" do
-      expect(result.supplied_body).to eq(imap_message)
-    end
-  end
-
-  describe "#to_serialized" do
-    let(:mail) { instance_double(Mail::Message, from: [from], date: date) }
-
-    before do
-      allow(Mail).to receive(:new).with(cloned_message_body) { mail }
-    end
-
-    it "adds a 'From ' line at the start" do
-      expected = "From #{from} #{date.asctime}\n"
-      expect(subject.to_serialized).to start_with(expected)
-    end
-
-    it "replaces existing 'From ' with '>From '" do
-      expect(subject.to_serialized).to include("\n>From at the beginning")
-    end
-
-    it "appends > before '>+From '" do
-      expect(subject.to_serialized).to include("\n>>>From quoted")
-    end
-
-    context "when date is missing" do
-      let(:date) { nil }
-
-      it "does no fail" do
-        expect { subject.to_serialized }.to_not raise_error
-      end
-    end
-  end
-
-  describe "From" do
-    before do
-      # call original for these tests because we want to test the behaviour of
-      # class-under-test given different behaviour of the Mail parser
-      allow(Mail).to receive(:new).and_call_original
-    end
-
-    context "when original message 'from' is missing" do
-      let(:message_body) { msg_no_from }
-
-      it "'from' is empty string" do
-        expect(subject.to_serialized).to start_with("From \n")
-      end
-    end
-
-    context "when original message 'from' is not a well-formed address" do
-      let(:message_body) { msg_bad_from }
-
-      it "'from' is empty string" do
-        expect(subject.to_serialized).to start_with("From \n")
-      end
-    end
-
-    context "when original message 'from' is nil and " \
-      "'envelope from' is nil and 'return path' is available" do
-      let(:message_body) { msg_no_from_but_return_path }
-
-      it "'return path' is used as 'from'" do
-        expect(subject.to_serialized).to start_with("From #{from}\n")
-      end
-    end
-
-    context "with no from and a 'Sender'" do
-      let(:message_body) { msg_no_from_but_sender }
-
-      it "Sender is used as 'from'" do
-        expect(subject.to_serialized).to start_with("From #{from}\n")
-      end
-    end
-  end
-
-  describe "#date" do
-    let(:message_body) { msg_good }
-
-    it "returns the date" do
-      expect(subject.date).to eq(date)
-    end
-
-    context "with incorrect minutes and seconds" do
-      let(:message_body) { msg_bad_date }
-
-      it "returns nil" do
-        expect(subject.date).to be_nil
-      end
-    end
-  end
-
-  describe "#imap_body" do
-    let(:message_body) { "Ciao" }
-
-    it "returns the supplied body" do
-      expect(subject.imap_body).to eq(message_body)
-    end
-
-    context "when newlines are not IMAP standard" do
-      let(:message_body) { "Ciao\nHello" }
-      let(:corrected) { "Ciao\r\nHello" }
-
-      it "corrects them" do
-        expect(subject.imap_body).to eq(corrected)
-      end
-    end
-  end
-end

data/spec/unit/email/provider/apple_mail_spec.rb

@@ -1,7 +0,0 @@
-describe Email::Provider::AppleMail do
-  describe "#host" do
-    it "returns host" do
-      expect(subject.host).to eq("imap.mail.me.com")
-    end
-  end
-end

data/spec/unit/email/provider/base_spec.rb

@@ -1,11 +0,0 @@
-describe Email::Provider::Base do
-  describe "#options" do
-    it "returns options" do
-      expect(subject.options).to be_a(Hash)
-    end
-
-    it "forces TLSv1_2" do
-      expect(subject.options[:ssl][:ssl_version]).to eq(:TLSv1_2)
-    end
-  end
-end

data/spec/unit/email/provider/fastmail_spec.rb

@@ -1,7 +0,0 @@
-describe Email::Provider::Fastmail do
-  describe "#host" do
-    it "returns host" do
-      expect(subject.host).to eq("imap.fastmail.com")
-    end
-  end
-end

data/spec/unit/email/provider/gmail_spec.rb

@@ -1,7 +0,0 @@
-describe Email::Provider::GMail do
-  describe "#host" do
-    it "returns host" do
-      expect(subject.host).to eq("imap.gmail.com")
-    end
-  end
-end

data/spec/unit/email/provider_spec.rb

@@ -1,27 +0,0 @@
-describe Email::Provider do
-  describe ".for_address" do
-    context "with known providers" do
-      [
-        ["fastmail.com", "Fastmail .com", Email::Provider::Fastmail],
-        ["fastmail.fm", "Fastmail .fm", Email::Provider::Fastmail],
-        ["gmail.com", "GMail", Email::Provider::GMail],
-        ["icloud.com", "Apple Mail icloud.com", Email::Provider::AppleMail],
-        ["mac.com", "Apple Mail mac.com", Email::Provider::AppleMail],
-        ["me.com", "Apple Mail me.com", Email::Provider::AppleMail]
-      ].each do |domain, name, klass|
-        it "recognizes #{name} addresses" do
-          address = "foo@#{domain}"
-          expect(described_class.for_address(address)).to be_a(klass)
-        end
-      end
-    end
-
-    context "with unknown providers" do
-      it "returns the Unknown provider" do
-        result = described_class.for_address("foo@unknown.com")
-
-        expect(result).to be_a(Email::Provider::Unknown)
-      end
-    end
-  end
-end

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -1,433 +0,0 @@
-require "ostruct"
-
-describe Imap::Backup::Account::Connection do
-  BACKUP_FOLDER = "backup_folder".freeze
-  FOLDER_CONFIG = {name: BACKUP_FOLDER}.freeze
-  FOLDER_NAME = "my_folder".freeze
-  GMAIL_IMAP_SERVER = "imap.gmail.com".freeze
-  IMAP_FOLDER = "imap_folder".freeze
-  LOCAL_PATH = "local_path".freeze
-  LOCAL_UID = "local_uid".freeze
-  PASSWORD = "secret".freeze
-  ROOT_NAME = "foo".freeze
-  SERVER = "imap.example.com".freeze
-  USERNAME = "username@example.com".freeze
-
-  subject { described_class.new(account) }
-
-  let(:client) do
-    instance_double(
-      Imap::Backup::Client::Default, authenticate: nil, login: nil, disconnect: nil
-    )
-  end
-  let(:imap_folders) { [] }
-  let(:account) do
-    instance_double(
-      Imap::Backup::Account,
-      username: username,
-      password: PASSWORD,
-      local_path: LOCAL_PATH,
-      folders: config_folders,
-      multi_fetch_size: multi_fetch_size,
-      server: server,
-      connection_options: nil
-    )
-  end
-  let(:username) { USERNAME }
-  let(:config_folders) { [FOLDER_CONFIG] }
-  let(:multi_fetch_size) { 1 }
-  let(:root_info) do
-    instance_double(Net::IMAP::MailboxList, name: ROOT_NAME)
-  end
-  let(:serializer) do
-    instance_double(
-      Imap::Backup::Serializer,
-      folder: serialized_folder,
-      force_uid_validity: nil,
-      apply_uid_validity: new_uid_validity,
-      uids: [LOCAL_UID]
-    )
-  end
-  let(:serialized_folder) { nil }
-  let(:server) { SERVER }
-  let(:new_uid_validity) { nil }
-
-  before do
-    allow(Imap::Backup::Client::Default).to receive(:new) { client }
-    allow(client).to receive(:list) { imap_folders }
-    allow(Imap::Backup::Utils).to receive(:make_folder)
-  end
-
-  shared_examples "connects to IMAP" do
-    it "logs in to the imap server" do
-      expect(client).to have_received(:login)
-    end
-  end
-
-  describe "#client" do
-    let(:result) { subject.client }
-
-    it "returns the IMAP connection" do
-      expect(result).to eq(client)
-    end
-
-    it "uses the password" do
-      result
-
-      expect(client).to have_received(:login).with(USERNAME, PASSWORD)
-    end
-
-    context "when the first login attempt fails" do
-      before do
-        outcomes = [-> { raise EOFError }, -> { true }]
-        allow(client).to receive(:login) { outcomes.shift.call }
-      end
-
-      it "retries" do
-        subject.client
-
-        expect(client).to have_received(:login).twice
-      end
-    end
-
-    context "when the provider is Apple" do
-      let(:username) { "user@mac.com" }
-      let(:apple_client) do
-        instance_double(
-          Imap::Backup::Client::AppleMail, login: nil
-        )
-      end
-
-      before do
-        allow(Imap::Backup::Client::AppleMail).to receive(:new) { apple_client }
-      end
-
-      it "returns the Apple client" do
-        expect(result).to eq(apple_client)
-      end
-    end
-
-    context "when run" do
-      before { subject.client }
-
-      include_examples "connects to IMAP"
-    end
-  end
-
-  describe "#folder_names" do
-    let(:imap_folders) do
-      [IMAP_FOLDER]
-    end
-
-    it "returns the list of folders" do
-      expect(subject.folder_names).to eq([IMAP_FOLDER])
-    end
-  end
-
-  describe "#status" do
-    let(:folder) do
-      instance_double(
-        Imap::Backup::Account::Folder,
-        uids: [remote_uid],
-        name: IMAP_FOLDER
-      )
-    end
-    let(:remote_uid) { "remote_uid" }
-
-    before do
-      allow(Imap::Backup::Account::Folder).to receive(:new) { folder }
-      allow(Imap::Backup::Serializer).to receive(:new) { serializer }
-    end
-
-    it "creates the path" do
-      expect(Imap::Backup::Utils).to receive(:make_folder)
-
-      subject.status
-    end
-
-    it "returns the names of folders" do
-      expect(subject.status[0][:name]).to eq(IMAP_FOLDER)
-    end
-
-    it "returns local message uids" do
-      expect(subject.status[0][:local]).to eq([LOCAL_UID])
-    end
-
-    it "retrieves the available uids" do
-      expect(subject.status[0][:remote]).to eq([remote_uid])
-    end
-  end
-
-  describe "#run_backup" do
-    let(:folder) do
-      instance_double(
-        Imap::Backup::Account::Folder,
-        name: IMAP_FOLDER,
-        exist?: exists,
-        uid_validity: uid_validity
-      )
-    end
-    let(:exists) { true }
-    let(:uid_validity) { 123 }
-    let(:downloader) { instance_double(Imap::Backup::Downloader, run: nil) }
-    let(:multi_fetch_size) { 10 }
-
-    before do
-      allow(Imap::Backup::Downloader).
-        to receive(:new).with(folder, serializer, anything) { downloader }
-      allow(Imap::Backup::Account::Folder).to receive(:new).
-        with(subject, BACKUP_FOLDER) { folder }
-      allow(Imap::Backup::Serializer).to receive(:new).
-        with(LOCAL_PATH, IMAP_FOLDER) { serializer }
-    end
-
-    it "passes the multi_fetch_size" do
-      subject.run_backup
-
-      expect(Imap::Backup::Downloader).to have_received(:new).
-        with(anything, anything, {multi_fetch_size: 10})
-    end
-
-    context "with supplied config_folders" do
-      it "runs the downloader" do
-        expect(downloader).to receive(:run)
-
-        subject.run_backup
-      end
-
-      context "when a folder does not exist" do
-        let(:exists) { false }
-
-        it "does not run the downloader" do
-          expect(downloader).to_not receive(:run)
-
-          subject.run_backup
-        end
-      end
-    end
-
-    context "without supplied config_folders" do
-      let(:imap_folders) { [ROOT_NAME] }
-
-      before do
-        allow(Imap::Backup::Account::Folder).to receive(:new).
-          with(subject, ROOT_NAME) { folder }
-        allow(Imap::Backup::Serializer).to receive(:new).
-          with(LOCAL_PATH, ROOT_NAME) { serializer }
-      end
-
-      context "when supplied config_folders is nil" do
-        let(:config_folders) { nil }
-
-        it "runs the downloader for each folder" do
-          expect(downloader).to receive(:run).exactly(:once)
-
-          subject.run_backup
-        end
-      end
-
-      context "when supplied config_folders is an empty list" do
-        let(:config_folders) { [] }
-
-        it "runs the downloader for each folder" do
-          expect(downloader).to receive(:run).exactly(:once)
-
-          subject.run_backup
-        end
-      end
-
-      context "when the imap server doesn't return folders" do
-        let(:config_folders) { nil }
-        let(:imap_folders) { [] }
-
-        it "fails" do
-          expect do
-            subject.run_backup
-          end.to raise_error(RuntimeError, /Unable to get folder list/)
-        end
-      end
-    end
-
-    context "when the IMAP session expires" do
-      before do
-        data = OpenStruct.new(data: "Session expired")
-        response = OpenStruct.new(data: data)
-        outcomes = [
-          -> { raise Net::IMAP::ByeResponseError, response },
-          -> { nil }
-        ]
-        allow(downloader).to receive(:run) { outcomes.shift.call }
-      end
-
-      it "reconnects" do
-        expect(downloader).to receive(:run).exactly(:twice)
-
-        subject.run_backup
-      end
-    end
-
-    context "when run" do
-      before { subject.run_backup }
-
-      include_examples "connects to IMAP"
-    end
-  end
-
-  describe "#restore" do
-    let(:folder) do
-      instance_double(
-        Imap::Backup::Account::Folder,
-        create: nil,
-        uids: uids,
-        name: IMAP_FOLDER,
-        uid_validity: uid_validity
-      )
-    end
-    let(:uids) { [99] }
-    let(:uid_validity) { 123 }
-    let(:serialized_folder) { "old name" }
-    let(:uploader) do
-      instance_double(Imap::Backup::Uploader, run: false)
-    end
-    let(:updated_uploader) do
-      instance_double(Imap::Backup::Uploader, run: false)
-    end
-    let(:updated_folder) do
-      instance_double(
-        Imap::Backup::Account::Folder,
-        create: nil,
-        uid_validity: "new uid validity"
-      )
-    end
-    let(:updated_serializer) do
-      instance_double(
-        Imap::Backup::Serializer, force_uid_validity: nil
-      )
-    end
-
-    before do
-      allow(Imap::Backup::Account::Folder).to receive(:new).
-        with(subject, FOLDER_NAME) { folder }
-      allow(Imap::Backup::Serializer).to receive(:new).
-        with(anything, FOLDER_NAME) { serializer }
-      allow(Imap::Backup::Account::Folder).to receive(:new).
-        with(subject, "new name") { updated_folder }
-      allow(Imap::Backup::Serializer).to receive(:new).
-        with(anything, "new name") { updated_serializer }
-      allow(Imap::Backup::Uploader).to receive(:new).
-        with(folder, serializer) { uploader }
-      allow(Imap::Backup::Uploader).to receive(:new).
-        with(updated_folder, updated_serializer) { updated_uploader }
-      allow(Pathname).to receive(:glob).
-        and_yield(Pathname.new(File.join(LOCAL_PATH, "#{FOLDER_NAME}.imap")))
-    end
-
-    it "sets local uid validity" do
-      expect(serializer).to receive(:apply_uid_validity).with(uid_validity)
-
-      subject.restore
-    end
-
-    context "when folders exist with contents" do
-      context "when the local folder is renamed" do
-        let(:new_uid_validity) { "new name" }
-
-        it "creates the new folder" do
-          expect(updated_folder).to receive(:create)
-
-          subject.restore
-        end
-
-        it "sets the renamed folder's uid validity" do
-          expect(updated_serializer).
-            to receive(:force_uid_validity).with("new uid validity")
-
-          subject.restore
-        end
-
-        it "creates the uploader with updated folder and serializer" do
-          expect(updated_uploader).to receive(:run)
-
-          subject.restore
-        end
-      end
-
-      context "when the local folder is not renamed" do
-        it "runs the uploader" do
-          expect(uploader).to receive(:run)
-
-          subject.restore
-        end
-      end
-    end
-
-    context "when folders don't exist or are empty" do
-      let(:uids) { [] }
-
-      it "creates the folder" do
-        expect(folder).to receive(:create)
-
-        subject.restore
-      end
-
-      it "forces local uid validity" do
-        expect(serializer).to receive(:force_uid_validity).with(uid_validity)
-
-        subject.restore
-      end
-
-      it "runs the uploader" do
-        expect(uploader).to receive(:run)
-
-        subject.restore
-      end
-    end
-  end
-
-  describe "#reconnect" do
-    context "when the IMAP connection has been used" do
-      before { subject.client }
-
-      it "disconnects from the server" do
-        expect(client).to receive(:disconnect)
-
-        subject.reconnect
-      end
-    end
-
-    context "when the IMAP connection has not been used" do
-      it "does not disconnect from the server" do
-        expect(client).to_not receive(:disconnect)
-
-        subject.reconnect
-      end
-    end
-
-    it "causes reconnection on future access" do
-      expect(Imap::Backup::Client::Default).to receive(:new)
-
-      subject.reconnect
-      subject.client
-    end
-  end
-
-  describe "#disconnect" do
-    context "when the IMAP connection has been used" do
-      it "disconnects from the server" do
-        subject.client
-
-        expect(client).to receive(:disconnect)
-
-        subject.disconnect
-      end
-    end
-
-    context "when the IMAP connection has not been used" do
-      it "does not disconnect from the server" do
-        expect(client).to_not receive(:disconnect)
-
-        subject.disconnect
-      end
-    end
-  end
-end