remote-session 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.rvmrc
+Gemfile.lock
+coverage
+pkg
+

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+script: "bundle exec rake spec"
+

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joe Yates
+
+MIT License
+
+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/README.md

@@ -0,0 +1,64 @@
+remote-session [![Build Status](https://secure.travis-ci.org/joeyates/remote-session.png)][Continuous Integration]
+==============
+
+*Run user, and sudo, commands over an SSH connection*
+
+  * [Source Code]
+  * [API documentation]
+  * [Rubygem]
+  * [Continuous Integration]
+
+[Source Code]: https://github.com/joeyates/remote-session "Source code at GitHub"
+[API documentation]: http://rubydoc.info/gems/remote-session/frames "RDoc API Documentation at Rubydoc.info"
+[Rubygem]: http://rubygems.org/gems/remote-session "Ruby gem at rubygems.org"
+[Continuous Integration]: http://travis-ci.org/joeyates/remote-session "Build status by Travis-CI"
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'remote-session'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install remote-session
+
+## Usage
+
+```ruby
+require 'remote-session'
+
+r = Remote::Session.new( 'host.example.com' )
+puts r.run( 'pwd' )
+puts r.sudo( 'apt-get update' )
+r.close
+```
+
+In a block:
+```ruby
+Remote::Session.new( 'host.example.com', :user => 'user' ) | r | do
+  puts r.run( 'pwd' )
+  puts r.sudo( 'apt-get update' )
+end
+```
+
+Options:
+```ruby
+Remote::Session.new( 'host.example.com', :user => 'user', :password => 'password' ) | r | do
+  puts r.run( 'pwd' )
+  puts r.sudo( 'apt-get update' )
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new do | t |
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+if RUBY_VERSION < '1.9'
+
+  RSpec::Core::RakeTask.new( 'spec:coverage' ) do |t|
+    t.pattern   = 'spec/**/*_spec.rb'
+    t.rcov      = true
+    t.rcov_opts = [ '--exclude', 'spec/,/gems/' ]
+  end
+
+else
+
+  desc 'Run specs and create coverage output'
+  RSpec::Core::RakeTask.new( 'spec:coverage' ) do |t|
+    t.pattern    = ['spec/gather_rspec_coverage.rb', 'spec/**/*_spec.rb']
+  end
+
+end
+

data/lib/remote/session.rb

@@ -0,0 +1,90 @@
+require 'remote/session/version'
+require 'net/ssh'
+
+module Remote
+  class Session
+    SUDO_PROMPT = 'sudo_prompt'
+
+    def self.open( host, options = {}, &block )
+      rs = new( host, options )
+
+      block.call rs
+
+      rs.close
+    end
+
+    attr_accessor :host, :user, :password, :options
+
+    def initialize( host, options = {} )
+      @host     = host
+      @options  = options.clone
+      @user     = @options.delete( :user ) || ENV[ 'USER' ]
+      @password = @options.delete( :password )
+      connect
+    end
+
+    def run( command )
+      raise "Session is closed" if @session.nil?
+      puts "@#{ @host }: #{ command }"
+      puts @session.exec!( command )
+    end
+
+    def sudo( command, prompts = {} )
+      raise "Session is closed" if @session.nil?
+
+      puts "@#{ @host }: sudo #{ command }"
+      @session.open_channel do |ch|
+        ch.request_pty do |ch, success|
+          raise "Could not obtain pty" if ! success
+
+          channel_exec ch, command, prompts
+        end
+      end
+      @session.loop
+    end
+
+    def close
+      @session.close
+      @session = nil
+    end
+
+    private
+
+    def ssh_options
+      s = {}
+      s[ :password ] = @password if @password
+      s
+    end
+
+    def connect
+      @session = Net::SSH.start( @host, @user, ssh_options )
+    end
+
+    def channel_exec( ch, command, prompts )
+      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"
+          else
+            prompt_matched = false
+            prompts.each_pair do | prompt, send |
+              if data =~ Regexp.new( prompt )
+                ch.send_data "#{ send }\n"
+                prompt_matched = true
+              end
+            end
+            puts data if ! prompt_matched
+          end
+        end
+
+        ch.on_extended_data do |ch, type, data|
+          raise "Error #{ data } while performing command: #{ command }"
+        end
+      end
+    end
+
+  end
+end
+

data/lib/remote/session/version.rb

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

data/remote-session.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.unshift( File.join( File.dirname( __FILE__ ), 'lib' ) )
+require 'remote/session/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Joe Yates']
+  gem.email         = ['joe.g.yates@gmail.com']
+  gem.description   = %q{This gem uses Net::SSH to create a connection and allow command execution over it.
+Run commands as the logged on user, or via sudo as any permitetd user (defaults to root).}
+  gem.summary       = %q{Run user commands, and sudo, commands over an SSH connection}
+  gem.homepage      = ''
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'remote-session'
+  gem.require_paths = ['lib']
+  gem.version       = Remote::Session::VERSION
+
+  gem.add_runtime_dependency 'rake', '>= 0.8.7'
+  gem.add_runtime_dependency 'net-ssh'
+
+  gem.add_development_dependency 'rspec',  '>= 2.3.0'
+  if RUBY_VERSION < '1.9'
+    gem.add_development_dependency 'rcov'
+  else
+    gem.add_development_dependency 'simplecov'
+  end
+
+  gem.rubyforge_project = 'nowarning'
+end
+

data/spec/gather_rspec_coverage.rb

@@ -0,0 +1,2 @@
+GATHER_RSPEC_COVERAGE = 1
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+
+if RUBY_VERSION < '1.9'
+  require 'rspec/autorun'
+else
+  require 'simplecov'
+  if defined?( GATHER_RSPEC_COVERAGE )
+    SimpleCov.start do
+      add_filter "/spec/"
+    end
+  end
+end
+
+require File.expand_path( File.dirname(__FILE__) + '/../lib/remote/session' )
+

data/spec/unit/session_spec.rb

@@ -0,0 +1,301 @@
+# encoding: utf-8
+load File.expand_path( '../spec_helper.rb', File.dirname(__FILE__) )
+
+describe Remote::Session do
+
+  TEST_HOST = 'host.example.com'
+
+  context 'initialization' do
+
+    before :each do
+      Net::SSH.stub!( :start )
+      @user         = ENV[ 'USER' ]
+      ENV[ 'USER' ] = 'the_user'
+    end
+
+    after :each do
+      ENV[ 'USER' ] = @user
+    end
+
+    it 'should require a hostname parameter' do
+      expect do
+        Remote::Session.new
+      end.       to         raise_error( ArgumentError, 'wrong number of arguments (0 for 1)' )
+    end
+
+    it 'should connect automatically' do
+      Net::SSH.should_receive( :start )
+
+      Remote::Session.new( TEST_HOST )
+    end
+
+    it 'user 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
+      Net::SSH.should_receive( :start ).with( TEST_HOST, 'another_user', {} )
+
+      Remote::Session.new( TEST_HOST, :user => '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' )
+    end
+
+  end
+
+  context 'instance methods' do
+
+    before :each do
+      @ssh = stub( 'Net::SSH instance' )
+      Net::SSH.stub!( :start => @ssh )
+    end
+
+    context '#open' do
+
+      it 'should run the block' do
+        @ssh.stub!( :close )
+
+        called = false
+        Remote::Session.open( TEST_HOST, :user => 'another_user' ) do | rs |
+          called = true
+        end
+
+        called.should be_true
+      end
+
+      it 'should open a connection' do
+        @ssh.stub!( :close )
+
+        Net::SSH.should_receive( :start ).with( 'host.example.com', 'another_user', {} )
+
+        Remote::Session.open( TEST_HOST, :user => 'another_user' ) {}
+      end
+
+      it 'should require a block' do
+        expect do
+          Remote::Session.open( TEST_HOST, :user => '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' ) {}
+      end
+
+    end
+
+    context '#run' do
+
+      subject { Remote::Session.new( TEST_HOST ) }
+
+      it 'should fail, if the session is closed' do
+        @ssh.stub!( :close )
+        subject.close
+
+        expect do
+          subject.run( 'pwd' )
+        end.to raise_error( RuntimeError, 'Session is closed' )
+      end
+
+      it 'should print the command to stdout' do
+        @ssh.stub!( :exec! => "/foo/bar\n" )
+
+        subject.should_receive( :puts ).with( "@#{TEST_HOST}: pwd" )
+        subject.should_receive( :puts ).with( "/foo/bar\n" )
+
+        subject.run( 'pwd' )
+      end
+
+      it 'should run the command' do
+        subject.stub!( :puts )
+
+        @ssh.should_receive( :exec! ).with( 'pwd' ).and_return( "/foo/bar\n" )
+
+        subject.run( 'pwd' )
+      end
+
+    end
+
+    context '#sudo' do
+
+      subject { Remote::Session.new( TEST_HOST ) }
+
+      it 'should fail, if the session is closed' do
+        @ssh.stub!( :close )
+        subject.close
+
+        expect do
+          subject.sudo( 'pwd' )
+        end.to raise_error( RuntimeError, 'Session is closed' )
+      end
+
+      it 'should print the command to stdout' do
+        @ssh.stub!( :open_channel => nil )
+        @ssh.stub!( :loop         => nil )
+
+        subject.should_receive( :puts ).with( "@#{TEST_HOST}: sudo pwd" )
+
+        subject.sudo( 'pwd' )
+      end
+
+      it 'should run the command' do
+        subject.stub!( :puts )
+
+        @ssh.should_receive( :open_channel ) do |&open_channel_block|
+          @channel = stub( 'channel' )
+
+          @channel.should_receive( :request_pty ) do |&request_pty_block|
+            request_pty_block.call( @channel, true )
+          end
+
+          @channel.should_receive( :exec ).with( "sudo -p 'sudo_prompt' pwd" )
+
+          open_channel_block.call @channel
+        end
+        @ssh.should_receive( :loop )
+
+        subject.sudo( 'pwd' )
+      end
+
+      context 'in channel' do
+
+        before :each do
+          @rs = Remote::Session.new( TEST_HOST, { :sudo_password => 'secret' } )
+          @rs.stub!( :puts )
+
+          @ssh.stub!( :loop => nil )
+          @ch = stub( 'channel' )
+          @ssh.stub!( :open_channel ) do |&block|
+            block.call @ch
+          end
+        end
+
+        it 'should fail if pty request is unsuccessful' do
+          @ch.stub!( :request_pty ) do |&block|
+            expect do
+              block.call( @ch, false )
+            end.to raise_error( RuntimeError, 'Could not obtain pty' )
+          end
+
+          @rs.sudo( 'pwd' )
+        end
+
+        context 'with pty' do
+
+          before :each do
+            @ch.stub!( :request_pty ) do |&block|
+              block.call( @ch, true )
+            end
+          end
+
+          it 'should fail if the command fails' do
+            @ch.stub!( :exec ) do |&block|
+              expect do
+                block.call( @ch, false )
+              end.to raise_error( RuntimeError, 'Could not execute sudo command: pwd' )
+            end
+
+            @rs.sudo( 'pwd' )
+          end
+
+          context 'in exec' do
+            before :each do
+              @ch.stub!( :exec ) do |&block|
+                block.call( @ch, true )
+              end
+              @ch.stub!( :on_extended_data => nil )
+              @ch.stub!( :send_data )
+            end
+
+            it 'should output returning data' do
+              @ch.stub!( :on_data ) do |&block|
+                block.call( @ch, 'some_data' )
+              end
+
+              @rs.should_receive( :puts ).with( 'some_data' )
+
+              @rs.sudo( 'pwd' )
+            end
+
+            context 'with password prompt' do
+              before :each do
+                @ch.stub!( :on_data ) do |&block|
+                  block.call( @ch, 'sudo_prompt' )
+                end
+              end
+
+              it 'should supply the sudo password, when prompted' do
+                @ch.should_receive( :send_data ).with( "secret\n" )
+
+                @rs.sudo( 'pwd' )
+              end
+
+              it 'should not echo the standard prompt' do
+                output = []
+                @rs.stub!( :puts ) do | s |
+                  output << s
+                end
+
+                @rs.sudo( 'pwd' )
+
+                output.should == ["@#{TEST_HOST}: sudo pwd"]
+              end
+            end
+
+            context 'with user-supplied prompt' do
+              before :each do
+                @ch.stub!( :on_data ) do |&block|
+                  block.call( @ch, 'Here is my prompt:' )
+                end
+              end
+
+              it 'should send the supplied data' do
+                @ch.should_receive( :send_data ).with( "this data\n" )
+
+                @rs.sudo( 'pwd', 'my prompt' => 'this data' )
+              end
+
+              it 'should not echo the prompt' do
+                output = []
+                @rs.stub!( :puts ) do | s |
+                  output << s
+                end
+
+                @rs.sudo( 'pwd', 'my prompt' => 'this data' )
+
+                output.should == ["@#{TEST_HOST}: sudo pwd"]
+              end
+
+            end
+
+            it 'should fail if error data is received' do
+              @ch.stub!( :on_data )
+
+              @ch.stub!( :on_extended_data ) do |&block|
+                block.call @ch, 'foo', 'It failed' 
+              end
+
+              expect do
+                @rs.sudo( 'pwd' )
+              end.to raise_error( RuntimeError, 'Error It failed while performing command: pwd' )
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: remote-session
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'This gem uses Net::SSH to create a connection and allow command execution
+  over it.
+
+  Run commands as the logged on user, or via sudo as any permitetd user (defaults
+  to root).'
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/remote/session.rb
+- lib/remote/session/version.rb
+- remote-session.gemspec
+- spec/gather_rspec_coverage.rb
+- spec/spec_helper.rb
+- spec/unit/session_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -78875980215889898
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -78875980215889898
+requirements: []
+rubyforge_project: nowarning
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Run user commands, and sudo, commands over an SSH connection
+test_files:
+- spec/gather_rspec_coverage.rb
+- spec/spec_helper.rb
+- spec/unit/session_spec.rb