rmybackup 0.3.0 → 0.3.5

data/Readme.md

@@ -12,6 +12,11 @@ The gem will install an rmybackup binary. RMyBackup will read its configuration
 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]
+    
+Rmybackup --edit and --list will edit and list the config file respectively. Edit will use the EDITOR environment variable, or search for vim.
+
+    # rmybackup --edit
+    # rmybackup --list
 
 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.
 
@@ -20,7 +25,11 @@ If use_mycnf_credentials is set to true in the config file, mysqldump will not b
     [mysqldump]
     user = root
     password = roots_password
-    
+
+RMyBackup will also use rsync to sync to URIs listed in the push configuration file option. For example, if you set push: user@server:/remote/path, after the backups were completed, rmybackup would run rsync -rz /local/backup/path/ user@server:/remote/path/. Push can either be a list or URIs or a single URI.
+
+    push: [ "username@server:/directory/for/backups", 
+            "another_user@another_server:/directory/for/backups" ]
 
 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.
 
@@ -33,31 +42,39 @@ The default location for the configuration file is /etc/rmybackup.conf then ~/.r
 
     ---
     backup_dir: /Users/username/mysql_backups/
-    
+
     #Pruning. Remove_after is evaluated first, then only_keep
 
     #Remove after x days
-    remove_after: 7
+    #remove_after: 7
 
     #Only keep x number
-    only_keep: 5
+    #only_keep: 5
 
     #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
+    #If use_mycnf_credentials is set to true, no --user --password or --host switches will be passed to mysqldump
     use_mycnf_credentials: false
 
     #Databases to back up
     skip_databases: [ mysql, test, information_schema ]
 
+
+    #RMyBackup will use Rsync to push to the Rsync compatible URI's listed in push:. This can be a single value or a list.
+
+    #push: [ "username@server:/directory/for/backups", 
+    #        "another_user@another_server:/directory/for/backups" ]
+
+
     #Command Locations
-    #You can override where to find the needed system commands, default locations are prefixed with /usr/bin/
+    #You may override where to find the needed system commands
+    #RMyBackup will try to locate these files if they are not specified here
 
     #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
+
+    #Rsync, only needed if you designate pushes
+    #rsync_command: /usr/bin/rsync

data/bin/rmybackup

@@ -5,7 +5,6 @@ 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") }
@@ -13,6 +12,10 @@ else
   options = { :config_file => "/etc/rmybackup.conf" }
 end
 
+#Default edit or list options to false
+options[:edit] = false
+options[:list] = false
+
 gem_version = RMyBackup::GEM_VERSION
 
 #Process the command line arguments
@@ -32,14 +35,35 @@ ARGV.options do |opts|
     exit 0
   end
   
+  opts.on("-l","--list","Lists the configuration file") {
+    #Set the list option to true
+    options[:list] = true
+  }
+  
+  opts.on("-e","--edit","Edit the configuration file in vim, or the editor defined by the system variable $EDITOR") {
+    #Set the list option to true
+    options[:edit] = true
+  }
+  
   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
+#The first remaining ARGV, we'll take as a command
+command = ARGV.shift
+
+#Load up the config file. This will exit 1 if the config file can't be found
+RMyBackup::Base.load_config(options[:config_file])
+
+#Evaluate edit or list options
+if options[:list]
+  RMyBackup.list_config_file
+  exit 0
+end
+
+if options[:edit]
+  RMyBackup.edit_config_file
+  exit 0
 end
 
-#Run
-RMyBackup::Base.new(options[:config_file])
+#Run the backups
+RMyBackup::Backup.run

data/lib/rmybackup.rb

@@ -2,114 +2,14 @@ require 'yaml'
 require 'time'
 require 'mysql'
 
+#Load our libraries
 require File.expand_path('../rmybackup/install_config',__FILE__)
 require File.expand_path('../rmybackup/purge_files',__FILE__)
+require File.expand_path('../rmybackup/base',__FILE__)
+require File.expand_path('../rmybackup/backup',__FILE__)
+require File.expand_path('../rmybackup/push',__FILE__)
 
+#Set the version
 module RMyBackup
