imap-backup 0.0.3 → 0.0.4

data/bin/imap-backup

@@ -7,10 +7,11 @@ $:.unshift(File.expand_path('../../lib/', __FILE__))
 require 'imap/backup'
 
 KNOWN_COMMANDS = [
+  {:name => 'help',    :help => 'Show usage'},
+  {:name => 'setup',   :help => 'Create/edit the configuration file'},
   {:name => 'backup',  :help => 'Do the backup (default)'},
   {:name => 'folders', :help => 'List folders for all (or selected) accounts'},
   {:name => 'status',  :help => 'List count of non backed-up emails per folder'},
-  {:name => 'help',    :help => 'Show usage'},
 ]
 
 options = {:command => 'backup'}
@@ -45,22 +46,32 @@ if KNOWN_COMMANDS.find{|c| c[:name] == options[:command] }.nil?
   raise "Unknown command '#{options[:command]}'"
 end
 
-settings = Imap::Backup::Settings.new(options[:accounts])
+if options[:command] == 'help'
+  puts opts
+  exit
+end
+
+begin
+  configuration = Imap::Backup::Configuration::List.new(options[:accounts])
+rescue Imap::Backup::ConfigurationNotFound
+  Imap::Backup::Configuration::Setup.new(options).run
+  exit
+end
 
 case options[:command]
 when 'backup'
-  settings.each_connection do |connection|
+  configuration.each_connection do |connection|
     connection.run_backup
   end
-when 'help'
-  puts opts
 when 'folders'
-  settings.each_connection do |connection|
+  configuration.each_connection do |connection|
     puts connection.username
     connection.folders.each { |f| puts "\t" + f.name }
   end
+when 'setup'
+  Imap::Backup::Configuration::Setup.new(options).run
 when 'status'
-  settings.each_connection do |connection|
+  configuration.each_connection do |connection|
     puts connection.username
     folders = connection.status
     folders.each do |f|

data/imap-backup.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Imap::Backup::VERSION
 
   gem.add_runtime_dependency 'rake'
+  gem.add_runtime_dependency 'highline'
   if RUBY_VERSION < '1.9'
     gem.add_runtime_dependency 'json'
   end

data/lib/imap/backup.rb

@@ -1,8 +1,20 @@
 require 'imap/backup/utils'
 require 'imap/backup/account/connection'
 require 'imap/backup/account/folder'
+require 'imap/backup/configuration/account'
+require 'imap/backup/configuration/asker'
+require 'imap/backup/configuration/connection_tester'
+require 'imap/backup/configuration/folder_chooser'
+require 'imap/backup/configuration/list'
+require 'imap/backup/configuration/setup'
+require 'imap/backup/configuration/store'
 require 'imap/backup/downloader'
 require 'imap/backup/serializer/directory'
-require 'imap/backup/settings'
 require 'imap/backup/version'
 
+module Imap
+  module Backup
+    class ConfigurationNotFound < StandardError; end
+  end
+end
+

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

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+module Imap
+  module Backup
+    module Configuration
+      class Account
+
+        def initialize(store, account)
+          @store, @account = store, account
+        end
+
+        def run
+          loop do
+            Setup.highline.choose do |menu|
+              password =
+                if @account[:password] == ''
+                 '(unset)'
+                else
+                  @account[:password].gsub(/./, 'x')
+                end
+              menu.header = <<EOT
+Account:
+  email:    #{@account[:username]}
+  path:     #{@account[:local_path]}
+  folders:  #{@account[:folders].map { |f| f[:name] }.join(', ')}
+  password: #{password}
+EOT
+              menu.choice('modify email') do
+                username = Asker.email(username)
+                others   = @store.data[:accounts].select { |a| a != @account}.map { |a| a[:username] }
+                if others.include?(username)
+                  puts 'There is already an account set up with that email address'
+                else
+                  @account[:username] = username
+                end
+              end
+              menu.choice('modify password') do
+                password = Asker.password
+                if ! password.nil?
+                  @account[:password] = password
+                end
+              end
+              menu.choice('modify backup path') do
+                validator = lambda do |p|
+                  same = @store.data[:accounts].find do |a|
+                    a[:username] != @account[:username] && a[:local_path] == p
+                  end
+                  if same
+                    puts "The path '#{p}' is used to backup the account '#{same[:username]}'"
+                    false
+                  else
+                    true
+                  end
+                end
+                @account[:local_path] = Asker.backup_path(@account[:local_path], validator)
+              end
+              menu.choice('choose backup folders') do
+                FolderChooser.new(@account).run
+              end
+              menu.choice 'test authentication' do
+                result = ConnectionTester.test(@account)
+                puts result 
+                Setup.highline.ask 'Press a key '
+              end
+              menu.choice(:delete) do
+                if Setup.highline.agree("Are you sure? (y/n) ")
+                  @store.data[:accounts].reject! { |a| a[:username] == @account[:username] }
+                  return
+                end
+              end
+              menu.choice('return to main menu') do
+                return
+              end
+              menu.hidden('quit') do
+                return
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+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 = '')
+          Setup.highline.ask('email address: ') do |q|
+            q.default               = default
+            q.readline              = true
+            q.validate              = EMAIL_MATCHER
+            q.responses[:not_valid] = 'Enter a valid email address '
+          end
+        end
+
+        def self.password
+          password     = Setup.highline.ask('password: ')        { |q| q.echo = false }
+          confirmation = Setup.highline.ask('repeat password: ') { |q| q.echo = false }
+          if password != confirmation
+            return nil unless Setup.highline.agree("the password and confirmation did not match.\nContinue? (y/n) ")
+            return self.password
+          end
+          password
+        end
+
+        def self.backup_path(default, validator)
+          Setup.highline.ask('backup directory: ') do |q|
+            q.default  = default
+            q.readline = true
+            q.validate = validator
+            q.responses[:not_valid] = 'Choose a different directory '
+          end
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Imap
+  module Backup
+    module Configuration
+      module ConnectionTester
+        def self.test(account)
+          Imap::Backup::Account::Connection.new(account)
+          return 'Connection successful'
+        rescue Net::IMAP::NoResponseError
+          return 'No response'
+        rescue Exception => e
+          return "Unexpected error: #{e}"
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module Imap
+  module Backup
+    module Configuration
+      class FolderChooser
+
+        def initialize(account)
+          @account = account
+        end
+
+        def run
+          begin
+            @connection = Imap::Backup::Account::Connection.new(@account)
+          rescue => e
+            puts 'Connection failed'
+            Setup.highline.ask 'Press a key '
+            return
+          end
+          @folders = @connection.folders
+          loop do
+            Setup.highline.choose do |menu|
+              menu.header = 'Add/remove folders'
+              menu.index = :number
+              @folders.each do |folder|
+                name  = folder.name
+                found = @account[:folders].find { |f| f[:name] == name }
+                mark  =
+                  if found
+                    '+'
+                  else
+                    '-'
+                  end
+                menu.choice("#{mark} #{name}") do
+                  if found
+                    @account[:folders].reject! { |f| f[:name] == name }
+                  else
+                    @account[:folders] << { :name => name }
+                  end
+                end
+              end
+              menu.choice('return to the account menu') do
+                return
+              end
+              menu.hidden('quit') do
+                return
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Imap
+  module Backup
+    module Configuration
+      class List
+
+      attr_reader :accounts
+
+      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]) }
+        end
+      end
+
+      def each_connection
+        @accounts.each do |account|
+          connection = Imap::Backup::Account::Connection.new(account)
+          yield connection
+          connection.disconnect
+        end
+      end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'highline'
+
+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)
+        end
+
+        def run
+          loop do
+            self.class.highline.choose do |menu|
+              menu.header = 'Choose an action'
+              @config.data[:accounts].each do |account|
+                menu.choice("#{account[:username]}") do
+                  Account.new(@config, account[:username]).run
+                end
+              end
+              menu.choice('add account') do
+                username = Asker.email
+                edit_account username
+              end
+              menu.choice('save and exit') do
+                @config.save
+                return
+              end
+              menu.choice(:quit) do
+                return
+              end
+            end
+          end
+        end
+
+        private
+
+        def add_account(username)
+          account = {
+            :username   => username,
+            :password   => '',
+            :local_path => File.join(@config.path, username.gsub('@', '_')),
+            :folders    => []
+          }
+          @config.data[:accounts] << account
+          account
+        end
+
+        def edit_account(username)
+          account = @config.data[:accounts].find { |a| a[:username] == username }
+          if account.nil?
+            account = add_account(username)
+          end
+          Account.new @config, account[:username]
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'json'
+
+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
+          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
+          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
+              parts.each do |part|
+                path = File.join(path, part)
+                mkdir_private path
+              end
+            end
+          end
+        end
+
+        private
+
+        def mkdir_private(path)
+          if ! File.directory?(path)
+            FileUtils.mkdir path
+          end
+          if Imap::Backup::Utils::stat(path) != 0700
+            FileUtils.chmod 0700, path
+          end
+        end
+
+      end
+    end
+  end
+end
+