imap-backup 0.0.5 → 1.0.0

data/README.md

@@ -14,19 +14,23 @@
 
 # Installation
 
-    $ gem install 'imap-backup'
+```shell
+$ gem install 'imap-backup'
+```
 
 # Setup
 
 Run:
 
-    $ imap-backup setup
+```shell
+$ imap-backup setup
+```
 
 The setup system is a menu-driven command line application.
 
 It creates ~/.imap-backup directory and configuration file. E.g.:
 
-```
+```json
 {
   "accounts":
   [
@@ -44,6 +48,27 @@ It creates ~/.imap-backup directory and configuration file. E.g.:
 }
 ```
 
+It connects to GMail by default, but you can also specify a server:
+
+```json
+{  
+  "accounts":
+  [
+    {
+      "username": "my.user@gmail.com",
+      "password": "secret",
+      "server": "my.imap.example.com",
+      "local_path": "/path/to/backup/root",
+      "folders":
+        [
+          {"name": "[Gmail]/All Mail"},
+          {"name": "my_folder"}
+        ]
+    }
+  ]
+}  
+```
+
 # Security
 
 Note that email usernames and passwords are held in plain text
@@ -57,19 +82,31 @@ by your user.
 
 Manually, from the command line:
 
-    $ imap-backup
+```shell
+$ imap-backup
+```
 
 Altertatively, add it to your crontab.
 
+# Result
+
+Each folder is saved to an mbox file.
+Alongside each mbox is a fine *.imap which lists the source IMAP UIDs to allow
+a full restore.
+
 # Other Usage
 
 List IMAP folders:
 
-    imap-backup folders
+```shell
+$ imap-backup folders
+```
 
 Get statistics of emails to download per folder:
 
-    imap-backup status
+```shell
+$ imap-backup status
+```
 
 # Design Goals
 

data/bin/imap-backup

@@ -34,7 +34,6 @@ opts = OptionParser.new do |opts|
     puts opts
     exit
   end
-
 end
 opts.parse!
 

data/imap-backup.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'highline'
+  gem.add_runtime_dependency 'mail'
   if RUBY_VERSION < '1.9'
     gem.add_runtime_dependency 'json'
   end
@@ -30,6 +31,5 @@ Gem::Specification.new do |gem|
   else
     gem.add_development_dependency 'simplecov'
   end
-  
 end
 

data/lib/email/mboxrd/message.rb

@@ -0,0 +1,37 @@
+require 'mail'
+
+module Email
+  module Mboxrd
+    class Message
+      def initialize(body)
+        @body = body.clone
+        @body.force_encoding('binary') if RUBY_VERSION >= '1.9.0'
+      end
+
+      def to_s
+        'From ' + from + "\n" + body + "\n"
+      end
+
+      private
+
+      def parsed
+        @parsed ||= Mail.new(@body)
+      end
+
+      def from
+        parsed.from[0] + ' ' + asctime
+      end
+
+      def body
+        mbox = @body.gsub(/\n(>*From)/, "\n>\\1")
+        mbox + "\n" unless mbox.end_with?("\n")
+        mbox
+      end
+
+      def asctime
+        parsed.date.asctime
+      end
+    end
+  end
+end
+

data/lib/imap/backup.rb

@@ -9,7 +9,9 @@ require 'imap/backup/configuration/list'
 require 'imap/backup/configuration/setup'
 require 'imap/backup/configuration/store'
 require 'imap/backup/downloader'
+require 'imap/backup/serializer/base'
 require 'imap/backup/serializer/directory'
+require 'imap/backup/serializer/mbox'
 require 'imap/backup/version'
 
 module Imap

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

@@ -4,14 +4,13 @@ module Imap
   module Backup
     module Account
       class Connection
-
         attr_reader :username
         attr_reader :imap
 
         def initialize(options)
           @username = options[:username]
           @local_path, @backup_folders = options[:local_path], options[:folders]
-          @imap = Net::IMAP.new('imap.gmail.com', 993, true)
+          @imap = Net::IMAP.new(options[:server] || 'imap.gmail.com', 993, true)
           @imap.login(@username, options[:password])
         end
 
@@ -34,12 +33,11 @@ module Imap
         def run_backup
           @backup_folders.each do |folder|
             f = Imap::Backup::Account::Folder.new(self, folder[:name])
-            s = Imap::Backup::Serializer::Directory.new(@local_path, folder[:name])
+            s = Imap::Backup::Serializer::Mbox.new(@local_path, folder[:name])
             d = Imap::Backup::Downloader.new(f, s)
             d.run
           end
         end
-
       end
     end
   end

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

@@ -4,7 +4,6 @@ module Imap
   module Backup
     module Account
       class Folder
-
         REQUESTED_ATTRIBUTES = ['RFC822', 'FLAGS', 'INTERNALDATE']
 
         def initialize(connection, folder)
@@ -22,7 +21,6 @@ module Imap
           message['RFC822'].force_encoding('utf-8') if RUBY_VERSION > '1.9'
           message
         end
-
       end
     end
   end

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

@@ -4,7 +4,6 @@ module Imap
   module Backup
     module Configuration
       class Account
-
         def initialize(store, account)
           @store, @account = store, account
         end
@@ -77,7 +76,6 @@ EOT
             end
           end
         end
-
       end
     end
   end

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

@@ -4,7 +4,6 @@ module Imap
   module Backup
     module Configuration
       module Asker
-
         EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i
 
         def self.email(default = '')
@@ -34,7 +33,6 @@ module Imap
             q.responses[:not_valid] = 'Choose a different directory '
           end
         end
-
       end
     end
   end

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

@@ -4,7 +4,6 @@ module Imap
   module Backup
     module Configuration
       class FolderChooser
-
         def initialize(account)
           @account = account
         end
@@ -48,7 +47,6 @@ module Imap
             end
           end
         end
-
       end
     end
   end

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

@@ -4,28 +4,29 @@ module Imap
   module Backup
     module Configuration
       class List
+        attr_reader :accounts
 
-      attr_reader :accounts
+        def initialize(accounts = nil)
+          if not Imap::Backup::Configuration::Store.exist?
+            raise ConfigurationNotFound.new("Configuration file '#{Imap::Backup::Configuration::Store.default_pathname}' not found")
+          end
+          @config = Imap::Backup::Configuration::Store.new
 
-      def initialize(accounts = nil)
-        @config = Imap::Backup::Configuration::Store.new
-
-        if accounts.nil?
-          @accounts = @config.data[:accounts]
-        else
-          @accounts = @config.data[:accounts].select{ |account| accounts.include?(account[:username]) }
+          if accounts.nil?
+            @accounts = @config.data[:accounts]
+          else
+            @accounts = @config.data[:accounts].select{ |account| accounts.include?(account[:username]) }
+          end
         end
-      end
 
-      def each_connection
-        @accounts.each do |account|
-          connection = Imap::Backup::Account::Connection.new(account)
-          yield connection
-          connection.disconnect
+        def each_connection
+          @accounts.each do |account|
+            connection = Imap::Backup::Account::Connection.new(account)
+            yield connection
+            connection.disconnect
+          end
         end
       end
-
-      end
     end
   end
 end

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

@@ -6,14 +6,13 @@ module Imap
   module Backup
     module Configuration
       class Setup
-
         class << self
           attr_accessor :highline
         end
         self.highline = HighLine.new
 
         def initialize
-          @config = Imap::Backup::Configuration::Store.new(false)
+          @config = Imap::Backup::Configuration::Store.new
         end
 
         def run
@@ -60,7 +59,6 @@ module Imap
           end
           Account.new(@config, account).run
         end
-
       end
     end
   end

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

@@ -6,41 +6,44 @@ module Imap
   module Backup
     module Configuration
       class Store
-
         CONFIGURATION_DIRECTORY = File.expand_path('~/.imap-backup')
 
         attr_reader :data
         attr_reader :path
 
-        def initialize(fail_if_missing = true)
-          @path     = CONFIGURATION_DIRECTORY
-          @pathname = File.join(@path, 'config.json')
-          if File.directory?(@path)
-            Imap::Backup::Utils.check_permissions @path, 0700
+        def self.default_pathname
+          File.join(CONFIGURATION_DIRECTORY, 'config.json')
+        end
+
+        def self.exist?(pathname = default_pathname)
+          File.exist?(pathname)
+        end
+
+        def initialize(pathname = self.class.default_pathname)
+          @pathname = pathname
+          if File.directory?(path)
+            Imap::Backup::Utils.check_permissions path, 0700
           end
           if File.exist?(@pathname)
             Imap::Backup::Utils.check_permissions @pathname, 0600
             @data = JSON.parse(File.read(@pathname), :symbolize_names => true)
           else
-            if fail_if_missing
-              raise ConfigurationNotFound.new("Configuration file '#{@pathname}' not found")
-            end
             @data = {:accounts => []}
           end
         end
 
         def save
-          mkdir_private @path
+          mkdir_private path
           File.open(@pathname, 'w') { |f| f.write(JSON.pretty_generate(@data)) }
           FileUtils.chmod 0600, @pathname
           @data[:accounts].each do |account|
             mkdir_private account[:local_path]
             account[:folders].each do |f|
               parts = f[:name].split('/')
-              path  = account[:local_path].clone
+              p     = account[:local_path].clone
               parts.each do |part|
-                path = File.join(path, part)
-                mkdir_private path
+                p    = File.join(p, part)
+                mkdir_private p
               end
             end
           end
@@ -57,6 +60,9 @@ module Imap
           end
         end
 
+        def path
+          File.dirname(@pathname)
+        end
       end
     end
   end

data/lib/imap/backup/downloader.rb

@@ -5,7 +5,6 @@ require 'json'
 module Imap
   module Backup
     class Downloader
-
       def initialize(folder, serializer)
         @folder, @serializer = folder, serializer
       end
@@ -17,7 +16,6 @@ module Imap
           @serializer.save(uid, message)
         end
       end
-
     end
   end
 end

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

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Imap
+  module Backup
+    module Serializer
+      DIRECTORY_PERMISSIONS = 0700
+      FILE_PERMISSIONS      = 0600
+      class Base
+        def initialize(path, folder)
+          @path, @folder = path, folder
+          Imap::Backup::Utils.check_permissions(@path, DIRECTORY_PERMISSIONS)
+        end
+      end
+    end
+  end
+end
+

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

@@ -4,13 +4,10 @@ require 'fileutils'
 module Imap
   module Backup
     module Serializer
-      class Directory
-
+      class Directory < Base
         def initialize(path, folder)
-          @path, @folder = path, folder
-          permissions = 0700
-          Imap::Backup::Utils.check_permissions(@path, permissions)
-          Imap::Backup::Utils.make_folder(@path, @folder, permissions)
+          super
+          Imap::Backup::Utils.make_folder(@path, @folder, DIRECTORY_PERMISSIONS)
         end
 
         def uids
@@ -43,7 +40,6 @@ module Imap
         def filename(uid)
           "#{directory}/%012u.json" % uid.to_i
         end
-
       end
     end
   end