outback 0.0.2 → 0.0.3

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/outback/archive.rb

@@ -1,5 +1,30 @@
 module Outback
   class Archive
-  
+    NAME_PATTERN = /([A-Za-z0-9.\-]+)_(\d{14})_(\w+)/
+    
+    attr_reader :filename, :backup_name, :timestamp, :source_name, :parent
+    
+    def initialize(filename, parent)
+      @filename, @parent = Pathname.new(filename), parent
+      unless match_data = @filename.basename.to_s.match(NAME_PATTERN)
+        raise ArgumentError, 'invalid name'
+      end
+      @backup_name, @timestamp, @source_name = match_data.captures[0..2]
+    end
+    
+    def size
+      filename.size
+    end
+    
+    def open
+      filename.open
+    end
+    
+    def outdated?
+      if timestamp && parent && parent.ttl
+        Time.now - Time.parse(timestamp) > parent.ttl
+      end
+    end
+    
   end
 end

data/lib/outback/backup.rb

@@ -4,6 +4,7 @@ module Outback
     delegate :sources, :targets, :to => :configuration
     
     def initialize(configuration)
+      raise ArgumentError, "configuration required" unless configuration.is_a?(Outback::Configuration)
       @configuration = configuration
       @name = configuration.name
       @timestamp = Time.now.to_formatted_s(:number)
@@ -11,15 +12,14 @@ module Outback
     
     def run!
       @archives  = []
-      puts configuration.inspect
       begin
         @tmpdir = Dir.mktmpdir([name, timestamp])
         @archives = create_archives
-        upload_archives
+        store_archives
       ensure
         FileUtils.remove_entry_secure(tmpdir)
       end
-      purge_repository
+      purge_targets
     end
     
     private
@@ -31,14 +31,12 @@ module Outback
       archives.flatten.compact
     end
     
-    def purge_repository
-      
+    def store_archives
+      targets.each { |target| target.put(archives) }
     end
-    
-    def upload_archives
-      targets.each do |target|
-        target.put(archives, timestamp)
-      end
+
+    def purge_targets
+      targets.each { |target| target.purge! }
     end
     
   end

data/lib/outback/cli.rb

@@ -4,47 +4,60 @@ module Outback
   module CLI
     DEFAULT_CONFIGURATION_FILE = '/etc/outback/outback.conf'
     
-    def self.invoke
-      options = {}
-      option_parser = OptionParser.new do |p|
-        p.banner = "Usage: outback [configfile]"
-        # p.on -v --verbose be talky
-        p.on_tail("-h", "--help", "Show this message") do
-          puts p
-          exit
+    class << self
+      def invoke
+        options = {}
+        option_parser = OptionParser.new do |p|
+          p.banner = "Usage: outback [configfile]"
+          p.on('-v', '--verbose [VERBOSE]', 'be talky') do
+            Outback.verbose = true
+          end
+          p.on('-s', '--silent [SILENT]', 'be silent') do
+            Outback.silent = true
+          end
+          p.on_tail("-h", "--help", "Show this message") do
+            puts p
+            exit
+          end
+          p.on_tail("--version", "Show version") do
+            Outback.info "Outback #{Outback::VERSION}"
+            exit
+          end
         end
-        p.on_tail("--version", "Show version") do
-          puts "Outback #{Outback::VERSION}"
-          exit
+        option_parser.parse!
+        options[:configuration] = ARGV.first unless ARGV.first.blank?
+        Outback::Configuration.reset
+        config_file = options[:configuration] or begin
+          unless File.exists?(DEFAULT_CONFIGURATION_FILE)
+            Outback.error 'no configuration found'
+            exit(1)
+          end
+          DEFAULT_CONFIGURATION_FILE
         end
-      end
-      option_parser.parse!
-      options[:configuration] = ARGV.first unless ARGV.first.blank?
-      Outback::Configuration.reset
-      config_file = options[:configuration] or begin
-        unless File.exists?(DEFAULT_CONFIGURATION_FILE)
-          puts 'no configuration found'
+        begin
+          load config_file
+        rescue ConfigurationError => conf_error
+          Outback.error "Configuration Error! #{conf_error}"
+          exit(1)
+        rescue Exception => e
+          Outback.error "Error loading config file: #{e}"
           exit(1)
         end
-        DEFAULT_CONFIGURATION_FILE
-      end
-      begin
-        load config_file
-      rescue ConfigurationError => conf_error
-        puts "Configuration Error! #{conf_error}"
-        exit(1)
-      rescue Exception => e
-        puts 'Error loading config file'
-        puts e
-        exit(1)
-      end
-      if Outback::Configuration.loaded.empty?
-        puts 'no configuration could be loaded'
-        exit(1)
-      end
-      Outback::Configuration.loaded.each do |configuration|
-        Outback::Backup.new(configuration).run!
+        if Outback::Configuration.loaded.empty?
+          Outback.info 'no configuration could be loaded'
+          exit(1)
+        end
+        invalid_configs = Outback::Configuration.loaded.reject(&:valid?)
+        invalid_configs.each do |configuration|
+          Outback.error "configuration #{configuration.name}: #{configuration.errors}"
+        end
+        exit(1) unless invalid_configs.empty?
+        Outback::Configuration.loaded.each do |configuration|
+          Outback::Backup.new(configuration).run!
+        end
       end
+    
     end
+    
   end  
 end

data/lib/outback/configuration.rb

@@ -4,7 +4,7 @@ module Outback
 
     class << self
       def add(configuration)
-        raise "duplicate configuration #{configuration.name}" if loaded.any?(&its.name == configuration.name)
+        raise ConfigurationError.new("duplicate configuration #{configuration.name}") if loaded.any?(&its.name == configuration.name)
         loaded << configuration
       end
       
@@ -12,6 +12,10 @@ module Outback
         @loaded
       end
       
+      def [](name)
+        loaded.detect { |configuration| configuration.name == name.to_s }
+      end
+      
       def reset
         @loaded = []
       end
@@ -20,13 +24,13 @@ module Outback
     attr_reader :name, :sources, :targets, :errors
 
     def initialize(name, &block)
-      raise(ConfigurationError.new(:name)) if name.blank?
+      raise(ConfigurationError.new("configuration name can't be blank")) if name.blank?
       @name = name.to_s
+      raise(ConfigurationError.new('configuration name may not contain underscores')) if @name.include?('_')
       @sources, @targets, @errors = [], [], []
       if block_given?
         if block.arity == 1 then yield(self) else instance_eval(&block) end
       end
-      raise unless valid?
       self.class.add(self)
     end
 
@@ -42,12 +46,15 @@ module Outback
   
     def valid?
       errors.clear
-      return error(:targets) if targets.empty?
+      return error('no targets specified') if targets.empty?
+      moving_targets = targets.select { |t| t.is_a?(DirectoryTarget) && t.move }
+      return error('cannot define more than one moving target') if moving_targets.size > 1
+      return error('moving target must be defined last') if moving_targets.first && moving_targets.first != targets.last
       true
     end
     
-    def error(attribute, description = nil)
-      errors << ConfigurationError.new(attribute, description)
+    def error(message)
+      errors << ConfigurationError.new(message)
       false
     end
   end

data/lib/outback/configuration_error.rb

@@ -1,10 +1,4 @@
 module Outback
   class ConfigurationError < Exception
-    attr_reader :attribute, :description
-    
-    def initialize(attribute, description)
-      self.attribute = attribute
-      self.description = description
-    end
   end
 end

data/lib/outback/directory_archive.rb

@@ -0,0 +1,8 @@
+module Outback
+  class DirectoryArchive < Archive
+    def purge!
+      Outback.debug "purging DirectoryArchive: #{filename}"
+      filename.unlink
+    end
+  end
+end

data/lib/outback/directory_source.rb

@@ -14,8 +14,8 @@ module Outback
       @excludes ||= []
     end
     
-    def exclude(path)
-      excludes << path
+    def exclude(*paths)
+      excludes.concat(paths.map(&:to_s)).uniq!
     end
     
     def create_archives(backup_name, timestamp, tmpdir)
@@ -24,9 +24,10 @@ module Outback
       exclude_list = Pathname.new(tmpdir).join('exclude_list.txt')
       File.open(exclude_list, 'w') { |f| f << excludes.join("\n") }
       commandline = "tar --create --file #{archive_name} --preserve-permissions --gzip --verbose --exclude-from #{exclude_list} #{source_dir}"
-      puts "EXECUTING #{commandline}"
-      puts `#{commandline}`
-      [TempArchive.new(archive_name)]
+      Outback.debug "executing command: #{commandline}"
+      result = `#{commandline}`
+      Outback.debug result
+      [TempArchive.new(archive_name, self)]
     end
   end
 end

data/lib/outback/directory_target.rb

@@ -4,34 +4,38 @@ module Outback
     attr_setter :user, :group, :directory_permissions, :archive_permissions, :ttl, :move
     
     def initialize(path)
-      @path = path
+      @path = Pathname.new(path)
     end
     
     def valid?
       (user and group) or (not user and not group)
     end
     
-    def put(archives, timestamp)
-      backup_folder = Pathname.new(path).join(timestamp[0..7]) # yyyymmdd
-      Dir.mkdir(backup_folder) unless backup_folder.directory?
-      FileUtils.chmod directory_permissions || 0700, backup_folder
+    def put(archives)
+      Dir.mkdir(path) unless path.directory?
+      FileUtils.chmod directory_permissions || 0700, path
       archives.each do |archive|
         basename = Pathname.new(archive.filename).basename
         if move
-          puts "moving #{archive.filename} to #{backup_folder}"
-          FileUtils.mv archive.filename, backup_folder
+          Outback.debug "moving #{archive.filename} to #{path}"
+          FileUtils.mv archive.filename, path
         else
-          puts "copying #{archive.filename} to #{backup_folder}"
-          FileUtils.cp_r 
+          Outback.debug "copying #{archive.filename} to #{path}"
+          FileUtils.cp_r archive.filename, path
         end
-        archived_file = backup_folder.join(basename)
-        puts "chmodding"
+        archived_file = path.join(basename)
+        Outback.debug "setting permissions for #{archived_file}"
         FileUtils.chmod archive_permissions || 0600, archived_file
         if user && group
-          puts "chowning"
+          Outback.debug "setting owner #{user}, group #{group} for #{archived_file}"
           FileUtils.chown user, group, archived_file
         end 
       end
     end
+
+    def list_archives
+      path.files(Archive::NAME_PATTERN).map { |f| DirectoryArchive.new(f, self) }
+    end
+    
   end
 end

data/lib/outback/mysql_source.rb

@@ -10,12 +10,12 @@ module Outback
       @excludes ||= []
     end
     
-    def database(name)
-      databases << name
+    def database(*names)
+      databases.concat(names.map(&:to_s)).uniq!
     end
     
-    def exclude(name)
-      excludes << name.to_s
+    def exclude(*names)
+      excludes.concat(names.map(&:to_s)).uniq!
     end
     
     def valid?
@@ -37,12 +37,11 @@ module Outback
         mysql_conf_file = Pathname.new(tmpdir).join('outback_my.cnf')
         File.open(mysql_conf_file, 'w') { |f| f << "[client]\npassword=#{password}\n" }
         FileUtils.chmod 0600, mysql_conf_file
-        
-        # base_command="$mysqldump --defaults-extra-file=$mysql_conffile $opt -u$BM_MYSQL_ADMINLOGIN -h$BM_MYSQL_HOST -P$BM_MYSQL_PORT"
-        commandline = "mysqldump --defaults-extra-file=#{mysql_conf_file} --user=#{user} --host=#{mysql_host} --port=#{mysql_port} #{database} | gzip > #{archive_name}"
-        puts commandline
-        puts `#{commandline}`
-        TempArchive.new(archive_name)
+        Outback.debug "MysqlSource: dumping database '#{database}'"
+        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?
+        TempArchive.new(archive_name, self).tap { |archive| Outback.debug "dumped #{archive.filename.basename} with #{archive.size} bytes" }
       end
     end
   end

data/lib/outback/s3_archive.rb

@@ -1,6 +1,9 @@
 module Outback
-  class S3Archive < RemoteArchive
-    
-    
+  class S3Archive < Archive
+    def purge!
+      Outback.debug "purging S3Archive: #{filename}"
+      parent.connect
+      AWS::S3::S3Object.delete filename, parent.bucket
+    end
   end
 end

data/lib/outback/s3_target.rb

@@ -1,7 +1,32 @@
 module Outback
   class S3Target < Target
     attr_setter :bucket, :access_key, :secret_key, :ttl, :prefix
-        
+    
+    def valid?
+      bucket && 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)
+    end
+    
+    def put(archives)
+      connect
+      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
+        object_exists = AWS::S3::S3Object.exists?(object_name, bucket)
+        Outback.debug "Checking if object exists: #{object_exists}"
+      end
+    end
+    
+    def list_archives
+      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.map { |e| S3Archive.new(e.key, self) }
+    end
   end
   
 end

