rmybackup 0.0.3 → 0.0.4

data/Readme.md

@@ -3,19 +3,23 @@
 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.
 
 ### To Install
-    gem install rmybackup
+    # 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.
 
+To generate a sample config file, use the --config_file option. Default location is /etc/rmybackup.conf, or you can specify your own location.
+
+    # rmybackup --config_file /etc/rmybackup.conf
+
 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.
 
     # example my.cnf
-    #
-    # [mysqldump]
-    # user = root
-    # password = roots_password
+    
+    [mysqldump]
+    user = root
+    password = roots_password
     
 
 Once everything is set up correctly in the config file, and mysqldump is able to operate using credentials specified in the appropriate my.cnf file, you should simply be able to run the rmybackup command.
@@ -32,11 +36,6 @@ The default location for the configuration file is /etc/rmybackup.conf, formatte
     #Backup Directory
     backup_dir: /Users/bshelton/mysql_tmp
 
-    database_connection:
-      host: localhost
-      user: root
-      password: batman
-
     #Databases to back up
     databases: [
       bercilak,

data/bin/rmybackup

@@ -12,12 +12,19 @@ require 'optparse'
 
 #Set some globals
 OPTIONS = { :config_file => "/etc/rmybackup.conf" }
-GEM_VERSION = "0.0.3"
+GEM_VERSION = "0.0.4"
 
 #Process the command line arguments
 ARGV.options do |opts|
   opts.on("-f /etc/rmybackup.conf","--config_file /etc/rmybackup.conf","Set Config File",String) { |OPTIONS[:config_file]| }
   opts.on("-v","--version","Outputs version") { puts "Version - #{GEM_VERSION}"; exit }
+
+  #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|
+    RMyBackup.install_config(ic)
+    exit 0
+  end
   opts.parse!
 end
 

data/lib/rmybackup.rb

@@ -1,15 +1,65 @@
-#Require Yaml
 require 'yaml'
 require 'time'
 
+#The main RMyBackup library
 class RMyBackup
-  
+    
   def initialize(config_file)
     @config_file = config_file
-    #if the config has been parsed correctly, run the backups
+    #if the config file passes, run the backups
     run_backups if parse_config
   end
   
+  #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
+    file = File.expand_path(file)
+
+    if File.exists? file
+      puts "The file already exists, do you want to overwrite it? (Y/Yes):"
+      STDOUT.flush
+      answer = gets.chomp
+      exit 1 unless answer.upcase == "Y" or answer.upcase == "YES"
+    end
+
+    config_file = <<CONFIG_FILE
+#Configuration File in YAML format
+
+#Backup Directory
+backup_dir: /Users/bshelton/mysql_tmp/
+
+#Databases to backup
+#This is an array of databases that are to be backed ups
+# i.e.
+# databases: [
+#   test,
+#   mysql,
+#   important_db
+# ]
+
+#Databases to back up
+databases: [
+  test
+]
+
+#Command Locations
+#You can override where to find the needed system commands, default locations are prefixed with /usr/bin/
+
+#mysqldump_command: /usr/local/mysql/bin/mysqldump
+#gzip_command: /usr/bin/gzip
+#find_command: /usr/bin/find
+CONFIG_FILE
+
+    begin
+      File.open(file,'w') {|f| f.write(config_file) }
+      puts "Installing #{file}"
+    rescue Errno::EACCES
+      puts "Can't write to - #{file}"
+    end
+    exit 0
+  end
+  
   private
   #Run the backups, we should have proper validation at this point
   def run_backups
@@ -22,13 +72,15 @@ class RMyBackup
     #Cycle through databases to backup
     @config['databases'].each do |db|
       puts "Backing up #{db}\n"
-      system "#{mysql_dump} #{db} |#{gzip} > #{backup_dir}#{db}_#{date_string}.sql.gz"
+      system "#{mysql_dump} #{db} |#{gzip} > #{backup_dir}/#{db}_#{date_string}.sql.gz"
     end
   end
   
+  #Parse the config YAML file
   def parse_config
     @config = YAML::load(File.open(@config_file))
 
+    #Initialize error array
     @error = Array.new 
     
     #Defaults
@@ -36,13 +88,11 @@ class RMyBackup
     @config['mysqldump_command'] = "/usr/bin/mysqldump" if @config['mysqldump_command'].nil?
     @config['find_command'] = "/usr/bin/find" if @config['find_command'].nil?
 
-    #Fix Slash at the end of the path
-    @config['backup_dir'] += "/" unless @config['backup_dir'][-1,1] == "/"
-
-    #Run Some checks
+    #Backup dir validation
     if not File.directory? @config['backup_dir']
       @error << "No Such Backup Directory #{@config['backup_dir']}"
     else
+      @config['backup_dir'] = File.expand_path @config['backup_dir']
       if not File.writable? @config['backup_dir']
         @error << "Can't write to the backup directory - #{@config['backup_dir']}"
       end
@@ -58,11 +108,12 @@ class RMyBackup
       return true
     else
       @error.each {|e| puts "#{e}\n" }
-      exit
+      exit 1
     end
+  #Rescue anything by displaying errors if we have them and exiting 1
   rescue
     @error.each {|e| puts "#{e}\n" }
-    exit
+    exit 1
     return false
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Bryan Shelton