backup 3.0.16 → 3.0.18

data/backup.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |gem|
   gem.executables   = ['backup']
 
   ##
-  # Production gem dependencies
-  gem.add_dependency 'thor', ['~> 0.14.6']
+  # Gem dependencies
+  gem.add_dependency 'thor',   ['~> 0.14.6']
+  gem.add_dependency 'popen4', ['~> 0.1.2']
 
 end

data/bin/backup

@@ -1,4 +1,4 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
 
 ##
 # Load RubyGems for Ruby <= 1.8.7
@@ -7,12 +7,14 @@ require 'tempfile'
 require 'fileutils'
 
 ##
-# Load Thor for the Command Line Interface
+# Load Thor for the CLI and POpen4 for reading unix process status
 begin
   require 'thor'
+  require 'popen4'
 rescue LoadError
-  puts 'Backup uses Thor as CLI (Command Line Interface).'
-  puts 'Please install Thor first: `gem install thor`'
+  puts "\nBackup requires Thor to load the CLI (Command Line Interface) and POpen4 to determine the status of unix processes."
+  puts "Please install both Thor and POpen4 first:\n\ngem install thor -v '~> 0.14.6'\ngem install popen4 -v '~> 0.1.2'"
+  exit 1
 end
 
 ##
@@ -29,15 +31,16 @@ class BackupCLI < Thor
   ##
   # [Perform]
   # Performs the backup process. The only required option is the --trigger [-t].
-  # If the other options (--config_file, --data_path, --tmp_path) aren't specified
+  # If the other options (--config-file, --data-path, --cache--path, --tmp-path) aren't specified
   # it'll fallback to the (good) defaults
   method_option :trigger,     :type => :string,  :aliases => ['-t', '--triggers'], :required => true
   method_option :config_file, :type => :string,  :aliases => '-c'
   method_option :data_path,   :type => :string,  :aliases => '-d'
   method_option :log_path,    :type => :string,  :aliases => '-l'
+  method_option :cache_path,  :type => :string
   method_option :tmp_path,    :type => :string
   method_option :quiet,       :type => :boolean, :aliases => '-q'
-  desc 'perform', "Performs the backup for the specified trigger.\n" + 
+  desc 'perform', "Performs the backup for the specified trigger.\n" +
                   "You may perform multiple backups by providing multiple triggers, separated by commas.\n\n" +
                   "Example:\n\s\s$ backup perform --triggers backup1,backup2,backup3,backup4\n\n" +
                   "This will invoke 4 backups, and they will run in the order specified (not asynchronous)."
@@ -64,6 +67,13 @@ class BackupCLI < Thor
       Backup.send(:const_set, :LOG_PATH, options[:log_path])
     end
 
+    ##
+    # Overwrites the CACHE_PATH location, if --cache-path was specified
+    if options[:cache_path]
+      Backup.send(:remove_const, :CACHE_PATH)
+      Backup.send(:const_set, :CACHE_PATH, options[:cache_path])
+    end
+
     ##
     # Overwrites the TMP_PATH location, if --tmp-path was specified
     if options[:tmp_path]
@@ -71,21 +81,32 @@ class BackupCLI < Thor
       Backup.send(:const_set, :TMP_PATH, options[:tmp_path])
     end
 
-    ##
-    # Ensure the TMP_PATH and LOG_PATH are created if they do not yet exist
-    Array.new([Backup::TMP_PATH, Backup::LOG_PATH]).each do |path|
-      FileUtils.mkdir_p(path)
-    end
-
     ##
     # Silence Backup::Logger from printing to STDOUT, if --quiet was specified
     if options[:quiet]
       Backup::Logger.send(:const_set, :QUIET, options[:quiet])
     end
 
+    ##
+    # Ensure the CACHE_PATH, TMP_PATH and LOG_PATH are created if they do not yet exist
+    Array.new([Backup::CACHE_PATH, Backup::TMP_PATH, Backup::LOG_PATH]).each do |path|
+      FileUtils.mkdir_p(path)
+    end
+
+    ##
+    # Prepare all trigger names by splitting them by ','
+    # and finding trigger names matching wildcard
+    triggers = options[:trigger].split(",")
+    triggers.map!(&:strip).map!{ |t|
+      t.include?(Backup::Finder::WILDCARD) ?
+        Backup::Finder.new(t).matching : t
+    }.flatten!
+
+    #triggers.unique! # Uncomment if its undesirable to call triggers twice
+
     ##
     # Process each trigger
-    options[:trigger].split(",").map(&:strip).each do |trigger|
+    triggers.each do |trigger|
 
       ##
       # Defines the TRIGGER constant
@@ -101,7 +122,7 @@ class BackupCLI < Thor
 
       ##
       # Parses the backup configuration file and returns the model instance by trigger
-      model = Backup::Finder.new(trigger, Backup::CONFIG_FILE).find
+      model = Backup::Finder.new(trigger).find
 
       ##
       # Runs the returned model
@@ -177,7 +198,7 @@ class BackupCLI < Thor
         file.write( File.read(temp_file.path) )
         puts "Generated configuration file in '#{ config }'"
       end
-    end    
+    end
     temp_file.unlink
   end
 

data/lib/backup.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'yaml'
+require 'etc'
 
 ##
 # The Backup Ruby Gem
@@ -17,8 +18,8 @@ module Backup
   # You can do:
   #  database MySQL do |mysql|
   DATABASES   = ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis']
-  STORAGES    = ['S3', 'CloudFiles', 'Dropbox', 'FTP', 'SFTP', 'SCP', 'RSync']
-  COMPRESSORS = ['Gzip', 'Bzip2']
+  STORAGES    = ['S3', 'CloudFiles', 'Ninefold', 'Dropbox', 'FTP', 'SFTP', 'SCP', 'RSync', 'Local']
+  COMPRESSORS = ['Gzip', 'Bzip2', 'Lzma']
   ENCRYPTORS  = ['OpenSSL', 'GPG']
   SYNCERS     = ['RSync', 'S3']
   NOTIFIERS   = ['Mail', 'Twitter', 'Campfire', 'Presently']
@@ -37,11 +38,13 @@ module Backup
 
   ##
   # Backup's Environment paths
-  PATH               = File.join(ENV['HOME'], 'Backup')
-  DATA_PATH          = File.join(ENV['HOME'], 'Backup', 'data')
-  CONFIG_FILE        = File.join(ENV['HOME'], 'Backup', 'config.rb')
-  LOG_PATH           = File.join(ENV['HOME'], 'Backup', 'log')
-  TMP_PATH           = File.join(ENV['HOME'], 'Backup', '.tmp')
+  USER        = ENV['USER'] || Etc.getpwuid.name
+  PATH        = File.join(ENV['HOME'], 'Backup')
+  DATA_PATH   = File.join(ENV['HOME'], 'Backup', 'data')
+  CONFIG_FILE = File.join(ENV['HOME'], 'Backup', 'config.rb')
+  LOG_PATH    = File.join(ENV['HOME'], 'Backup', 'log')
+  CACHE_PATH  = File.join(ENV['HOME'], 'Backup', '.cache')
+  TMP_PATH    = File.join(ENV['HOME'], 'Backup', '.tmp')
 
   ##
   # Autoload Backup base files
@@ -60,10 +63,10 @@ module Backup
     autoload :Helpers,  File.join(CONFIGURATION_PATH, 'helpers')
 
     module Notifier
-      autoload :Base,    File.join(CONFIGURATION_PATH, 'notifier', 'base')
-      autoload :Mail,    File.join(CONFIGURATION_PATH, 'notifier', 'mail')
-      autoload :Twitter, File.join(CONFIGURATION_PATH, 'notifier', 'twitter')
-      autoload :Campfire, File.join(CONFIGURATION_PATH, 'notifier', 'campfire')
+      autoload :Base,      File.join(CONFIGURATION_PATH, 'notifier', 'base')
+      autoload :Mail,      File.join(CONFIGURATION_PATH, 'notifier', 'mail')
+      autoload :Twitter,   File.join(CONFIGURATION_PATH, 'notifier', 'twitter')
+      autoload :Campfire,  File.join(CONFIGURATION_PATH, 'notifier', 'campfire')
       autoload :Presently, File.join(CONFIGURATION_PATH, 'notifier', 'presently')
     end
 
@@ -74,20 +77,23 @@ module Backup
     end
 
     module Compressor
-      autoload :Base, File.join(CONFIGURATION_PATH, 'compressor', 'base')
-      autoload :Gzip, File.join(CONFIGURATION_PATH, 'compressor', 'gzip')
+      autoload :Base,  File.join(CONFIGURATION_PATH, 'compressor', 'base')
+      autoload :Gzip,  File.join(CONFIGURATION_PATH, 'compressor', 'gzip')
       autoload :Bzip2, File.join(CONFIGURATION_PATH, 'compressor', 'bzip2')
+      autoload :Lzma,  File.join(CONFIGURATION_PATH, 'compressor', 'lzma')
     end
 
     module Storage
       autoload :Base,       File.join(CONFIGURATION_PATH, 'storage', 'base')
       autoload :S3,         File.join(CONFIGURATION_PATH, 'storage', 's3')
       autoload :CloudFiles, File.join(CONFIGURATION_PATH, 'storage', 'cloudfiles')
