omniscient 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dbme.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,34 @@
+Omniscient is a gem that automatically dumps a MySQL database in a remote server
+via SSH, copies the dumped file to localhost via SCP and imports it, overwriting the local
+database (or table).
+
+It'll be very useful for those that are developing using more than one machine and
+don't want to dump and clone data manually all the time.
+
+Getting Started
+===============
+
+In your console, type the following, where aliasname is a name you choose
+(i.e. home_computer, work etc):
+
+$ omniscient clone aliasname
+
+A setup will begin. The data will be save to ~/.omni_config.yml
+
+Now that Omniscient knows where to connect, run the following command again
+
+$ omniscient clone aliasname
+
+You can clone a 'custom_dbname' database from that host.
+
+$ omniscient clone aliasname -d custom_dbname
+
+Troubleshoting
+==============
+
+Tested on Mac OS X.
+
+Credits
+=======
+
+Alexandre de Oliveira

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+# just 'rake test'
+Rake::TestTask.new do |t|
+#  t.libs << "lib"
+  t.test_files = Dir["test/**/test*.rb"]
+end

data/bin/omniscient

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib/', __FILE__)
+
+require "omniscient"
+require "command"
+require "shell/shell.rb"
+
+command = Shell::Parser::get_command ARGV
+
+unless command.empty? then
+  command_file = File.expand_path('../../lib/omniscient/command/'+command+'.rb', __FILE__)
+
+  # checks if class file exists
+  if File.exists? command_file then
+    require command_file
+    command = command.capitalize
+    command_obj = Omniscient::Command.const_get(command).new(ARGV)
+  end
+end

data/lib/omniscient.rb

@@ -0,0 +1,11 @@
+$:.unshift File.expand_path('../omniscient/', __FILE__)
+
+require 'configuration'
+require 'shell/shell'
+require 'command'
+
+module Omniscient
+  DUMP_FILENAME = '.omni_dump.sql'
+  DUMP_LOCAL_PATH = '~/'+DUMP_FILENAME
+  DUMP_REMOTE_PATH = DUMP_FILENAME
+end

data/lib/omniscient/adapters/mysql.rb

@@ -0,0 +1,48 @@
+module Omniscient
+  module Adapter
+    class MySQL
+      attr_accessor :attributes
+      def initialize( config )
+        @attributes = config
+      end
+    
+      def method_missing( name, *args, &block )
+        if args.empty? && block.nil? 
+          if @attributes.has_key?(name.to_s) 
+            @attributes[name.to_s]
+          elsif @attributes.has_key?(name.to_sym) 
+            @attributes[name.to_sym]
+          else
+            nil
+          end
+        else
+          nil
+        end
+      end
+   
+      def access_statements
+        str = ''
+        str << ' -u '+self.user unless self.user.nil?
+        str << ' '+self.database unless self.database.nil?
+        str << ' -p'+self.password unless self.password.empty?
+        str
+      end
+      
+      def dump
+        str = 'mysqldump'
+        str << access_statements
+        str << ' '+self.table unless self.database.nil? || self.table.nil?
+        str << ' --single-transaction'
+        str << ' > .omni_dump.sql'
+        str
+      end
+      
+      def import
+        str = 'mysql'
+        str << access_statements
+        str << ' < '+Omniscient::DUMP_LOCAL_PATH
+        str
+      end
+    end
+  end
+end

data/lib/omniscient/command.rb

@@ -0,0 +1,32 @@
+module Omniscient
+
+  module Command
+
+    class Run
+      def initialize argv = ''
+        @argv = argv
+        
+        @configurations = Omniscient::Configuration.new
+        
+        if Shell::Parser.is_option "help", argv
+          help if self.respond_to?('help')
+          exit
+        end
+
+        if( self.respond_to?('run') )
+          run
+        elsif( self.respond_to?('help') )
+          help
+        end
+        
+      end
+      
+      def request_configuration
+        @configurations.configuration @configurations.questions(:alias_name => @alias_name)
+      end
+      
+    end
+  
+  end
+
+end

data/lib/omniscient/command/clone.rb

