backup 3.3.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e889097f40e239697f1c8b2d7cec1e2783674c15
-  data.tar.gz: f70369a752f7fb511ad3e0de69b98ef0d0959a15
+  metadata.gz: 552f524acf300a8918b07f535d29b23506cb1b9d
+  data.tar.gz: 31a993d965e008dba36bdcb1319e7be4bc4ab0c2
 SHA512:
-  metadata.gz: 5f38d5b86b108d53afdbffc33c120672364960abcc54bdf3f4ccbb12d85793ef118931b30091d5774cb8516b16aedaf9eaf84fc7b220551606cb44f5ab596c53
-  data.tar.gz: 108266c5088cabe8ec5d125626daed7af0260055a11d4ea35afb7d29edf5f89666e0068415fbe936b8206263f24c0c1438078eb872a9a1af92b7e02871f158c4
+  metadata.gz: 76ce5ab435d082d9947211a394ce1985f69f965758595e89a14b0f57f001b852b6bc4d2df89437c9ee5267c3196ae7c57c7075c006a9ba0637323e7c8e986623
+  data.tar.gz: 4b5c1ad79f13079a3a009a85012c80065c76dd16f62883bfd3ffb28b86822f06759e7a5990d5646c6b71611128d53c0d61a7c008a905e5404f6d99abc6cef09d

data/lib/backup/cleaner.rb

@@ -9,22 +9,22 @@ module Backup
       # from the last time this model/trigger was run,
       # then removes the files.
       def prepare(model)
-        @model = model
-
         messages = []
-        if packaging_folder_dirty?
+
+        packaging_folder = File.join(Config.tmp_path, model.trigger)
+        if File.exist?(packaging_folder)
           messages << <<-EOS
-            The temporary backup folder still contains files!
-            '#{ File.join(Config.tmp_path, @model.trigger) }'
-            These files will now be removed.
+            The temporary packaging folder still exists!
+            '#{ packaging_folder }'
+            It will now be removed.
           EOS
-          FileUtils.rm_rf(File.join(Config.tmp_path, @model.trigger))
+          FileUtils.rm_rf(packaging_folder)
         end
 
-        package_files = tmp_path_package_files
+        package_files = package_files_for(model.trigger)
         unless package_files.empty?
-          # the chances that tmp_path would be dirty
-          # AND package files exist are practically nil
+          # the chances of the packaging folder AND
+          # the package files existing are practically nil
           messages << ('-' * 74) unless messages.empty?
 
           messages << <<-EOS
@@ -41,7 +41,7 @@ module Backup
             Cleanup Warning
             #{ messages.join("\n") }
             Please check the log for messages and/or your notifications
-            concerning this backup: '#{ @model.label } (#{ @model.trigger })'
+            concerning this backup: '#{ model.label } (#{ model.trigger })'
             The temporary files which had to be removed should not have existed.
           EOS
         end
@@ -68,21 +68,21 @@ module Backup
       # Logs warnings if any temporary files still exist
       # when errors occur during the backup
       def warnings(model)
-        @model = model
-
         messages = []
-        if packaging_folder_dirty?
+
+        packaging_folder = File.join(Config.tmp_path, model.trigger)
+        if File.exist?(packaging_folder)
           messages << <<-EOS
-            The temporary backup folder still contains files!
-            '#{ File.join(Config.tmp_path, @model.trigger) }'
+            The temporary packaging folder still exists!
+            '#{ packaging_folder }'
             This folder may contain completed Archives and/or Database backups.
           EOS
         end
 
-        package_files = tmp_path_package_files
+        package_files = package_files_for(model.trigger)
         unless package_files.empty?
-          # the chances that tmp_path would be dirty
-          # AND package files exist are practically nil
+          # the chances of the packaging folder AND
+          # the package files existing are practically nil
           messages << ('-' * 74) unless messages.empty?
 
           messages << <<-EOS
@@ -97,7 +97,7 @@ module Backup
             Cleanup Warning
             #{ messages.join("\n") }
             Make sure you check these files before the next scheduled backup for
-            '#{ @model.label } (#{ @model.trigger })'
+            '#{ model.label } (#{ model.trigger })'
             These files will be removed at that time!
           EOS
         end
@@ -105,15 +105,8 @@ module Backup
 
       private
 
-      def packaging_folder_dirty?
-        !Dir[File.join(Config.tmp_path, @model.trigger, '*')].empty?
-      end
-
-      def tmp_path_package_files
-        Dir[File.join(
-          Config.tmp_path,
-          "????.??.??.??.??.??.#{ @model.trigger }.tar{,[.-]*}"
-        )]
+      def package_files_for(trigger)
+        Dir[File.join(Config.tmp_path,"#{ trigger }.tar{,[.-]*}")]
       end
 
     end

data/lib/backup/database/base.rb

@@ -8,6 +8,10 @@ module Backup
 
       attr_reader :model, :database_id, :dump_path
 
+      ##
+      # If given, +database_id+ will be appended to the #dump_filename.
+      # This is required if multiple Databases of the same class are added to
+      # the model.
       def initialize(model, database_id = nil)
         @model = model
         @database_id = database_id.to_s.gsub(/\W/, '_') if database_id
@@ -37,7 +41,7 @@ module Backup
       # is defined, the user will be warned and one will be auto-generated.
       #
       # Model#initialize calls this method *after* all defined databases have
-      # been initialized so `backup perform --check` can report these warnings.
+      # been initialized so `backup check` can report these warnings.
       def dump_filename
         @dump_filename ||= begin
           unless database_id

data/lib/backup/model.rb

@@ -80,6 +80,7 @@ module Backup
     def initialize(trigger, label, &block)
       @trigger = trigger.to_s
       @label   = label.to_s
+      @package = Package.new(self)
 
       procedure_instance_variables.each do |variable|
         instance_variable_set(variable, Array.new)
@@ -230,7 +231,7 @@ module Backup
     #
     def perform!
       @started_at = Time.now
-      @time = @started_at.strftime("%Y.%m.%d.%H.%M.%S")
+      @time = package.time = @started_at.strftime("%Y.%m.%d.%H.%M.%S")
       log!(:started)
 
       prepare!
@@ -263,13 +264,12 @@ module Backup
     end
 
     ##
-    # After all the databases and archives have been dumped and sorted,
+    # After all the databases and archives have been dumped and stored,
     # these files will be bundled in to a .tar archive (uncompressed),
     # which may be optionally Encrypted and/or Split into multiple "chunks".
     # All information about this final archive is stored in the @package.
     # Once complete, the temporary folder used during packaging is removed.
     def package!
-      @package = Package.new(self)
       Packager.package!(self)
       Cleaner.remove_packaging(self)
     end
@@ -277,7 +277,7 @@ module Backup
     ##
     # Removes the final package file(s) once all configured Storages have run.
     def clean!
-      Cleaner.remove_package(@package)
+      Cleaner.remove_package(package)
     end
 
     ##

data/lib/backup/package.rb

@@ -5,7 +5,7 @@ module Backup
 
     ##
     # The time when the backup initiated (in format: 2011.02.20.03.29.59)
-    attr_reader :time
+    attr_accessor :time
 
     ##
     # The trigger which initiated the backup process
@@ -24,11 +24,10 @@ module Backup
     attr_reader :version
 
     def initialize(model)
-      @time = model.time
       @trigger = model.trigger
       @extension = 'tar'
       @chunk_suffixes = Array.new
-      @version = Backup::Version.current
+      @version = Version.current
     end
 
     def filenames
@@ -40,7 +39,7 @@ module Backup
     end
 
     def basename
-      "#{ time }.#{ trigger }.#{ extension }"
+      "#{ trigger }.#{ extension }"
     end
 
   end

data/lib/backup/splitter.rb

