jemmyw-backs3 0.0.3 → 0.0.4

data/Manifest.txt

@@ -10,8 +10,11 @@ lib/backs3/backs3.rb
 lib/backs3/backup.rb
 lib/backs3/restore.rb
 lib/backs3/version.rb
+lib/backs3/backup_info.rb
 spec/spec.opts
 spec/spec_helper.rb
 spec/backs3/backup_spec.rb
 spec/backs3/restore_spec.rb
+spec/backs3/backup_info_spec.rb
+spec/backs3/backup_file_info_spec.rb
 tasks/rspec.rake

data/README.txt

@@ -29,7 +29,7 @@ A simple backup and restore program for S3
 
 (The MIT License)
 
-Copyright (c) 2009 Jeremy Wells / Boost Limited
+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

data/bin/res3

@@ -81,4 +81,10 @@ rescue Exception => e
 end
 
 res3 = Backs3::Restore.new($options)
-res3.send($command, *args)
+
+begin
+  res3.send($command, *args)
+rescue Exception => e
+  puts e
+  puts e.backtrace.join("\n")
+end

data/lib/backs3/backs3.rb

@@ -5,11 +5,17 @@ require 'aws/s3'
 require 'active_support'
 require 'digest/md5'
 require 'time'
+require File.join(File.dirname(__FILE__), 'backup_info')
 
 $has_md5 = !(`which md5`).blank?
 
 module Backs3
   include AWS::S3
