christianhellsten-mysql-backup 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-05-02
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/mysql_backup
+bin/mysql_backup_install
+lib/mysql_backup.rb
+lib/mysql_backup/install.rb
+lib/mysql_backup/pty.rb
+lib/mysql_backup/backup.rb
+lib/mysql_backup/options.rb
+lib/mysql_backup/mysql_backup.yml.example
+test/test_mysql_backup.rb

data/README.txt

@@ -0,0 +1,48 @@
+= blah
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/mysql_backup.rb'
+
+Hoe.new('MysqlBackup', MysqlBackup::VERSION) do |p|
+  # p.rubyforge_name = 'MysqlBackupx' # if different than lowercase project name
+  p.developer('Christian Hellsten', 'christian@aktagon.com')
+end
+
+task :cultivate do
+  system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
+  system "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+end
+
+# vim: syntax=Ruby

data/bin/mysql_backup

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'mysql_backup'
+
+MysqlBackup.run

data/bin/mysql_backup_install

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'mysql_backup'
+
+MysqlBackup.install
+

data/lib/mysql_backup.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'sequel'
+require 'expect'
+require 'pty'
+require 'pp'
+
+class MysqlBackup
+  VERSION = '1.1.0'
+end
+
+['install', 'pty', 'options', 'backup'].each do |file|
+  require File.dirname(__FILE__) + "/mysql_backup/#{file}"
+end
+
+if __FILE__ == $0
+  MysqlBackup.run
+end

data/lib/mysql_backup/backup.rb

@@ -0,0 +1,61 @@
+#require 'ruby-debug'
+
+class MysqlBackup
+  class << self
+
+    # TODO refactor, too long
+    def run
+      user      = options['user']
+      password  = options['password']
+      host      = options['host']
+      encoding  = options['encoding']
+      dir       = options['dir']
+      format    = options['format']
+      keep      = options['keep'] || 10
+      skip      = options['skip']
+      mysqldump_options = options['mysqldump']['options']
+      path      = options['mysqldump']['path']
+
+      timestamp = Time.now.strftime(format)
+
+      connection = Sequel.mysql nil, :user => user, :password => password, :host => host, :encoding => encoding
+
+      databases = []
+      connection['show databases'].each do |db|
+        databases << db[:Database]
+      end
+      databases = databases - skip #['mysql', 'test', 'information_schema']
+
+      databases.each do |db|
+        raise "The backup directory '#{dir}' doesn't exist" if !File.exist?(dir)
+
+        file = File.join(dir, "#{db}_#{timestamp}.sql")
+        p "Backing up #{db.ljust(40)} > #{file}"
+
+        cmd = "#{path}mysqldump -u#{user} -p#{password} -h#{host} #{mysqldump_options} #{db} --result-file=#{file}"
+        
+        result = exec_pty(cmd, password)
+
+        if options['gzip'] != false
+          `gzip -fq #{file}`
+        end
+    
+        # Find all backups and sort
+        all_backups = Dir.entries("#{dir}").select{|f| f =~ /^#{db}/}.select{|f| File.file? "#{File.join(dir, f)}" }.sort_by { |f| File.mtime("#{File.join(dir,f)}") }.reverse
+
+        #pp all_backups
+
+        keep = all_backups[0..keep] # eg. 10 latest
+
+        remove = all_backups - keep
+
+        remove.each do |file|
+          puts "Removing backup '#{file}' keeping #{keep}"
+          FileUtils.rm_rf(file)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/mysql_backup/install.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+
+class MysqlBackup
+  CONF_FILE = '/etc/mysql_backup'
+
+  class << self
+    def ask_for_options
+      require "highline/import"
+
+      puts <<-PROMPT
+
+      Please enter your MySQL username and password.
+
+      PROMPT
+
+      user     = ask("MySQL username   : ")
+      password = ask("MySQL password   : ") { |q| q.echo = false }
+      host     = ask("MySQL host       : ") { |q| q.default = 'localhost' }
+      dir      = ask("Backup directory : ") { |q| q.default = '/tmp' }
+
+      [user, password, host, dir]
+    end
+
+    def install
+      begin
+        if File.exist?(CONF_FILE)
+          puts <<-WARN
+
+          #{CONF_FILE} already exists. Remove it and try again.
+          
+          WARN
+
+          exit
+        end
+
+        user, password, host, dir = ask_for_options
+
+        File.open(CONF_FILE, 'w') do |file|
+          template = File.read(File.join(File.dirname(__FILE__), 'mysql_backup.yml.example'))
+          template.gsub!('USER', user)
+          template.gsub!('PASS', password)
+          template.gsub!('HOST', host)
+          template.gsub!('DIR', dir)
+          
+          file << template
+        end
+
+        FileUtils.chmod(750, CONF_FILE)
+
+        puts <<-ERR
+
+
+          Configuration file #{CONF_FILE} written.
+
+          You can now backup all databases by running the following command:
+
+            $ mysql_backup
+
+        ERR
+
+      rescue Errno::EACCES => e
+        puts <<-ERR
+
+          You need to run this command with sudo or as root.
+
+        ERR
+        exit
+      end
+    end
+  end
+end

data/lib/mysql_backup/mysql_backup.yml.example

@@ -0,0 +1,11 @@
+user: USER
+password: PASS
+host: HOST
+dir: DIR
+format: %d-%m-%y
+keep: 10
+
+mysqldump:
+  options: -Q -c -C --add-drop-table --add-locks --quick --lock-tables
+  path:
+skip: [mysql, test, information_schema]

data/lib/mysql_backup/pty.rb

@@ -0,0 +1,30 @@
+#
+# This errors means the directory doesn't exist or there's a problem with permissions:
+# /usr/local/lib/ruby/1.8/expect.rb:17:in `expect': undefined method `chr' for nil:NilClass (NoMethodError)
+#
+class MysqlBackup
+  class << self
+    def exec_pty(cmd, password)
+      #$expect_verbose = true 
+      password = '' if password.nil?
+
+      PTY.spawn(cmd) do |reader, writer, pid|
+        begin
+          reader.expect(/Enter password/, 1) do |line|
+            writer.puts password
+          end 
+        rescue
+          print reader.gets
+        end
+
+        begin
+          while line = reader.gets
+            # TODO detect errors we should act upon
+#            raise line if line.strip.length > 1
+          end
+        rescue Errno::EIO # EOF
+        end
+      end 
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: christianhellsten-mysql-backup
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Christian Hellsten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: mysql-backup is a command line tool that backups all MySQL database instances it can find on a server.
+email: 
+- christian@aktagon.com
+executables: 
+- mysql_backup
+- mysql_backup_install
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/mysql_backup
+- bin/mysql_backup_install
+- lib/mysql_backup.rb
+- lib/mysql_backup/install.rb
+- lib/mysql_backup/pty.rb
+- lib/mysql_backup/backup.rb
+- lib/mysql_backup/mysql_backup.yml.example
+- test/test_mysql_backup.rb
+has_rdoc: true
+homepage: http://aktagon.com/projects/ruby/mysql-backup
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: mysqlbackup
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: mysql-backup is a command line tool that backups all MySQL database instances it can find on a server.
+test_files: 
+- test/test_mysql_backup.rb