imap-backup 0.0.5 → 1.0.0

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

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require 'csv'
+require 'email/mboxrd/message'
+
+module Imap
+  module Backup
+    module Serializer
+      class Mbox < Base
+        def initialize(path, folder)
+          super
+          create_containing_directory
+          assert_files
+        end
+
+        # TODO: cleanup locks, close file handles
+
+        def uids
+          return @uids if @uids
+
+          @uids = []
+          return @uids if not exist?
+
+          CSV.foreach(imap_pathname) do |row|
+            @uids << row[0]
+          end
+          @uids
+        end
+
+        def save(uid, message)
+          uid = uid.to_s
+          return if uids.include?(uid)
+          message = Email::Mboxrd::Message.new(message['RFC822'])
+          mbox = imap = nil
+          begin
+            mbox = File.open(mbox_pathname, 'ab')
+            imap = File.open(imap_pathname, 'ab')
+            mbox.write message.to_s
+            imap.write uid + "\n"
+          ensure
+            mbox.close if mbox
+            imap.close if imap
+          end
+        end
+
+        private
+
+        def assert_files
+          mbox = mbox_exist?
+          imap = imap_exist?
+          raise '.imap file missing' if mbox and not imap
+          raise '.mbox file missing' if imap and not mbox
+        end
+
+        def create_containing_directory
+          mbox_relative_path = File.dirname(mbox_relative_pathname)
+          return if mbox_relative_path == '.'
+          Imap::Backup::Utils.make_folder(@path, mbox_relative_path, DIRECTORY_PERMISSIONS)
+        end
+
+        def exist?
+          mbox_exist? and imap_exist?
+        end
+
+        def mbox_exist?
+          File.exist?(mbox_pathname)
+        end
+
+        def imap_exist?
+          File.exist?(imap_pathname)
+        end
+
+        def mbox_relative_pathname
+          @folder + '.mbox'
+        end
+
+        def mbox_pathname
+          File.join(@path, mbox_relative_pathname)
+        end
+
+        def imap_pathname
+          filename = @folder + '.imap'
+          File.join(@path, filename)
+        end
+
+        def lock
+          # lock mbox and imap files
+          # create both empty if missing
+        end
+
+        def unlock
+        end
+      end
+    end
+  end
+end
+

data/lib/imap/backup/utils.rb

@@ -16,7 +16,7 @@ module Imap
       def self.stat(filename)
         return nil unless File.exist?(filename)
 
-        stat   = File.stat(filename)
+        stat = File.stat(filename)
         stat.mode & 0777
       end
 
@@ -25,8 +25,11 @@ module Imap
         return if parts.size == 0
         full_path = File.join(base_path, path)
         FileUtils.mkdir_p full_path
-        first_directory = File.join(base_path, parts[0])
-        FileUtils.chmod permissions, first_directory
+        path = base_path
+        parts.each do |part|
+          path = File.join(path, part)
+          FileUtils.chmod permissions, path
+        end
       end
 
       private

data/lib/imap/backup/version.rb

@@ -1,8 +1,8 @@
 module Imap
   module Backup
-    MAJOR    = 0
+    MAJOR    = 1
     MINOR    = 0
-    REVISION = 5
+    REVISION = 0
     VERSION  = [ MAJOR, MINOR, REVISION ].map( &:to_s ).join( '.' )
   end
 end

data/spec/unit/account/connection_spec.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
-load File.expand_path( '../../spec_helper.rb', File.dirname(__FILE__) )
+require 'spec_helper'
 
 describe Imap::Backup::Account::Connection do
-
   context '#initialize' do
-
     it 'should login to the imap server' do
       imap = stub('Net::IMAP')
       Net::IMAP.should_receive(:new).with('imap.gmail.com', 993, true).and_return(imap)
@@ -13,10 +11,18 @@ describe Imap::Backup::Account::Connection do
       Imap::Backup::Account::Connection.new(:username => 'myuser', :password => 'secret')
     end
 