+  
+  def logger
+    logger_output = @options['logger'] || $stdout
+    @logger ||= Logger.new(logger_output)
+  end
 
   def establish_connection
     AWS::S3::Base.establish_connection!(
@@ -20,20 +26,39 @@ module Backs3
 
   def md5(filename)
     if $has_md5
-      `md5 #{filename}`
+      `md5 -q #{filename}`
     else
       Digest::MD5.hexdigest(filename)
     end
   end
+  
+  def save_backup_info(info)
+    S3Object.store(@options['prefix'] + 's3backup', YAML.dump(info), @options['bucket'])
+    logger.info "Backup info has been stored"
+  end
 
-  def backup_info
-    @backup_info ||= begin
+  def load_backup_info
+    @backups ||= begin
       backup_info_file = S3Object.find(@options['prefix'] + 's3backup', @options['bucket'])
       backup_info_data = backup_info_file.value(:reload)
-      YAML.load(backup_info_data) || {}
+      YAML.load(backup_info_data) || {}      
     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

@@ -3,84 +3,19 @@ require File.dirname(__FILE__) + '/backs3'
 module Backs3
   class Backup
     include Backs3
-    include AWS::S3
 
     def initialize(options = {})
       @options = options
       @options['prefix'] ||= ''
-    end
-
-    def first_backup?
-      last_backup.nil?
-    end
-
-    def full_backup
-      @options['force-full'] || first_backup? || Time.now.to_i - last_backup > (@options['full'] || 7).days
-    end
 
-    def last_backup
-      backup_info['last_backup'].to_i
-    end
-
-    def backup_key
-      @options['prefix'] + @current_backup
-    end
-
-    def last_key
-      @options['prefix'] + last_backup.to_s
-    end
-
-    def files_to_backup
-      @files_to_backup ||= 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_backup || File.mtime(file).to_i > last_backup
-                true
-              else
-                false
-              end
-            else
-              false
-            end
-          end
-        end
-      end
+      establish_connection
+      
+      @backups = load_backup_info      
+      @backup = BackupInfo.new(@backups, @options)
     end
 
     def backup
-      @current_backup = Time.now.to_i.to_s
-      @files_to_backup = nil
-      @backup_info = nil
-
-      establish_connection
-
-      puts "Backup started at #{Time.now}"
-      puts "Last backup happened at #{backup_info['last_backup']}"
-      puts "Performing %s" % (full_backup ? "full backup" : "incremental backup")
-
-      files_to_backup.each do |filename|
-        puts "Backing up #{filename}"
-        file_md5 = md5(filename)
-        aws_filename = File.join(backup_key, filename)
-
-        object = S3Object.find(aws_filename, @options['bucket']) rescue nil
-
-        if object.nil? || object.metadata[:md5sum] != file_md5
-          S3Object.store(aws_filename, open(filename), @options['bucket'])
-          object = S3Object.find(aws_filename, @options['bucket'])
-          object.metadata[:md5sum] = file_md5
-          object.save
-        end
-      end
-
-      backup_info['last_backup'] = @current_backup
-      backup_info['backups'] ||= []
-      backup_info['backups'] << @current_backup
-      S3Object.store(@options['prefix'] + 's3backup', YAML.dump(backup_info), @options['bucket'])
-      puts "Backup completed, #{files_to_backup.size} files backed up"
+      @backup.backup
     end
   end
 end

data/lib/backs3/restore.rb

@@ -7,39 +7,44 @@ module Backs3
     include AWS::S3
 
     def self.commands
-      %w(ls available restore cat)
+      %w(ls available restore cat info)
     end
 
     def initialize(options = {})
       @options = options
       @options['prefix'] ||= ''
       establish_connection
+      @backups = load_backup_info.sort{|a,b| a.date <=> b.date }
     end
 
-    def available(file = nil)
-      if file.nil?
-        puts "Backups available: #{backup_info['backups'].join(", ")}"
+    def available(backup_key = nil)
+      if backup_key.nil?
+        puts "Backups available: #{@backups.map{|b| b.date}.join(", ")}"
       else
-        info = backup_info['backups'].collect do |backup|
-          backup_key = @options['prefix'] + backup.to_s
-          object = S3Object.find(File.join(backup_key, file), @options['bucket']) rescue nil
-
-          if object
-            {
-              :backup => backup,
-              :md5 => object.metadata[:md5sum]
-            }
-          else
-            nil
-          end
+        unless backup = @backups.detect{|b| b.date.to_s == backup_key.to_s }
+          raise "No backup #{backup_key} available"
+        end
 
-        end.compact
+        files = backup.all_files
 
-        puts "Backup information for #{file}:"
-        info.each do |i|
-          puts "\tBackup #{i[:backup]}: #{i[:md5]}"
+        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
 
@@ -60,30 +65,10 @@ module Backs3
       end
     end
 
-    def restore(backup, file = nil)
-      backup_key = @options['prefix'] + backup.to_s
-      objects = []
-
-      if file.nil?
-        objects = Bucket.objects(@options['bucket'], :prefix => @options['prefix'] + backup.to_s)
-      else
-        objects << S3Object.find(File.join(backup_key, file), @options['bucket']) rescue nil
-      end
-
-      objects.compact!
-
-      objects.each do |object|
-        $stdout.write "Restoring file #{object.key} to /tmp/#{object.key}"
-        filename = "/tmp/#{object.key}"
-        FileUtils.mkdir_p File.dirname(filename)
-        File.open(filename, 'w') do |f|
-          object.value do |segment|
-            $stdout.write "."
-            f.write segment
-          end
-        end
-        $stdout.write "\n"
-      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

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

data/spec/backs3/backup_spec.rb

@@ -8,66 +8,4 @@ describe Backup do
     @bucket = 'test_bucket'
     @backup = Backup.new({'bucket' => @bucket})
   end
-
-  describe 'backup' do
-    it 'should backup all the files returned by files_to_backup'
-  end
-
-  describe 'first_backup?' do
-    it 'should be true if there is no previous backup' do
-      @backup.should_receive(:last_backup).and_return(nil)
-      @backup.first_backup?.should be_true
-    end
-
-    it 'should be false if there is a previous backup' do
-      @backup.should_receive(:last_backup).and_return(12345)
-      @backup.first_backup?.should be_false
-    end
-  end
-
-  describe 'full_backup' do
-    it 'should be true if force-full option is set' do
-      @backup = Backup.new('force-full' => true)
-      @backup.should_not_receive(:last_backup)
-      @backup.should_not_receive(:first_backup?)
-      @backup.full_backup.should be_true
-    end
-    it 'should be true if this is the first backup' do
-      @backup.should_receive(:first_backup?).and_return(true)
-      @backup.full_backup.should be_true
-    end
-    it 'should be true if the last backup was more than 7 days ago' do
-      @backup.should_receive(:first_backup?).and_return(false)
-      @backup.should_receive(:last_backup).and_return((Time.now - 8.days).to_i)
-      @backup.full_backup.should be_true
-    end
-    it 'should be false' do
-      @backup.should_receive(:first_backup?).and_return(false)
-      @backup.should_receive(:last_backup).and_return(Time.now.to_i)
-      @backup.full_backup.should be_false
-    end
-  end
-
-  describe 'last_backup' do
-    it 'should return the integer time of the last backup' do
-      time = Time.now
-      time.should_receive(:to_i).and_return(12345)
-      @backup.should_receive(:backup_info).and_return({'last_backup' => time})
-      @backup.last_backup.should == 12345
-    end
-  end
-
-  describe 'backup_key' do
-    it 'should return the prefix + the backup time'
-  end
-
-  describe 'last_key' do
-    it 'should return the prefix + the last backup time'
-  end
-
-  describe 'files_to_backup' do
-    it 'should return all the files in the backup folder'
-    it 'should not return excluded files'
-    it 'should not return files that have not changed if this is an incremental backup'
-  end
 end

data/spec/backs3/restore_spec.rb

@@ -1,15 +1,43 @@
 require File.dirname(__FILE__) + "/../spec_helper"
 require 'backs3/restore'
 
-include Backs3
-
-describe Restore do
+describe Backs3::Restore do
   before(:each) do
     AWS::S3::Base.stub!(:establish_connection!)
     @bucket = 'test_bucket'
     @restore = Restore.new('bucket' => @bucket)
 
     @file_1 = mock(:s3object, :metadata => {})
+
+    @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
@@ -19,22 +47,27 @@ describe Restore do
   end
 
   describe 'available' do
-    it 'should list all of the backups available if no file is specified' do
-      @restore.should_receive(:backup_info).and_return({'backups' => [12345, 54321]})
+    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 backups a file is in' do
-      file = 'test/file_1'
-      @restore.should_receive(:backup_info).and_return({'backups' => [12345, 54321]})
-      S3Object.should_receive(:find).with('12345/test/file_1', @bucket).and_return(@file_1)
-      S3Object.should_receive(:find).with('54321/test/file_1', @bucket).and_return(nil)
 
-      @restore.should_receive(:puts).with('Backup information for test/file_1:')
-      @restore.should_receive(:puts).with("\tBackup 12345: ")
-      @restore.should_not_receive(:puts).with("\tBackup 54321: ")
+    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(file)
+      @restore.available(54321)
     end
   end
 

data/spec/spec.opts

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jemmyw-backs3
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-25 00:00:00 -07:00
+date: 2009-04-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,7 +97,7 @@ requirements: []
 rubyforge_project: backs3
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: S3 backup and restore program
 test_files: []