data/lib/outback/support/pathname_ext.rb

@@ -0,0 +1,17 @@
+module Outback
+  module PathnameExt
+    def files(regexp = nil)
+      returning Dir[join('**')].map { |f| Pathname.new(f) }.select(&:file?) do |entries|
+        entries.delete_if { |f| not f.basename.to_s.match(regexp) } if regexp
+      end
+    end
+    
+    def directories(regexp = nil)
+      returning Dir[join('**')].map { |f| Pathname.new(f) }.select(&:directory?) do |entries|
+        entries.delete_if { |f| not f.basename.to_s.match(regexp) } if regexp
+      end
+    end    
+  end
+end
+
+Pathname.send :include, Outback::PathnameExt

data/lib/outback/target.rb

@@ -1,6 +1,14 @@
 module Outback
   class Target
     include Configurable
+
+    def outdated_archives
+      list_archives.select(&:outdated?)
+    end
     
+    def purge!
+      outdated_archives.each &:purge!
+    end
+  
   end
 end

data/lib/outback/temp_archive.rb

@@ -1,9 +1,5 @@
 module Outback
   class TempArchive < Archive
-    attr_reader :filename
-    
-    def initialize(filename)
-      @filename = filename
-    end
+
   end
 end

data/lib/outback.rb

@@ -20,6 +20,7 @@ require 'outback/support/returning'
 require 'outback/support/attr_setter'
 require 'outback/support/configurable'
 require 'outback/support/mysql_ext'
+require 'outback/support/pathname_ext'
 require 'outback/configuration'
 require 'outback/configuration_error'
 require 'outback/source'
@@ -29,9 +30,36 @@ require 'outback/archive'
 require 'outback/temp_archive'
 require 'outback/target'
 require 'outback/directory_target'
+require 'outback/directory_archive'
 require 'outback/s3_target'
+require 'outback/s3_archive'
 require 'outback/backup'
 
 module Outback
   VERSION = Pathname.new(__FILE__).dirname.join('..', 'VERSION').read.strip
+  
+  class << self
+    %w(verbose silent).each do |method|
+      attr_accessor method
+      alias_method "#{method}?", method
+    end
+    
+    def info(message)
+      return if silent?
+      puts message
+      true
+    end
+    
+    def debug(message)
+      return unless verbose?
+      return if silent?
+      puts message
+      true
+    end
+    
+    def error(message, options = nil)
+      return if silent?
+      puts "Outback error: #{message}"
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: outback
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Matthias Grosser
@@ -58,28 +58,29 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/outback/target.rb
-- lib/outback/source.rb
-- lib/outback/mysql_source.rb
-- lib/outback/s3_target.rb
+- lib/outback/archive.rb
 - lib/outback/backup.rb
 - lib/outback/cli.rb
+- lib/outback/configuration.rb
+- lib/outback/configuration_error.rb
+- lib/outback/directory_archive.rb
+- lib/outback/directory_source.rb
 - lib/outback/directory_target.rb
+- lib/outback/local_archive.rb
+- lib/outback/mysql_source.rb
+- lib/outback/s3_archive.rb
+- lib/outback/s3_target.rb
+- lib/outback/source.rb
 - lib/outback/support/attr_setter.rb
-- lib/outback/support/returning.rb
-- lib/outback/support/mysql_ext.rb
 - lib/outback/support/configurable.rb
-- lib/outback/configuration_error.rb
+- lib/outback/support/mysql_ext.rb
+- lib/outback/support/pathname_ext.rb
+- lib/outback/support/returning.rb
+- lib/outback/target.rb
 - lib/outback/temp_archive.rb
-- lib/outback/s3_archive.rb
-- lib/outback/local_archive.rb
-- lib/outback/archive.rb
-- lib/outback/configuration.rb
-- lib/outback/directory_source.rb
 - lib/outback/vendor/metaclass.rb
-- lib/outback/vendor/mysql.rb
 - lib/outback/vendor/methodphitamine.rb
-- lib/outback/remote_archive.rb
+- lib/outback/vendor/mysql.rb
 - lib/outback.rb
 - bin/outback
 - MIT-LICENSE
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Ruby Backup Tool

data/lib/outback/remote_archive.rb

@@ -1,6 +0,0 @@
-module Outback
-  class RemoteArchive < Archive
-    
-    
-  end
-end