backup 3.3.2 → 3.4.0

data/lib/backup/storage/cycler.rb

@@ -10,8 +10,9 @@ module Backup
         # to the given +storage+ and Package#trigger (Model#trigger).
         # Then, calls the +storage+ to remove the files for any older
         # packages that were removed from the YAML storage file.
-        def cycle!(storage, package)
-          @storage, @package = storage, package
+        def cycle!(storage)
+          @storage = storage
+          @package = storage.package
           @storage_file = storage_file
 
           update_storage_file!
@@ -52,10 +53,9 @@ module Backup
         # Return full path to the YAML data file,
         # based on the current values of @storage and @package
         def storage_file
-          type     = @storage.class.to_s.split('::').last
-          suffix   = @storage.storage_id.to_s.strip.gsub(/[\W]/, '_')
-          filename = suffix.empty? ? type : "#{type}-#{suffix}"
-          File.join(Config.data_path, @package.trigger, "#{filename}.yml")
+          filename = @storage.class.to_s.split('::').last
+          filename << "-#{ @storage.storage_id }" if @storage.storage_id
+          File.join(Config.data_path, @package.trigger, "#{ filename }.yml")
         end
 
         ##

data/lib/backup/storage/dropbox.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# Only load the Dropbox gem when the Backup::Storage::Dropbox class is loaded
 Backup::Dependency.load('dropbox-sdk')
 
 module Backup
@@ -19,10 +17,6 @@ module Backup
       #   :dropbox (full access)
       attr_accessor :access_type
 
-      ##
-      # Path to where the backups will be stored
-      attr_accessor :path
-
       ##
       # Chunk size, specified in MiB, for the ChunkedUploader.
       attr_accessor :chunk_size
@@ -35,23 +29,18 @@ module Backup
       # Seconds to wait between chunk retries.
       attr_accessor :retry_waitsec
 
-      attr_deprecate :email,    :version => '3.0.17'
-      attr_deprecate :password, :version => '3.0.17'
-
-      attr_deprecate :timeout, :version => '3.0.21'
-
       ##
       # Creates a new instance of the storage object
       def initialize(model, storage_id = nil, &block)
-        super(model, storage_id)
+        super
+        instance_eval(&block) if block_given?
 
         @path           ||= 'backups'
         @access_type    ||= :app_folder
         @chunk_size     ||= 4 # MiB
         @chunk_retries  ||= 10
         @retry_waitsec  ||= 30
-
-        instance_eval(&block) if block_given?
+        path.sub!(/^\//, '')
       end
 
       private
@@ -85,7 +74,7 @@ module Backup
       # Attempt to load a cached session
       def cached_session
         session = false
-        if cache_exists?
+        if File.exist?(cached_file)
           begin
             session = DropboxSession.deserialize(File.read(cached_file))
             Logger.info "Session data loaded from cache!"
@@ -105,65 +94,58 @@ module Backup
       # Each chunk will be retried +chunk_retries+ times, pausing +retry_waitsec+
       # between retries, if errors occur.
       def transfer!
-        remote_path = remote_path_for(@package)
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
 
-        files_to_transfer_for(@package) do |local_file, remote_file|
-          Logger.info "#{ storage_name } started transferring '#{ local_file }'."
-
-          uploader, retries = nil, 0
-          File.open(File.join(local_path, local_file), 'r') do |file|
+          uploader = nil
+          File.open(src, 'r') do |file|
             uploader = connection.get_chunked_uploader(file, file.stat.size)
             while uploader.offset < uploader.total_size
-              begin
+              with_retries do
                 uploader.upload(1024**2 * chunk_size)
-                retries = 0
-              # Timeout::Error is not a StandardError under ruby-1.8.7
-              rescue StandardError, Timeout::Error => err
-                retries += 1
-                if retries <= chunk_retries
-                  Logger.info "Chunk retry #{ retries } of #{ chunk_retries }."
-                  sleep(retry_waitsec)
-                  retry
-                end
-                raise Errors::Storage::Dropbox::TransferError.
-                    wrap(err, 'Dropbox upload failed!')
               end
             end
           end
 
-          uploader.finish(File.join(remote_path, remote_file))
+          with_retries do
+            uploader.finish(dest)
+          end
         end
-      end
 
-      ##
-      # 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)
+      rescue => err
+        raise Errors::Storage::Dropbox::TransferError.wrap(err, 'Upload Failed!')
+      end
 
-        messages = []
-        transferred_files_for(package) do |local_file, remote_file|
-          messages << "#{storage_name} started removing " +
-              "'#{ local_file }' from Dropbox."
+      # Timeout::Error is not a StandardError under ruby-1.8.7
+      def with_retries
+        retries = 0
+        begin
+          yield
+        rescue StandardError, Timeout::Error => err
+          retries += 1
+          raise if retries > chunk_retries
+
+          Logger.info Errors::Storage::Dropbox::TransferError.
+              wrap(err, "Retry ##{ retries } of #{ chunk_retries }.")
+          sleep(retry_waitsec)
+          retry
         end
-        Logger.info messages.join("\n")
+      end
 
-        connection.file_delete(remote_path)
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
+      def remove!(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
+
+        connection.file_delete(remote_path_for(package))
       end
 
-      ##
-      # Returns the path to the cached file
       def cached_file
         File.join(Config.cache_path, api_key + api_secret)
       end
 
-      ##
-      # Checks to see if the cache file exists
-      def cache_exists?
-        File.exist?(cached_file)
-      end
-
       ##
       # Serializes and writes the Dropbox session to a cache file
       def write_cache!(session)
@@ -211,6 +193,10 @@ module Backup
           )
       end
 
+      attr_deprecate :email,    :version => '3.0.17'
+      attr_deprecate :password, :version => '3.0.17'
+      attr_deprecate :timeout,  :version => '3.0.21'
+
     end
   end
 end

data/lib/backup/storage/ftp.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# Only load the Net::FTP library/gem when the Backup::Storage::FTP class is loaded
 require 'net/ftp'
 
 module Backup
@@ -16,26 +14,18 @@ module Backup
       # Server IP Address and FTP port
       attr_accessor :ip, :port
 
-      ##
-      # Path to store backups to
-      attr_accessor :path
-
       ##
       # use passive mode?
       attr_accessor :passive_mode
 
-      ##
-      # Creates a new instance of the storage object
       def initialize(model, storage_id = nil, &block)
-        super(model, storage_id)
+        super
+        instance_eval(&block) if block_given?
 
         @port         ||= 21
         @path         ||= 'backups'
         @passive_mode ||= false
-
-        instance_eval(&block) if block_given?
-
-        @path = path.sub(/^\~\//, '')
+        path.sub!(/^~\//, '')
       end
 
       private
@@ -58,38 +48,28 @@ module Backup
         end
       end
 
-      ##
-      # Transfers the archived file to the specified remote server
       def transfer!
-        remote_path = remote_path_for(@package)
-
         connection do |ftp|
-          create_remote_path(remote_path, ftp)
-
-          files_to_transfer_for(@package) do |local_file, remote_file|
-            Logger.info "#{storage_name} started transferring " +
-                "'#{ local_file }' to '#{ ip }'."
-            ftp.put(
-              File.join(local_path, local_file),
-              File.join(remote_path, remote_file)
-            )
+          create_remote_path(ftp)
+
+          package.filenames.each do |filename|
+            src = File.join(Config.tmp_path, filename)
+            dest = File.join(remote_path, filename)
+            Logger.info "Storing '#{ ip }:#{ dest }'..."
+            ftp.put(src, dest)
           end
         end
       end
 
-      ##
-      # 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.
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
       def remove!(package)
-        remote_path = remote_path_for(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
 
+        remote_path = remote_path_for(package)
         connection do |ftp|
-          transferred_files_for(package) do |local_file, remote_file|
-            Logger.info "#{storage_name} started removing " +
-                "'#{ local_file }' from '#{ ip }'."
-
-            ftp.delete(File.join(remote_path, remote_file))
+          package.filenames.each do |filename|
+            ftp.delete(File.join(remote_path, filename))
           end
 
           ftp.rmdir(remote_path)
@@ -104,7 +84,7 @@ module Backup
       # '/') and loop through that to create the directories one by one.
       # Net::FTP raises an exception when the directory it's trying to create
       # already exists, so we have rescue it
-      def create_remote_path(remote_path, ftp)
+      def create_remote_path(ftp)
         path_parts = Array.new
         remote_path.split('/').each do |path_part|
           path_parts << path_part

data/lib/backup/storage/local.rb

@@ -4,76 +4,57 @@ module Backup
   module Storage
     class Local < Base
 
-      ##
-      # Path where the backup will be stored.
-      attr_accessor :path
-
-      ##
-      # Creates a new instance of the storage object
       def initialize(model, storage_id = nil, &block)
-        super(model, storage_id)
-
-        @path ||= File.join(
-          File.expand_path(ENV['HOME'] || ''),
-          'backups'
-        )
-
+        super
         instance_eval(&block) if block_given?
 
-        @path = File.expand_path(@path)
+        @path ||= '~/backups'
       end
 
       private
 
-      ##
-      # Transfers the archived file to the specified path
       def transfer!
-        remote_path = remote_path_for(@package)
         FileUtils.mkdir_p(remote_path)
 
-        files_to_transfer_for(@package) do |local_file, remote_file|
-          Logger.info "#{storage_name} started transferring '#{ local_file }'."
+        transfer_method = package_movable? ? :mv : :cp
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
 
-          src_path = File.join(local_path, local_file)
-          dst_path = File.join(remote_path, remote_file)
-          FileUtils.send(transfer_method, src_path, dst_path)
+          FileUtils.send(transfer_method, src, dest)
         end
       end
 
-      ##
-      # 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.
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
       def remove!(package)
-        remote_path = remote_path_for(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
 
-        messages = []
-        transferred_files_for(package) do |local_file, remote_file|
-          messages << "#{storage_name} started removing '#{ local_file }'."
-        end
-        Logger.info messages.join("\n")
+        FileUtils.rm_r(remote_path_for(package))
+      end
 
-        FileUtils.rm_r(remote_path)
+      # expanded since this is a local path
+      def remote_path(pkg = package)
+        File.expand_path(super)
       end
+      alias :remote_path_for :remote_path
 
       ##
-      # Set and return the transfer method.
       # If this Local Storage is not the last Storage for the Model,
       # force the transfer to use a *copy* operation and issue a warning.
-      def transfer_method
-        return @transfer_method if @transfer_method
-
-        if self == @model.storages.last
-          @transfer_method = :mv
+      def package_movable?
+        if self == model.storages.last
+          true
         else
           Logger.warn Errors::Storage::Local::TransferError.new(<<-EOS)
             Local File Copy Warning!
-            The final backup file(s) for '#{@model.label}' (#{@model.trigger})
-            will be *copied* to '#{remote_path_for(@package)}'
+            The final backup file(s) for '#{ model.label }' (#{ model.trigger })
+            will be *copied* to '#{ remote_path }'
             To avoid this, when using more than one Storage, the 'Local' Storage
             should be added *last* so the files may be *moved* to their destination.
           EOS
-          @transfer_method = :cp
+          false
         end
       end
 

data/lib/backup/storage/ninefold.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# Only load the Fog gem when the Backup::Storage::Ninefold class is loaded
 Backup::Dependency.load('fog')
 
 module Backup
@@ -12,39 +10,36 @@ module Backup
       # Ninefold Credentials
       attr_accessor :storage_token, :storage_secret
 
-      ##
-      # Ninefold directory path
-      attr_accessor :path
-
-      ##
-      # Creates a new instance of the storage object
       def initialize(model, storage_id = nil, &block)
-        super(model, storage_id)
+        super
+        instance_eval(&block) if block_given?
 
         @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
+        path.sub!(/^\//, '')
       end
 
-
       private
 
-      ##
-      # This is the provider that Fog uses for the Ninefold storage
-      def provider
-        'Ninefold'
-      end
-
-      ##
-      # Establishes a connection to Amazon S3
       def connection
         @connection ||= Fog::Storage.new(
-          :provider                => provider,
+          :provider                => 'Ninefold',
           :ninefold_storage_token  => storage_token,
           :ninefold_storage_secret => storage_secret
         )
       end
 
+      def transfer!
+        directory = directory_for(remote_path, true)
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
+          File.open(src, 'r') do |file|
+            directory.files.create(:key => filename, :body => file)
+          end
+        end
+      end
+
       ##
       # Queries the connection for the directory for the given +remote_path+
       # Returns nil if not found, or creates the directory if +create+ is true.
@@ -56,59 +51,23 @@ module Backup
         directory
       end
 
-      def remote_path_for(package)
-        super(package).sub(/^\//, '')
-      end
-
-      ##
-      # Transfers the archived file to the specified directory
-      def transfer!
-        remote_path = remote_path_for(@package)
-
-        directory = directory_for(remote_path, true)
-
-        files_to_transfer_for(@package) do |local_file, remote_file|
-          Logger.info "#{storage_name} started transferring '#{ local_file }'."
-
-          File.open(File.join(local_path, local_file), 'r') do |file|
-            directory.files.create(:key => remote_file, :body => file)
-          end
-        end
-      end
-
-      ##
-      # 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.
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
       def remove!(package)
-        remote_path = remote_path_for(package)
-
-        if directory = directory_for(remote_path)
-          not_found = []
-
-          transferred_files_for(package) do |local_file, remote_file|
-            Logger.info "#{storage_name} started removing " +
-                "'#{ local_file }' from Ninefold."
+        Logger.info "Removing backup package dated #{ package.time }..."
 
-            if file = directory.files.get(remote_file)
-              file.destroy
-            else
-              not_found << remote_file
-            end
-          end
+        remote_path = remote_path_for(package)
+        directory = directory_for(remote_path)
 
-          directory.destroy
+        raise Errors::Storage::Ninefold::NotFoundError,
+            "Directory at '#{ remote_path }' not found" unless directory
 
-          unless not_found.empty?
-            raise Errors::Storage::Ninefold::NotFoundError, <<-EOS
-                The following file(s) were not found in '#{ remote_path }'
-                #{ not_found.join("\n") }
-            EOS
-          end
-        else
-          raise Errors::Storage::Ninefold::NotFoundError,
-              "Directory at '#{remote_path}' not found"
+        package.filenames.each do |filename|
+          file = directory.files.get(filename)
+          file.destroy if file
         end
+
+        directory.destroy
       end
 
     end