rmybackup 0.0.1 → 0.0.3

data/Readme.md

@@ -0,0 +1,52 @@
+# 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.
+
+### 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.
+
+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
+    
+
+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.
+
+    # rmybackup
+
+
+## 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.
+
+    #Configuration File in YAML format
+
+    #Backup Directory
+    backup_dir: /Users/bshelton/mysql_tmp
+
+    database_connection:
+      host: localhost
+      user: root
+      password: batman
+
+    #Databases to back up
+    databases: [
+      bercilak,
+      etrack,
+      bbpress
+    ]
+
+    #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

data/bin/rmybackup

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-#Load the libraries, see if we're local or not for testing
+#Load our libraries, if we can't load them from the gem, assume we're running from source
 begin
   require 'rubygems'
   require 'rmybackup'
@@ -10,14 +10,22 @@ end
 
 require 'optparse'
 
+#Set some globals
 OPTIONS = { :config_file => "/etc/rmybackup.conf" }
-GEM_VERSION = "0.0.1"
+GEM_VERSION = "0.0.3"
 
+#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 }
   opts.parse!
 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]}"
+  exit
+end
+
 #Run
 RMyBackup.new(OPTIONS[:config_file])

data/lib/rmybackup.rb

@@ -40,7 +40,13 @@ class RMyBackup
     @config['backup_dir'] += "/" unless @config['backup_dir'][-1,1] == "/"
 
     #Run Some checks
-    @error << "No Such Backup Directory #{@config['backup_dir']}" unless File.directory? @config['backup_dir']
+    if not File.directory? @config['backup_dir']
+      @error << "No Such Backup Directory #{@config['backup_dir']}"
+    else
+      if not File.writable? @config['backup_dir']
+        @error << "Can't write to the backup directory - #{@config['backup_dir']}"
+      end
+    end
 
     #Check Commands
     @error << "Can't locate find command: #{@config['find_command']}" unless File.exists? @config['find_command']

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Bryan Shelton
@@ -28,7 +28,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/rmybackup.rb
-- Readme
+- Readme.md
 has_rdoc: true
 homepage: http://github.com/bshelton229/rmybackup/
 licenses: []

data/Readme

@@ -1 +0,0 @@
-#RMyBackup runs mysql dumps from an /etc/rmybackup.conf file