snatchdb 1.0.0

data/bin/snatch

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'rubygems'
+require 'yaml'
+require 'optparse'
+require 'snatch'
+
+SAMPLE_SCHEMA = <<END
+---
+host: YOUR_HOSTNAME
+user: YOUR_SSH_USER
+password: YOUR_SSH_PASSWORD
+db_user: MYSQL_USER
+db_password: MYSQL_PASSWORD
+db_list:
+- database1
+- database2
+END
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: snatch CONFIG.yml"
+  opts.on('-i', '--info', 'Display this information.') { puts opts ; exit }
+  opts.on('-v', '--version', 'Show version') { puts "Snatch v#{Snatch::VERSION}" ; exit }
+  opts.on('-n', '--new NAME', 'Create a new config file') do |name|
+    unless name =~ /^[a-z\d\_\-]{2,64}$/i
+      puts "Name should be in format: [A-Za-z0-9\-\_]{2,64}"
+      exit
+    end
+    
+    file = "#{Dir.pwd}/#{name}.yml"
+    if File.exists?(file)
+      puts "File already exists!" ; exit
+    end
+    
+    File.open(file, 'w') { |f| f.write(SAMPLE_SCHEMA) }
+    puts "File #{file} has been created. Edit and snatch!" ; exit
+  end
+end
+
+begin
+  optparse.parse!
+  
+  unless ARGV.empty?
+    file = File.expand_path(ARGV.shift)
+    unless File.exists?(file)
+      puts "File #{file} was not found!"
+      exit
+    end
+    
+    config = YAML.load_file(file)
+    config.symbolize!
+    Snatch.run(config)
+  else
+    puts optparse
+  end
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts optparse
+  exit
+rescue Interrupt
+  puts "Interrupted."
+rescue StandardError, Snatch::CredentialsError, Snatch::NoDatabaseError => ex
+  puts "ERROR: #{ex.message}"
+end

data/lib/snatch/handler.rb

@@ -0,0 +1,15 @@
+module Snatch
+  class TransferHandler
+    def on_open(downloader, file)
+      puts "ftp: downloading: #{file.remote} -> #{file.local}"
+    end
+
+    def on_close(downloader, file)
+      puts "ftp: finished downloading #{File.basename(file.remote)}"
+    end
+
+    def on_finish(downloader)
+      puts "ftp: file saved."
+    end
+  end
+end

data/lib/snatch/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def symbolize!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end

data/lib/snatch/session.rb

@@ -0,0 +1,90 @@
+module Snatch
+  class CredentialsError < Exception ; end
+  class NoDatabaseError < Exception ; end
+  
+  class Session
+    attr_reader :config, :filename
+    
+    def initialize(config)
+      @config = config
+      @ssh = nil
+      @filename = "#{@config[:host]}_#{Time.now.strftime("%Y%m%d%H%M%S")}.sql.gz"
+    end
+    
+    def run!
+      connect
+      test
+      dump
+      download
+      cleanup
+      disconnect
+    end
+    
+    private
+    
+    # Connect to remote server
+    def connect
+      puts "ssh: connecting..."
+      begin
+        @ssh = Net::SSH.start(@config[:host], @config[:user],:password => @config[:password])
+      rescue Net::SSH::AuthenticationFailed
+        raise CredentialsError, 'Invalid SSH user or password'
+      end
+      puts "ssh: connected."
+    end
+    
+    # Close ssh connection
+    def disconnect
+      @ssh.close
+      puts "ssh: disconnected."
+    end
+    
+    # Check configuration options
+    def test
+      resp = @ssh.exec!("mysql --execute='SHOW DATABASES;' --user=#{@config[:db_user]} --password=#{@config[:db_password]}")
+      if resp =~ /ERROR 1045/
+        raise CredentialsError, 'Invalid MySQL user or password'
+      end
+      
+      list = resp.split("\n").map { |s| s.strip }.select { |s| !s.empty? }.drop(1)
+      diff = @config[:db_list] - list
+      
+      unless diff.empty?
+        raise NoDatabaseError, "Database(s) not found: #{diff.join(', ')}"
+      end
+    end
+    
+    # Generate MySQL database dump
+    def dump
+      cmd = []
+      cmd << "--user=#{@config[:db_user]}"
+      cmd << "--password=#{@config[:db_password]}" unless @config[:db_password].strip.empty?
+      cmd << "--databases #{@config[:db_list].join(' ')}"
+      cmd << "--add-drop-database"
+      cmd << "--add-drop-table"
+      cmd << "--compact"
+      cmd = "mysqldump #{cmd.join(' ')} | gzip --best > /tmp/#{filename}"
+      
+      puts "mysql: creating a dump..."
+      @ssh.exec!(cmd)
+      puts "mysql: done."
+    end
+    
+    # Cleanup dump
+    def cleanup
+      @ssh.exec!("rm -f /tmp/#{filename}")
+    end
+    
+    # Fetch remote dump to local filesystem
+    def download
+      Net::SFTP.start(@config[:host], @config[:user], :password => @config[:password]) do |sftp|
+        t = sftp.download!(
+          "/tmp/#{filename}",                  # Remote file
+          "#{Dir.pwd}/#{filename}",            # Local file
+          :progress => TransferHandler.new     # Handler
+        )
+        t.wait
+      end
+    end
+  end
+end

data/lib/snatch/version.rb

@@ -0,0 +1,3 @@
+module Snatch
+  VERSION = '1.0.0'
+end

data/lib/snatch.rb

@@ -0,0 +1,14 @@
+require 'net/ssh'
+require 'net/sftp'
+
+require 'snatch/version'
+require 'snatch/hash'
+require 'snatch/handler'
+require 'snatch/session'
+
+module Snatch
+  def self.run(config)
+    s = Snatch::Session.new(config)
+    s.run!
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: snatchdb
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-09 00:00:00 -06:00
+default_executable: snatch
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 2
+        - 0
+        - 24
+        version: 2.0.24
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-sftp
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 0
+        - 5
+        version: 2.0.5
+  type: :runtime
+  version_requirements: *id002
+description: Remote database downloader
+email: dan.sosedoff@gmail.com
+executables: 
+- snatch
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/snatch
+- lib/snatch.rb
+- lib/snatch/version.rb
+- lib/snatch/hash.rb
+- lib/snatch/handler.rb
+- lib/snatch/session.rb
+has_rdoc: true
+homepage: http://github.com/sosedoff/snatch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Snatch is a remote database downloader via SSH protocol
+test_files: []
+