@@ -0,0 +1,68 @@
+require 'yaml'
+
+module Omniscient
+  
+  module Command
+
+    class Clone < Omniscient::Command::Run
+
+      def run
+ 
+        @alias_name = Shell::Parser.get_arguments(@argv).first || ""
+        
+        has_conf = load_configuration_by_alias(@alias_name)
+        unless has_conf
+          request_configuration
+        end
+        
+        database = Shell::Parser.get_option_value('d', @argv) || nil
+        @configurations['mysql']['database'] = database unless database.empty?
+        
+        require 'ssh'
+        require 'scp'
+        require 'adapters/mysql'
+        @ssh = Omniscient::Ssh.new(@configurations['ssh'])
+        @scp = Omniscient::Scp.new(@configurations['ssh'])
+        @mysql = Omniscient::Adapter::MySQL.new(@configurations['mysql'])
+
+        # Dumps remotely
+        command_to_issue = "#{@ssh.connect} '#{@mysql.dump}'"
+        puts "Running => #{command_to_issue}"
+        exit unless system command_to_issue
+
+        # Copies dumped data
+        command_to_issue = "#{@scp.connect}:"+Omniscient::DUMP_REMOTE_PATH+" "+Omniscient::DUMP_LOCAL_PATH
+        puts "Running => #{command_to_issue}"
+        exit unless system command_to_issue
+        
+        # Imports data
+        command_to_issue = "#{@mysql.import}"
+        puts "Running => #{command_to_issue}"
+        exit unless system command_to_issue
+        
+      end
+   
+      def load_configuration_by_alias alias_name
+        return false unless alias_name
+        return false unless File.exist?(File.expand_path('~/.omniscient_conf.yml'))
+        
+        config_file = File.new(File.expand_path('~/.omniscient_conf.yml'), 'r')
+        existing_configurations = YAML::load(config_file.read)
+        if existing_configurations.kind_of?(Hash) && existing_configurations.has_key?(alias_name)
+          @configurations = existing_configurations[alias_name]
+          true
+        else
+          false
+        end
+
+      end
+        
+      def help
+        puts 'Help is missing.'
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/omniscient/configuration.rb

@@ -0,0 +1,83 @@
+require 'yaml'
+
+module Omniscient
+  class Configuration
+    def initialize( conf = {} )
+      @configuration = conf
+    end
+    
+    def method_missing( name, *args, &block )
+      if args.empty? && block.nil? && @attributes.has_key?(name)
+        @attributes[name.to_sym]
+      else
+        nil
+      end
+    end
+    
+    def questions informations
+      
+      custom_alias = informations[:alias_name].nil? ? nil : informations[:alias_name]
+
+      unless custom_alias.nil?
+        puts "No configuration found for #{custom_alias}. You need to setup a remote machine.\n"
+        @configuration = { custom_alias => {} }
+      else
+        puts "No configuration found. You need to setup a remote machine.\n"
+        print "Type an name for this remote machine [a word you want]: "
+        custom_alias = Shell::Input.text.downcase
+      end
+
+      @configuration = { custom_alias => {} }
+      @configuration[custom_alias]['ssh'] = {}
+      @configuration[custom_alias]['mysql'] = {}
+      
+      unless @configuration[custom_alias]['ssh'].has_key?('address')
+        print "SSH address [i.e. username@some_ip]: "
+        @configuration[custom_alias]['ssh']['address'] = Shell::Input.text
+      end
+
+      unless @configuration[custom_alias]['ssh'].has_key?('port')
+        print "SSH port [leave empty for default]: "
+        ssh_port = Shell::Input.text
+        @configuration[custom_alias]['ssh']['port'] = ssh_port.empty? ? 22 : ssh_port.empty?
+      end
+
+      unless @configuration[custom_alias]['mysql'].has_key?('user')
+        print "Database's username [default's 'root']: "
+        mysql_user = Shell::Input.text
+        @configuration[custom_alias]['mysql']['user'] = mysql_user.empty? ? 'root' : mysql_user
+      end
+
+      unless @configuration[custom_alias]['mysql'].has_key?('password')
+        system "stty -echo"
+        print "Database's password [leave it blank if none is needed]: "
+        mysql_password = Shell::Input.text
+        system "stty echo"
+        print "\n"
+        @configuration[custom_alias]['mysql']['password'] = mysql_password.empty? ? '' : mysql_password
+      end
+
+      unless @configuration[custom_alias]['mysql'].has_key?('database')
+        print "The default database name you will work with: "
+        mysql_db = Shell::Input.text
+        @configuration[custom_alias]['mysql']['database'] = mysql_db.empty? ? '' : mysql_db
+      end
+      
+      config_file = File.new(File.expand_path('~/.omniscient_conf.yml'), 'a+')
+      existing_configurations = YAML::load(config_file.read)
+      
+      if existing_configurations && existing_configurations.kind_of?(Hash)
+        @configuration = existing_configurations.merge(@configuration)
+      end
+      config_file.truncate(0)
+      config_file.puts YAML::dump(@configuration)
+      config_file.close
+      
+      puts "\nDone."
+      puts "Now, just type: omniscient clone #{custom_alias}"
+      exit
+      
+    end
+    
+  end
+end

data/lib/omniscient/connection.rb

@@ -0,0 +1,10 @@
+require 'configuration'
+require 'ssh'
+
+module Omniscient
+  class Connection
+    def initialize
+      @configuration = Omniscient::Configuration.new
+    end
+  end
+end

data/lib/omniscient/scp.rb

@@ -0,0 +1,33 @@
+module Omniscient
+  class Scp
+    
+    def initialize( config )
+      @attributes = config
+    end
+    
+    def method_missing( name, *args, &block )
+      if args.empty? && block.nil? 
+        if @attributes.has_key?(name.to_s) 
+          @attributes[name.to_s]
+        elsif @attributes.has_key?(name.to_sym) 
+          @attributes[name.to_sym]
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+    
+    def get_address
+      return false unless self.address
+      self.address
+    end
+    
+    def connect( custom_message = '' )
+      command = "scp "+self.get_address.to_s
+      command.to_s
+    end
+    
+  end
+end

data/lib/omniscient/ssh.rb

@@ -0,0 +1,34 @@
+module Omniscient
+  class Ssh
+    
+    def initialize( config )
+      @attributes = config
+    end
+    
+    def method_missing( name, *args, &block )
+      if args.empty? && block.nil? 
+        if @attributes.has_key?(name.to_s) 
+          @attributes[name.to_s]
+        elsif @attributes.has_key?(name.to_sym) 
+          @attributes[name.to_sym]
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+    
+    def get_address
+      return false unless self.address
+      self.address
+    end
+    
+    def connect( custom_message = '' )
+      command = "ssh "+self.get_address.to_s
+      command << " '"+custom_message+"'" unless custom_message.empty?
+      command.to_s
+    end
+    
+  end
+end

data/lib/omniscient/version.rb

@@ -0,0 +1,3 @@
+module Omniscient
+  VERSION = "0.0.1"
+end

data/lib/shell/shell.rb

@@ -0,0 +1,140 @@
+module Shell
+  
+  class Run
+    
+    # all arguments passed
+    @argv
+    
+    def initialize argv
+      @argv = argv
+      
+      @options = Shell::Parser.get_options @argv
+      @command = Shell::Parser.get_command @argv
+      @arguments = Shell::Parser.get_arguments @argv
+    end
+    
+  end
+  
+  class Input
+    
+    def self.text
+      begin
+        STDOUT.flush
+        STDIN.gets.strip
+      rescue
+      end
+    end
+    
+    def self.yesno message
+      STDOUT.flush
+      has_result = false
+      while has_result == false
+        print message.strip + " "
+        input = STDIN.gets.strip
+        
+        if input == "yes" or input == "y" then
+          final_input = "yes"
+        elsif input == "no" or input == "n" then
+          final_input = "no"
+        end
+        
+        if ( final_input == "yes" or final_input == "no" )
+          has_result = true
+        end
+      end
+      
+      if final_input == "yes"
+        result = true
+      else
+        result = false
+      end
+      result
+    end
+    
+  end
+  
+  class Parser
+    
+    # defines the command of the application (e.g. 'push' in uplift push)
+    def self.get_command argv = []
+      command = String.new
+      
+      argv.each {
+        |e|
+        e_length = e.length
+        if (e[0,2] != "--" and e[0,1] != "-") then
+            command = e
+            break
+        end
+      }
+      
+      if command.empty? then
+        command = ""
+      end
+      
+      command
+      
+    end # get_command
+    
+    # get only options in ARGV (arguments starting with _ or __)
+    def self.get_options argv
+      @options = Array.new
+      
+      argv.each {
+        |e|
+        e_length = e.length
+        if e[0,2] == "--" 
+          @options.push e[2,e_length]
+        elsif e[0,1] == "-"
+            @options.push e[1,e_length]
+        end
+      }
+      @options
+    end # get_options
+    
+    def self.get_option_value option, argv = Array.new
+      next_item, option_value = false
+      argv.each { |e|
+        if next_item
+          option_value = e
+          break
+        end
+        e_length = e.length
+        if e[0,2] == "--" 
+          next_item = true if e[2,e_length] == option
+        elsif e[0,1] == "-"
+          next_item = true if e[1,e_length] == option
+        end
+      }
+      option_value || ''
+    end
+    
+    # get arguments. arguments are anything written besides the command and options.
+    # in 'push today --list', 'today' is the argument
+    def self.get_arguments argv
+      @arguments = Array.new
+      i = 0
+      argv.each {
+        |e|
+        
+        i+= 1
+        next if i == 1
+        
+        e_length = e.length
+        if e[0,2] != "--" and e[0,1] != "-"
+          
+          @arguments.push e[0,e_length]
+        end
+        
+      }
+      @arguments
+    end # get_options
+    
+    def self.is_option option, argv = Array.new
+      argv_options = self.get_options argv
+      argv_options.include?(option)
+    end # is_option
+    
+  end
+  
+end

data/omniscient.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniscient/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniscient"
+  s.version     = Omniscient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alexandre de Oliveira"]
+  s.email       = ["chavedomundo@gmail.com"]
+  s.homepage    = "http://github.com/kurko/omniscient"
+  s.summary     = %q{Manage DBs from your local machine.}
+  s.description = %q{Clone DBs from one machine to another.}
+
+  s.rubyforge_project = "omniscient"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/lib/omniscient/adapters/test_mysql.rb

@@ -0,0 +1,37 @@
+require "test/unit"
+require "omniscient"
+require "adapters/mysql"
+
+class MySQLTest < Test::Unit::TestCase
+  
+  def tear_down
+    @mysql = nil
+  end
+  
+  def setup
+    @mysql = Omniscient::Adapter::MySQL.new(
+      :database => 'omniscient',
+      :user     => 'root',
+      :password => 'pw' )
+  end
+
+  def test_initialization
+    assert_equal 'omniscient', @mysql.database
+    assert_equal 'root', @mysql.user
+  end
+  
+  def test_dump
+    assert_equal %Q{mysqldump -u root -ppw omniscient --single-transaction > .omni_dump.sql}, @mysql.dump()
+  end
+
+  def test_dump_a_specific_table
+    @mysql.attributes[:table] = 'mytable'
+    assert_equal %Q{mysqldump -u root -ppw omniscient mytable --single-transaction > .omni_dump.sql}, @mysql.dump()
+  end
+
+  def test_import
+    assert_equal %Q{mysql -u root -ppw omniscient < }+Omniscient::DUMP_LOCAL_PATH, @mysql.import()
+  end
+
+
+end

data/test/lib/omniscient/command/test_clone.rb

@@ -0,0 +1,13 @@
+require "test/unit"
+require "omniscient"
+require "command/clone"
+
+class CloneTest < Test::Unit::TestCase
+  def setup
+
+  end
+   
+  def test_start
+
+  end
+end

data/test/lib/omniscient/test_command.rb

@@ -0,0 +1,18 @@
+require "test/unit"
+require "omniscient"
+
+class SshTest < Test::Unit::TestCase
+  
+  def tear_down
+    @command = nil
+  end
+  
+  def setup
+    @command = Omniscient::Command::Run.new
+  end
+
+  def test_initialization
+
+  end
+
+end

data/test/lib/omniscient/test_connection.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+require "omniscient"
+require "connection"
+
+class ConnectionTest < Test::Unit::TestCase
+  def setup
+    @conn = Omniscient::Connection.new
+  end
+end

data/test/lib/omniscient/test_ssh.rb

@@ -0,0 +1,37 @@
+require "test/unit"
+require "omniscient"
+require "ssh"
+
+class SshTest < Test::Unit::TestCase
+  
+  def tear_down
+    @ssh = nil
+  end
+  
+  def setup
+    @ssh = Omniscient::Ssh.new :address => 'user@localhost'
+  end
+
+  def test_initialization
+    assert_equal 'user@localhost', @ssh.address
+  end
+   
+  def test_address
+    assert_equal 'user@localhost', @ssh.get_address()
+  end
+
+  def test_address_without_user
+    @ssh = Omniscient::Ssh.new :address => 'localhost'
+    assert_equal 'localhost', @ssh.get_address()
+  end
+
+  def test_address_with_port
+    @ssh = Omniscient::Ssh.new :address => 'user@localhost', :port => '22'
+    # TODO
+  end
+
+  def test_address_with_port
+    assert_equal %q{ssh user@localhost 'custom message'}, @ssh.connect('custom message')
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: omniscient
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexandre de Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-06 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Clone DBs from one machine to another.
+email: 
+- chavedomundo@gmail.com
+executables: 
+- omniscient
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/omniscient
+- lib/omniscient.rb
+- lib/omniscient/adapters/mysql.rb
+- lib/omniscient/command.rb
+- lib/omniscient/command/clone.rb
+- lib/omniscient/configuration.rb
+- lib/omniscient/connection.rb
+- lib/omniscient/scp.rb
+- lib/omniscient/ssh.rb
+- lib/omniscient/version.rb
+- lib/shell/shell.rb
+- omniscient.gemspec
+- test/lib/omniscient/adapters/test_mysql.rb
+- test/lib/omniscient/command/test_clone.rb
+- test/lib/omniscient/test_command.rb
+- test/lib/omniscient/test_connection.rb
+- test/lib/omniscient/test_ssh.rb
+has_rdoc: true
+homepage: http://github.com/kurko/omniscient
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: omniscient
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Manage DBs from your local machine.
+test_files: 
+- test/lib/omniscient/adapters/test_mysql.rb
+- test/lib/omniscient/command/test_clone.rb
+- test/lib/omniscient/test_command.rb
+- test/lib/omniscient/test_connection.rb
+- test/lib/omniscient/test_ssh.rb