imap-backup 0.0.4 → 0.0.5

data/README.md

@@ -14,20 +14,17 @@
 
 # Installation
 
-    gem install 'imap-backup'
+    $ gem install 'imap-backup'
 
-# Basic Usage
+# Setup
 
-* Create ~/.imap-backup directory and configuration file
+Run:
 
-```shell
-$ cd
-$ mkdir .imap-backup
-$ chmod 0700 .imap-backup
-$ cd .imap-backup
-$ touch config.json
-$ chmod 0600 config.json
-```
+    $ imap-backup setup
+
+The setup system is a menu-driven command line application.
+
+It creates ~/.imap-backup directory and configuration file. E.g.:
 
 ```
 {
@@ -47,9 +44,22 @@ $ chmod 0600 config.json
 }
 ```
 
-* Run
+# Security
+
+Note that email usernames and passwords are held in plain text
+in the configuration file.
+
+The directory ~/.imap-backup, the configuration file and all backup
+directories have their access permissions set to only allow access
+by your user.
+
+# Run Backup
+
+Manually, from the command line:
+
+    $ imap-backup
 
-    imap-backup
+Altertatively, add it to your crontab.
 
 # Other Usage
 

data/bin/imap-backup

@@ -54,7 +54,7 @@ end
 begin
   configuration = Imap::Backup::Configuration::List.new(options[:accounts])
 rescue Imap::Backup::ConfigurationNotFound
-  Imap::Backup::Configuration::Setup.new(options).run
+  Imap::Backup::Configuration::Setup.new.run
   exit
 end
 
@@ -69,7 +69,7 @@ when 'folders'
     connection.folders.each { |f| puts "\t" + f.name }
   end
 when 'setup'
-  Imap::Backup::Configuration::Setup.new(options).run
+  Imap::Backup::Configuration::Setup.new.run
 when 'status'
   configuration.each_connection do |connection|
     puts connection.username

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

@@ -22,7 +22,7 @@ module Imap
               menu.header = 'Choose an action'
               @config.data[:accounts].each do |account|
                 menu.choice("#{account[:username]}") do
-                  Account.new(@config, account[:username]).run
+                  edit_account account[:username]
                 end
               end
               menu.choice('add account') do
@@ -58,7 +58,7 @@ module Imap
           if account.nil?
             account = add_account(username)
           end
-          Account.new @config, account[:username]
+          Account.new(@config, account).run
         end
 
       end

data/lib/imap/backup/version.rb

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

data/spec/unit/configuration/setup_spec.rb

@@ -23,11 +23,9 @@ describe Imap::Backup::Configuration::Setup do
     end
 
     def prepare_store
-      accounts = [
-        { :username => 'account@example.com' }
-      ]
-      @data  = {:accounts => accounts}
-      @store = stub('Imap::Backup::Configuration::Store', :data => @data, :path => '/base/path')
+      @account1 = { :username => 'account@example.com' }
+      @data     = { :accounts => [ @account1 ] }
+      @store    = stub('Imap::Backup::Configuration::Store', :data => @data, :path => '/base/path')
       Imap::Backup::Configuration::Store.stub!(:new).with(false).and_return(@store)
     end
 
@@ -64,7 +62,7 @@ describe Imap::Backup::Configuration::Setup do
       end
 
       @account = stub('Imap::Backup::Configuration::Account')
-      Imap::Backup::Configuration::Account.should_receive(:new).with(@store, 'account@example.com').and_return(@account)
+      Imap::Backup::Configuration::Account.should_receive(:new).with(@store, @account1).and_return(@account)
       @account.should_receive(:run).with()
 
       subject.run
@@ -82,8 +80,11 @@ describe Imap::Backup::Configuration::Setup do
         end
       end
 
+      blank_account = {:username=>"new@example.com", :password=>"", :local_path=>"/base/path/new_example.com", :folders=>[]}
       Imap::Backup::Configuration::Asker.should_receive(:email).with().and_return('new@example.com')
-      Imap::Backup::Configuration::Account.should_receive(:new).with(@store, 'new@example.com')
+      @account = stub('Imap::Backup::Configuration::Account')
+      Imap::Backup::Configuration::Account.should_receive(:new).with(@store, blank_account).and_return(@account)
+      @account.should_receive(:run).once
 
       subject.run
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1194066517873683688
+      hash: 475594614106241971
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1194066517873683688
+      hash: 475594614106241971
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23