@@ -4,8 +4,10 @@ module Backup
   class Splitter
     include Backup::Utilities::Helpers
 
+    attr_reader :package, :chunk_size
+
     def initialize(model, chunk_size)
-      @model = model
+      @package = model.package
       @chunk_size = chunk_size
     end
 
@@ -17,8 +19,8 @@ module Backup
     # Once the packaging procedure is complete, it will return and
     # @package.chunk_suffixes will be set based on the resulting files.
     def split_with
-      before_packaging
-      yield @split_command
+      Logger.info "Splitter configured with a chunk size of #{ chunk_size }MB."
+      yield split_command
       after_packaging
     end
 
@@ -30,13 +32,9 @@ module Backup
     # written using the given `prefix`, which is the full path to the
     # final @package.basename, plus a '-' separator. This `prefix` will then
     # be suffixed using 'aa', 'ab', and so on... for each file.
-    def before_packaging
-      @package = @model.package
-      Logger.info "Splitter configured with a chunk size of " +
-          "#{ @chunk_size }MB."
-
-      @split_command = "#{ utility(:split) } -b #{ @chunk_size }m - " +
-          "'#{ File.join(Config.tmp_path, @package.basename + '-') }'"
+    def split_command
+      "#{ utility(:split) } -b #{ chunk_size }m - " +
+          "'#{ File.join(Config.tmp_path, package.basename + '-') }'"
     end
 
     ##
@@ -49,11 +47,11 @@ module Backup
       suffixes = chunk_suffixes
       if suffixes == ['aa']
         FileUtils.mv(
-          File.join(Config.tmp_path, @package.basename + '-aa'),
-          File.join(Config.tmp_path, @package.basename)
+          File.join(Config.tmp_path, package.basename + '-aa'),
+          File.join(Config.tmp_path, package.basename)
         )
       else
-        @package.chunk_suffixes = suffixes
+        package.chunk_suffixes = suffixes
       end
     end
 
@@ -68,7 +66,7 @@ module Backup
     # Returns an array of full paths to the backup chunks.
     # Chunks are sorted in alphabetical order.
     def chunks
-      Dir[File.join(Config.tmp_path, @package.basename + '-*')].sort
+      Dir[File.join(Config.tmp_path, package.basename + '-*')].sort
     end
 
   end

data/lib/backup/storage/base.rb

@@ -5,77 +5,45 @@ module Backup
     class Base
       include Backup::Configuration::Helpers
 
+      ##
+      # Base path on the remote where backup package files will be stored.
+      attr_accessor :path
+
       ##
       # Sets the limit to how many backups to keep in the remote location.
       # If exceeded, the oldest will be removed to make room for the newest
       attr_accessor :keep
 
-      ##
-      # User-defined string used to uniquely identify multiple storages of the
-      # same type. If multiple storages of the same type are added to a single
-      # backup model, then this identifier must be set. This will be appended
-      # to the YAML storage file used for cycling backups.
-      attr_reader :storage_id
+      attr_reader :model, :package, :storage_id
 
+      ##
+      # +storage_id+ is a user-defined string used to uniquely identify
+      # multiple storages of the same type. If multiple storages of the same
+      # type are added to a single backup model, this identifier must be set.
+      # This will be appended to the YAML storage file used for cycling backups.
       def initialize(model, storage_id = nil)
         @model = model
-        @storage_id = storage_id
+        @package = model.package
+        @storage_id = storage_id.to_s.gsub(/\W/, '_') if storage_id
 
         load_defaults!
       end
 
       def perform!
-        @package = @model.package
+        Logger.info "#{ storage_name } Started..."
         transfer!
         cycle!
+        Logger.info "#{ storage_name } Finished!"
       end
 
       private
 
       ##
-      # Provider defaults to false. Overridden when using a service-based
-      # storage such as Amazon S3, Rackspace Cloud Files or Dropbox
-      def provider
-        false
-      end
-
-      ##
-      # Each subclass must define a +path+ where remote files will be stored
-      def path; end
-
-      ##
-      # Return the storage name, with optional storage_id
-      def storage_name
-        @storage_name ||= self.class.to_s.sub('Backup::', '') +
-            (storage_id ? " (#{ storage_id })" : '')
-      end
-
-      ##
-      # Returns the local path
-      # This is where any Package to be transferred is located.
-      def local_path
-        Config.tmp_path
+      # Return the remote path for the current or given package.
+      def remote_path(pkg = package)
+        File.join(path, pkg.trigger, pkg.time)
       end
-
-      ##
-      # Returns the remote path for the given Package
-      # This is where the Package will be stored, or was previously stored.
-      def remote_path_for(package)
-        File.join(path, package.trigger, package.time)
-      end
-
-      ##
-      # Yields two arguments to the given block: "local_file, remote_file"
-      # The local_file is the full file name:
-      # e.g. "2011.08.30.11.00.02.trigger.tar.enc"
-      # The remote_file is the full file name, minus the timestamp:
-      # e.g. "trigger.tar.enc"
-      def files_to_transfer_for(package)
-        package.filenames.each do |filename|
-          yield filename, filename[20..-1]
-        end
-      end
-      alias :transferred_files_for :files_to_transfer_for
+      alias :remote_path_for :remote_path
 
       ##
       # Adds the current package being stored to the YAML cycle data file
@@ -85,9 +53,13 @@ module Backup
       # containing the original error message.
       def cycle!
         return unless keep.to_i > 0
-        Logger.info "#{ storage_name }: Cycling Started..."
-        Cycler.cycle!(self, @package)
-        Logger.info "#{ storage_name }: Cycling Complete!"
+        Logger.info "Cycling Started..."
+        Cycler.cycle!(self)
+      end
+
+      def storage_name
+        @storage_name ||= self.class.to_s.sub('Backup::', '') +
+            (storage_id ? " (#{ storage_id })" : '')
       end
 
     end

data/lib/backup/storage/cloudfiles.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# Only load the Fog gem when the Backup::Storage::CloudFiles class is loaded
 Backup::Dependency.load('fog')
 
 module Backup
@@ -18,33 +16,23 @@ module Backup
       attr_accessor :servicenet
 
       ##
-      # Rackspace Cloud Files container name and path
-      attr_accessor :container, :path
+      # Rackspace Cloud Files container name
+      attr_accessor :container
 
-      ##
-      # 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?
 
         @servicenet ||= false
         @path       ||= 'backups'
-
-        instance_eval(&block) if block_given?
+        path.sub!(/^\//, '')
       end
 
       private
 
-      ##
-      # This is the provider that Fog uses for the Cloud Files Storage
-      def provider
-        'Rackspace'
-      end
-
-      ##
-      # Establishes a connection to Rackspace Cloud Files
       def connection
         @connection ||= Fog::Storage.new(
-          :provider             => provider,
+          :provider             => 'Rackspace',
           :rackspace_username   => username,
           :rackspace_api_key    => api_key,
           :rackspace_auth_url   => auth_url,
@@ -52,35 +40,27 @@ module Backup
         )
       end
 
-      ##
-      # Transfers the archived file to the specified Cloud Files container
       def transfer!
-        remote_path = remote_path_for(@package)
-
         connection.put_container(container)
 
-        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|
-            connection.put_object(
-              container, File.join(remote_path, remote_file), file
-            )
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ container }/#{ dest }'..."
+          File.open(src, 'r') do |file|
+            connection.put_object(container, dest, 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)
+        Logger.info "Removing backup package dated #{ package.time }..."
 
-        transferred_files_for(package) do |local_file, remote_file|
-          Logger.info "#{storage_name} started removing '#{ local_file }' " +
-              "from container '#{ container }'."
-          connection.delete_object(container, File.join(remote_path, remote_file))
+        remote_path = remote_path_for(package)
+        package.filenames.each do |filename|
+          connection.delete_object(container, File.join(remote_path, filename))
         end
       end