backs3 0.0.5

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.5 2009-09-16
+
+* Upgraded hoe

data/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+example.conf
+bin/backs3
+bin/res3
+lib/backs3.rb
+lib/backs3/backs3.rb
+lib/backs3/backup.rb
+lib/backs3/restore.rb
+lib/backs3/version.rb
+lib/backs3/backup.rb
+lib/backs3/file_info.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/backs3/backup_spec.rb
+spec/backs3/restore_spec.rb
+spec/backs3/backup_spec.rb
+spec/backs3/file_info_spec.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,51 @@
+= Backs3
+
+* http://github.com/jemmyw/backs3
+
+== DESCRIPTION:
+
+A simple backup and restore program for S3
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  backs3 -c s3.conf test
+  res3 -c s3.conf available => [12345, 54321]
+  res3 -c s3.conf restore 12345
+
+== REQUIREMENTS:
+
+* ActiveSupport
+* AWS/S3
+
+== INSTALL:
+
+* sudo gem install jemmyw-backs3
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jeremy Wells / Boost Limited (http://www.boost.co.nz)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/backs3'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'backs3' do
+  self.developer 'Jeremy Wells', 'jeremy@boost.co.nz'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.description = "S3 backup and restore program"
+  #self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['activesupport','>= 2.0.2'], ['aws-s3', '>= 0.5.1']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/backs3

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rubygems'
+  require 'backs3/backs3'
+rescue LoadError => e
+  require 'lib/backs3/backs3'
+end
+
+require 'active_support'
+require 'getoptlong'
+
+option_parser = GetoptLong.new(
+  ['--help', '-h', GetoptLong::NO_ARGUMENT],
+  ['--config', '-c', GetoptLong::REQUIRED_ARGUMENT],
+  ['--exclude', GetoptLong::REQUIRED_ARGUMENT],
+  ['--id', '-i', GetoptLong::REQUIRED_ARGUMENT],
+  ['--key', '-k', GetoptLong::REQUIRED_ARGUMENT],
+  ['--bucket', '-b', GetoptLong::REQUIRED_ARGUMENT],
+  ['--prefix', '-p', GetoptLong::REQUIRED_ARGUMENT],
+  ['--full', '-f', GetoptLong::REQUIRED_ARGUMENT],
+  ['--force-full', GetoptLong::NO_ARGUMENT]
+)
+
+$options = {}
+
+def usage(message = nil)
+  $stderr.puts message unless message.blank?
+
+  name = $0.split('/').last
+  $stderr.puts <<"ENDUSAGE"
+  #{name} [options] <directory>
+  --help        -h
+  --config      -c      Configuration file
+  --id          -i      AWS Access Key ID
+  --key         -k      AWS Secret Key
+  --bucket      -b      AWS Bucket name
+  --full=d      -f d    Number of days between full backups (default: 7)
+  --force-full          Force a full backup
+  --prefix      -p
+  --exclude="regex" Exclude files based on regex
+
+ENDUSAGE
+
+  $stderr.puts "Current configuration:"
+  $options.each do |key, value|
+    $stderr.puts "  #{key}:    \t#{value}"
+  end
+
+  exit!
+end #usage
+
+begin
+  option_parser.each do |opt, arg|
+    $options[opt.gsub(/^-*/, '')] = (arg || true)
+  end
+
+  usage if $options['help']
+  $options['folder'] = ARGV[0] unless ARGV[0].blank?
+
+  raise Exception.new("Invalid configuration file #{$options['config']}") unless $options['config'].blank? || File.exists?($options['config'])
+  $options['config'] ||= '/etc/backs3.conf'
+
+  if File.exists?($options['config'])
+    begin
+      puts "Reading configuration from #{$options['config']}"
+      config = YAML::load_file($options['config'])
+      $options = config.merge($options)
+    rescue
+      raise Exception.new("Invalid configuration file #{$options['config']}")
+    end
+  end
+
+  raise Exception.new("You must specify a directory to backup") if $options['folder'].blank?
+  raise Exception.new("You must specify a bucket") if $options['bucket'].blank?
+  raise Exception.new("You must specify an AWS ID") if $options['id'].blank?
+  raise Exception.new("You must specify an AWS Secret Key") if $options['key'].blank?
+rescue Exception => e
+  usage(e.to_s)
+end
+
+class Backs3::BackupCmd
+  include Backs3
+
+  def initialize(options = {})
+    @options = options
+    @options['prefix'] ||= ''
+
+    establish_connection
+
+    @backups = load_backup_info
+    @backup = Backup.new(@backups, @options)
+  end
+
+  def backup
+    @backup.backup
+  end
+end
+
+Backs3::BackupCmd.new($options).backup

data/bin/res3

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rubygems'
+  require 'backs3/restore'
+rescue LoadError => e
+  require 'lib/backs3/restore'
+end
+
+require 'active_support'
+require 'getoptlong'
+
+option_parser = GetoptLong.new(
+  ['--help', '-h', GetoptLong::NO_ARGUMENT],
+  ['--config', '-c', GetoptLong::REQUIRED_ARGUMENT],
+  ['--id', '-i', GetoptLong::REQUIRED_ARGUMENT],
+  ['--key', '-k', GetoptLong::REQUIRED_ARGUMENT],
+  ['--bucket', '-b', GetoptLong::REQUIRED_ARGUMENT],
+  ['--prefix', '-p', GetoptLong::REQUIRED_ARGUMENT]
+)
+
+$options = {}
+
+def usage(message = nil)
+  $stderr.puts message unless message.blank?
+
+  name = $0.split('/').last
+  $stderr.puts <<"ENDUSAGE"
+  #{name} [options] <directory> <command> [command options]
+  Commands:
+    #{Backs3::Restore.commands.join(", ")}
+
+  --help        -h
+  --config      -c      Configuration file
+  --id          -i      AWS Access Key ID
+  --key         -k      AWS Secret Key
+  --bucket      -b      AWS Bucket name
+  --prefix      -p
+
+ENDUSAGE
+
+  $stderr.puts "Current configuration:"
+  $options.each do |key, value|
+    $stderr.puts "  #{key}:    \t#{value}"
+  end
+
+  exit!
+end #usage
+
+begin
+  option_parser.each do |opt, arg|
+    $options[opt.gsub(/^-*/, '')] = (arg || true)
+  end
+
+  usage if $options['help']
+
+  raise Exception.new("Invalid configuration file #{$options['config']}") unless $options['config'].blank? || File.exists?($options['config'])
+  $options['config'] ||= '/etc/backs3.conf'
+
+  if File.exists?($options['config'])
+    begin
+      puts "Reading configuration from #{$options['config']}"
+      config = YAML::load_file($options['config'])
+      $options = config.merge($options)
+    rescue
+      raise Exception.new("Invalid configuration file #{$options['config']}")
+    end
+  end
+
+  args = ARGV
+  $options['folder'] = args.shift if $options['folder'].blank?
+  $command = args.shift
+
+  raise Exception.new("You must specify a directory to restore from") if $options['folder'].blank?
+  raise Exception.new("You must specify a bucket") if $options['bucket'].blank?
+  raise Exception.new("You must specify an AWS ID") if $options['id'].blank?
+  raise Exception.new("You must specify an AWS Secret Key") if $options['key'].blank?
+  raise Exception.new("You must specify a valid command") unless Backs3::Restore.commands.include?($command)
+rescue Exception => e
+  usage(e.to_s)
+end
+
+res3 = Backs3::Restore.new($options)
+
+begin
+  res3.send($command, *args)
+rescue Exception => e
+  puts e
+  puts e.backtrace.join("\n")
+end

data/example.conf

@@ -0,0 +1,5 @@
+---
+id: xxx
+key: xxx
+folder: xxx
+bucket: xxx

data/lib/backs3.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/backs3/backs3'
+
+module Backs3
+  VERSION = '0.0.5'
+end

data/lib/backs3/backs3.rb

@@ -0,0 +1,56 @@
+# #!/usr/bin/env ruby
+
+require 'rubygems' rescue nil
+require 'aws/s3'
+require 'active_support'
+require 'active_support/dependencies'
+require 'digest/md5'
+require 'time'
+
+unless ActiveSupport::Dependencies.load_paths.include?(File.expand_path(File.dirname(__FILE__) + '/..'))
+  ActiveSupport::Dependencies.load_paths << File.expand_path(File.dirname(__FILE__) + '/..')
+end
+
+module Backs3
+  autoload :Backup, 'backs3/backup'
+  autoload :FileInfo, 'backs3/file_info'
+  autoload :Storage, 'backs3/storage'
+
+  def logger
+    logger_output = @options['logger'] || $stdout
+    @logger ||= Logger.new(logger_output)
+  end
+
+  def md5(filename)
+    Digest::MD5.hexdigest(filename)
+  end
+  
+  def save_backup_info(info)
+    storage.store('s3backup', YAML.dump(info))
+    logger.info "Backup info has been stored"
+  end
+
+  def load_backup_info
+    @backups ||= begin
+      backup_info_file = storage.read('s3backup') || ''
+      YAML.load(backup_info_file) || []
+    rescue Exception => e
+      puts e.to_s
+      []
+    end
+    
+    unless @backups.respond_to?(:sort) && @backups.respond_to?(:each) && @backups.respond_to?(:reject!)
+      @backups = []
+    end
+    
+    @backups.reject! do |backup|
+      !backup.respond_to?(:date)
+    end
+    
+    @backups.sort do |a,b|
+      a.date <=> b.date
+    end
+    
+    @backups
+  end
+end

data/lib/backs3/backup.rb

@@ -0,0 +1,111 @@
+module Backs3
+  class Backup
+    include Backs3
+    include Storage
+
+    attr_reader :date, :files, :full, :options, :last_backup, :last_full_backup, :done
+
+    def initialize(previous, options)
+      @backups = previous.sort{|a,b| a.date <=> b.date } if previous
+      @last_backup = self.backups.last
+      @last_full_backup = self.backups.reverse.detect{|b| b.full == true }
+
+      @date = Time.now.to_i
+      @options = options
+      @options['prefix'] ||= ''
+      @full = @options['force-full'] || first_backup? || @date - @last_full_backup.date > (@options['full'] || 7).days
+    end
+
+    def ==(other_obj)
+      other_obj.date == self.date && other_obj.full == self.full
+    end
+
+    def backups
+      @backups ||= load_backup_info.sort{|a,b| a.date <=> b.date } || []
+    end
+
+    # All of the files for a backup. If the backup is partial this function will
+    # find the files from the last full backup to this one.
+    def all_files
+      if !full && @last_full_backup
+        backups = self.backups.select{|b| b.date >= @last_full_backup.date && b.date <= self.date }
+        backups << self unless backups.include?(self)
+
+        rfiles = backups.collect{|b| b.files}.flatten.uniq
+        rfiles.reject! do |first_file|
+          rfiles.detect{|second_file| second_file.path == first_file.path && second_file.backup_info.date > first_file.backup_info.date }
+        end
+        rfiles
+      else
+        self.files
+      end
+    end
+
+    def key
+      @options['prefix'] + @date.to_s
+    end
+
+    def first_backup?
+      @last_full_backup.nil?
+    end
+
+    def backup
+      raise "Cannot backup again!" if @done
+
+      logger.info "Backing up #{@options['folder']} in key #{self.key}"
+
+      @files = collect_files
+      @files.each do |file|
+        file.backup
+      end
+
+      update_backup_info
+      storage.flush
+
+      @done = true
+      logger.info "Backup finished!"
+    end
+
+    def restore(location = '/tmp', file = nil)
+      files = file.nil? ? all_files : all_files.select{|f| f.path == file}
+      files.each do |file|
+        file.restore(location)
+      end
+    end
+
+    def to_yaml_properties
+      instance_variables.reject{|i| %w(@backups).include?(i) }.sort
+    end
+
+    private
+
+    def update_backup_info
+      raise "Cannot save info twice!" if @done
+
+      @backups << self
+      save_backup_info(@backups)
+    end
+
+    def collect_files
+      files = begin
+        Dir.glob(File.join(@options['folder'], '**', '**')).select do |file|
+          if File.directory?(file) || File.symlink?(file)
+            false
+          else
+            if @options['exclude'].blank? || file !~ /#{@options['exclude']}/
+              if @full || File.mtime(file).to_i > @last_backup.date
+                true
+              else
+                false
+              end
+            else
+              false
+            end
+          end
+        end
+      end
+
+      files.collect{|f| FileInfo.new(self, f) }
+    end
+  end
+end

data/lib/backs3/file_info.rb

@@ -0,0 +1,51 @@
+module Backs3
+  class FileInfo
+    include Backs3
+
+    attr_reader :backup_info
+    attr_reader :path
+    attr_reader :md5sum
+
+    def initialize(backup, path)
+      @backup_info = backup
+      @path = path
+      @md5sum = md5(@path)
+      @options = @backup_info.options
+    end
+
+    def storage
+      @backup_info.storage
+    end
+
+    def ==(other_obj)
+      other_obj.backup_info == self.backup_info && other_obj.path == self.path
+    end
+
+    def aws_filename
+      File.join(@backup_info.key, path)
+    end
+
+    def backup
+      logger.info "Backing up #{@path} to #{aws_filename}"
+      storage.store(aws_filename, open(@path))
+    end
+
+    def restore(location = '/tmp')
+      restore_path = File.join(location, @path)
+      
+      if storage.exists?(aws_filename)
+        $stdout.write "Restoring file #{@path}"
+        FileUtils.mkdir_p File.dirname(restore_path)
+        File.open(restore_path, 'w') do |f|
+          storage.read(aws_filename) do |segment|
+            $stdout.write "."
+            f.write segment
+          end
+        end
+        $stdout.write "\n"
+      else
+        logger.info "Could not restore #{@path} because file data could not be found!"
+      end
+    end
+  end
+end

data/lib/backs3/restore.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/backs3'
+require 'fileutils'
+
+module Backs3
+  class Restore
+    include Backs3
+    include Storage
+
+    def self.commands
+      %w(ls available restore cat info)
+    end
+
+    def initialize(options = {})
+      @options = options
+      @options['prefix'] ||= ''
+      @backups = load_backup_info.sort{|a,b| a.date <=> b.date }
+    end
+
+    def available(backup_key = nil)
+      if backup_key.nil?
+        puts "Backups available: #{@backups.map{|b| b.date}.join(", ")}"
+      else
+        unless backup = @backups.detect{|b| b.date.to_s == backup_key.to_s }
+          raise "No backup #{backup_key} available"
+        end
+
+        files = backup.all_files
+
+        puts "Backup information for #{backup.date}"
+        files.each do |file|
+          puts "\tFile: #{file.path}, backed up #{Time.at(file.backup_info.date).to_s}"
+        end
+      end
+    end
+
+    def info(file)
+      files = @backups.collect{|b| b.files}.flatten.select{|f| f.path == file}
+
+      if files.empty?
+        puts "No information found for file #{file}"
+      else
+        puts "Backup information for file #{file}"
+
+        files.each do |f|
+          puts "\tBacked up #{Time.at(f.backup_info.date).to_s} in #{f.backup_info.date} with md5sum #{f.md5sum}"
+        end
+      end
+    end
+
+    def ls(backup)
+      storage.list(backup).each do |name|
+        puts name
+      end
+    end
+
+    def cat(date, name)
+      backup = @backups.detect{|b| b.date.to_s == date.to_s}
+      raise "Cannot find backup #{date}" unless backup
+      file = backup.all_files.detect{|f| f.path == name}
+      raise "Cannot find file #{name}" unless file
+      puts storage.read(File.join(backup.date.to_s, name))
+    end
+
+    def restore(date, file = nil)
+      backup = @backups.detect{|b| b.date.to_s == date.to_s}
+      raise 'Cannot find backup %s' % date if backup.nil?
+      backup.restore('/tmp', file)
+    end
+  end
+end

data/lib/backs3/version.rb

@@ -0,0 +1,9 @@
+module Backs3 #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 4
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/backs3/backup_spec.rb

@@ -0,0 +1,132 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'backs3/backs3'
+require 'backs3/backup'
+
+describe Backs3::Backup do
+  before(:each) do
+    @options = {'folder' => 'test', 'logger' => StringIO.new(''), 'storage' => 'test'}
+    @previous = []
+  end
+  
+  it 'should set the date to Time.now.to_i' do
+    @mock_time = mock(:time)
+    @mock_time.should_receive(:to_i).and_return(1)
+    Time.should_receive(:now).and_return(@mock_time)
+    
+    Backup.new(@previous, @options).date.should == 1
+  end
+
+  describe 'backup' do
+    before(:each) do
+      @file_info = mock(:file_info)
+      @backup = Backup.new(@previous, @options)
+    end
+
+    it 'should call backup on each file in the backup folder' do
+      @backup.should_receive(:save_backup_info).once
+      @file_info.should_receive(:backup).exactly(3).times
+
+      (1..3).each do |f|
+        FileInfo.should_receive(:new).with(@backup, 'test/file_%d' % f).and_return(@file_info)
+      end
+
+      @backup.backup
+    end
+
+    it 'should exclude files based on the exclude option' do
+      @options['exclude'] = 'file_1'
+      @backup = Backup.new(@previous, @options)
+      @backup.should_receive(:save_backup_info).once
+
+      @file_info.should_receive(:backup).exactly(2).times
+
+      (2..3).each do |f|
+        FileInfo.should_receive(:new).with(@backup, 'test/file_%d' % f).and_return(@file_info)
+      end
+
+      @backup.backup
+    end
+  end
+
+  describe 'full_backup?' do
+    it 'should be false if there is a previous full backup' do
+      @previous << mock(:backup, :date => Time.now.to_i, :full => true)
+      Backup.new(@previous, @options).first_backup?.should == false
+    end
+
+    it 'should be true if there are no previous full backups' do
+      Backup.new(@previous, @options).first_backup?.should == true
+      @previous << mock(:backup, :date => Time.now.to_i, :full => false)
+      Backup.new(@previous, @options).first_backup?.should == true
+    end
+  end
+
+  describe 'all_files' do
+    it 'should just be the list of files in the backup if the backup is full' do
+      backup = Backup.new(@previous, @options)
+      backup.full.should == true
+      backup.all_files.should == backup.files
+    end
+
+    it 'should include files from the last full backup if partial' do
+      last_full = Backup.new([], @options)
+      last_full.stub!(:full).and_return(true)
+
+      current = Backup.new([last_full], @options)
+      current.stub!(:full).and_return(false)
+
+      file_1 = mock(:file_info, :path => 'test/file_1', :backup_info => last_full)
+      file_2 = mock(:file_info, :path => 'test/file_2', :backup_info => current)
+
+      last_full.stub!(:files).and_return([file_1])
+      current.stub!(:files).and_return([file_2])
+
+      current.all_files.should == [file_1, file_2]
+    end
+  end
+
+  describe '@full' do
+    it 'should set full if there is no previous backup specified' do
+      Backup.new(@previous, @options).full.should == true
+    end
+
+    it 'should always set full if there is no full previous backup' do
+      (1..10).each do |d|
+        @previous << mock(:backup, :date => Time.now.to_i - d.days, :full => false)
+        Backup.new(@previous, @options).full.should == true
+      end
+    end
+  
+    it 'should set full if the previous backup happened more than 7 days ago' do
+      @previous << mock(:backup, :date => Time.now.to_i - 8.days, :full => true)
+      Backup.new(@previous, @options).full.should == true
+    end
+  
+    it 'should set full to false if the previous backup happened less than 7 days ago' do
+      @previous << mock(:backup, :date => Time.now.to_i - 6.days, :full => true)
+      Backup.new(@previous, @options).full.should == false
+    end
+
+    it 'should set full if the previous backup happened more than options full' do
+      @options['full'] = 5
+      @previous << mock(:backup, :date => Time.now.to_i - 6.days, :full => true)
+      Backup.new(@previous, @options).full.should == true
+    end
+
+    it 'should not set full if the previous backup happened less than options full days ago' do
+      @options['full'] = 5
+      @previous << mock(:backup, :date => Time.now.to_i - 4.days, :full => true)
+      Backup.new(@previous, @options).full.should == false
+    end
+
+    it 'should always set full if the force full backup options is passed' do
+      @options['force-full'] = true
+      Backup.new(@previous, @options).full.should == true
+
+      (1..10).each do |d|
+        @previous << mock(:backup, :date => Time.now.to_i - d.days, :full => true)
+        Backup.new(@previous, @options).full.should == true
+      end
+    end
+  end
+end

data/spec/backs3/file_info_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'backs3/backs3'
+require 'backs3/file_info'
+
+include Backs3
+
+describe Backs3::FileInfo do
+  before(:each) do
+    @options = {'folder' => 'test', 'logger' => StringIO.new(''), 'bucket' => 'test_bucket'}
+    @backup = mock(:backup)
+    @path = 'test/file_1'
+
+    @storage = mock(:storage)
+    @backup.stub!(:storage).and_return(@storage)
+
+    @backup.stub!(:options).and_return(@options)
+  end
+
+  describe 'aws_filename' do
+    it 'should return the full filename to be put on aws' do
+      @backup.should_receive(:key).and_return('12345')
+      FileInfo.new(@backup, @path).aws_filename.should == '12345/test/file_1'
+    end
+  end
+
+  describe '==' do
+    it 'should be equal if files have same path and same backup info' do
+      file_1 = FileInfo.new(@backup, @path)
+      file_2 = FileInfo.new(@backup, @path)
+      file_1.should == file_2
+    end
+
+    it 'should be different if files have different path' do
+      file_1 = FileInfo.new(@backup, @path)
+      file_2 = FileInfo.new(@backup, @path + 'diff')
+      file_1.should_not == file_2
+    end
+
+    it 'should be different if files have different backup' do
+      @backup2 = mock(:backup)
+      @backup2.stub!(:options).and_return(@options)
+      file_1 = FileInfo.new(@backup, @path)
+      file_2 = FileInfo.new(@backup2, @path)
+      file_1.should_not == file_2
+    end
+  end
+
+  describe 'backup' do
+    before(:each) do
+      @backup.stub!(:key).and_return('12345')
+    end
+
+    it 'should store the file' do
+      @storage.should_receive(:store).with('12345/test/file_1', anything())
+
+      @info = FileInfo.new(@backup, @path)
+      @info.backup
+    end
+  end
+end

data/spec/backs3/restore_spec.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'backs3/restore'
+
+describe Backs3::Restore do
+  before(:each) do
+    @restore = Restore.new('storage' => 'test', 'folder' => 'test')
+
+    @backup_mock1 = mock(:backup_info, :date => 12345, :full => true)
+    @backup_mock2 = mock(:backup_info, :date => 54321, :last_full_backup => @backup_mock1, :full => false)
+
+    @file_mock1 = mock(:file, :backup_info => @backup_mock1, :path => 'test/file_1')
+    @file_mock2 = mock(:file, :backup_info => @backup_mock1, :path => 'test/file_2')
+    @file_mock3 = mock(:file, :backup_info => @backup_mock1, :path => 'test/file_3')
+    @file_mock4 = mock(:file, :backup_info => @backup_mock2, :path => 'test/file_1')
+    
+    @files_mock1 = [
+      @file_mock1, @file_mock2, @file_mock3
+    ]
+
+    @files_mock2 = [
+      @file_mock4
+    ]
+
+    @files_mock3 = [
+      @file_mock4, @file_mock2, @file_mock3
+    ]
+
+    @backup_mock1.stub!(:files).and_return(@files_mock1)
+    @backup_mock2.stub!(:files).and_return(@files_mock2)
+
+    @backup_mock1.stub!(:all_files).and_return(@files_mock1)
+    @backup_mock2.stub!(:all_files).and_return(@files_mock3)
+
+    @backup_array = [@backup_mock1, @backup_mock2]
+    @restore.stub!(:load_backup_info).and_return(@backup_array)
+    @restore.instance_variable_set('@backups', @backup_array)
+  end
+
+  describe 'self.commands' do
+    it 'should return an array' do
+      Restore.commands.should be_a(Array)
+    end
+  end
+
+  describe 'available' do
+    it 'should list all of the backups available' do
+      @restore.should_receive(:puts).with('Backups available: 12345, 54321')
+      @restore.available
+    end
+
+    it 'should list all of the available files in a full backup' do
+      @restore.should_receive(:puts).once.with('Backup information for 12345')
+      @restore.should_receive(:puts).once.with("\tFile: test/file_1, backed up #{Time.at(12345).to_s}")
+      @restore.should_receive(:puts).once.with("\tFile: test/file_2, backed up #{Time.at(12345).to_s}")
+      @restore.should_receive(:puts).once.with("\tFile: test/file_3, backed up #{Time.at(12345).to_s}")
+      @restore.available(12345)
+    end
+
+    it 'should list all the files from the last full backup for a partial backup' do
+      @restore.should_receive(:puts).once.with('Backup information for 54321')
+      @restore.should_receive(:puts).once.with("\tFile: test/file_1, backed up #{Time.at(54321).to_s}")
+      @restore.should_receive(:puts).once.with("\tFile: test/file_2, backed up #{Time.at(12345).to_s}")
+      @restore.should_receive(:puts).once.with("\tFile: test/file_3, backed up #{Time.at(12345).to_s}")
+
+      @restore.available(54321)
+    end
+  end
+
+  describe 'ls' do
+    it 'should list all of the files in a directory'
+  end
+
+  describe 'cat' do
+    it 'should show an error if the file specified does not exist'
+    it 'should output the contents of a file'
+  end
+
+  describe 'restore' do
+    it 'should restore a whole backup if no file is specified'
+    it 'should restore a file'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'backs3'
+
+include Spec::Matchers
+
+module Kernel
+  def logger
+    @@__log_file__ ||= StringIO.new
+    @@__log__ = ActiveSupport::BufferedLogger.new @@__log_file__
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: backs3
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- Jeremy Wells
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-16 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: S3 backup and restore program
+email: 
+- jeremy@boost.co.nz
+executables: 
+- backs3
+- res3
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- example.conf
+- bin/backs3
+- bin/res3
+- lib/backs3.rb
+- lib/backs3/backs3.rb
+- lib/backs3/backup.rb
+- lib/backs3/restore.rb
+- lib/backs3/version.rb
+- lib/backs3/file_info.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/backs3/backup_spec.rb
+- spec/backs3/restore_spec.rb
+- spec/backs3/file_info_spec.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/jemmyw/backs3
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: backs3
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: A simple backup and restore program for S3
+test_files: []
+