backupgem 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,5 +1,9 @@
 = Backup Changelog
 
+== Version 0.0.5
+* Added Amazon s3 support. Thanks to Jason Perry for this patch.
+* Added an option for ssh port. Thanks to Frank Oxener for this patch.
+
 == Version 0.0.4
 
 * Fixed a bug in 'scp' in the standard recipe that ignored the user when using

data/TODO

@@ -0,0 +1,7 @@
+== 2007-01-26
+* Write some better tests
+* Create a "rake test" task
+* Create rake tasks for generating documentation
+* Move documentation maker to this project
+* Add documentation for s3
+* Add documentation for ssh port

data/examples/s3.rb

@@ -0,0 +1,35 @@
+#------------------------------------------------------------------------------
+# Example S3 Backup script
+# @author: Jason L. Perry <jasper@ambethia.com>
+#------------------------------------------------------------------------------
+
+# Set the name of the s3 bucket you want to store your backups in.
+# Your Access ID is prepended to this to avoid naming conflicts.
+set :backup_path, "database_backup" 
+
+# You can specify your keys here, or set them as environment variables:
+# AMAZON_ACCESS_KEY_ID
+# AMAZON_SECRET_ACCESS_KEY
+set :aws_access, '123'
+set :aws_secret, 'ABC'
+
+# S3 does not support renaming objects, so rotation data is stored in an
+# index. You can specify a different key for index here, if you need to.
+#
+# set :rotation_object_key, 'backup_rotation_index.yml'
+
+action(:content) do
+  dump = c[:tmp_dir] + "/databases.sql" 
+  sh "mysqldump -uroot --all-databases > #{dump}" 
+  dump
+end
+
+action :deliver,  :method => :s3
+action :rotate,   :method => :via_s3
+
+set :son_promoted_on,    :fri
+set :father_promoted_on, :last_fri_of_the_month
+
+set :sons_to_keep,         7  
+set :fathers_to_keep,      5
+set :grandfathers_to_keep, 12

data/lib/backup/actor.rb

@@ -113,6 +113,7 @@ module Backup
     def via_mv;  rotator.rotate_via_mv(last_result);   end
     def via_ssh; rotator.rotate_via_ssh(last_result);  end
     def via_ftp; rotator.rotate_via_ftp(last_result);  end
+    def via_s3;  rotator.rotate_via_s3(last_result);   end
 
     # By default, +:content+ can perform one of three actions
     # * +:is_file+

data/lib/backup/recipes/standard.rb

@@ -79,6 +79,11 @@ action(:mv) do
   c[:backup_path] + "/" + File.basename(last_result)
 end
 
+action(:s3) do
+  s3 = S3Actor.new(c)
+  s3.put last_result
+end
+
 action(:encrypt) do
   result = last_result
   if c[:encrypt]

data/lib/backup/rotator.rb

@@ -59,6 +59,15 @@ module Backup
 #      ftp.close
     end
 
+    def rotate_via_s3(last_result)
+      s3 = Backup::S3Actor.new(c)
+      s3.verify_rotation_hierarchy_exists(hierarchy)
+      index = s3.rotation
+      index[todays_generation] << last_result
+      s3.rotation = index
+      s3.cleanup(todays_generation, how_many_to_keep_today)
+    end
+
     def create_sons_today?;     is_today_a? :son_created_on;     end
     def promote_sons_today?;    is_today_a? :son_promoted_on;    end
     def promote_fathers_today?; is_today_a? :father_promoted_on; end
@@ -110,18 +119,21 @@ module Backup
                   promote_sons_today?    ? "fathers"      : "sons"
       end
 
+      def self.timestamped_prefix(name)
+        newname = Time.now.strftime("%Y-%m-%d-%H-%M-%S_") + File.basename(name)
+      end
+      
+      # Given +name+ returns a timestamped version of name. 
+      def timestamped_prefix(name)
+        Backup::Rotator.timestamped_prefix(name)
+      end
+
       private
       def place_in
         goes_in = todays_generation
         place_in = c[:backup_path] + "/" + goes_in
       end
  
-
-      # Given +name+ returns a timestamped version of name. 
-      def timestamped_prefix(name)
-        newname = Time.now.strftime("%Y-%m-%d-%H-%M-%S_") + File.basename(name)
-      end
-
       # Returns the number of sons to keep. Looks for config values +:sons_to_keep+, 
       # +:son_promoted_on+. Default +14+.
       def sons_to_keep

data/lib/backup/s3_helpers.rb

