rmybackup 0.1.2 → 0.2.0

data/Readme.md

@@ -1,28 +1,28 @@
 # RMyBackup
 
-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.
+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 your 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 ~/.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.
+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 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 all databases excluding the databases listed in the skip_databases: [] list in the configuration file.
 
 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 [/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.
+If use_mycnf_credentials is set to true in the config file, mysqldump will not be passed --user, --password, or --host based on the values in the config file. The script will rely on your [mysqldump] configuration in either /etc/my.cnf or the user's ~/.my.cnf. This is more secure if running on a shared server.
 
-    # example my.cnf
+    # example my.cnf or ~/.my.cnf
     
     [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.
+Once everything is set up, simply run the rmybackup command. It will connect to the mysql server using the values in your config file and back up your databases.
 
     # rmybackup
 
@@ -31,15 +31,26 @@ Once everything is set up correctly in the config file, and mysqldump is able to
 
 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.
 
+    ---
     backup_dir: /Users/username/mysql_backups/
-    #Number of days to keep backups
     remove_after: 7
 
+    #Database
+    username: root
+    password: password
+    host: localhost
+
+    #If this is set to true, no --user --password or --host switches will be passed to
+    #mysqldump. You will need to have credentials within /etc/my.cnf or ~/.my.cnf
+    use_mycnf_credentials: false
+
     #Databases to back up
-    databases: [ test2, test3 ]
+    skip_databases: [ mysql, test, information_schema ]
 
     #Command Locations
-    mysqldump_command: /usr/local/mysql/bin/mysqldump
-    gzip_command: /usr/bin/gzip
+    #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
     
 If mysqldump_command, or gzip_command are left out, they will default to finding the applications in /usr/bin

data/bin/rmybackup

@@ -8,22 +8,22 @@ 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") }
+  options = { :config_file => File.expand_path("~/.rmybackup.conf") }
 else
-  OPTIONS = { :config_file => "/etc/rmybackup.conf" }
+  options = { :config_file => "/etc/rmybackup.conf" }
 end
 
-GEM_VERSION = "0.1.2"
+gem_version = RMyBackup::GEM_VERSION
 
 #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| 
-    OPTIONS[:config_file] = o 
+    options[:config_file] = o 
   end
   
   #Version
-  opts.on("-v","--version","Outputs version") { puts "Version - #{GEM_VERSION}"; exit }
+  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
@@ -36,10 +36,10 @@ ARGV.options do |opts|
 end
 
 #If the config file doesn't exist, warn and exit
-if not File.exists? OPTIONS[:config_file]
-  puts "Unable to read the configuration file - #{OPTIONS[:config_file]}"
+if not File.exists? options[:config_file]
+  puts "Unable to read the configuration file - #{options[:config_file]}"
   exit
 end
 
 #Run
-RMyBackup::Base.new(OPTIONS[:config_file])
+RMyBackup::Base.new(options[:config_file])

data/lib/rmybackup/config_file.txt

@@ -1,10 +1,16 @@
+---
 backup_dir: /Users/username/mysql_backups/
 remove_after: 7
 
-#Databases to back up
-#databases: [ test, test2 ]
+#Database
+username: root
+password: password
+host: localhost
+
+use_mycnf_credentials: false
 
-databases: []
+#Databases to back up
+skip_databases: [ mysql, test, information_schema ]
 
 #Command Locations
 #You can override where to find the needed system commands, default locations are prefixed with /usr/bin/

data/lib/rmybackup.rb

@@ -1,9 +1,14 @@
 require 'yaml'
 require 'time'
+require 'mysql'
+
 require File.expand_path('../rmybackup/install_config',__FILE__)
 require File.expand_path('../rmybackup/purge_files',__FILE__)
 
 module RMyBackup
+
+  GEM_VERSION = "0.2.0"
+  
   class Base
     def initialize(config_file)
       @config_file = config_file
@@ -17,18 +22,43 @@ module RMyBackup
       
       #Grab some config variables
       mysql_dump = @config['mysqldump_command']
-      backup_dir = @config['backup_dir']
+      backup_root = @config['backup_dir']
       gzip = @config['gzip_command']
       date_string = Time.now.strftime "%m_%d_%Y_%H_%M"
 
+      
       #Cycle through databases to backup
-      @config['databases'].each do |db|
+      get_databases.each do |db|
+        backup_dir = File.expand_path("#{backup_root}/#{db}")
+        Dir.mkdir(backup_dir) if not File.exists?(backup_dir)
+
+        #Decide if we use my.cnf or creds on cli
+        if @config['use_mycnf_credentials']
+          cred_string = " --user=#{@config['username']} --password=#{@config['password']} --host=#{@config['host']}"
+        else
+          cred_string = ''
+        end
+        
         puts "Backing up #{db}\n"
-        system "#{mysql_dump} #{db} |#{gzip} > #{backup_dir}/#{db}_#{date_string}.sql.gz"
+        system "#{mysql_dump}#{cred_string} #{db} |#{gzip} > #{backup_dir}/#{db}_#{date_string}.sql.gz"
+        
+        #Purge after x days
+        RMyBackup.purge_days(backup_dir,@config['remove_after'])
       end
-      
-      #Purges after x days
-      RMyBackup.purge_days(@config['backup_dir'],@config['remove_after'])
+    end
+    
+    #Get Databases from MySQL
+    def get_databases
+      dbc = Mysql.real_connect(@config['host'],@config['username'],@config['password'])
+      res = dbc.query('SHOW DATABASES;')
+      databases = []
+      res.each_hash do |db|
+        databases << db['Database']
+      end
+      return databases - @config['skip_databases']
+    rescue
+      puts "There was a problem connecting to the mysql server"
+      exit 0
     end
   
     #Parse the config YAML file
@@ -44,6 +74,13 @@ module RMyBackup
       @config['find_command'] = "/usr/bin/find" if @config['find_command'].nil?
       @config['remove_after'] = @config['remove_after'] || false
 
+      @config['use_mycnf_credentials'] = @config['use_mycnf_credentials'] ? true : false
+
+      #Database Config
+      @config['username'] = @config['username'] || false
+      @config['password'] = @config['password'] || false
+      @config['host'] = @config['host'] || false
+
       #Backup dir validation
       if not File.directory? @config['backup_dir']
         @error << "No Such Backup Directory #{@config['backup_dir']}"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bryan Shelton
@@ -16,8 +16,20 @@ cert_chain: []
 
 date: 2010-05-13 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: Ruby mysql backup script, the script uses mysqldump from the system
 email: bryan@sheltonopensolutions.com
 executables: