backup 3.11.0 → 4.0.0rc1

data/lib/backup/storage/dropbox.rb

@@ -4,12 +4,24 @@ require 'dropbox_sdk'
 module Backup
   module Storage
     class Dropbox < Base
+      include Storage::Cycler
       class Error < Backup::Error; end
 
       ##
       # Dropbox API credentials
       attr_accessor :api_key, :api_secret
 
+      ##
+      # Path to store cached authorized session.
+      #
+      # Relative paths will be expanded using Config.root_path,
+      # which by default is ~/Backup unless --root-path was used
+      # on the command line or set in config.rb.
+      #
+      # By default, +cache_path+ is '.cache', which would be
+      # '~/Backup/.cache/' if using the default root_path.
+      attr_accessor :cache_path
+
       ##
       # Dropbox Access Type
       # Valid values are:
@@ -39,6 +51,7 @@ module Backup
         super
 
         @path           ||= 'backups'
+        @cache_path     ||= '.cache'
         @access_type    ||= :app_folder
         @chunk_size     ||= 4 # MiB
         @max_retries    ||= 10
@@ -54,7 +67,7 @@ module Backup
       # authorization successfully took place. If this is the case, then the
       # user hits 'enter' and the session will be properly established.
       # Immediately after establishing the session, the session will be
-      # serialized and written to a cache file in Backup::Config.cache_path.
+      # serialized and written to a cache file in +cache_path+.
       # The cached file will be used from that point on to re-establish a
       # connection with Dropbox at a later time. This allows the user to avoid
       # having to go to a new Dropbox URL to authorize over and over again.
@@ -121,12 +134,11 @@ module Backup
         raise Error.wrap(err, 'Upload Failed!')
       end
 
-      # Timeout::Error is not a StandardError under ruby-1.8.7
       def with_retries
         retries = 0
         begin
           yield
-        rescue StandardError, Timeout::Error => err
+        rescue StandardError => err
           retries += 1
           raise if retries > max_retries
 
@@ -145,13 +157,15 @@ module Backup
       end
 
       def cached_file
-        File.join(Config.cache_path, api_key + api_secret)
+        path = cache_path.start_with?('/') ?
+               cache_path : File.join(Config.root_path, cache_path)
+        File.join(path, api_key + api_secret)
       end
 
       ##
       # Serializes and writes the Dropbox session to a cache file
       def write_cache!(session)
-        FileUtils.mkdir_p(Config.cache_path)
+        FileUtils.mkdir_p File.dirname(cached_file)
         File.open(cached_file, "w") do |cache_file|
           cache_file.write(session.serialize)
         end
@@ -193,13 +207,6 @@ module Backup
         raise Error.wrap(err, 'Could not create or authenticate a new session')
       end
 
-      attr_deprecate :email,    :version => '3.0.17'
-      attr_deprecate :password, :version => '3.0.17'
-      attr_deprecate :timeout,  :version => '3.0.21'
-
-      attr_deprecate :chunk_retries, :version => '3.7.0',
-                     :message => 'Use #max_retries instead.',
-                     :action => lambda {|klass, val| klass.max_retries = val }
     end
   end
 end

data/lib/backup/storage/ftp.rb

@@ -4,6 +4,7 @@ require 'net/ftp'
 module Backup
   module Storage
     class FTP < Base
+      include Storage::Cycler
 
       ##
       # Server credentials

data/lib/backup/storage/local.rb

@@ -3,6 +3,7 @@
 module Backup
   module Storage
     class Local < Base
+      include Storage::Cycler
       class Error < Backup::Error; end
 
       def initialize(model, storage_id = nil)

data/lib/backup/storage/ninefold.rb

@@ -4,6 +4,7 @@ require 'fog'
 module Backup
   module Storage
     class Ninefold < Base
+      include Storage::Cycler
       class Error < Backup::Error; end
 
       ##

data/lib/backup/storage/rsync.rb

@@ -3,7 +3,7 @@
 module Backup
   module Storage
     class RSync < Base
-      include Backup::Utilities::Helpers
+      include Utilities::Helpers
 
       ##
       # Mode of operation
@@ -120,16 +120,11 @@ module Backup
       # into. For `:ssh_daemon` or `:rsync_daemon` modes, this would reference
       # an rsync module/path.
       #
-      # In :ssh_daemon and :rsync_daemon modes, the files will be stored
-      # directly to the +path+ given. The path (or path defined by your rsync
-      # module) must already exist.
-      # Note that no additional `<trigger>` directory will be added to this path.
+      # In :ssh_daemon and :rsync_daemon modes, +path+ (or path defined by
+      # your rsync module) must already exist.
       #
-      # In :ssh mode or local operation (no +host+ specified), the actual
-      # destination path will be `<path>/<trigger>/`. This path will be created
-      # if needed - either locally, or on the remote for :ssh mode.
-      # This behavior will change in v4.0, when :ssh mode and local operations
-      # will also store the files directly in the +path+ given.
+      # In :ssh mode or local operation (no +host+ specified), +path+ will
+      # be created if needed - either locally, or on the remote for :ssh mode.
       attr_accessor :path
 
       def initialize(model, storage_id = nil)
@@ -157,27 +152,16 @@ module Backup
         remove_password_file
       end
 
-      # Storage::RSync doesn't cycle
-      def cycle!; end
-
       ##
       # Other storages add an additional timestamp directory to this path.
       # This is not desired here, since we need to transfer the package files
       # to the same location each time.
-      #
-      # Note: In v4.0, the additional trigger directory will to be dropped
-      # from remote_path for both local and :ssh mode, so the package files
-      # will be stored directly in #path.
       def remote_path
         @remote_path ||= begin
           if host
