outback 0.0.7 → 0.0.8

data/CHANGELOG

@@ -1,4 +1,9 @@
-*0.0.7 (March 12,2012)*
+*0.0.8 (March 21, 2012)*
+
+* Removed aws-s3 gem in favour of s3 gem
+* changed bucket to bucket_name in S3 target configuration
+
+*0.0.7 (March 12, 2012)*
 
 * Fixed active_support dependency
 * Improved output

data/README.md

@@ -0,0 +1,134 @@
+Welcome to Outback
+==================
+
+Outback is a Ruby backup tool, enabling you to create backups of
+your server files and databases and storing them in a local or
+remote repository. Using a simple DSL, you can specify multiple
+sources that generate backup data, as well as multiple targets,
+where backups are going to be stored.
+
+Outback configuration files are pure Ruby, so writing dynamic
+configurations or even customized backup sources and targets is a
+piece of cake.
+
+Installation
+------------
+    $ gem install outback
+
+Then you can invoke outback from the command line:
+
+    $ outback --help
+
+A simple configuration example
+------------------------------
+
+You can instantiate as many configurations as you like.
+Outback will enqueue and execute all configurations that were
+instantiated during a single run.
+
+```` ruby
+Outback::Configuration.new 'name' do
+  source :directory, '/ver/www' do
+    exclude '/var/www/foo'
+    exclude '/var/www/icons/*.png'
+  end
+
+  source :mysql do
+    user 'mysqlusername'
+    password 'mysqlpassword'
+    host 'localhost'
+    exclude 'mysql', 'information_schema'
+
+    #
+    # If you do not specify a specific database, all databases
+    # will be dumped and included in the backup
+    # database 'specific_database'  
+  end
+
+  # Amazon S3 storage
+  target :s3 do
+    access_key  'S3 access key'
+    secret_key  'S3 secret key'
+    bucket_name 'bucketname'
+    prefix      'backups/daily'
+
+    # Backups will be purged after the time specified here.
+    # Just omit the definition to keep archives forever.
+    ttl         1.month
+  end
+
+  # Store on a local filesystem path
+  target :directory, '/media/backups/daily' do
+    # If you specify the move option, archives will be moved from the temporary
+    # filesystem location in order to speed up things. Otherwise, archives will
+    # be copied. Note that a 'move'-to target must be specified last in the target
+    # chain.
+    move  true
+    ttl   1.day
+    user  'root'
+    group 'root'
+    directory_permissions 0700
+    archive_permissions   0600
+  end
+end
+````
+
+Default configurations and commandline options
+----------------------------------------------
+
+If you place your backup configurations in the file `/etc/outback.conf` they
+will be read automatically when the outback executable is invoked. Make
+sure to have correct permissions on the configuration files, as they might
+include database passwords.
+
+Alternatively, you can pass in the configuration file to read as a
+commandline argument. The default configuration file in /etc will then be
+ignored:
+
+    $ outback ./my_config.rb
+
+If you have several backup configurations in a single file, say, for daily
+and monthly backups, you can use the `-c` commandline option to select the
+backup to be invoked:
+
+    $ outback -c 'myservername-daily'
+
+This will run only the backup with the specified name, which enables you to
+write DRY configurations like this:
+
+```` ruby
+{ :daily => [14.days, 5.days], :monthly	=> [1.year, 1.year] }.each do |frequency, ttls|
+  s3_ttl, directory_ttl = ttls
+
+  Outback::Configuration.new "yourserver-#{frequency}" do
+    source :directory, '/home'
+    source :directory, '/var/svn'
+
+    target :s3 do
+      access_key  'foo'
+      secret_key  'foo'
+      bucket_name 'somebucket'
+      prefix      "yourserver/#{frequency}"
+      ttl         s3_ttl
+    end
+
+    target :directory, "/media/backups/#{frequency}" do
+      move  true
+      ttl   directory_ttl
+      user  'root'
+      group 'root'
+      directory_permissions 0700
+      archive_permissions   0600
+    end
+  end
+end
+````
+
+Other commandline options are:
+
+* `-v` `--verbose` be talky
+* `-s` `--silent`  be silent
+* `-t` `--test`    test configuration, then exit
+* `-l` `--list`    list available configurations, then exit
+* `-h` `--help`    display help
+* `--version`      display version

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/outback/backup.rb

@@ -15,6 +15,7 @@ module Outback
       begin
         @tmpdir = Dir.mktmpdir([name, timestamp])
         @archives = create_archives
+        Outback.info "Created #{@archives.size} archives"
         store_archives
       ensure
         FileUtils.remove_entry_secure(tmpdir)

data/lib/outback/directory_source.rb

@@ -27,7 +27,7 @@ module Outback
       Outback.debug "executing command: #{commandline}"
       result = `#{commandline}`
       Outback.debug "result: #{result}"
-      Outback.info "archived directory #{path}"
+      Outback.info "Archived directory #{path}"
       [TempArchive.new(archive_name, self)]
     end
   end

data/lib/outback/directory_target.rb

@@ -11,6 +11,10 @@ module Outback
       (user and group) or (not user and not group)
     end
     
+    def display_name
+      "directory:#{path}"
+    end
+    
     def put(archives)
       Dir.mkdir(path) unless path.directory?
       FileUtils.chmod directory_permissions || 0700, path
@@ -33,7 +37,8 @@ module Outback
         end
         size += archived_file.size
       end
-      Outback.info "#{move ? 'Moved' : 'Copied'} #{archives.size} archives (#{size} bytes) to directory #{path}"
+      Outback.info "#{move ? 'Moved' : 'Copied'} #{archives.size} archives (#{size} bytes) to #{display_name}"
+      archives.size
     end
 
     def list_archives(name)

data/lib/outback/mysql_source.rb

@@ -41,7 +41,7 @@ module Outback
         commandline = "mysqldump --defaults-extra-file=#{mysql_conf_file} --opt --user=#{user} --host=#{mysql_host} --port=#{mysql_port} #{database} | gzip > #{archive_name}"
         result = `#{commandline}`.strip
         Outback.debug(result) unless result.blank?
-        Outback.info "archived database #{database}"
+        Outback.info "Archived database #{database}"
         TempArchive.new(archive_name, self).tap { |archive| Outback.debug "dumped #{archive.filename.basename} with #{archive.size} bytes" }
       end
     end

data/lib/outback/s3_archive.rb

@@ -1,9 +1,18 @@
 module Outback
   class S3Archive < Archive
+    def size
+      object.size.to_i
+    end
+    
     def purge!
       Outback.debug "purging S3Archive: #{filename}"
-      parent.connect
-      AWS::S3::S3Object.delete filename, parent.bucket
+      object && object.destroy or Outback.error("could not find object #{filename} for purging")
+    end
+    
+    private
+    
+    def object
+      parent.bucket.objects.find(filename.to_s)
     end
   end
 end

data/lib/outback/s3_target.rb

@@ -1,37 +1,46 @@
 module Outback
   class S3Target < Target
-    attr_setter :bucket, :access_key, :secret_key, :ttl, :prefix
+    attr_setter :bucket_name, :access_key, :secret_key, :ttl, :prefix
+    
+    def display_name
+      "s3:#{bucket_name}/#{prefix}"
+    end
     
     def valid?
-      bucket && access_key && secret_key
+      bucket_name && access_key && secret_key
+    end
+    
+    def service(force_reconnect = false)
+      @service = nil if force_reconnect
+      @service ||= S3::Service.new(:access_key_id => access_key, :secret_access_key => secret_key)
     end
     
-    def connect(force = true)
-      @connection = nil if force
-      @connection ||= AWS::S3::Base.establish_connection!(:access_key_id => access_key, :secret_access_key => secret_key)
+    def bucket
+      service.buckets.find(bucket_name)
     end
     
     def put(archives)
-      connect
-      size, count = 0, 0
+      size = count = 0
       archives.each do |archive|
         object_name = [prefix.to_s, archive.filename.basename.to_s].join('/')
-        Outback.debug "S3Target: storing #{archive.filename} in s3://#{bucket}/#{object_name}"
-        AWS::S3::S3Object.store object_name, archive.open, bucket
-        if AWS::S3::S3Object.exists?(object_name, bucket)
+        Outback.debug "S3Target: storing #{archive.filename} in s3://#{bucket_name}/#{object_name}"
+        object = bucket.objects.build(object_name)
+        object.content = archive.open
+        object.acl = :private
+        object.save
+        if object.exists?
           size += archive.size
           count += 1
         else
           Outback.error "S3 archive upload failed: #{object_name}"
         end
       end
-      Outback.debug "Uploaded #{size} bytes to S3"
-      Outback.info "Uploaded #{count} archives (#{size} bytes) to bucket s3://#{bucket}"
+      Outback.info "Uploaded #{count} archives (#{size} bytes) to #{display_name}"
+      count
     end
     
     def list_archives(name)
-      connect
-      entries = AWS::S3::Bucket.objects(bucket).select { |e| e.key.start_with?(prefix.to_s) && e.key[prefix.to_s.size..-1].match(Archive::NAME_PATTERN) }
+      entries = bucket.objects.select { |e| e.key.start_with?(prefix.to_s) && e.key[prefix.to_s.size..-1].match(Archive::NAME_PATTERN) }
       entries.map { |e| S3Archive.new(e.key, self) }.select(&its.backup_name == name)
     end
   end

data/lib/outback/target.rb

@@ -7,7 +7,15 @@ module Outback
     end
     
     def purge!(name)
-      outdated_archives(name).each &:purge!
+      size = count = 0
+      outdated_archives(name).each do |archive|
+        archive_size = archive.size
+        if archive.purge!
+          count += 1
+          size += archive_size
+        end
+      end
+      Outback.info "Purged #{count} archives (#{size} bytes) from #{display_name}"
     end
   
   end

data/lib/outback.rb

@@ -5,7 +5,7 @@ require 'tmpdir'
 
 require 'active_support/core_ext'
 
-require 'aws/s3'
+require 's3'
 
 require 'outback/vendor/mysql'
 require 'outback/vendor/metaclass'
@@ -55,6 +55,7 @@ module Outback
     def error(message, options = nil)
       return if silent?
       puts "Outback error: #{message}"
+      false
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: outback
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Matthias Grosser
@@ -16,11 +16,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-12 00:00:00 +01:00
+date: 2012-03-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: aws-s3
+  name: s3
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -85,6 +85,7 @@ files:
 - bin/outback
 - MIT-LICENSE
 - VERSION
+- README.md
 - CHANGELOG
 has_rdoc: true
 homepage: http://rubygems.org/gems/outback