+    context "with specific server" do
+      it 'should login to the imap server' do
+        imap = stub('Net::IMAP')
+        Net::IMAP.should_receive(:new).with('my.imap.example.com', 993, true).and_return(imap)
+        imap.should_receive('login').with('myuser', 'secret')
+
+        Imap::Backup::Account::Connection.new(:username => 'myuser', :password => 'secret', :server => 'my.imap.example.com')
+      end
+    end
   end
 
   context 'instance methods' do
-
     before :each do
       @imap = stub('Net::IMAP', :login => nil)
       Net::IMAP.stub!(:new).and_return(@imap)
@@ -46,9 +52,7 @@ describe Imap::Backup::Account::Connection do
       end
     end
 
-
     context '#status' do
-
       before :each do
         @folder = stub('Imap::Backup::Account::Folder', :uids => [])
         Imap::Backup::Account::Folder.stub!(:new).with(subject, 'my_folder').and_return(@folder)
@@ -71,16 +75,14 @@ describe Imap::Backup::Account::Connection do
 
         subject.status[0][:remote].should == [101, 234]
       end
-
     end
 
     context '#run_backup' do
-
       before :each do
         @folder = stub('Imap::Backup::Account::Folder', :uids => [])
         Imap::Backup::Account::Folder.stub!(:new).with(subject, 'my_folder').and_return(@folder)
         @serializer = stub('Imap::Backup::Serializer')
-        Imap::Backup::Serializer::Directory.stub!(:new).with('/base/path', 'my_folder').and_return(@serializer)
+        Imap::Backup::Serializer::Mbox.stub!(:new).with('/base/path', 'my_folder').and_return(@serializer)
         @downloader = stub('Imap::Backup::Downloader', :run => nil)
         Imap::Backup::Downloader.stub!(:new).with(@folder, @serializer).and_return(@downloader)
       end
@@ -92,7 +94,7 @@ describe Imap::Backup::Account::Connection do
       end
 
       it 'should instantiate serializers' do
-        Imap::Backup::Serializer::Directory.should_receive(:new).with('/base/path', 'my_folder').and_return(@serializer)
+        Imap::Backup::Serializer::Mbox.should_receive(:new).with('/base/path', 'my_folder').and_return(@serializer)
 
         subject.run_backup
       end
@@ -108,10 +110,7 @@ describe Imap::Backup::Account::Connection do
 
         subject.run_backup
       end
-
     end
-
   end
-
 end
 

data/spec/unit/account/folder_spec.rb

@@ -1,11 +1,8 @@
 # encoding: utf-8
-
-load File.expand_path('../../spec_helper.rb', File.dirname(__FILE__))
+require 'spec_helper'
 
 describe Imap::Backup::Account::Folder do
-
   context 'with instance' do
-
     before :each do
       @imap    = stub('Net::IMAP')
       @connection = stub('Imap::Backup::Account::Connection', :imap => @imap)
@@ -14,14 +11,12 @@ describe Imap::Backup::Account::Folder do
     subject { Imap::Backup::Account::Folder.new(@connection, 'my_folder') }
 
     context '#uids' do
-
       it 'should list available messages' do
         @imap.should_receive(:examine).with('my_folder')
         @imap.should_receive(:uid_search).with(['ALL']).and_return([5678, 123])
 
         subject.uids.should == [123, 5678]
       end
-
     end
 
     context '#fetch' do
@@ -51,10 +46,7 @@ describe Imap::Backup::Account::Folder do
           subject.fetch(123)
         end
       end
-
     end
-
   end
-
 end
 

data/spec/unit/configuration/account_spec.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
-load File.expand_path( '../../spec_helper.rb', File.dirname(__FILE__) )
+require 'spec_helper'
 
 describe Imap::Backup::Configuration::Account do
-
   include HighLineTestHelpers
   include InputOutputTestHelpers
 
@@ -20,7 +19,6 @@ describe Imap::Backup::Configuration::Account do
   end
 
   context '#run' do
-
     before :each do
       @account1_path = '/backup/path'
       @account1 = {
@@ -45,7 +43,6 @@ describe Imap::Backup::Configuration::Account do
     subject { Imap::Backup::Configuration::Account.new(@store, @account1) }
 
     context 'menu' do
-
       it 'should show a menu' do
         subject.run
 
@@ -78,7 +75,6 @@ describe Imap::Backup::Configuration::Account do
     end
 
     context 'email' do
-
       it 'should modify the email address' do
         Imap::Backup::Configuration::Asker.should_receive(:email).once.and_return('new@example.com')
 
@@ -99,11 +95,9 @@ describe Imap::Backup::Configuration::Account do
           subject.run
         end.should =~ /there is already an account set up with that email address/i
       end
-
     end
 
     context 'password' do
-
       it 'should update the password' do
         Imap::Backup::Configuration::Asker.should_receive(:password).once.and_return('new_pwd')
 
@@ -123,11 +117,9 @@ describe Imap::Backup::Configuration::Account do
 
         @account1[:password].should == 'secret'
       end
-
     end
 
     context 'backup_path' do
-
       it 'should update the path' do
         Imap::Backup::Configuration::Asker.should_receive(:backup_path).once do |default, validator|
           validator.call('new/path')
@@ -153,7 +145,6 @@ describe Imap::Backup::Configuration::Account do
           subject.run
         end.should =~ %r{The path '/existing/path' is used to backup the account 'existing@example.com'}
       end
-
     end
 
     it 'should add/remove folders' do
@@ -177,7 +168,6 @@ describe Imap::Backup::Configuration::Account do
     end
 
     context 'deletion' do
-
       it 'should confirm deletion' do
         Imap::Backup::Configuration::Setup.highline.should_receive(:agree).with("Are you sure? (y/n) ").and_return(true)
 
@@ -205,20 +195,15 @@ describe Imap::Backup::Configuration::Account do
 
         @data[:accounts].should include(@account1)
       end
-
     end
 
     context 'return to main menu' do
-
       it 'should return' do
         @input.stub!(:gets).with().and_return("return\n")
 
         subject.run.should be_nil
       end
-
     end
-
   end
-
 end
 

data/spec/unit/configuration/asker_spec.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
-load File.expand_path( '../../spec_helper.rb', File.dirname(__FILE__) )
+require 'spec_helper'
 
 describe Imap::Backup::Configuration::Asker do
-
   context '.email' do
-
     it 'should ask for an email' do
       Imap::Backup::Configuration::Setup.highline.should_receive(:ask).with(/email/)
 
@@ -29,11 +27,9 @@ describe Imap::Backup::Configuration::Asker do
 
       Imap::Backup::Configuration::Asker.email.should == 'new@example.com'
     end
-
   end
 
   context '.password' do
-
     before :each do
       Imap::Backup::Configuration::Setup.highline.stub!(:ask).with(/^password/).and_return('secret')
       Imap::Backup::Configuration::Setup.highline.stub!(:ask).with(/^repeat password/).and_return('secret')
@@ -92,11 +88,9 @@ describe Imap::Backup::Configuration::Asker do
 
       Imap::Backup::Configuration::Asker.password.should be_nil
     end
-
   end
 
   context '.backup_path' do
-
     it 'should ask for a directory' do
       validator = /validator/
       Imap::Backup::Configuration::Setup.highline.should_receive(:ask).with(/directory/) do |&block|
@@ -115,8 +109,6 @@ describe Imap::Backup::Configuration::Asker do
 
       Imap::Backup::Configuration::Asker.backup_path('default path', //).should == '/path'
     end
-
   end
-
 end
 

data/spec/unit/configuration/connection_tester_spec.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
-load File.expand_path( '../../spec_helper.rb', File.dirname(__FILE__) )
+require 'spec_helper'
 
 describe Imap::Backup::Configuration::ConnectionTester do
-
   context '.test' do
-
     it 'should try to connect' do
       Imap::Backup::Account::Connection.should_receive(:new).with('foo')
 
@@ -40,8 +38,6 @@ describe Imap::Backup::Configuration::ConnectionTester do
 
       result.should =~ /unexpected error/i
     end
-
   end
-
 end
 

data/spec/unit/configuration/folder_chooser_spec.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-load File.expand_path( '../../spec_helper.rb', File.dirname(__FILE__) )
+require 'spec_helper'
 
 describe Imap::Backup::Configuration::FolderChooser do
 
@@ -7,7 +7,6 @@ describe Imap::Backup::Configuration::FolderChooser do
   include InputOutputTestHelpers
 
   context '#run' do
-
     before :each do
       empty_account = {
         :folders => []
@@ -62,7 +61,6 @@ describe Imap::Backup::Configuration::FolderChooser do
     end
 
     context 'folder listing' do
-
       before :each do
         account = {
           :folders => [{:name => 'my_folder'}]
@@ -121,11 +119,7 @@ describe Imap::Backup::Configuration::FolderChooser do
         @output.string.should =~ /\d+\. \- my_folder/
         @account[:folders].should_not include( { :name => 'my_folder' } )
       end
-
-
     end
-
   end
-
 end
 

data/spec/unit/configuration/list_spec.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
-load File.expand_path( '../../spec_helper.rb', File.dirname(__FILE__) )
+require 'spec_helper'
 
 describe Imap::Backup::Configuration::List do
-  before :each do
-    @configuration_data = {
+  let(:configuration_data) do
+    {
       :accounts => [
         {
           :username => 'a1@example.com'
@@ -13,61 +13,65 @@ describe Imap::Backup::Configuration::List do
         },
       ]
     }
-    @store = stub('Imap::Backup::Configuration::Store', :data => @configuration_data)
-    Imap::Backup::Configuration::Store.stub!(:new => @store)
+  end
+  let(:store) { stub('Imap::Backup::Configuration::Store', :data => configuration_data) }
+
+  before do
+    Imap::Backup::Configuration::Store.stub!(:new => store)
+    Imap::Backup::Configuration::Store.stub!(:exist? => true)
   end
 
   context '#initialize' do
+    it 'fails if the configuration file is missing' do
+      Imap::Backup::Configuration::Store.should_receive(:exist?).and_return(false)
+
+      expect {
+        Imap::Backup::Configuration::List.new
+      }.to raise_error(Imap::Backup::ConfigurationNotFound, /not found/)
+    end
 
     context 'with account parameter' do
       it 'should only create requested accounts' do
         configuration = Imap::Backup::Configuration::List.new(['a2@example.com'])
 
-        configuration.accounts.should == @configuration_data[:accounts][1..1]
+        configuration.accounts.should == configuration_data[:accounts][1..1]
       end
     end
-
   end
 
   context 'instance methods' do
-
-    before :each do
-      @connection = stub('Imap::Backup::Account::Connection', :disconnect => nil)
-    end
+    let(:connection) { stub('Imap::Backup::Account::Connection', :disconnect => nil) }
 
     subject { Imap::Backup::Configuration::List.new }
 
     context '#each_connection' do
 
       it 'should instantiate connections' do
-        Imap::Backup::Account::Connection.should_receive(:new).with(@configuration_data[:accounts][0]).and_return(@connection)
-        Imap::Backup::Account::Connection.should_receive(:new).with(@configuration_data[:accounts][1]).and_return(@connection)
+        Imap::Backup::Account::Connection.should_receive(:new).with(configuration_data[:accounts][0]).and_return(connection)
+        Imap::Backup::Account::Connection.should_receive(:new).with(configuration_data[:accounts][1]).and_return(connection)
 
         subject.each_connection{}
       end
 
       it 'should call the block' do
-        Imap::Backup::Account::Connection.stub!(:new).and_return(@connection)
+        Imap::Backup::Account::Connection.stub!(:new).and_return(connection)
         calls = 0
 
         subject.each_connection do |a|
           calls += 1
-          a.should == @connection
+          a.should == connection
         end
         calls.should == 2
       end
 
       it 'should disconnect connections' do
-        Imap::Backup::Account::Connection.stub!(:new).and_return(@connection)
+        Imap::Backup::Account::Connection.stub!(:new).and_return(connection)
 
-        @connection.should_receive(:disconnect)
+        connection.should_receive(:disconnect)
 
         subject.each_connection {}
       end
-
     end
-
   end
-
 end