-            if mode == :ssh
-              File.join(path.sub(/^~\//, ''), package.trigger)
-            else
-              path.sub(/^~\//, '').sub(/\/$/, '')
-            end
+            path.sub(/^~\//, '').sub(/\/$/, '')
           else
-            File.join(File.expand_path(path), package.trigger)
+            File.expand_path(path)
           end
         end
       end
@@ -259,24 +243,6 @@ module Backup
         @password_file.delete if @password_file
       end
 
-      attr_deprecate :local, :version => '3.2.0',
-                     :message => "If 'host' is not set, the operation will be local."
-
-      attr_deprecate :username, :version => '3.2.0',
-                     :message => 'Use #ssh_user instead.',
-                     :action => lambda {|klass, val|
-                       klass.ssh_user = val
-                     }
-      attr_deprecate :password, :version => '3.2.0',
-                     :message => 'Use #rsync_password instead.',
-                     :action => lambda {|klass, val|
-                       klass.rsync_password = val
-                     }
-      attr_deprecate :ip, :version => '3.2.0',
-                     :message => 'Use #host instead.',
-                     :action => lambda {|klass, val|
-                       klass.host = val
-                     }
     end
   end
 end

data/lib/backup/storage/s3.rb

@@ -4,6 +4,7 @@ require 'backup/cloud_io/s3'
 module Backup
   module Storage
     class S3 < Base
+      include Storage::Cycler
       class Error < Backup::Error; end
 
       ##

data/lib/backup/storage/scp.rb

@@ -4,6 +4,7 @@ require 'net/scp'
 module Backup
   module Storage
     class SCP < Base
+      include Storage::Cycler
       class Error < Backup::Error; end
 
       ##

data/lib/backup/storage/sftp.rb

@@ -4,6 +4,7 @@ require 'net/sftp'
 module Backup
   module Storage
     class SFTP < Base
+      include Storage::Cycler
 
       ##
       # Server credentials

data/lib/backup/syncer/base.rb

@@ -3,8 +3,8 @@
 module Backup
   module Syncer
     class Base
-      include Backup::Utilities::Helpers
-      include Backup::Configuration::Helpers
+      include Utilities::Helpers
+      include Config::Helpers
 
       ##
       # Path to store the synced files/directories to

data/lib/backup/syncer/cloud/cloud_files.rb

@@ -77,22 +77,6 @@ module Backup
           EOS
         end
 
-        attr_deprecate :concurrency_type, :version => '3.7.0',
-                       :message => 'Use #thread_count instead.',
-                       :action => lambda {|klass, val|
-                         if val == :threads
-                           klass.thread_count = 2 unless klass.thread_count
-                         else
-                           klass.thread_count = 0
-                         end
-                       }
-
-        attr_deprecate :concurrency_level, :version => '3.7.0',
-                       :message => 'Use #thread_count instead.',
-                       :action => lambda {|klass, val|
-                         klass.thread_count = val unless klass.thread_count == 0
-                       }
-
       end # class Cloudfiles < Base
     end # module Cloud
   end

data/lib/backup/syncer/cloud/s3.rb

@@ -104,22 +104,6 @@ module Backup
           EOS
         end
 
-        attr_deprecate :concurrency_type, :version => '3.7.0',
-                       :message => 'Use #thread_count instead.',
-                       :action => lambda {|klass, val|
-                         if val == :threads
-                           klass.thread_count = 2 unless klass.thread_count
-                         else
-                           klass.thread_count = 0
-                         end
-                       }
-
-        attr_deprecate :concurrency_level, :version => '3.7.0',
-                       :message => 'Use #thread_count instead.',
-                       :action => lambda {|klass, val|
-                         klass.thread_count = val unless klass.thread_count == 0
-                       }
-
       end # Class S3 < Base
     end # module Cloud
   end

data/lib/backup/syncer/rsync/local.rb

@@ -25,11 +25,6 @@ module Backup
           FileUtils.mkdir_p dest_path
         end
 
-        attr_deprecate :additional_options, :version => '3.2.0',
-                       :message => 'Use #additional_rsync_options instead.',
-                       :action => lambda {|klass, val|
-                         klass.additional_rsync_options = val
-                       }
       end
     end
   end

data/lib/backup/syncer/rsync/pull.rb

@@ -45,27 +45,6 @@ module Backup
           FileUtils.mkdir_p dest_path
         end
 
-        attr_deprecate :additional_options, :version => '3.2.0',
-                       :message => 'Use #additional_rsync_options instead.',
-                       :action => lambda {|klass, val|
-                         klass.additional_rsync_options = val
-                       }
-
-        attr_deprecate :username, :version => '3.2.0',
-                       :message => 'Use #ssh_user instead.',
-                       :action => lambda {|klass, val|
-                         klass.ssh_user = val
-                       }
-        attr_deprecate :password, :version => '3.2.0',
-                       :message => 'Use #rsync_password instead.',
-                       :action => lambda {|klass, val|
-                         klass.rsync_password = val
-                       }
-        attr_deprecate :ip, :version => '3.2.0',
-                       :message => 'Use #host instead.',
-                       :action => lambda {|klass, val|
-                         klass.host = val
-                       }
       end
     end
   end

data/lib/backup/syncer/rsync/push.rb

@@ -199,27 +199,6 @@ module Backup
           @password_file.delete if @password_file
         end
 
-        attr_deprecate :additional_options, :version => '3.2.0',
-                       :message => 'Use #additional_rsync_options instead.',
-                       :action => lambda {|klass, val|
-                         klass.additional_rsync_options = val
-                       }
-
-        attr_deprecate :username, :version => '3.2.0',
-                       :message => 'Use #ssh_user instead.',
-                       :action => lambda {|klass, val|
-                         klass.ssh_user = val
-                       }
-        attr_deprecate :password, :version => '3.2.0',
-                       :message => 'Use #rsync_password instead.',
-                       :action => lambda {|klass, val|
-                         klass.rsync_password = val
-                       }
-        attr_deprecate :ip, :version => '3.2.0',
-                       :message => 'Use #host instead.',
-                       :action => lambda {|klass, val|
-                         klass.host = val
-                       }
       end
     end
   end

data/lib/backup/utilities.rb

@@ -7,9 +7,8 @@ module Backup
     UTILITY = {}
     NAMES = %w{
       tar cat split sudo chown hostname
-      gzip bzip2 lzma pbzip2
-      mongo mongodump mysqldump innobackupex
-      pg_dump pg_dumpall redis-cli riak-admin
+      gzip bzip2
+      mongo mongodump mysqldump pg_dump pg_dumpall redis-cli riak-admin
       gpg openssl
       rsync ssh
       sendmail exim
@@ -73,8 +72,6 @@ module Backup
       #     # Compressors
       #     gzip    '/path/to/gzip'
       #     bzip2   '/path/to/bzip2'
-      #     lzma    '/path/to/lzma'   # deprecated. use a Custom Compressor
-      #     pbzip2  '/path/to/pbzip2' # deprecated. use a Custom Compressor
       #
       #     # Database Utilities
       #     mongo       '/path/to/mongo'
@@ -101,17 +98,6 @@ module Backup
       #
       # These paths may be set using absolute paths, or relative to the
       # working directory when Backup is run.
-      #
-      # Note that many of Backup's components currently have their own
-      # configuration settings for utility paths. For instance, when configuring
-      # a +MySQL+ database backup, +mysqldump_utility+ may be used:
-      #
-      #   database MySQL do |db|
-      #     db.mysqldump_utility = '/path/to/mysqldump'
-      #   end
-      #
-      # Use of these configuration settings will override the path set here.
-      # (The use of these may be deprecated in the future)
       def configure(&block)
         DSL.instance_eval(&block)
       end
@@ -184,18 +170,12 @@ module Backup
 
         begin
           out, err = '', ''
-          # popen4 doesn't work in 1.8.7 with stock versions of ruby shipped
-          # with major OSs. Hack to make it stop segfaulting.
-          # See: https://github.com/engineyard/engineyard/issues/115
-          GC.disable if RUBY_VERSION < '1.9'
           ps = Open4.popen4(command) do |pid, stdin, stdout, stderr|
             stdin.close
             out, err = stdout.read.strip, stderr.read.strip
           end
         rescue Exception => e
           raise Error.wrap(e, "Failed to execute '#{ name }'")
-        ensure
-          GC.enable if RUBY_VERSION < '1.9'
         end
 
         if ps.success?

data/lib/backup/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Backup
-  VERSION = '3.11.0'
+  VERSION = '4.0.0rc1'
 end

data/templates/cli/archive

@@ -18,9 +18,6 @@
   #
   #   archive.root '/path/to/archive/root'
   #
-  # For more details, please see:
-  # https://github.com/meskyanichi/backup/wiki/Archives
-  #
   archive :my_archive do |archive|
     # Run the `tar` command using `sudo`
     # archive.use_sudo

data/templates/cli/compressor/custom

@@ -1,10 +1,6 @@
   ##
   # Custom [Compressor]
   #
-  # For information on using a Custom Compressor,
-  # please see the following Wiki page:
-  # https://github.com/meskyanichi/backup/wiki/Compressors
-  #
   compress_with Custom do |compressor|
     compressor.command   = 'gzip'
     compressor.extension = '.gz'

data/templates/cli/config

@@ -1,14 +1,47 @@
 # encoding: utf-8
 
 ##
-# Backup
-# Generated Main Config Template
+# Backup v<%= Backup::VERSION.split('.').first %>.x Configuration
 #
-# For more information:
+# Documentation: http://meskyanichi.github.io/backup
+# Issue Tracker: https://github.com/meskyanichi/backup/issues
+
+##
+# Config Options
+#
+# The options here may be overridden on the command line, but the result
+# will depend on the use of --root-path on the command line.
+#
+# If --root-path is used on the command line, then all paths set here
+# will be overridden. If a path (like --tmp-path) is not given along with
+# --root-path, that path will use it's default location _relative to --root-path_.
+#
+# If --root-path is not used on the command line, a path option (like --tmp-path)
+# given on the command line will override the tmp_path set here, but all other
+# paths set here will be used.
+#
+# Note that relative paths given on the command line without --root-path
+# are relative to the current directory. The root_path set here only applies
+# to relative paths set here.
+#
+# ---
+#
+# Sets the root path for all relative paths, including default paths.
+# May be an absolute path, or relative to the current working directory.
 #
-# View the Git repository at https://github.com/meskyanichi/backup
-# View the Wiki/Documentation at https://github.com/meskyanichi/backup/wiki
-# View the issue log at https://github.com/meskyanichi/backup/issues
+# root_path 'my/root'
+#
+# Sets the path where backups are processed until they're stored.
+# This must have enough free space to hold apx. 2 backups.
+# May be an absolute path, or relative to the current directory or +root_path+.
+#
+# tmp_path  'my/tmp'
+#
+# Sets the path where backup stores persistent information.
+# When Backup's Cycler is used, small YAML files are stored here.
+# May be an absolute path, or relative to the current directory or +root_path+.
+#
+# data_path 'my/data'
 
 ##
 # Utilities
@@ -88,14 +121,3 @@
 #       mail.to = 'john.smith@email.com'
 #     end
 #   end
-
-
-# * * * * * * * * * * * * * * * * * * * *
-#        Do Not Edit Below Here.
-# All Configuration Should Be Made Above.
-
-##
-# Load all models from the models directory.
-Dir[File.join(File.dirname(Config.config_file), "models", "*.rb")].each do |model|
-  instance_eval(File.read(model))
-end