remote_executor 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,4 +1,6 @@
-= Remote Executor: A simplistic remote command launcher over SSH conections
+= Remote Executor: 
+
+A simplistic remote command launcher over SSH conections
 
 == Installing
     
@@ -7,18 +9,57 @@ The latest stable version is published in gemcutter.
   gem source --add http://gemcutter.org
   gem install remote_executor
 
-
 == Notes
 
 At the moment the gem have a strong dependency of your local SSH configuration, commonly located at ${HOME}/.ssh/config, this is only a 
 very simple mechanism for keep safe your private data, but this need a ugly configuration with a fake user name in the connection 
 process. I provide a basic SSH config if your aren´t familiar with this configuration stuff
 
+=== How to use
+
+An example may be the next. Launch the command 'hostname' over your production farm system named 'myFarm' configured in your home 
+directory into the file ${HOME}/.remoteexecutorrc like this:
+  
+  ---
+  :production:
+    - :name: 'myFarm'
+      :hosts: 
+        - 'myHost1'
+        - 'myHost2'
+        - 'myHost3'
+        - 'myHost4'
+
+you need this minimal SSH configuration (${HOME}/.ssh/config) for the example
+
+  Host myHost1
+    HostName myhost1.example.com
+  Host myHost2
+    HostName myhost2.example.com
+  Host myHost3
+    HostName myhost3.example.com
+  Host myHost4
+    HostName myhost4.example.com
+    
+  *.example.com
+    User admin
+  
+with this line: 
+
+  remote_executor --system=myFarm --environment=production --command='hostname'
+  
+=== Configuration
+
+The configuration for this gem is divided in 3 levels
 
+* Via --config command option
+* Via your shell environment with the variable REMOTEEXECUTOR (export REMOTEEXECUTOR="${HOME}/configs/remote_executor_settins.yml")
+* Via your user preferences located in the ${HOME}/.remoteexecutorrc file 
+   
 == TODO
 
-* Document all stuff in english... I promise ;)
-* Write some test...
+* Document all this stuff in english... I promise
+* Write some test could be a gread idea xD
+* Pullrequests are welcome... of course
   
 == License
 

data/bin/remote_executor

@@ -11,8 +11,8 @@ module CLIApplication
   
   def self.execute
     RemoteExecutor::Cli::execute( 
-      Choice.choices[:environment],
       Choice.choices[:system], 
+      Choice.choices[:environment],
       Choice.choices[:command]
     )
   end

data/lib/remote_executor.rb

@@ -1,13 +1,13 @@
 begin
   %w[rubygems yaml singleton choice net/ssh].each { |gem| require gem }
 rescue LoadError => e
-  fail "Some gem dependencies can´t be loaded: #{e.message}" 
+  fail "Some gem dependencies can not be loaded: #{e.message}" 
 end
 
 $:.unshift File.join( File.dirname( __FILE__), 'remote_executor' )
 
 begin
-  %w[version config options_parser cli].each { |lib| require lib }
+  %w[version config system_config options_parser cli].each { |lib| require lib }
 rescue LoadError => e
-  fail "Some lib dependencies can´t be loaded: #{e.message}" 
+  fail "Some lib dependencies can not be loaded: #{e.message}" 
 end

data/lib/remote_executor/cli.rb

@@ -1,13 +1,22 @@
 module RemoteExecutor
+  
+  class BadEnvironment < Exception
+  end
+  
   class Cli
     
-    def self.execute( environment, name, command )
-
-      Config.instance[environment].each do |system| 
+    def self.execute( name, environment, command )
 
-        if( system[:name] == name )          
-          system[:hosts].each { |host| Net::SSH.start( host, 'root', :config=>true ) { |ssh| ssh.exec "#{command}" } }
-        end 
+      system_target = SystemConfig.instance.find_system( name )
+      
+      if( system_target[:environment].to_sym == environment.to_sym )
+        
+        system_target[:hosts].each do |host|
+        
+          Net::SSH.start( host, system_target[:user], :config=>true ) { |ssh_session| ssh_session.exec( "#{command}" ) }
+        end
+      else
+        raise BadEnvironment.new( "Bad environment..." )
       end
     end
   end

data/lib/remote_executor/config.rb

@@ -1,9 +1,9 @@
 module RemoteExecutor
+  
   class YAMLFileNotFound < Exception
   end
   
   class Config
-    include Singleton
     
     ##
     # Get the default configuration over Choice, environment and user default settings
@@ -24,10 +24,6 @@ module RemoteExecutor
       @config = YAML.load_file( Config.get_config_file( CLIApplication::NAME ) )
     rescue Exception => e
       raise YAMLFileNotFound.new( e.message )
-    end
-    
-    def [](key)
-      @config[key.to_sym] if @config
-    end
+    end    
   end
 end

data/lib/remote_executor/system_config.rb

@@ -0,0 +1,28 @@
+module RemoteExecutor
+  
+  class ConfigurationError < Exception
+  end
+  
+  class SystemConfig < Config
+    include Singleton
+
+    def find_system( system_name )
+      
+      @config.each { |s| return s if( s[:name] == system_name) }
+      
+      raise ConfigurationError.new( "System #{system_name} not found" )
+    end
+    
+    def find_environment( system_name )
+      @config.each { |s| return s[:environment].to_sym if( s[:name] == system_name) }
+
+      raise ConfigurationError.new( "The system #{system_name} do not have declared environment" )
+    end
+    
+    def find_hosts( system_name )
+      @config.each { |s| return s[:hosts] if( s[:name] == system_name) }
+
+      raise ConfigurationError.new( "The system #{system_name} do not have host lists, WTF!!!" )
+    end      
+  end
+end

data/lib/remote_executor/version.rb

@@ -2,7 +2,7 @@ module RemoteExecutor
   module Version
 
     MAJOR = 0 
-    MINOR = 2 
+    MINOR = 3 
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH ].compact.join( '.' )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: remote_executor
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Javier Juarez
@@ -60,6 +60,7 @@ files:
 - lib/remote_executor/cli.rb
 - lib/remote_executor/config.rb
 - lib/remote_executor/options_parser.rb
+- lib/remote_executor/system_config.rb
 - lib/remote_executor/version.rb
 - README.rdoc
 has_rdoc: true