@@ -0,0 +1,95 @@
+require 'YAML'
+
+module Backup
+  class S3Actor
+    include AWS::S3
+    
+    attr_accessor :rotation
+    
+    attr_reader :config
+    alias_method :c, :config
+
+    def initialize(config)
+      @config       = config
+      @rotation_key = c[:rotation_object_key] ||= 'backup_rotation_index.yml'
+      @access_key   = c[:aws_access] ||= ENV['AMAZON_ACCESS_KEY_ID']
+      @secret_key   = c[:aws_secret] ||= ENV['AMAZON_SECRET_ACCESS_KEY']
+      @bucket_key   = "#{@access_key}.#{c[:backup_path]}"
+      Base.establish_connection!(
+        :access_key_id     => @access_key,
+        :secret_access_key => @secret_key
+      )
+      begin
+        # Look for our bucket, if it's not there, try to create it.
+        @bucket = Bucket.find @bucket_key
+      rescue NoSuchBucket
+        @bucket = Bucket.create @bucket_key
+        @bucket = Bucket.find @bucket_key
+      end   
+    end
+
+    def rotation
+      object = S3Object.find(@rotation_key, @bucket.name)
+      index  = YAML::load(object.value)
+    end
+
+    def rotation=(index)
+      object = S3Object.store(@rotation_key, index.to_yaml, @bucket.name)
+      index
+    end
+
+    # Send a file to s3
+    def put(last_result)
+      puts last_result
+      object_key = Rotator.timestamped_prefix(last_result)
+      S3Object.store object_key,
+                     open(last_result),
+                     @bucket.name
+      object_key
+    end
+
+    # Remove a file from s3
+    def delete(object_key)
+      S3Object.delete object_key, @bucket.name
+    end
+
+    # Make sure our rotation index exists and contains the hierarchy we're using.
+    # Create it if it does not exist
+    def verify_rotation_hierarchy_exists(hierarchy)
+      begin
+        index = rotation
+        verified_index = index.merge(init_rotation_index(hierarchy)) { |m,x,y| x ||= y }
+        unless (verified_index == index)
+          self.rotation = verified_index
+        end
+      rescue NoSuchKey
+        self.rotation = init_rotation_index(hierarchy)
+      end
+    end
+
+    # Expire old objects
+    def cleanup(generation, keep)
+      puts "Cleaning up"
+      
+      keys = self.rotation[generation]
+      diff = keys.size - keep
+      
+      1.upto( diff ) do
+        extra_key = keys.shift
+        delete extra_key
+      end
+    end
+
+    private
+    
+      # Create a new index representing our backup hierarchy
+      def init_rotation_index(hierarchy)
+        hash = {}
+        hierarchy.each do |m|
+          hash[m] = Array.new
+        end
+        hash
+      end
+    
+  end
+end

data/lib/backup/ssh_helpers.rb

@@ -96,8 +96,9 @@ module Backup
     def connect
       c[:servers].each do |server| # todo, make this actually work
       @session = Net::SSH.start(
-           server, 
-           c[:ssh_user],
+           server,
+           :port         => c[:port],
+           :username     => c[:ssh_user],
            :host_key     => "ssh-rsa",
            :keys         => [ c[:identity_key] ],
            :auth_methods => %w{ publickey } )

data/lib/backup.rb

@@ -5,3 +5,12 @@ require 'backup/configuration'
 require 'backup/extensions'
 require 'backup/ssh_helpers'
 require 'backup/date_parser'
+
+begin
+  require 'aws/s3'
+  require 'backup/s3_helpers'
+rescue LoadError
+  # If AWS::S3 is not installed, no worries, we just
+  # wont have access to s3 methods. It's worth noting
+  # at least version 1.8.4 of ruby is required for s3.
+end

data/tests/s3_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + "/tests_helper"
+
+class S3Test < Test::Unit::TestCase
+
+  # These tests require actual S3 access keys set as environment variables
+
+  def setup
+    @config = Backup::Configuration.new
+    @config.load "standard"
+    @config.set :backup_path, 'test_backup'
+    @config.action :deliver, :method => :s3 
+    @actor = Backup::S3Actor.new(@config) 
+  end
+
+  def test_exists
+    assert @config
+    assert @actor
+  end
+
+  def test_on_s3
+    dir = create_tmp_files
+    config = <<-END
+      action :content, :is_folder => "#{dir}"
+      action :rotate,  :method  => :via_s3
+    END
+    @config.load :string => config
+    assert result = @config.actor.content
+    assert File.exists?(result)
+    @config.actor.start_process!
+  end
+  
+  private
+  
+    def create_tmp_files
+      newtmp = @config[:tmp_dir] + "/test_#{rand}_" + Time.now.strftime("%Y%m%d%H%M%S")
+      sh "mkdir #{newtmp}"
+      0.upto(5) { |i| sh "touch #{newtmp}/#{i}" }
+      newtmp
+    end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: backupgem
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2006-10-16 00:00:00 -07:00
+  version: 0.0.5
+date: 2007-01-26 00:00:00 -08:00
 summary: Beginning-to-end solution for backups and rotation.
 require_paths: 
 - lib
@@ -40,29 +40,35 @@ files:
 - lib/backup/extensions.rb
 - lib/backup/recipes
 - lib/backup/rotator.rb
+- lib/backup/s3_helpers.rb
 - lib/backup/ssh_helpers.rb
 - lib/backup/recipes/standard.rb
 - tests/actor_test.rb
 - tests/cleanup.sh
 - tests/rotation_test.rb
+- tests/s3_test.rb
 - tests/ssh_test.rb
 - tests/tests_helper.rb
 - examples/global.rb
 - examples/mediawiki.rb
+- examples/s3.rb
 - doc/index.html
 - doc/LICENSE-GPL
 - doc/styles.css
 - README
 - CHANGELOG
+- TODO
 test_files: 
 - tests/actor_test.rb
 - tests/rotation_test.rb
+- tests/s3_test.rb
 - tests/ssh_test.rb
 rdoc_options: []
 
 extra_rdoc_files: 
 - README
 - CHANGELOG
+- TODO
 executables: []
 
 extensions: []