remote_executor 0.3.0 → 0.4.0

data/README.rdoc

@@ -2,6 +2,7 @@
 
 A simplistic remote command launcher over SSH conections
 
+
 == Installing
     
 The latest stable version is published in gemcutter.
@@ -9,20 +10,31 @@ 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 
+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'
+      :environment: 'production'
+      :user: admin
+      :hosts: 
+        - 'myHost1'
+        - 'myHost2'
+        - 'myHost3'
+        - 'myHost4'
+    - :name: 'myFarm'
+      :environment: 'production'
+      :user: admin
       :hosts: 
         - 'myHost1'
         - 'myHost2'
@@ -46,6 +58,7 @@ you need this minimal SSH configuration (${HOME}/.ssh/config) for the example
 with this line: 
 
   remote_executor --system=myFarm --environment=production --command='hostname'
+
   
 === Configuration
 
@@ -54,13 +67,35 @@ 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 this stuff in english... I promise
-* Write some test could be a gread idea xD
+* Write some test could be a gread idea
+* Take decisions about user by hosts or user by farm
 * Pullrequests are welcome... of course
+
   
 == License
 
-Copyright © 2007-2010 Javier Juarez, released under the MIT license.
+Copyright (c) 2010-2030 Javier Juarez Martinezi
+
+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/lib/remote_executor/cli.rb

@@ -4,19 +4,21 @@ module RemoteExecutor
   end
   
   class Cli
-    
-    def self.execute( name, environment, command )
 
-      system_target = SystemConfig.instance.find_system( name )
+    DEFAULT_SSH_OPTIONS = { :config=>true }
+        
+    def self.execute( name, environment, command, ssh_options=DEFAULT_SSH_OPTIONS )
+
+      system = System.new( SystemConfig.instance.find_system( name ) )
       
-      if( system_target[:environment].to_sym == environment.to_sym )
+      if( system.environment == environment )
         
-        system_target[:hosts].each do |host|
+        system.hosts.each do |host|
         
-          Net::SSH.start( host, system_target[:user], :config=>true ) { |ssh_session| ssh_session.exec( "#{command}" ) }
+          Net::SSH.start( host, system.user, ssh_options ) { |ssh| ssh.exec( "#{command}" ) }
         end
       else
-        raise BadEnvironment.new( "Bad environment..." )
+        raise BadEnvironment.new( "Bad environment: '#{system.environment}' for target: '#{system.name}'..." )
       end
     end
   end

data/lib/remote_executor/config.rb

@@ -9,15 +9,20 @@ module RemoteExecutor
     # Get the default configuration over Choice, environment and user default settings
     def self.get_config_file( config_key )
       
-      return Choice.choices[:config] if Choice.choices[:config]
+      if( Choice.choices[:config] )
+        return Choice.choices[:config] 
+      end
       
-      environment_var = ENV["#{config_key.upcase}"]
-      return environment_var if environment_var
+      if( environment_var = ENV["#{config_key.upcase}"] )
+        return environment_var
+      end
       
-      default_user_config_file = "#{ENV['HOME']}/.#{config_key.downcase}rc"
-      return default_user_config_file if File.exist?( default_user_config_file )
+      if( user_config_file = File.join( "#{ENV['HOME']}", ".#{config_key.downcase}rc" ) )
+        
+        return user_config_file if File.exist?( user_config_file )
+      end
       
-      raise YAMLFileNotFound.new( "Configuration file not found" )
+      raise YAMLFileNotFound.new( "Configuration not found" )
     end
     
     def initialize()

data/lib/remote_executor/system.rb

@@ -0,0 +1,22 @@
+module RemoteExecutor
+  
+  class System < Struct.new( :name, :environment, :user, :hosts )
+    
+    public
+    def initialize( params )
+      
+      unless params && params.class == Hash
+        fail "Bad parameters"
+      end
+      
+      if( params[:name]  &&
+          params[:environment]  &&
+          params[:user] &&
+          params[:hosts]  )
+          
+        super( params[:name], params[:environment], params[:user], params[:hosts] )         
+        self
+      end
+    end
+  end
+end

data/lib/remote_executor/system_config.rb

@@ -8,21 +8,9 @@ module RemoteExecutor
 
     def find_system( system_name )
       
-      @config.each { |s| return s if( s[:name] == system_name) }
+      @config.each { |system| return system if( system[:name] == system_name ) }
       
-      raise ConfigurationError.new( "System #{system_name} not found" )
+      raise ConfigurationError.new( "System: '#{system_name}' not found in #{@config.inspect}" )
     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 = 3 
+    MINOR = 4 
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH ].compact.join( '.' )

data/lib/remote_executor.rb

@@ -7,7 +7,7 @@ end
 $:.unshift File.join( File.dirname( __FILE__), 'remote_executor' )
 
 begin
-  %w[version config system_config options_parser cli].each { |lib| require lib }
+  %w[version config system_config system options_parser cli].each { |lib| require lib }
 rescue LoadError => e
   fail "Some lib dependencies can not be loaded: #{e.message}" 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: remote_executor
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.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.rb
 - lib/remote_executor/system_config.rb
 - lib/remote_executor/version.rb
 - README.rdoc