+      autoload :Ninefold,   File.join(CONFIGURATION_PATH, 'storage', 'ninefold')
       autoload :Dropbox,    File.join(CONFIGURATION_PATH, 'storage', 'dropbox')
       autoload :FTP,        File.join(CONFIGURATION_PATH, 'storage', 'ftp')
       autoload :SFTP,       File.join(CONFIGURATION_PATH, 'storage', 'sftp')
       autoload :SCP,        File.join(CONFIGURATION_PATH, 'storage', 'scp')
       autoload :RSync,      File.join(CONFIGURATION_PATH, 'storage', 'rsync')
+      autoload :Local,      File.join(CONFIGURATION_PATH, 'storage', 'local')
     end
 
     module Syncer
@@ -111,11 +117,13 @@ module Backup
     autoload :Object,     File.join(STORAGE_PATH, 'object')
     autoload :S3,         File.join(STORAGE_PATH, 's3')
     autoload :CloudFiles, File.join(STORAGE_PATH, 'cloudfiles')
+    autoload :Ninefold,   File.join(STORAGE_PATH, 'ninefold')
     autoload :Dropbox,    File.join(STORAGE_PATH, 'dropbox')
     autoload :FTP,        File.join(STORAGE_PATH, 'ftp')
     autoload :SFTP,       File.join(STORAGE_PATH, 'sftp')
     autoload :SCP,        File.join(STORAGE_PATH, 'scp')
     autoload :RSync,      File.join(STORAGE_PATH, 'rsync')
+    autoload :Local,      File.join(STORAGE_PATH, 'local')
   end
 
   ##
@@ -139,9 +147,10 @@ module Backup
   ##
   # Autoload compressor files
   module Compressor
-    autoload :Base, File.join(COMPRESSOR_PATH, 'base')
-    autoload :Gzip, File.join(COMPRESSOR_PATH, 'gzip')
+    autoload :Base,  File.join(COMPRESSOR_PATH, 'base')
+    autoload :Gzip,  File.join(COMPRESSOR_PATH, 'gzip')
     autoload :Bzip2, File.join(COMPRESSOR_PATH, 'bzip2')
+    autoload :Lzma,  File.join(COMPRESSOR_PATH, 'lzma')
   end
 
   ##
@@ -155,11 +164,11 @@ module Backup
   ##
   # Autoload notification files
   module Notifier
-    autoload :Base,     File.join(NOTIFIER_PATH, 'base')
-    autoload :Binder,   File.join(NOTIFIER_PATH, 'binder')
-    autoload :Mail,     File.join(NOTIFIER_PATH, 'mail')
-    autoload :Twitter,  File.join(NOTIFIER_PATH, 'twitter')
-    autoload :Campfire, File.join(NOTIFIER_PATH, 'campfire')
+    autoload :Base,      File.join(NOTIFIER_PATH, 'base')
+    autoload :Binder,    File.join(NOTIFIER_PATH, 'binder')
+    autoload :Mail,      File.join(NOTIFIER_PATH, 'mail')
+    autoload :Twitter,   File.join(NOTIFIER_PATH, 'twitter')
+    autoload :Campfire,  File.join(NOTIFIER_PATH, 'campfire')
     autoload :Presently, File.join(NOTIFIER_PATH, 'presently')
   end
 
@@ -167,6 +176,7 @@ module Backup
   # Autoload exception classes
   module Exception
     autoload :CommandNotFound, File.join(EXCEPTION_PATH, 'command_not_found')
+    autoload :CommandFailed,   File.join(EXCEPTION_PATH, 'command_failed')
   end
 
   ##

data/lib/backup/cli.rb

@@ -23,9 +23,15 @@ module Backup
     def run(command)
       command.gsub!(/^\s+/, '')
       raise_if_command_not_found!(
-        command.slice(0, command.index(/\s/)).split('/')[-1]
+        command_name(command)
       )
-      %x[#{command}]
+
+      pid, stdin, stdout, stderr = Open4::popen4(command)
+      ignored, @status = Process::waitpid2(pid)
+      @stdout = stdout.read
+      @stderr = stderr.read
+
+      raise_if_command_failed!(command_name(command), @status)
     end
 
     ##
@@ -63,6 +69,10 @@ module Backup
       name
     end
 
+    def command_name(command)
+      command.slice(0, command.index(/\s/)).split('/')[-1]
+    end
+
     ##
     # If the command that was previously run via this Ruby process returned
     # error code "32512", the invoked utility (e.g. mysqldump, pgdump, etc) could not be found.
@@ -78,5 +88,23 @@ module Backup
       end
     end
 
+    ##
+    # If the command that was previously run via this Ruby process returned
+    # a non-zero error code, the invoked utility (e.g. mysqldump, pgdump, etc) failed to run.
+    # If this is the case then this method will throw an exception, informing the user of this problem.
+    #
+    # Since this raises an exception, it'll stop the entire backup process, clean up the temp files
+    # and notify the user via the built-in notifiers if these are set.
+    def raise_if_command_failed!(utility, status)
+      unless status.to_i.eql?(0)
+        raise Exception::CommandFailed , "Failed to run \"#{utility}\" on \"#{RUBY_PLATFORM}\".\n" +
+                                         "The status code returned was #{status}\n" +
+                                         "STDOUT was:\n" +
+                                         @stdout +
+                                         "STDERR was:\n" +
+                                         @stderr
+      end
+    end
+
   end
 end

data/lib/backup/compressor/lzma.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Lzma < Base
+
+      ##
+      # Tells Backup::Compressor::Lzma to compress
+      # better (-9) rather than faster when set to true
+      attr_writer :best
+
+      ##
+      # Tells Backup::Compressor::Lzma to compress
+      # faster (-1) rather than better when set to true
+      attr_writer :fast
+
+      ##
+      # Creates a new instance of Backup::Compressor::Lzma and
+      # configures it to either compress faster or better
+      # Lzma compresses by default with -9 (best compression)
+      # and lower block sizes don't make things significantly faster
+      # (according to official bzip2 docs)
+      def initialize(&block)
+        load_defaults!
+
+        @best ||= false
+        @fast ||= false
+
+        instance_eval(&block) if block_given?
+      end
+
+      ##
+      # Performs the compression of the packages backup file
+      def perform!
+        log!
+        run("#{ utility(:lzma) } #{ options } '#{ Backup::Model.file }'")
+        Backup::Model.extension += '.lzma'
+      end
+
+    private
+
+      ##
+      # Combines the provided options and returns a bzip2 options string
+      def options
+        (best + fast).join("\s")
+      end
+
+      ##
+      # Returns the lzma option syntax for compressing
+      # setting @best to true is redundant, as lzma compresses best by default
+      def best
+        return ['--best'] if @best; []
+      end
+
+      ##
+      # Returns the lzma option syntax for compressing
+      # (not significantly) faster when @fast is set to true
+      def fast
+        return ['--fast'] if @fast; []
+      end
+    end
+  end
+end

data/lib/backup/configuration/compressor/lzma.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Lzma < Base
+        class << self
+
+          ##
+          # Tells Backup::Compressor::Lzma to compress
+          # better (--best) which is lzma default anyway
+          attr_accessor :best
+
+          ##
+          # Tells Backup::Compressor::Lzma to compress
+          # faster (--fast) (but not significantly faster)
+          attr_accessor :fast
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/helpers.rb

@@ -8,13 +8,19 @@ module Backup
       # Finds all the object's getter methods and checks the global
       # configuration for these methods, if they respond then they will
       # assign the object's attribute(s) to that particular global configuration's attribute
-      def load_defaults!
-        c             = self.class.name.split('::')
-        configuration = Backup::Configuration.const_get(c[1]).const_get(c[2])
+      def load_defaults!(options = {})
+        c                  = self.class.name.split('::')
+        configuration      = Backup::Configuration.const_get(c[1]).const_get(c[2])
+        options[:except] ||= []
+        options[:only]   ||= []
 
         getter_methods.each do |attribute|
           if configuration.respond_to?(attribute)
-            unless configuration.send(attribute).nil?
+            if options[:only].any? and options[:only].include?(attribute)
+              self.send("#{attribute}=", configuration.send(attribute))
+            elsif options[:except].any? and !options[:except].include?(attribute)
+              self.send("#{attribute}=", configuration.send(attribute))
+            elsif options[:only].empty? and options[:except].empty?
               self.send("#{attribute}=", configuration.send(attribute))
             end
           end

data/lib/backup/configuration/notifier/mail.rb

@@ -45,6 +45,11 @@ module Backup
           # Example: true
           attr_accessor :enable_starttls_auto
 
+          ##
+          # OpenSSL Verify Mode
+          # Example: none - Only use this option for a self-signed and/or wildcard certificate
+          attr_accessor :openssl_verify_mode
+
         end
       end
     end

data/lib/backup/configuration/storage/dropbox.rb

@@ -6,10 +6,6 @@ module Backup
       class Dropbox < Base
         class << self
 
-          ##
-          # Dropbox user credentials
-          attr_accessor :email, :password
-
           ##
           # Dropbox API credentials
           attr_accessor :api_key, :api_secret
@@ -22,6 +18,25 @@ module Backup
           # Dropbox connection timeout
           attr_accessor :timeout
 
+
+          # DEPRECATED METHODS #############################################
+
+          def email
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email is deprecated and will be removed at some point."
+          end
+
+          def email=(value)
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email= is deprecated and will be removed at some point."
+          end
+
+          def password
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.password is deprecated and will be removed at some point."
+          end
+
+          def password=(value)
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.password= is deprecated and will be removed at some point."
+          end
+
         end
       end
     end