backup 3.1.3 → 3.2.0

data/lib/backup/utilities.rb

@@ -8,10 +8,112 @@ module Backup
       gzip bzip2 lzma pbzip2
       mongo mongodump mysqldump pg_dump redis-cli riak-admin
       gpg openssl
-      rsync
+      rsync ssh
     }
 
-    module Helpers
+    module DSL
+      class << self
+        ##
+        # Allow users to set the path for all utilities in the .configure block.
+        #
+        # Utility names with dashes ('redis-cli') will be set using method calls
+        # with an underscore ('redis_cli').
+        NAMES.each do |name|
+          define_method name.gsub('-', '_'), lambda {|val|
+            path = File.expand_path(val)
+            unless File.executable?(path)
+              raise Errors::Utilities::NotFoundError, <<-EOS
+                The path given for '#{ name }' was not found or not executable.
+                Path was: #{ path }
+              EOS
+            end
+            UTILITY[name] = path
+          }
+        end
+
+        ##
+        # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
+        def tar_dist(val)
+          Utilities.tar_dist(val)
+        end
+      end
+    end
+
+    class << self
+      ##
+      # Configure the path to system utilities used by Backup.
+      #
+      # Backup will attempt to locate any required system utilities using a
+      # +which+ command call. If a utility can not be found, or you need to
+      # specify an alternate path for a utility, you may do so in your
+      # +config.rb+ file using this method.
+      #
+      # Backup supports both GNU and BSD utilities.
+      # While Backup uses these utilities in a manner compatible with either
+      # version, the +tar+ utility requires some special handling with respect
+      # to +Archive+s. Backup will attempt to detect if the +tar+ command
+      # found (or set here) is GNU or BSD. If for some reason this fails,
+      # this may be set using the +tar_dist+ command shown below.
+      #
+      #   Backup::Utilities.configure do
+      #     # General Utilites
+      #     tar   '/path/to/tar'
+      #     tar_dist :gnu   # or :bsd
+      #     cat   '/path/to/cat'
+      #     split '/path/to/split'
+      #     find  '/path/to/find'
+      #     xargs '/path/to/xargs'
+      #
+      #     # 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'
+      #     mongodump   '/path/to/mongodump'
+      #     mysqldump   '/path/to/mysqldump'
+      #     pg_dump     '/path/to/pg_dump'
+      #     redis_cli   '/path/to/redis-cli'
+      #     riak_admin  '/path/to/riak-admin'
+      #
+      #     # Encryptors
+      #     gpg     '/path/to/gpg'
+      #     openssl '/path/to/openssl'
+      #
+      #     # Syncer and Storage
+      #     rsync   '/path/to/rsync'
+      #     ssh     '/path/to/ssh'
+      #   end
+      #
+      # 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
+
+      def tar_dist(val)
+        # the acceptance tests need to be able to reset this to nil
+        @gnu_tar = val.nil? ? nil : val == :gnu
+      end
+
+      def gnu_tar?
+        return @gnu_tar unless @gnu_tar.nil?
+        @gnu_tar = !!run("#{ utility(:tar) } --version").match(/GNU/)
+      end
+
       private
 
       ##
@@ -100,112 +202,21 @@ module Backup
         end
       end
 
