rmybackup 0.1.0 → 0.1.2

data/Readme.md

@@ -1,17 +1,17 @@
 # RMyBackup
 
-RMyBackup was created to solve a simple problem I had, and is hopefully useful to somebody else out there. It is a quick way to backup up specified mysql databases using mysqldump. It writes a gzipped .sql file using a date/time naming convention to a specified directory.
+RMyBackup was created to solve a simple problem I had, and is hopefully useful to somebody else out there. RMyBackup is a quick way to backup up specified mysql databases using mysqldump. It writes a gzipped .sql file using a date/time naming convention to a specified directory.
 
 ### To Install
     # gem install rmybackup
     
 ## Usage
 
-The gem will install an rmybackup binary. RMyBackup will read its configuration from /etc/rmybackup.conf (a sample configuration file is shown below). RMyBackup will backup the specified databases in the databases: [] list in the configuration file.
+The gem will install an rmybackup binary. RMyBackup will read its configuration from ~/.rmybackup.conf or /etc/rmybackup.conf (a sample configuration file is shown below). The .rmybackup.conf file in your home folder will be used if present, next it rmybackup will look for /etc/rmybackup. You may also specify an alternate config file on the command line using rmybackup --config-file /alternate/config/file. RMyBackup will backup the specified databases in the databases: [] list in the configuration file.
 
-To generate a sample config file, use the --instal_config option. Default location is /etc/rmybackup.conf, or you can specify your own location.
+To generate a sample config file, use the --instal-config option. Default location is /etc/rmybackup.conf, or if we can't write to /etc, ~/.rmybacukp.conf.
 
-    # rmybackup --install_config /etc/rmybackup.conf
+    # rmybackup --install-config [/config/location]
 
 Right now the script relies on your [mysqldump] configuration in either /etc/my.cnf or the user's ~/.my.cnf. I'm hoping to change this soon, allowing you to specify the host, user, password, and socket in the configuration file.
 
@@ -29,22 +29,17 @@ Once everything is set up correctly in the config file, and mysqldump is able to
 
 ## Sample Configuration File
 
-The default location for the configuration file is /etc/rmybackup.conf, formatted in YAML. You can specify a different config file on the command line using the --config_file (-f) switch.
+The default location for the configuration file is /etc/rmybackup.conf then ~/.rmybacukp.conf, it's formatted in YAML. You can specify a different config file on the command line using the --config-file (-f) option.
 
-    #Configuration File in YAML format
-
-    #Backup Directory
-    backup_dir: /Users/bshelton/mysql_tmp
+    backup_dir: /Users/username/mysql_backups/
+    #Number of days to keep backups
+    remove_after: 7
 
     #Databases to back up
-    databases: [
-      bercilak,
-      bbpress
-    ]
+    databases: [ test2, test3 ]
 
     #Command Locations
     mysqldump_command: /usr/local/mysql/bin/mysqldump
     gzip_command: /usr/bin/gzip
-    find_command: /usr/bin/find
     
-If mysqldump_command, gzip_command, or find_command are left out, they will default to finding the applications in /usr/bin
+If mysqldump_command, or gzip_command are left out, they will default to finding the applications in /usr/bin

data/bin/rmybackup

@@ -1,17 +1,11 @@
 #!/usr/bin/env ruby
 
 #Load our libraries, if we can't load them from the gem, assume we're running from source
-begin
-  require 'rubygems'
-  require 'rmybackup'
-rescue LoadError
-  require '../lib/rmybackup'
-end
-
+require 'rubygems'
+require 'rmybackup'
 require 'optparse'
 
 #GLOBALS
-
 #Default to local config file if it exists
 if File.exists?(File.expand_path("~/.rmybackup.conf"))
   OPTIONS = { :config_file => File.expand_path("~/.rmybackup.conf") }
@@ -19,12 +13,12 @@ else
   OPTIONS = { :config_file => "/etc/rmybackup.conf" }
 end
 
-GEM_VERSION = "0.1.0"
+GEM_VERSION = "0.1.2"
 
 #Process the command line arguments
 ARGV.options do |opts|
   #Set the config file
-  opts.on("-f /etc/rmybackup.conf","--config_file /etc/rmybackup.conf","Set Config File",String) do |o| 
+  opts.on("-f /etc/rmybackup.conf","--config-file /etc/rmybackup.conf","Set Config File",String) do |o| 
     OPTIONS[:config_file] = o 
   end
   