-
-  GEM_VERSION = "0.3.0"
-  
-  class Base
-    def initialize(config_file)
-      @config_file = config_file
-      #if the config file passes, run the backups
-      run_backups if parse_config
-    end
-  
-    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_root = @config['backup_dir']
-      gzip = @config['gzip_command']
-      date_string = Time.now.strftime "%m_%d_%Y_%H_%M"
-
-      
-      #Cycle through databases to backup
-      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 = ''
-        else
-          cred_string = " --user=#{@config['username']} --password=#{@config['password']} --host=#{@config['host']}"
-        end
-        
-        puts "Backing up #{db}\n"
-        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'])
-        RMyBackup.purge_number(backup_dir,@config['only_keep'])
-      end
-    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
-    def parse_config
-      @config = YAML::load(File.open(@config_file))
-
-      #Initialize error array
-      @error = Array.new 
-    
-      #Defaults
-      @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
-      @config['only_keep'] = @config['only_keep'] || 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']}"
-      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
-      end
-
-      #Check Commands
-      @error << "Can't locate find command: #{@config['find_command']}" unless File.exists? @config['find_command']
-      @error << "Can't locate gzip command: #{@config['gzip_command']}" unless File.exists? @config['gzip_command']
-      @error << "Can't locate mysqldump command: #{@config['mysqldump_command']}" unless File.exists? @config['mysqldump_command']
-
-      #See if we've created any errors, if so, display them and exit
-      if @error.empty?
-        return true
-      else
-        @error.each {|e| puts "#{e}\n" }
-        exit 1
-      end
-    #Rescue anything by displaying errors if we have them and exiting 1
-    rescue
-      @error.each {|e| puts "#{e}\n" }
-      exit 1
-      return false
-    end
-  end
-end
+  GEM_VERSION = "0.3.5"
+end

data/lib/rmybackup/backup.rb

@@ -0,0 +1,54 @@
+module RMyBackup
+  class Backup
+    def self.run
+
+      #This will exit out if RMyBackup::Base.load_config(file) hasn't been loaded with a config file yet
+      @config = RMyBackup::Base.get_config
+
+      #Grab some config variables
+      mysql_dump = @config['mysqldump_command']
+      backup_root = @config['backup_dir']
+      gzip = @config['gzip_command']
+      date_string = Time.now.strftime "%m_%d_%Y_%H_%M"
+
+      
+      #Cycle through databases to backup
+      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 = ''
+        else
+          cred_string = " --user=#{@config['username']} --password=#{@config['password']} --host=#{@config['host']}"
+        end
+        
+        puts "Backing up #{db}\n"
+        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'])
+        RMyBackup.purge_number(backup_dir,@config['only_keep'])
+      end
+      
+      #If we need to push the dir, push it here
+      RMyBackup::Push.run if @config['push']
+    end
+    
+    #Get Databases from MySQL
+    def self.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
+    
+  end
+end

data/lib/rmybackup/base.rb

@@ -0,0 +1,106 @@
+module RMyBackup
+  class Base
+    class << self
+      #Load the configuration from the file
+      def load_config(file)
+
+        #Expand the file path
+        file = File.expand_path(file)
+        
+        if not File.exists? file
+          puts "Can't load config file: #{file}"
+          exit 1
+        end
+
+        #Load the YAML file
+        @config = YAML::load(File.open(file))
+
+        #Cache the expanded file we read
+        @config['file'] = file
+        
+        #Initialize error array
+        @error = Array.new 
+
+        #Command locations
+        if @config['gzip_command'].nil?
+          @config['gzip_command'] = `which gzip`.chop
+        end
+
+        if @config['mysqldump_command'].nil?
+          @config['mysqldump_command'] = `which mysqldump`.chop
+        end
+        
+
+        #Sanitize and check our PUSH options
+        if not @config['push'].nil?
+          #Turn this into an array, even if there is only one in the config file
+          @config['push'] = Array.new << @config['push'] if not @config['push'].kind_of? Array
+
+          #Because we have a push defined, lets find the rsync command
+          if @config['rsync_command'].nil?
+            @config['rsync_command'] = `which rsync`.chop
+          end
+          
+          @error << "Can't locate rsync command: #{@config['rsync_command']}" unless File.exists? @config['rsync_command']          
+        else
+          @config['push'] = false
+        end
+        
+        #Check that commands exist
+        @error << "Can't locate gzip command: #{@config['gzip_command']}" unless File.exists? @config['gzip_command']
+        @error << "Can't locate mysqldump command: #{@config['mysqldump_command']}" unless File.exists? @config['mysqldump_command']
+  
+  
+        #Default the purge settings
+        @config['remove_after'] = @config['remove_after'] || false
+        @config['only_keep'] = @config['only_keep'] || false
+
+
+        #Default .my.cnf usage
+        @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
+        @config['backup_dir'] = File.expand_path @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
+
+        #See if we've created any errors, if so, display them and exit
+        if @error.empty?
+          return true
+        else
+          @error.each {|e| puts "#{e}\n" }
+          exit 1
+        end
+
+      end
+      
+      def config_set?
+        return true if @config
+        false
+      end
+
+      def get_config
+
+        #Check to make sure the configuration file has already been loaded
+        if not @config
+          puts 'No config file has been loaded.'
+          exit
+        end
+        
+        @config
+      end
+    end
+  end
+end

data/lib/rmybackup/config_file.txt

@@ -14,13 +14,24 @@ username: root
 password: password
 host: localhost
 
+#If use_mycnf_credentials is set to true, no --user --password or --host switches will be passed to mysqldump
 use_mycnf_credentials: false
 
 #Databases to back up
 skip_databases: [ mysql, test, information_schema ]
 
+
+#RMyBackup will use Rsync to push to the Rsync compatible URI's listed in push:. This can be a single value or a list.
+
+#push: [ "username@server:/directory/for/backups", "another_user@another_server:/directory/for/backups" ]
+
+
 #Command Locations
-#You can override where to find the needed system commands, default locations are prefixed with /usr/bin/
+#You may override where to find the needed system commands
+#RMyBackup will locate these files if they are not specified here
 
 #mysqldump_command: /usr/local/mysql/bin/mysqldump
-#gzip_command: /usr/bin/gzip
+#gzip_command: /usr/bin/gzip
+
+#Rsync, only needed if you designate pushes
+#rsync_command: /usr/bin/rsync

data/lib/rmybackup/install_config.rb

@@ -31,4 +31,44 @@ module RMyBackup
     end
     exit 0
   end
+  
+  #Edit config Options
+  def self.editor
+    if ENV['EDITOR'].nil?
+      vim = `which vim`.chop
+      if vim.empty?
+        return false
+      else
+        return vim
+      end
+    else
+      return ENV['EDITOR']
+    end
+  end
+  
+  def self.list_config_file
+    if editor
+      config = RMyBackup::Base.get_config
+      file = config['file']
+      puts "Showing config file - #{file}:\n"
+      File.open(file, "r") do |infile|
+        while(line = infile.gets)
+          puts line
+        end
+      end
+    else
+      puts "Can't locate vim and $EDITOR isn't set"
+      exit 1
+    end
+  end
+  
+  def self.edit_config_file
+    config = RMyBackup::Base.get_config
+    if editor
+      exec "#{editor} #{config['file']}"
+    else
+      puts "Can't locate vim and $EDITOR isn't set"
+      exit 1
+    end
+  end
 end

data/lib/rmybackup/push.rb

@@ -0,0 +1,23 @@
+module RMyBackup
+  class Push
+    class << self
+      def run
+        #Load the config options
+        @config = RMyBackup::Base.get_config
+        
+        #Iterrate through the pushes in the @config options
+        @config['push'].each do |push|
+          #Define the rsync_command from the @config option
+          rsync_command = @config['rsync_command']
+          
+          #Add a trailing slash if not present
+          push += "/" if push[-1,1] != "/"
+          
+          puts "\nPushing to : #{push} -->\n\n"
+          system "#{rsync_command} -rz --delete #{@config['backup_dir']}/ #{push}"
+        end
+        
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Bryan Shelton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 -06:00
+date: 2010-07-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,6 +30,19 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Ruby mysql backup script, the script uses mysqldump from the system
 email: bryan@sheltonopensolutions.com
 executables: 
@@ -39,11 +52,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/rmybackup.rb
 - Readme.md
+- lib/rmybackup/backup.rb
+- lib/rmybackup/base.rb
 - lib/rmybackup/config_file.txt
 - lib/rmybackup/install_config.rb
 - lib/rmybackup/purge_files.rb
+- lib/rmybackup/push.rb
+- lib/rmybackup.rb
 - bin/rmybackup
 has_rdoc: true
 homepage: http://github.com/bshelton229/rmybackup/
@@ -60,16 +76,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: