omniscient 0.0.1 → 0.0.2

data/Gemfile

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

data/README.markdown

@@ -8,14 +8,18 @@ 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
+In your console:
+
+$ gem install omniscient
+
+Then, 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
+A setup will begin. The configuration will be saved to ~/.omni_config.yml.
 
-Now that Omniscient knows where to connect, run the following command again
+Now that Omniscient knows where to connect, run the following command again:
 
 $ omniscient clone aliasname
 

data/bin/omniscient

@@ -11,10 +11,11 @@ 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
+else
+  command_obj = Omniscient::Command::Run.new(ARGV)
 end

data/lib/omniscient/adapters/mysql.rb

@@ -19,16 +19,22 @@ module Omniscient
           nil
         end
       end
-   
+    
+      def valid_configuration?
+        return false unless database && user
+        true
+      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 << ' '+self.database unless self.database.nil?
         str
       end
       
       def dump
+        return false unless valid_configuration?
         str = 'mysqldump'
         str << access_statements
         str << ' '+self.table unless self.database.nil? || self.table.nil?
@@ -38,6 +44,7 @@ module Omniscient
       end
       
       def import
+        return false unless valid_configuration?
         str = 'mysql'
         str << access_statements
         str << ' < '+Omniscient::DUMP_LOCAL_PATH

data/lib/omniscient/command.rb

@@ -1,28 +1,63 @@
+require "version"
+require "configuration"
+
 module Omniscient
 
   module Command
-
+    
     class Run
+
+      attr_accessor :argv, :configurations
+
       def initialize argv = ''
         @argv = argv
         
-        @configurations = Omniscient::Configuration.new
+        @configurations = Omniscient::Configuration.load
         
-        if Shell::Parser.is_option "help", argv
+        unless (["h", "help"] & Shell::Parser.get_options(argv)).empty?
           help if self.respond_to?('help')
           exit
         end
+        unless (["v", "version"] & Shell::Parser.get_options(argv)).empty?
+          version if self.respond_to?('version')
+          exit
+        end
 
-        if( self.respond_to?('run') )
-          run
-        elsif( self.respond_to?('help') )
+        if self.respond_to?('run')
+          run unless defined? TESTING
+        elsif self.respond_to?('help')
           help
         end
-        
       end
       
       def request_configuration
-        @configurations.configuration @configurations.questions(:alias_name => @alias_name)
+        @configurations = Omniscient::Configuration::questions(:alias_name => @alias_name)
+      end
+      
+      def help
+        print "Usage:\n"
+        print "\s\somniscient COMMAND [options]"
+        print "\n\n"
+        print "Commands available:"
+        print "\n"
+        print "\s\sclone\t\tClones a database from a remote server"
+        print "\n\n"
+        print "Examples:"
+        print "\n"
+        print "\s\somniscient clone alias_server_name"
+        print "\n"
+        print "\tClones a database from a remote server. If \n"
+        print "\talias_server_name is unknown to Ominiscient, \n"
+        print "\tit'll ask you all connection information."
+        print "\n\n"
+        print "For more information, try:\n"
+        print "\s\somniscient COMMAND -h"
+        print "\n"
+      end
+      
+      def version
+        print "Omniscient v" + Omniscient::VERSION
+        print "\n"
       end
       
     end

data/lib/omniscient/command/clone.rb

@@ -1,29 +1,23 @@
 require 'yaml'
+require 'ssh'
+require 'scp'
+require 'adapters/mysql'
 
 module Omniscient
-  
   module Command
-
     class Clone < Omniscient::Command::Run
-
+      
+      attr_accessor :ssh, :scp, :mysql, :alias_name
+      
       def run
- 
         @alias_name = Shell::Parser.get_arguments(@argv).first || ""
         
-        has_conf = load_configuration_by_alias(@alias_name)
-        unless has_conf
-          request_configuration
-        end
+        (help; exit) if @alias_name.empty?
         
-        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'])
+        request_configuration unless configurations_exist? @alias_name
+        load_configurations
+        set_custom_variables
+        instantiate_adapters
 
         # Dumps remotely
         command_to_issue = "#{@ssh.connect} '#{@mysql.dump}'"
@@ -39,26 +33,38 @@ module Omniscient
         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
+      
+      def configurations_exist? alias_name
+        Omniscient::Configuration::load alias_name
+      end
+      
+      def set_custom_variables argv = false
+        database = Shell::Parser.get_option_value('d', (argv || @argv)) || nil
+        @configurations['mysql']['database'] = database unless database.empty?
 
+        address = Shell::Parser.get_option_value('host', (argv || @argv)) || nil
+        @configurations['ssh']['address'] = address unless address.empty?
+      end
+      
+      def instantiate_adapters
+        @ssh = Omniscient::Ssh.new @configurations['ssh']
+        @scp = Omniscient::Scp.new @configurations['ssh']
+        @mysql = Omniscient::Adapter::MySQL.new @configurations['mysql']
+      end
+      
+      def load_configurations alias_name = false
+        @configurations = Omniscient::Configuration.load(alias_name || @alias_name)
       end
         
       def help
-        puts 'Help is missing.'
+        print "Usage:\n"
+        print "\s\somniscient clone ALIAS_NAME [options]"
+        print "\n\n"
+        print "Options:"
+        print "\n"
+        print "\s\s-d\t\tSelect a different database\n"
+        print "\s\s--host\tSelect a different SSH address, e.g. foo@192.168.0.1\n"
       end
       
     end

data/lib/omniscient/configuration.rb

@@ -2,19 +2,32 @@ require 'yaml'
 
 module Omniscient
   class Configuration
-    def initialize( conf = {} )
-      @configuration = conf
+    
+    @PATH = File.expand_path('~/.omniscient_conf.yml')
+    @configuration = {}
+    
+    class << self
+      attr_accessor :PATH, :configuration
     end
     
-    def method_missing( name, *args, &block )
-      if args.empty? && block.nil? && @attributes.has_key?(name)
-        @attributes[name.to_sym]
+    def self.load alias_name = false
+      return false unless File.exist? @PATH
+      
+      config_file = File.new @PATH, 'r'
+      existing_configurations = YAML::load config_file.read
+      if existing_configurations.kind_of? Hash
+        @configuration = existing_configurations
+        if alias_name
+          return @configuration[alias_name.to_s] unless @configuration[alias_name.to_s].nil?
+          return false
+        end
+        @configuration
       else
-        nil
+        false
       end
     end
     
-    def questions informations
+    def self.questions informations
       
       custom_alias = informations[:alias_name].nil? ? nil : informations[:alias_name]
 
@@ -49,10 +62,15 @@ module Omniscient
       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"
+        begin
+          system "stty -echo"
+          print "Database's password [leave it blank if none is needed]: "
+          mysql_password = Shell::Input.text
+          system "stty echo"
+        rescue NoMethodError, Interrupt
+            system "stty echo"
+            exit
+        end
         print "\n"
         @configuration[custom_alias]['mysql']['password'] = mysql_password.empty? ? '' : mysql_password
       end

data/lib/omniscient/version.rb

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

data/lib/shell/shell.rb

@@ -76,9 +76,10 @@ module Shell
       
     end # get_command
     
-    # get only options in ARGV (arguments starting with _ or __)
-    def self.get_options argv
-      @options = Array.new
+    # get only options in ARGV (arguments starting with - or --)
+    def self.get_options argv = []
+      return [] if argv.empty?
+      @options = []
       
       argv.each {
         |e|
@@ -92,7 +93,7 @@ module Shell
       @options
     end # get_options
     
-    def self.get_option_value option, argv = Array.new
+    def self.get_option_value option, argv = []
       next_item, option_value = false
       argv.each { |e|
         if next_item

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

@@ -1,6 +1,5 @@
 require "test/unit"
-require "omniscient"
-require "adapters/mysql"
+require "omniscient/adapters/mysql"
 
 class MySQLTest < Test::Unit::TestCase
   
@@ -18,20 +17,42 @@ class MySQLTest < Test::Unit::TestCase
   def test_initialization
     assert_equal 'omniscient', @mysql.database
     assert_equal 'root', @mysql.user
+    assert_equal 'pw', @mysql.password
+  end
+
+  def test_valid_configuration?
+    @mysql = Omniscient::Adapter::MySQL.new( :database => 'omniscient', :user => 'root', :password => 'pw' )
+    assert @mysql.valid_configuration?
+    @mysql = Omniscient::Adapter::MySQL.new( :database => 'omniscient', :user => 'root' )
+    assert @mysql.valid_configuration?
+    @mysql = Omniscient::Adapter::MySQL.new( :user => 'root', :password => 'pw' )
+    assert !@mysql.valid_configuration?
   end
   
   def test_dump
     assert_equal %Q{mysqldump -u root -ppw omniscient --single-transaction > .omni_dump.sql}, @mysql.dump()
   end
 
+  def test_dump_if_not_valid_configuration
+    @mysql = Omniscient::Adapter::MySQL.new( :user => 'root', :password => 'pw' )
+    assert !@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
+  def test_importation
     assert_equal %Q{mysql -u root -ppw omniscient < }+Omniscient::DUMP_LOCAL_PATH, @mysql.import()
   end
 
+  def test_importation_if_not_valid_configuration
+    @mysql = Omniscient::Adapter::MySQL.new( :user => 'root', :password => 'pw' )
+    assert !@mysql.import()
+    @mysql = Omniscient::Adapter::MySQL.new( :database => 'anydb' )
+    assert !@mysql.import()
+  end
+
 
 end

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

@@ -1,13 +1,43 @@
 require "test/unit"
+require File.expand_path("../../../../set_test_environment.rb", __FILE__)
 require "omniscient"
 require "command/clone"
 
 class CloneTest < Test::Unit::TestCase
   def setup
-
+    test_path = File.expand_path("../../../../resources/configurations/omniscient_conf.yml", __FILE__)
+    Omniscient::Configuration.PATH = test_path
+    @obj = Omniscient::Command::Clone.new
+    @obj.configurations = Omniscient::Configuration.load :foo
+    @obj.alias_name = "foo"
   end
    
-  def test_start
+  def test_has_conf
+    assert @obj.configurations_exist? :foo
+  end
+  
+  def test_load_configurations
+    assert @obj.load_configurations.kind_of? Hash
+    assert @obj.load_configurations.has_key? "ssh"
+    assert @obj.configurations.has_key? "ssh"
+  end
+  
+  def test_set_custom_database
+    assert_equal @obj.configurations['mysql']['database'], "foo"
+    @obj.set_custom_variables ["-d", "custom_database"]
+    assert_equal @obj.configurations['mysql']['database'], "custom_database"
+  end
 
+  def test_set_custom_address
+    assert_equal @obj.configurations['ssh']['address'], "foo@192.168.0.100"
+    @obj.set_custom_variables ["--host", "custom_address"]
+    assert_equal "custom_address", @obj.configurations['ssh']['address']
+  end
+  
+  def test_instantiate_adapters
+    @obj.instantiate_adapters
+    assert @obj.ssh.kind_of? Omniscient::Ssh
+    assert @obj.scp.kind_of? Omniscient::Scp
+    assert @obj.mysql.kind_of? Omniscient::Adapter::MySQL
   end
 end

data/test/lib/omniscient/test_configuration.rb

@@ -0,0 +1,47 @@
+require "test/unit"
+require "omniscient"
+require "configuration"
+
+class ConfigurationTest < Test::Unit::TestCase
+  
+  def setup
+    @right_path = File.expand_path('~/.omniscient_conf.yml')
+    @test_path = File.expand_path("../../../resources/configurations/omniscient_conf.yml", __FILE__)
+  end
+
+  def test_right_path
+    Omniscient::Configuration.PATH = @right_path
+    assert_equal @right_path, Omniscient::Configuration.PATH
+  end
+  
+  def test_change_path
+    Omniscient::Configuration.PATH = @test_path
+    assert_equal Omniscient::Configuration.PATH, @test_path
+    Omniscient::Configuration.PATH = @right_path
+    assert_equal Omniscient::Configuration.PATH, @right_path
+  end
+  
+  def test_load_configuration
+    original_path = Omniscient::Configuration.PATH
+    Omniscient::Configuration.PATH = @test_path
+    conf = Omniscient::Configuration::load
+    assert conf.kind_of? Hash
+    assert conf["foo"]["ssh"]["address"] == "foo@192.168.0.100"
+    assert Omniscient::Configuration.configuration.kind_of? Hash
+    assert Omniscient::Configuration.configuration["foo"]["ssh"]["address"] == "foo@192.168.0.100"
+    conf = Omniscient::Configuration::load "foo"
+    assert conf.kind_of? Hash
+    assert conf["ssh"]["address"] == "foo@192.168.0.100"
+    conf = Omniscient::Configuration::load :foo
+    assert conf.kind_of? Hash
+    assert conf["ssh"]["address"] == "foo@192.168.0.100"
+
+    # inexistent key
+    conf = Omniscient::Configuration::load :lolwut
+    assert conf.kind_of? FalseClass
+    assert !conf
+
+    Omniscient::Configuration.PATH = original_path
+  end
+  
+end

data/test/lib/omniscient/test_ssh.rb

@@ -15,14 +15,18 @@ class SshTest < Test::Unit::TestCase
   def test_initialization
     assert_equal 'user@localhost', @ssh.address
   end
+  
+  def test_invalid_initialization
+    @ssh = Omniscient::Ssh.new :address => 'user@localhost'
+  end
    
   def test_address
-    assert_equal 'user@localhost', @ssh.get_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()
+    assert_equal 'localhost', @ssh.get_address
   end
 
   def test_address_with_port

data/test/resources/configurations/omniscient_conf.yml

@@ -0,0 +1,17 @@
+--- 
+foo: 
+  ssh: 
+    address: foo@192.168.0.100
+    port: false
+  mysql: 
+    user: root
+    password: 
+    database: foo
+bar:
+  ssh: 
+    address: bar@192.168.0.101
+    port: 22
+  mysql: 
+    user: root
+    password: ""
+    database: bar

data/test/set_test_environment.rb

@@ -0,0 +1 @@
+TESTING = true

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alexandre de Oliveira
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 -03:00
+date: 2011-05-18 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -47,8 +47,11 @@ 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_configuration.rb
 - test/lib/omniscient/test_connection.rb
 - test/lib/omniscient/test_ssh.rb
+- test/resources/configurations/omniscient_conf.yml
+- test/set_test_environment.rb
 has_rdoc: true
 homepage: http://github.com/kurko/omniscient
 licenses: []
@@ -85,5 +88,8 @@ 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_configuration.rb
 - test/lib/omniscient/test_connection.rb
 - test/lib/omniscient/test_ssh.rb
+- test/resources/configurations/omniscient_conf.yml
+- test/set_test_environment.rb