@@ -33,7 +27,7 @@ ARGV.options do |opts|
 
   #Allow the user to write the sample config file to either the default (no file specified) or to the file they specify
   #on the command line
-  opts.on("-i [config_file location]","--install_config [config_file location]","Generates a sample config file",String) do |ic|
+  opts.on("-i [config_file location]","--install-config [config_file location]","Generates a sample config file",String) do |ic|
     RMyBackup.install_config(ic)
     exit 0
   end
@@ -48,4 +42,4 @@ if not File.exists? OPTIONS[:config_file]
 end
 
 #Run
-RMyBackup::Base.new(OPTIONS[:config_file])
+RMyBackup::Base.new(OPTIONS[:config_file])

data/lib/rmybackup/config_file.txt

@@ -1,5 +1,5 @@
-#Backup Directory
-backup_dir: /Users/bshelton/mysql_tmp/
+backup_dir: /Users/username/mysql_backups/
+remove_after: 7
 
 #Databases to back up
 #databases: [ test, test2 ]

data/lib/rmybackup/{config.rb → install_config.rb}

@@ -2,11 +2,19 @@ module RMyBackup
   #Install a baseline config file from the template
   def self.install_config(file=false)
     #Default the file location
-    file = "/etc/rmybackup.conf" if not file
+    if not file
+      if File.writable_real?("/etc/rmybackup.conf")
+        file = "/etc/rmybackup.conf"
+      else
+        file = "~/.rmybackup.conf"
+      end
+    end
+    
+    #Expand the path
     file = File.expand_path(file)
-
+    
     if File.exists? file
-      puts "The file already exists, do you want to overwrite it? (Y/Yes):"
+      puts "#{file} already exists, do you want to overwrite it? (Y/n):"
       STDOUT.flush
       answer = gets.chomp
       exit 1 unless answer.upcase == "Y" or answer.upcase == "YES"

data/lib/rmybackup/purge_files.rb

@@ -0,0 +1,17 @@
+require 'date'
+require 'time'
+
+module RMyBackup
+  def self.purge_days(path,days=false)
+    return true unless days
+    Dir["#{path}/*.sql.gz"].each do |file|
+      mtime = File.mtime(File.expand_path(file))
+      mdate = Date.parse("#{mtime.year}-#{mtime.month}-#{mtime.day}")
+      date = Date.today - days
+      if mdate < date
+        puts "Cleaning up - #{file}"
+        File.delete(file)
+      end
+    end
+  end
+end

data/lib/rmybackup.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'time'
-require 'rmybackup/config'
+require File.expand_path('../rmybackup/install_config',__FILE__)
+require File.expand_path('../rmybackup/purge_files',__FILE__)
 
 module RMyBackup
   class Base
@@ -13,6 +14,7 @@ module RMyBackup
     private
     #Run the backups, we should have proper validation at this point
     def run_backups
+      
       #Grab some config variables
       mysql_dump = @config['mysqldump_command']
       backup_dir = @config['backup_dir']
@@ -24,6 +26,9 @@ module RMyBackup
         puts "Backing up #{db}\n"
         system "#{mysql_dump} #{db} |#{gzip} > #{backup_dir}/#{db}_#{date_string}.sql.gz"
       end
+      
+      #Purges after x days
+      RMyBackup.purge_days(@config['backup_dir'],@config['remove_after'])
     end
   
     #Parse the config YAML file
@@ -37,6 +42,7 @@ module RMyBackup
       @config['gzip_command'] = "/usr/bin/gzip" if @config['gzip_command'].nil?
       @config['mysqldump_command'] = "/usr/bin/mysqldump" if @config['mysqldump_command'].nil?
       @config['find_command'] = "/usr/bin/find" if @config['find_command'].nil?
+      @config['remove_after'] = @config['remove_after'] || false
 
       #Backup dir validation
       if not File.directory? @config['backup_dir']

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bryan Shelton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 -06:00
+date: 2010-05-13 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,8 @@ files:
 - lib/rmybackup.rb
 - Readme.md
 - lib/rmybackup/config_file.txt
-- lib/rmybackup/config.rb
+- lib/rmybackup/install_config.rb
+- lib/rmybackup/purge_files.rb
 - bin/rmybackup
 has_rdoc: true
 homepage: http://github.com/bshelton229/rmybackup/