remote-session 0.0.1 → 0.0.2

data/README.md

@@ -17,7 +17,7 @@ remote-session [![Build Status](https://secure.travis-ci.org/joeyates/remote-ses
 
 Add this line to your application's Gemfile:
 
-    gem 'remote-session'
+    gem 'remote/session'
 
 And then execute:
 
@@ -30,7 +30,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require 'remote-session'
+require 'remote/session'
 
 r = Remote::Session.new( 'host.example.com' )
 puts r.run( 'pwd' )

data/lib/remote/session.rb

@@ -1,4 +1,5 @@
 require 'remote/session/version'
+require 'net/sftp'
 require 'net/ssh'
 
 module Remote
@@ -13,13 +14,24 @@ module Remote
       rs.close
     end
 
-    attr_accessor :host, :user, :password, :options
+    attr_accessor :host
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :port
+    attr_accessor :private_key
+    attr_accessor :prompts
+    attr_accessor :session
 
     def initialize( host, options = {} )
-      @host     = host
-      @options  = options.clone
-      @user     = @options.delete( :user ) || ENV[ 'USER' ]
-      @password = @options.delete( :password )
+      @session       = nil
+      @host          = host
+      @username      = options[ :username      ] || ENV[ 'USER' ]
+      @password      = options[ :password      ]
+      @port          = options[ :port          ]
+      @private_key   = options[ :private_key   ]
+      @prompts       = options[ :prompts       ] || {}
+      @sudo_password = options[ :sudo_password ]
+
       connect
     end
 
@@ -29,7 +41,7 @@ module Remote
       puts @session.exec!( command )
     end
 
-    def sudo( command, prompts = {} )
+    def sudo( command )
       raise "Session is closed" if @session.nil?
 
       puts "@#{ @host }: sudo #{ command }"
@@ -37,7 +49,7 @@ module Remote
         ch.request_pty do |ch, success|
           raise "Could not obtain pty" if ! success
 
-          channel_exec ch, command, prompts
+          channel_exec ch, command
         end
       end
       @session.loop
@@ -48,28 +60,50 @@ module Remote
       @session = nil
     end
 
+    def sudo_put( remote_path, &block )
+      temp_path = "/tmp/remote-session.#{ Time.now.to_f }"
+      run "mkdir #{ temp_path }"
+      run "chmod 0700 #{ temp_path }"
+
+      temp_file = File.join( temp_path, File.basename( remote_path ) )
+      put temp_file, &block
+
+      sudo "cp -f #{ temp_file } #{ remote_path }"
+      run "rm -rf #{ temp_path }"
+    end
+    
+    def put( remote_path, &block )
+      sftp = Net::SFTP::Session.new( @session ).connect!
+      sftp.file.open( remote_path, 'w' ) do |f|
+        f.puts block.call
+      end
+      sftp.close_channel
+    end
+
     private
 
     def ssh_options
       s = {}
-      s[ :password ] = @password if @password
+      s[ :password ] = @password        if @password
+      s[ :keys     ] = [ @private_key ] if @private_key
+      s[ :port     ] = @port            if @port
       s
     end
 
     def connect
-      @session = Net::SSH.start( @host, @user, ssh_options )
+      @session = Net::SSH.start( @host, @username, ssh_options )
     end
 
-    def channel_exec( ch, command, prompts )
+    def channel_exec( ch, command )
       ch.exec "sudo -p '#{ SUDO_PROMPT }' #{ command }" do |ch, success|
         raise "Could not execute sudo command: #{ command }" if ! success
 
         ch.on_data do | ch, data |
           if data =~ Regexp.new( SUDO_PROMPT )
-            ch.send_data "#{ @options[ :sudo_password ] }\n"
+            ch.send_data "#{ @sudo_password }\n"
           else
             prompt_matched = false
-            prompts.each_pair do | prompt, send |
+            @prompts.each_pair do | prompt, send |
               if data =~ Regexp.new( prompt )
                 ch.send_data "#{ send }\n"
                 prompt_matched = true

data/lib/remote/session/version.rb

@@ -1,5 +1,5 @@
 module Remote
   class Session
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/remote-session.gemspec

@@ -17,6 +17,7 @@ Run commands as the logged on user, or via sudo as any permitetd user (defaults
   gem.version       = Remote::Session::VERSION
 
   gem.add_runtime_dependency 'rake', '>= 0.8.7'
+  gem.add_runtime_dependency 'net-sftp'
   gem.add_runtime_dependency 'net-ssh'
 
   gem.add_development_dependency 'rspec',  '>= 2.3.0'

data/spec/unit/session_spec.rb

@@ -9,12 +9,12 @@ describe Remote::Session do
 
     before :each do
       Net::SSH.stub!( :start )
-      @user         = ENV[ 'USER' ]
+      @username         = ENV[ 'USER' ]
       ENV[ 'USER' ] = 'the_user'
     end
 
     after :each do
-      ENV[ 'USER' ] = @user
+      ENV[ 'USER' ] = @username
     end
 
     it 'should require a hostname parameter' do
@@ -29,22 +29,22 @@ describe Remote::Session do
       Remote::Session.new( TEST_HOST )
     end
 
-    it 'user should default to the current user' do
+    it 'username should default to the current user' do
       Net::SSH.should_receive( :start ).with( TEST_HOST, 'the_user', {} )
 
       Remote::Session.new( TEST_HOST )
     end
 
-    it 'should accept user option' do
+    it 'should accept username option' do
       Net::SSH.should_receive( :start ).with( TEST_HOST, 'another_user', {} )
 
-      Remote::Session.new( TEST_HOST, :user => 'another_user' )
+      Remote::Session.new( TEST_HOST, :username => 'another_user' )
     end
 
     it 'should use any supplied password' do
       Net::SSH.should_receive( :start ).with( TEST_HOST, 'another_user', { :password => 'secret' } )
 
-      Remote::Session.new( TEST_HOST, :user => 'another_user', :password => 'secret' )
+      Remote::Session.new( TEST_HOST, :username => 'another_user', :password => 'secret' )
     end
 
   end
@@ -62,7 +62,7 @@ describe Remote::Session do
         @ssh.stub!( :close )
 
         called = false
-        Remote::Session.open( TEST_HOST, :user => 'another_user' ) do | rs |
+        Remote::Session.open( TEST_HOST, :username => 'another_user' ) do | rs |
           called = true
         end
 
@@ -74,19 +74,19 @@ describe Remote::Session do
 
         Net::SSH.should_receive( :start ).with( 'host.example.com', 'another_user', {} )
 
-        Remote::Session.open( TEST_HOST, :user => 'another_user' ) {}
+        Remote::Session.open( TEST_HOST, :username => 'another_user' ) {}
       end
 
       it 'should require a block' do
         expect do
-          Remote::Session.open( TEST_HOST, :user => 'another_user' )
+          Remote::Session.open( TEST_HOST, :username => 'another_user' )
         end.       to         raise_error( NoMethodError, "undefined method `call' for nil:NilClass" )
       end
 
       it 'should close the connection' do
         @ssh.should_receive( :close )
 
-        Remote::Session.open( TEST_HOST, :user => 'another_user' ) {}
+        Remote::Session.open( TEST_HOST, :username => 'another_user' ) {}
       end
 
     end
@@ -258,8 +258,9 @@ describe Remote::Session do
 
               it 'should send the supplied data' do
                 @ch.should_receive( :send_data ).with( "this data\n" )
+                @rs.prompts[ 'my prompt' ] = 'this data' 
 
-                @rs.sudo( 'pwd', 'my prompt' => 'this data' )
+                @rs.sudo( 'pwd' )
               end
 
               it 'should not echo the prompt' do
@@ -267,8 +268,9 @@ describe Remote::Session do
                 @rs.stub!( :puts ) do | s |
                   output << s
                 end
+                @rs.prompts[ 'my prompt' ] = 'this data' 
 
-                @rs.sudo( 'pwd', 'my prompt' => 'this data' )
+                @rs.sudo( 'pwd' )
 
                 output.should == ["@#{TEST_HOST}: sudo pwd"]
               end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote-session
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -78875980215889898
+      hash: 2675303135346864190
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -78875980215889898
+      hash: 2675303135346864190
 requirements: []
 rubyforge_project: nowarning
 rubygems_version: 1.8.24