added zip support

Author: Samuel Goebert

README

@@ -3,7 +3,7 @@ BackupFu
 
 The backup_fu plugin makes it redonkulously easy to:
 
- A) dump your database and/or static files to tar/gzipped archives, and
+ A) dump your database and/or static files to tar/gzipped or zipped archives, and
  B) upload these archives to a private Amazon S3 bucket for safekeeping
 
 Installation
@@ -60,7 +60,8 @@ Advanced options include:
 * specify static path(s) that should be backed up -- i.e. backup your entire 'public/static' directory
 * change default dump path from RAILS_ROOT/tmp/backup to whatever
 * specify fully-qualified 'mysqldump' path
-* disable tar/gzipping of database dump
+* disable compression of database dump
+* choose between zip or tar/gzip compression
 * enable 'nice' with level specification to prevent backup_fu from bogarding your server
 
 Cronjob Installation

config/backup_fu.yml.advanced_example

@@ -26,6 +26,9 @@ static_paths: "/u/apps/foo/current/public/static"
 # The default dump base path is 'tmp/backups'.  This can be changed with:
 dump_base_path: /tmp
 
+# To use tar-gzipping or zipping for compression. Use the values tar-gzip or zip here. Default is tar-gzip.
+compressor: tar-gzip
+
 # To disable compression of the DB backup:
 disable_compression: true
 

lib/backup_fu.rb

@@ -61,7 +61,7 @@ def dump_static
     if !@fu_conf[:static_paths]
       raise BackupFuConfigError, 'No static paths are defined in config/backup_fu.yml.  See README.'
     end
-    paths = @fu_conf[:static_paths].split(' ')´
+    paths = @fu_conf[:static_paths].split(' ')
     compress_static(paths)
   end
 
@@ -73,24 +73,30 @@ def backup_static
     puts "\nBacking up Static files to S3: #{file}\n" if @verbose
 
     AWS::S3::S3Object.store(File.basename(file), open(file), @fu_conf[:s3_bucket], :access => :private)
-    
   end
-  
+
   def cleanup
     count = @fu_conf[:keep_backups].to_i
     backups = Dir.glob("#{dump_base_path}/*.{sql}")
     if count >= backups.length
       puts "no old backups to cleanup"
     else
       puts "keeping #{count} of #{backups.length} backups"
-      
+
       files_to_remove = backups - backups.last(count)
-      files_to_remove = files_to_remove.concat(Dir.glob("#{dump_base_path}/*.{gz}")[0, files_to_remove.length]) unless @fu_conf[:disable_compression]
-      
+
+      if(!@fu_conf[:disable_compression])
+        if(@fu_conf[:compressor] == 'zip')
+          files_to_remove = files_to_remove.concat(Dir.glob("#{dump_base_path}/*.{zip}")[0, files_to_remove.length])
+        else
+          files_to_remove = files_to_remove.concat(Dir.glob("#{dump_base_path}/*.{gz}")[0, files_to_remove.length])
+        end
+      end
+
       files_to_remove.each do |f|
         File.delete(f)
       end
-      
+
     end
   end
 
@@ -135,30 +141,46 @@ def dump_base_path
   def db_filename
     "#{@fu_conf[:app_name]}_#{ @timestamp }_db.sql"
   end
-  
+
   def db_filename_compressed
-    db_filename.gsub('.sql', '.tar')
+    if(@fu_conf[:compressor] == 'zip')
+      db_filename.gsub('.sql', '.zip')
+    else
+      db_filename.gsub('.sql', '.tar')
+    end
   end
-  
+
   def final_db_dump_path
-    if @fu_conf[:disable_compression]
+    if(@fu_conf[:disable_compression])
       filename = db_filename
     else
-      filename = db_filename.gsub('.sql', '.tar.gz')
+      if(@fu_conf[:compressor] == 'zip')
+        filename = db_filename.gsub('.sql', '.zip')
+      else
+        filename = db_filename.gsub('.sql', '.tar.gz')
+      end
     end
     File.join(dump_base_path, filename)
   end
-  
+
   def static_compressed_path
-    f = "#{@fu_conf[:app_name]}_#{ @timestamp }_static.tar"
+    if(@fu_conf[:compressor] == 'zip')
+      f = "#{@fu_conf[:app_name]}_#{ @timestamp }_static.zip"
+    else
+      f = "#{@fu_conf[:app_name]}_#{ @timestamp }_static.tar"
+    end
     File.join(dump_base_path, f)
   end
-  
+
   def final_static_dump_path
-    f = "#{@fu_conf[:app_name]}_#{ @timestamp }_static.tar.gz"
+    if(@fu_conf[:compressor] == 'zip')
+      f = "#{@fu_conf[:app_name]}_#{ @timestamp }_static.zip"
+    else
+      f = "#{@fu_conf[:app_name]}_#{ @timestamp }_static.tar.gz"
+    end
     File.join(dump_base_path, f)
   end
-  
+
   def create_dirs
     ensure_directory_exists(dump_base_path)
   end
@@ -180,17 +202,24 @@ def datetime_formatted
   end
 
   def compress_db(dump_base_path, db_filename)
-    tar_path = File.join(dump_base_path, db_filename_compressed)
+    compressed_path = File.join(dump_base_path, db_filename_compressed)
 
-    # TAR it up
-    cmd = niceify "tar -cf #{tar_path} -C #{dump_base_path} #{db_filename}"
-    puts "\nTar: #{cmd}\n" if @verbose
-    `#{cmd}`
+    if(@fu_conf[:compressor] == 'zip')
+      cmd = niceify "zip #{compressed_path} #{dump_base_path}/#{db_filename}"
+      puts "\nZip: #{cmd}\n" if @verbose
+      `#{cmd}`
+    else
 
-    # GZip it up
-    cmd = niceify "gzip -f #{tar_path}"
-    puts "\nGzip: #{cmd}" if @verbose
-    `#{cmd}`
+      # TAR it up
+      cmd = niceify "tar -cf #{compressed_path} -C #{dump_base_path} #{db_filename}"
+      puts "\nTar: #{cmd}\n" if @verbose
+      `#{cmd}`
+
+      # GZip it up
+      cmd = niceify "gzip -f #{compressed_path}"
+      puts "\nGzip: #{cmd}" if @verbose
+      `#{cmd}`
+    end
   end
 
   def compress_static(paths)
@@ -202,23 +231,30 @@ def compress_static(paths)
       end
 
       puts "Static Path: #{p}" if @verbose
-      if path_num == 0
-        tar_switch = 'c'  # for create
+
+      if @fu_conf[:compressor] == 'zip'
+        cmd = niceify "zip -r #{static_compressed_path} #{p}"
+        puts "\nZip: #{cmd}\n" if @verbose
+        `#{cmd}`
       else
-        tar_switch = 'r'  # for append
-      end
+        if path_num == 0
+          tar_switch = 'c'  # for create
+        else
+          tar_switch = 'r'  # for append
+        end
 
-      # TAR
-      cmd = niceify "tar -#{tar_switch}f #{static_compressed_path} #{p}"
-      puts "\nTar: #{cmd}\n" if @verbose
-      `#{cmd}`
+        # TAR
+        cmd = niceify "tar -#{tar_switch}f #{static_compressed_path} #{p}"
+        puts "\nTar: #{cmd}\n" if @verbose
+        `#{cmd}`
 
-      path_num += 1
-    end
+        path_num += 1
 
-    # GZIP
-    cmd = niceify "gzip -f #{static_compressed_path}"
-    puts "\nGzip: #{cmd}" if @verbose
-    `#{cmd}`
+        # GZIP
+        cmd = niceify "gzip -f #{static_compressed_path}"
+        puts "\nGzip: #{cmd}" if @verbose
+        `#{cmd}`
+      end
+    end
   end
 end

tasks/backup_fu_tasks.rake

@@ -51,7 +51,7 @@ namespace :backup_fu do
 
   namespace :static do
 
-    desc "Tars and gzips static application files locally.  Does *not* upload to S3."
+    desc "Zips or Tars and gzips static application files locally.  Does *not* upload to S3."
     task :dump do
       b = BackupFu.new
       b.dump_static