net-ssh-session 0.1.0 → 0.1.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Dan Sosedoff.
+Copyright (c) 2012-2013 Dan Sosedoff.
 
 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:
 

data/README.md

@@ -71,6 +71,9 @@ session.run_multiple(
   'rake test'
 )
 
+# Execute as sudo
+session.sudo("whoami")
+
 # Execute with time limit (10s)
 begin
   session.with_timeout(10) do
@@ -166,6 +169,12 @@ s.run("bundler install --path .")
 s.close
 ```
 
+You can also disable histroy for the whole session:
+
+```ruby
+Net::SSH::Session.new(host, user, password, :history => false)
+```
+
 ## Credits
 
 Library code was extracted and modified from multiple sources:

data/lib/net-ssh-session/version.rb

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Session
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
     end
   end
 end

data/lib/net/ssh/session.rb

@@ -16,18 +16,24 @@ module Net
       attr_reader :history
 
       # Initialize a new ssh session
-      # @param host [String] remote hostname or ip address
-      # @param user [String] remote account username
-      # @param password [String] remote account password
-      def initialize(host, user, password='')
-        @host     = host
-        @user     = user
-        @password = password
-        @history  = []
+      # @param [String] remote hostname or ip address
+      # @param [String] remote account username
+      # @param [String] remote account password
+      # @param [Hash] options hash
+      def initialize(host, user, password='', options={})
+        @host          = host
+        @user          = user
+        @password      = password
+        @history       = []
+        @track_history = true
+
+        if options[:history] == false
+          @track_history = false
+        end
       end
 
       # Establish connection with remote server
-      # @param timeout [Integer] max timeout in seconds
+      # @param [Integer] max timeout in seconds
       # @return [Boolean]
       def open(timeout=nil)
         if timeout && timeout > 0
@@ -48,8 +54,8 @@ module Net
       end
 
       # Execute command
-      # @param command [String] command to execute
-      # @param on_output [Block] output event block
+      # @param [String] command to execute
+      # @param [Block] output event block
       # @return [Integer] command execution exit code
       def exec(command, &on_output)
         status = nil
@@ -63,8 +69,8 @@ module Net
       end
 
       # Execute a single command
-      # @param command [String] comand to execute
-      # @param options [Hash] execution options
+      # @param [String] comand to execute
+      # @param [Hash] execution options
       # @return [SessionCommand]
       def run(command, options={})
         output  = ''
@@ -82,15 +88,18 @@ module Net
           t_end - t_start
         )
 
-        history << cmd unless options[:history] == false
+        if options[:history] == true || @track_history == true
+          history << cmd
+        end
+
         logger.info(cmd.to_s) if logger
 
         cmd
       end
 
       # Execute multiple commands
-      # @param commands [Array] set of commands to execute
-      # @param options [Hash] execution options
+      # @param [Array] set of commands to execute
+      # @param [Hash] execution options
       # @return [Array] set of command execution results
       # 
       # Execution options are the following:
@@ -110,10 +119,17 @@ module Net
       end
 
       # Set a global session logger for commands
+      # @param [Logger] logger instance
       def logger=(log)
         @logger = log
       end
 
+      # Get last executed command
+      # @return [SessionCommand]
+      def last_command
+        history.last
+      end
+
       private
 
       def establish_connection

data/lib/net/ssh/session_command.rb

@@ -1,19 +1,20 @@
 module Net
   module SSH
     class SessionCommand
-      attr_reader   :command, :output, :exit_code
-      attr_reader   :duration
+      attr_reader :command, :duration
+      attr_accessor :output, :exit_code
       attr_accessor :start_time, :finish_time
       
       # Initialize a new session command
-      # @param command [String] original command
-      # @param output [String] command execution output
-      # @param exit_code [Integer] command execution exit code
-      # @param duration [Float] execution time in seconds
-      def initialize(command, output, exit_code, duration=0)
+      #
+      # @param [String] original command
+      # @param [String] command execution output
+      # @param [Integer] command execution exit code
+      # @param [Float] execution time in seconds
+      def initialize(command, output=nil, exit_code=nil, duration=0)
         @command   = command
         @output    = output || ''
-        @exit_code = Integer(exit_code) rescue 1
+        @exit_code = Integer(exit_code) rescue 1 if exit_code != nil
         @duration  = Float(duration)
       end
 
@@ -29,6 +30,8 @@ module Net
         exit_code != 0
       end
 
+      alias :error? :failure?
+
       # Get command string representation
       # @return [String]
       def to_s

data/lib/net/ssh/session_helpers.rb

@@ -3,6 +3,14 @@ require 'timeout'
 module Net
   module SSH
     module SessionHelpers
+      # Execute command with sudo
+      # @param [String] command string
+      # @param [Hash] execution options
+      # @return [SessionCommand]
+      def sudo(command, options={})
+        run("sudo #{command}", options)
+      end
+
       # Swith current directory
       # @param path [String] directory path
       # @return [Boolean] execution result

data/spec/session_command_spec.rb

@@ -45,6 +45,11 @@ describe Net::SSH::SessionCommand do
       cmd = Net::SSH::SessionCommand.new('cmd', 'output', '0')
       cmd.failure?.should be_false
     end
+
+    it 'has a :error? alias method' do
+      cmd = Net::SSH::SessionCommand.new('cmd', 'output', '0')
+      cmd.should respond_to :error?
+    end
   end
 
   describe '#to_s' do

metadata

@@ -1,71 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: net-ssh-session
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  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: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.11"
+      - !ruby/object:Gem::Version
+        version: '2.11'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: net-ssh
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Shell interface with helper methods to work with Net::SSH connections
-email: 
+email:
 - dan.sosedoff@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -89,35 +105,31 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/sosedoff/net-ssh-session
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Shell session for Net::SSH connections
-test_files: 
+test_files:
 - spec/fixtures/.gitkeep
 - spec/session_command_spec.rb
 - spec/session_helpers_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
-has_rdoc: