backup 3.0.20 → 3.0.21

data/lib/backup/storage/s3.rb

@@ -21,48 +21,25 @@ module Backup
       attr_accessor :region
 
       ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER, @time).sub(/^\//, '')
-      end
+      # Creates a new instance of the storage object
+      def initialize(model, storage_id = nil, &block)
+        super(model, storage_id)
 
-      ##
-      # This is the provider that Fog uses for the S3 Storage
-      def provider
-        'AWS'
-      end
+        @path ||= 'backups'
 
-      ##
-      # Performs the backup transfer
-      def perform!
-        super
-        transfer!
-        cycle!
+        instance_eval(&block) if block_given?
       end
 
-    private
+      private
 
       ##
-      # Set configuration defaults before evaluating configuration block,
-      # after setting defaults from Storage::Base
-      def pre_configure
-        super
-        @path ||= 'backups'
-      end
-
-      ##
-      # Adjust configuration after evaluating configuration block,
-      # after adjustments from Storage::Base
-      def post_configure
-        super
+      # This is the provider that Fog uses for the S3 Storage
+      def provider
+        'AWS'
       end
 
       ##
-      # Establishes a connection to Amazon S3 and returns the Fog object.
-      # Not doing any instance variable caching because this object gets persisted in YAML
-      # format to a file and will issues. This, however has no impact on performance since it only
-      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
-      # background anyway so even if it were a bit slower it shouldn't matter.
+      # Establishes a connection to Amazon S3
       def connection
         @connection ||= Fog::Storage.new(
           :provider               => provider,
@@ -72,29 +49,41 @@ module Backup
         )
       end
 
+      def remote_path_for(package)
+        super(package).sub(/^\//, '')
+      end
+
       ##
       # Transfers the archived file to the specified Amazon S3 bucket
       def transfer!
+        remote_path = remote_path_for(@package)
+
         connection.sync_clock
-        files_to_transfer do |local_file, remote_file|
+
+        files_to_transfer_for(@package) do |local_file, remote_file|
           Logger.message "#{storage_name} started transferring " +
-              "'#{ local_file }' to bucket '#{ bucket }'"
+              "'#{ local_file }' to bucket '#{ bucket }'."
 
-          connection.put_object(
-            bucket,
-            File.join(remote_path, remote_file),
-            File.open(File.join(local_path, local_file))
-          )
+          File.open(File.join(local_path, local_file), 'r') do |file|
+            connection.put_object(
+              bucket, File.join(remote_path, remote_file), file
+            )
+          end
         end
       end
 
       ##
-      # Removes the transferred archive file from the Amazon S3 bucket
-      def remove!
+      # Removes the transferred archive file(s) from the storage location.
+      # Any error raised will be rescued during Cycling
+      # and a warning will be logged, containing the error message.
+      def remove!(package)
+        remote_path = remote_path_for(package)
+
         connection.sync_clock
-        transferred_files do |local_file, remote_file|
+
+        transferred_files_for(package) do |local_file, remote_file|
           Logger.message "#{storage_name} started removing " +
-              "'#{ local_file }' from bucket '#{ bucket }'"
+              "'#{ local_file }' from bucket '#{ bucket }'."
 
           connection.delete_object(bucket, File.join(remote_path, remote_file))
         end

data/lib/backup/storage/scp.rb

@@ -6,7 +6,6 @@
 Backup::Dependency.load('net-ssh')
 Backup::Dependency.load('net-scp')
 
-
 module Backup
   module Storage
     class SCP < Base
@@ -24,38 +23,20 @@ module Backup
       attr_accessor :path
 
       ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER, @time)
-      end
-
-      ##
-      # Performs the backup transfer
-      def perform!
-        super
-        transfer!
-        cycle!
-      end
+      # Creates a new instance of the storage object
+      def initialize(model, storage_id = nil, &block)
+        super(model, storage_id)
 
-    private
-
-      ##
-      # Set configuration defaults before evaluating configuration block,
-      # after setting defaults from Storage::Base
-      def pre_configure
-        super
         @port ||= 22
         @path ||= 'backups'
-      end
 
-      ##
-      # Adjust configuration after evaluating configuration block,
-      # after adjustments from Storage::Base
-      def post_configure
-        super
+        instance_eval(&block) if block_given?
+
         @path = path.sub(/^\~\//, '')
       end
 
+      private
+
       ##
       # Establishes a connection to the remote server
       # and yields the Net::SSH connection.
@@ -69,10 +50,12 @@ module Backup
       ##
       # Transfers the archived file to the specified remote server
       def transfer!
+        remote_path = remote_path_for(@package)
+
         connection do |ssh|
-          create_remote_directories(ssh)
+          ssh.exec!("mkdir -p '#{ remote_path }'")
 
-          files_to_transfer do |local_file, remote_file|
+          files_to_transfer_for(@package) do |local_file, remote_file|
             Logger.message "#{storage_name} started transferring " +
                 "'#{local_file}' to '#{ip}'."
 
@@ -85,11 +68,16 @@ module Backup
       end
 
       ##
-      # Removes the transferred archive file from the server
-      def remove!
+      # Removes the transferred archive file(s) from the storage location.
+      # Any error raised will be rescued during Cycling
+      # and a warning will be logged, containing the error message.
+      def remove!(package)
+        remote_path = remote_path_for(package)
+
         messages = []
-        transferred_files do |local_file, remote_file|
-          messages << "#{storage_name} started removing '#{local_file}' from '#{ip}'."
+        transferred_files_for(package) do |local_file, remote_file|
+          messages << "#{storage_name} started removing " +
+              "'#{local_file}' from '#{ip}'."
         end
         Logger.message messages.join("\n")
 
@@ -102,22 +90,7 @@ module Backup
         unless errors.empty?
           raise Errors::Storage::SCP::SSHError,
             "Net::SSH reported the following errors:\n" +
-              errors.join("\n"), caller(1)
-        end
-      end
-
-      ##
-      # Creates (if they don't exist yet) all the directories on the remote
-      # server in order to upload the backup file. Net::SCP does not support
-      # paths to directories that don't yet exist when creating new directories.
-      # Instead, we split the parts up in to an array (for each '/') and loop through
-      # that to create the directories one by one. Net::SCP raises an exception when
-      # the directory it's trying ot create already exists, so we have rescue it
-      def create_remote_directories(ssh)
-        path_parts = Array.new
-        remote_path.split('/').each do |path_part|
-          path_parts << path_part
-          ssh.exec!("mkdir '#{path_parts.join('/')}'")
+              errors.join("\n")
         end
       end
 

data/lib/backup/storage/sftp.rb

@@ -2,6 +2,7 @@
 
 ##
 # Only load the Net::SFTP library/gem when the Backup::Storage::SFTP class is loaded
+Backup::Dependency.load('net-ssh')
 Backup::Dependency.load('net-sftp')
 
 module Backup
@@ -21,44 +22,22 @@ module Backup
       attr_accessor :path
 
       ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER, @time)
-      end
-
-      ##
-      # Performs the backup transfer
-      def perform!
-        super
-        transfer!
-        cycle!
-      end
-
-    private
+      # Creates a new instance of the storage object
+      def initialize(model, storage_id = nil, &block)
+        super(model, storage_id)
 
-      ##
-      # Set configuration defaults before evaluating configuration block,
-      # after setting defaults from Storage::Base
-      def pre_configure
-        super
         @port ||= 22
         @path ||= 'backups'
-      end
 
-      ##
-      # Adjust configuration after evaluating configuration block,
-      # after adjustments from Storage::Base
-      def post_configure
-        super
+        instance_eval(&block) if block_given?
+
         @path = path.sub(/^\~\//, '')
       end
 
+      private
+
       ##
-      # Establishes a connection to the remote server and returns the Net::SFTP object.
-      # Not doing any instance variable caching because this object gets persisted in YAML
-      # format to a file and will issues. This, however has no impact on performance since it only
-      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
-      # background anyway so even if it were a bit slower it shouldn't matter.
+      # Establishes a connection to the remote server
       def connection
         Net::SFTP.start(
           ip, username,
@@ -70,10 +49,12 @@ module Backup
       ##
       # Transfers the archived file to the specified remote server
       def transfer!
+        remote_path = remote_path_for(@package)
+
         connection do |sftp|
-          create_remote_directories(sftp)
+          create_remote_path(remote_path, sftp)
 
-          files_to_transfer do |local_file, remote_file|
+          files_to_transfer_for(@package) do |local_file, remote_file|
             Logger.message "#{storage_name} started transferring " +
                 "'#{ local_file }' to '#{ ip }'."
 
@@ -86,10 +67,14 @@ module Backup
       end
 
       ##
-      # Removes the transferred archive file from the server
-      def remove!
+      # Removes the transferred archive file(s) from the storage location.
+      # Any error raised will be rescued during Cycling
+      # and a warning will be logged, containing the error message.
+      def remove!(package)
+        remote_path = remote_path_for(package)
+
         connection do |sftp|
-          transferred_files do |local_file, remote_file|
+          transferred_files_for(package) do |local_file, remote_file|
             Logger.message "#{storage_name} started removing " +
                 "'#{ local_file }' from '#{ ip }'."
 
@@ -103,11 +88,12 @@ module Backup
       ##
       # Creates (if they don't exist yet) all the directories on the remote
       # server in order to upload the backup file. Net::SFTP does not support
-      # paths to directories that don't yet exist when creating new directories.
-      # Instead, we split the parts up in to an array (for each '/') and loop through
-      # that to create the directories one by one. Net::SFTP raises an exception when
-      # the directory it's trying to create already exists, so we have rescue it
-      def create_remote_directories(sftp)
+      # paths to directories that don't yet exist when creating new
+      # directories. Instead, we split the parts up in to an array (for each
+      # '/') and loop through that to create the directories one by one.
+      # Net::SFTP raises an exception when the directory it's trying to create
+      # already exists, so we have rescue it
+      def create_remote_path(remote_path, sftp)
         path_parts = Array.new
         remote_path.split('/').each do |path_part|
           path_parts << path_part

data/lib/backup/syncer/base.rb

@@ -5,6 +5,13 @@ module Backup
     class Base
       include Backup::CLI::Helpers
       include Backup::Configuration::Helpers
+
+      private
+
+      def syncer_name
+        self.class.to_s.sub('Backup::', '')
+      end
+
     end
   end
 end

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

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module RSync
+      class Base < Syncer::Base
+
+        ##
+        # Path to store the synced files/directories to
+        attr_accessor :path
+
+        ##
+        # Directories to sync
+        attr_writer :directories
+
+        ##
+        # Flag for mirroring the files/directories
+        attr_accessor :mirror
+
+        ##
+        # Additional options for the rsync cli
+        attr_accessor :additional_options
+
+        ##
+        # Instantiates a new RSync Syncer object
+        # and sets the default configuration
+        def initialize
+          load_defaults!
+
+          @path               ||= 'backups'
+          @directories          = Array.new
+          @mirror             ||= false
+          @additional_options ||= Array.new
+        end
+
+        ##
+        # Syntactical suger for the DSL for adding directories
+        def directories(&block)
+          return @directories unless block_given?
+          instance_eval(&block)
+        end
+
+        ##
+        # Adds a path to the @directories array
+        def add(path)
+          @directories << path
+        end
+
+        private
+
+        ##
+        # Returns the @directories as a space-delimited string of
+        # single-quoted values for use in the `rsync` command line.
+        # Each path is expanded, since these refer to local paths
+        # for both RSync::Local and RSync::Push.
+        # RSync::Pull does not use this method.
+        def directories_option
+          @directories.map do |directory|
+            "'#{ File.expand_path(directory) }'"
+          end.join(' ')
+        end
+
+        ##
+        # Returns Rsync syntax for enabling mirroring
+        def mirror_option
+          '--delete' if @mirror
+        end
+
+        ##
+        # Returns Rsync syntax for invoking "archive" mode
+        def archive_option
+          '--archive'
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module RSync
+      class Local < Base
+
+        ##
+        # Instantiates a new RSync::Local Syncer object.
+        # Default configuration values and any specified in
+        # Backup::Configuration::Syncer::RSync::Local are set from Base.
+        # The user's configuration file is then evaluated to overwrite
+        # these values or provide additional configuration.
+        def initialize(&block)
+          super
+
+          instance_eval(&block) if block_given?
+        end
+
+        ##
+        # Performs the RSync::Local operation
+        # debug options: -vhP
+        def perform!
+          Logger.message(
+            "#{ syncer_name } started syncing the following directories:\n\s\s" +
+            @directories.join("\n\s\s")
+          )
+          Logger.silent(
+            run("#{ utility(:rsync) } #{ options } " +
+                "#{ directories_option } '#{ dest_path }'")
+          )
+        end
+
+        private
+
+        ##
+        # Return expanded @path
+        def dest_path
+          @dest_path ||= File.expand_path(@path)
+        end
+
+        ##
+        # Returns all the specified Rsync::Local options,
+        # concatenated, ready for the CLI
+        def options
+          ([archive_option, mirror_option] +
+            additional_options).compact.join("\s")
+        end
+
+      end
+    end
+  end
+end