-      def gnu_tar?
-        Utilities.gnu_tar?
-      end
-    end # Helpers
-
-    class << self
-      include Helpers
-
-      ##
-      # Configure the path to system utilities used by Backup.
-      #
-      # Backup will attempt to locate any required system utilities using a
-      # +which+ command call. If a utility can not be found, or you need to
-      # specify an alternate path for a utility, you may do so in your
-      # +config.rb+ file using this method.
-      #
-      # Backup supports both GNU and BSD utilities.
-      # While Backup uses these utilities in a manner compatible with either
-      # version, the +tar+ utility requires some special handling with respect
-      # to +Archive+s. Backup will attempt to detect if the +tar+ command
-      # found (or set here) is GNU or BSD. If for some reason this fails,
-      # this may be set using the +tar_dist+ command shown below.
-      #
-      #   Backup::Utilities.configure do
-      #     # General Utilites
-      #     tar   '/path/to/tar'
-      #     tar_dist :gnu   # or :bsd
-      #     cat   '/path/to/cat'
-      #     split '/path/to/split'
-      #     find  '/path/to/find'
-      #     xargs '/path/to/xargs'
-      #
-      #     # 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'
-      #     mongodump   '/path/to/mongodump'
-      #     mysqldump   '/path/to/mysqldump'
-      #     pg_dump     '/path/to/pg_dump'
-      #     redis_cli   '/path/to/redis-cli'
-      #     riak_admin  '/path/to/riak-admin'
-      #
-      #     # Encryptors
-      #     gpg     '/path/to/gpg'
-      #     openssl '/path/to/openssl'
-      #
-      #     # Syncer and Storage
-      #     rsync   '/path/to/rsync'
-      #   end
-      #
-      # 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)
-        instance_eval(&block)
-      end
-
-      def gnu_tar?
-        return @gnu_tar unless @gnu_tar.nil?
-        @gnu_tar = !!run("#{ utility(:tar) } --version").match(/GNU/)
-      end
-
-      private
-
-      ##
-      # Allow users to set the path for all utilities in the .configure block.
-      #
-      # Utility names with dashes ('redis-cli') will be set using method calls
-      # with an underscore ('redis_cli').
-      NAMES.each do |name|
-        define_method name.gsub('-', '_'), lambda {|val|
-          path = File.expand_path(val)
-          unless File.executable?(path)
-            raise Errors::Utilities::NotFoundError, <<-EOS
-              The path given for '#{ name }' was not found or not executable.
-              Path was: #{ path }
-            EOS
-          end
-          UTILITY[name] = path
-        }
-      end
-
-      ##
-      # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
-      def tar_dist(val)
-        @gnu_tar = val == :gnu
-      end
-
       def reset!
         UTILITY.clear
         @gnu_tar = nil
       end
     end
+
+    # Allows these utility methods to be included in other classes,
+    # while allowing them to be stubbed in spec_helper for all specs.
+    module Helpers
+      [:utility, :command_name, :run].each do |name|
+        define_method name, lambda {|arg| Utilities.send(name, arg) }
+        private name
+      end
+      private
+      def gnu_tar?; Utilities.gnu_tar?; end
+    end
   end
 end

data/lib/backup/version.rb

@@ -13,7 +13,7 @@ module Backup
     #  Defines the minor version
     # PATCH:
     #  Defines the patch version
-    MAJOR, MINOR, PATCH = 3, 1, 3
+    MAJOR, MINOR, PATCH = 3, 2, 0
 
     ##
     # Returns the major version ( big release based off of multiple minor releases )

data/templates/cli/archive

@@ -1,21 +1,29 @@
   ##
   # Archive [Archive]
   #
-  # Adding a file:
+  # Adding a file or directory (including sub-directories):
   #   archive.add "/path/to/a/file.rb"
-  #
-  # Adding an directory (including sub-directories):
   #   archive.add "/path/to/a/directory/"
   #
-  # Excluding a file:
+  # Excluding a file or directory (including sub-directories):
   #   archive.exclude "/path/to/an/excluded_file.rb"
+  #   archive.exclude "/path/to/an/excluded_directory
+  #
+  # By default, relative paths will be relative to the directory
+  # where `backup perform` is executed, and they will be expanded
+  # to the root of the filesystem when added to the archive.
+  #
+  # If a `root` path is set, relative paths will be relative to the
+  # given `root` path and will not be expanded when added to the archive.
+  #
+  #   archive.root '/path/to/archive/root'
   #
-  # Excluding a directory (including sub-directories):
-  #   archive.exclude "/path/to/an/excluded_directory/
+  # For more details, please see:
+  # https://github.com/meskyanichi/backup/wiki/Archives
   #
   archive :my_archive do |archive|
     archive.add "/path/to/a/file.rb"
     archive.add "/path/to/a/folder/"
     archive.exclude "/path/to/a/excluded_file.rb"
-    archive.exclude "/path/to/a/excluded_folder/"
+    archive.exclude "/path/to/a/excluded_folder"
   end

data/templates/cli/notifier/mail

@@ -18,5 +18,5 @@
     mail.user_name            = "sender@email.com"
     mail.password             = "my_password"
     mail.authentication       = "plain"
-    mail.enable_starttls_auto = true
+    mail.encryption           = :starttls
   end

data/templates/cli/storage/rsync

@@ -1,11 +1,19 @@
   ##
   # RSync [Storage]
   #
-  store_with RSync do |server|
-    server.username   = "my_username"
-    server.password   = "my_password"
-    server.ip         = "123.45.678.90"
-    server.port       = 22
-    server.path       = "~/backups/"
-    server.local      = false
+  # The default `mode` is :ssh, which does not require the use
+  # of an rsync daemon on the remote. If you wish to connect
+  # directly to an rsync daemon, or via SSH using daemon features,
+  # :rsync_daemon and :ssh_daemon modes are also available.
+  #
+  # If no `host` is specified, the transfer will be a local
+  # operation. `mode` and `compress` will have no meaning.
+  #
+  # See the documentation on the Wiki for details.
+  # https://github.com/meskyanichi/backup/wiki/Storages
+  store_with RSync do |rsync|
+    rsync.mode      = :ssh
+    rsync.host      = "123.45.678.90"
+    rsync.path      = "~/backups/"
+    rsync.compress  = true
   end

data/templates/cli/syncer/rsync_local

@@ -2,7 +2,7 @@
   # RSync::Local [Syncer]
   #
   sync_with RSync::Local do |rsync|
-    rsync.path     = "~/backups/"
+    rsync.path     = "~/backups"
     rsync.mirror   = true
 
     rsync.directories do |directory|

data/templates/cli/syncer/rsync_pull

@@ -1,12 +1,17 @@
   ##
   # RSync::Pull [Syncer]
   #
+  # The default `mode` is :ssh, which does not require the use
+  # of an rsync daemon on the remote. If you wish to connect
+  # directly to an rsync daemon, or via SSH using daemon features,
+  # :rsync_daemon and :ssh_daemon modes are also available.
+  # See the documentation on the Wiki for details.
+  # https://github.com/meskyanichi/backup/wiki/Syncers
+  #
   sync_with RSync::Pull do |rsync|
-    rsync.ip       = "123.45.678.90"
-    rsync.port     = 22
-    rsync.username = "my_username"
-    rsync.password = "my_password"
-    rsync.path     = "~/backups/"
+    rsync.mode     = :ssh
+    rsync.host     = "123.45.678.90"
+    rsync.path     = "~/backups"
     rsync.mirror   = true
     rsync.compress = true
 

data/templates/cli/syncer/rsync_push

@@ -1,12 +1,17 @@
   ##
   # RSync::Push [Syncer]
   #
+  # The default `mode` is :ssh, which does not require the use
+  # of an rsync daemon on the remote. If you wish to connect
+  # directly to an rsync daemon, or via SSH using daemon features,
+  # :rsync_daemon and :ssh_daemon modes are also available.
+  # See the documentation on the Wiki for details.
+  # https://github.com/meskyanichi/backup/wiki/Syncers
+  #
   sync_with RSync::Push do |rsync|
-    rsync.ip       = "123.45.678.90"
-    rsync.port     = 22
-    rsync.username = "my_username"
-    rsync.password = "my_password"
-    rsync.path     = "~/backups/"
+    rsync.mode     = :ssh
+    rsync.host     = "123.45.678.90"
+    rsync.path     = "~/backups"
     rsync.mirror   = true
     rsync.compress = true
 

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.15.4
     - - <
@@ -24,7 +24,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.15.4
     - - <
@@ -177,12 +177,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -192,3 +192,4 @@ signing_key:
 specification_version: 4
 summary: Provides an elegant DSL in Ruby for performing backups on UNIX-like systems.
 test_files: []
+has_rdoc: