shexy 0.2 → 0.3

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 0.3
+
+* Bug fixes
+* Shexy should be thread safe now
+* Added some more methods (see README)
+  - Shexy.permit_root_login
+  - Shexy.copy_ssh_pubkey
+  - Shexy.batch
+

data/README.md

@@ -26,10 +26,48 @@ and added them to the SSH agent (ssh-add ~/.ssh/my-priv-key):
     end
     Shexy.exe 'echo hello' # no need to add host/user again
 
+
+Specify key to use:
+
+    Shexy.key = '~/.ssh/id_rsa'
+    out, err, exit_code = Shexy.exe 'test@test-host', 'ls -la'
+
 Copying files (local -> remote):
 
     Shexy.copy_to 'test@test-host', '/home/rubiojr/my-uber-file', '/tmp/'
 
+Batch mode:
+
+    Shexy.batch do
+      script <<-EOH
+        echo > /tmp/foo
+        ls -la
+        sed -i s/foo/bar/ /etc/foo
+      EOH
+    end
+
+Use sudo:
+
+     Shexy.use_sudo
+     # sudo will be used to run the commands
+     Shexy.exe 'test@foobar.com', 'echo | cat' # => sudo echo | sudo cat
+
+Query the server OS:
+
+     Shexy.distro          # => :ubuntu, :redhat, :centos, :fedora, :debian
+     Shexy.distro_release  # => 12.04, 5.8, etc.
+
+More helpers:
+
+     Shexy.user = 'rubiojr'
+     Shexy.password = 'secret'
+     Shexy.host = 'foo.com'
+     # Copy the key to /home/rubiojr/.ssh/authorized_keys in remote server
+     Shexy.copy_ssh_pubkey '~/.ssh/id_rsa.pub'
+     # Set PermitRootLogin to without-password in /etc/ssh/sshd_config
+     # requires sudo in remote server (unless using root user).
+     Shexy.permit_root_login 'without-password'
+
 ## Caution
 
 I was bored writing net-ssh boilerplate, so I created this highly 

data/lib/shexy.rb

@@ -30,40 +30,76 @@ require 'net/scp'
 #
 #     Shexy.copy_to 'test@test-host', '/home/rubiojr/my-uber-file', '/tmp/'
 #
+
 module Shexy
+    
+  VERSION = '0.3'
 
-  VERSION = '0.2'
+  [:user, :password, :key, :cmd, :host].each do |n|
+    instance_eval %{
+      def #{n}; Thread.current[:shexy_#{n}]; end
+      def #{n}=(v); Thread.current[:shexy_#{n}] = v; end
+    }
+  end
 
-  @flags = {}
+  def self.flags=(f);Thread.current[:shexy_flags] = f;end
+  def self.flags; Thread.current[:shexy_flags] ||= {} ; end
+  def self.sudo?;Thread.current[:shexy_use_sudo]; end
+  def self.use_sudo(v = true); Thread.current[:shexy_use_sudo] = v; end
 
-  def self.password=(password); flags[:password] = password; end
-  def self.password; flags[:password]; end
-  def self.key=(key); flags[:keys] = [File.expand_path(key)]; end
-  def self.key; flags[:keys]; end
-  def self.use_sudo(v=true); @sudo = v; end
-  def self.sudo?; @sudo ||= false; end
+  def self.wait_for_ssh(timeout = 60)
+    Timeout.timeout(timeout) do
+      begin
+        sleep(1) until tcp_test_ssh(host) do
+        end
+      rescue Errno::ECONNRESET
+        # safe to ignore, we need to retry all the time.
+      end
+    end
+    true
+  rescue Exception => e
+    $stderr.puts e.message
+    false
+  end
 
-  class << self
-    attr_accessor :host, :user, :flags
-    attr_reader :cmd
+  def self.tcp_test_ssh
+    tcp_socket = TCPSocket.new(host, 22)
+    readable = IO.select([tcp_socket], nil, nil, 5)
+    if readable
+      yield
+      true
+    else
+      false
+    end
+  rescue Errno::ETIMEDOUT, Errno::EPERM
+    false
+  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ENETUNREACH
+    sleep 2
+    false
+  ensure
+    tcp_socket && tcp_socket.close
   end
 
   def self.exe(*args)
     args.flatten!
     if args.size > 1
-      @host = args[0]
-      if @host =~ /@/
-        @user, @host = @host.split '@'
-      end
-      @cmd = args[1]
+      self.host = args[0]
+      self.user, self.host = self.host.split '@' if self.host =~ /@/
+      self.cmd = args[1]
     else
-      @cmd = args[0]
+      self.cmd = args[0]
     end
-    Net::SSH.start(host, user, flags) do |sh|
+    self.flags[:password] = self.password if self.password
+    self.flags[:keys] = [self.key] if self.key
+    Net::SSH.start(self.host, self.user, self.flags) do |sh|
       sh.open_channel do |ch| 
         if sudo?
           ch.request_pty 
-          @cmd = "sudo #{@cmd}"
+          if cmd =~ /(&&|\|\||&|\|)/
+            self.cmd = cmd.gsub(/(&&|\|\||&|\|)/, $1 + 'sudo')
+          end
+          self.cmd = "sudo #{cmd}"
+          puts "SHEXY: #{cmd}" if $DEBUG
         end
         ch.exec cmd do
           # FIXME: I don't think it's a good idea
@@ -95,6 +131,25 @@ module Shexy
     end
   end
 
+  def self.batch(&block)
+    require 'tempfile'
+    out, err = nil,nil
+    def self.script(script)
+      f = Tempfile.new 'shexy'
+      begin
+        f.puts script 
+        f.flush
+        copy_to f.path, "#{f.path}.remote"
+        out, err = exe "/bin/bash #{f.path}.remote" 
+      ensure
+        f.close
+        f.unlink
+      end
+      return out, err
+    end
+    instance_eval &block
+  end
+
   #
   # Shexy.copy_to 'root@foobar.com', 'source_file', 'dest_file'
   #
@@ -113,9 +168,9 @@ module Shexy
     
     if args.size > 2
       # First arg assumed to be foo@host.net
-      @host = args[0]
-      if @host =~ /@/
-        @user, @host = @host.split '@'
+      self.host = args[0]
+      if self.host =~ /@/
+        self.user, self.host = self.host.split '@'
       end
       from = args[1]
       to = args[2]
@@ -125,6 +180,7 @@ module Shexy
       from = args[0]
       to = args[1]
     end
+    self.flags[:password] = self.password if self.password
     from = File.expand_path from
     Net::SCP.start(host, user, flags) do |scp|
       scp.upload! from, to, opts
@@ -165,4 +221,38 @@ module Shexy
     issue
   end
 
+  def self.copy_ssh_pubkey(path, dest_dir = '~/.ssh')
+    path = File.expand_path path
+    raise ArgumentError.new("Invalid key file") unless File.exist?(path)
+    key = File.read path
+    batch do
+      script <<-EOH
+      mkdir -p #{dest_dir} && chmod 700 #{dest_dir}
+      echo '#{key}' >> #{dest_dir}/authorized_keys
+      EOH
+    end
+  end
+
+  #
+  # Set PermitRootLogin to value in /etc/ssh/sshd_config
+  # value accepted: yes,now, without-password
+  #
+  def self.permit_root_login(value)
+    value = value.to_s
+    unless value =~ /^(yes|no|without-password)$/
+      raise ArgumentError.new "Argument should be yes|no|without-password"
+    end
+    using_sudo = Shexy.sudo?
+    Shexy.use_sudo 
+    out, err = batch do
+      script <<-EOH
+      sed -i 's/^#\?PermitRootLogin.*$/PermitRootLogin\ #{value}/' /etc/ssh/sshd_config
+      test -f /etc/init.d/ssh && /etc/init.d/ssh restart
+      test -f /etc/init.d/sshd && /etc/init.d/sshd restart
+      EOH
+    end
+    Shexy.use_sudo(false) unless using_sudo
+    return out, err
+  end
+
 end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$: << File.join(File.dirname(__FILE__), '../lib')
+require 'shexy'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shexy
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -132,13 +132,13 @@ extra_rdoc_files:
 - README.md
 files:
 - .document
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/shexy.rb
-- test/helper.rb
-- test/test_shexy.rb
+- spec/spec_helper.rb
 homepage: http://github.com/rubiojr/shexy
 licenses:
 - MIT
@@ -154,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2098135952916495063
+      hash: 130145655460833176
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'shexy'
-
-class Test::Unit::TestCase
-end

data/test/test_shexy.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestShexy < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end