net-ssh 1.0.1 → 1.0.2

data/doc/manual-html/chapter-1.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>

data/doc/manual-html/chapter-2.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>
@@ -259,9 +259,9 @@
 	<div class='figure'>
 <span class='caption'>Using keyword arguments [ruby]</span>
 <div class='body'><table border='0' cellpadding='0' cellspacing='0'><tr><td class='lineno'>1<br />2<br />3<br />4<br />5<br />6<br />7<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">.</span><span class="ident">start</span><span class="punct">(</span> <span class="punct">'</span><span class="string">host</span><span class="punct">',</span>
-                <span class="symbol">:password</span><span class="punct">=&gt;'</span><span class="string">passwd</span><span class="punct">',</span> 
-                <span class="symbol">:port</span><span class="punct">=&gt;</span><span class="number">1234</span><span class="punct">,</span>
-                <span class="symbol">:username</span><span class="punct">=&gt;'</span><span class="string">user</span><span class="punct">',</span>
+                <span class="symbol">:password=</span><span class="punct">&gt;'</span><span class="string">passwd</span><span class="punct">',</span> 
+                <span class="symbol">:port=</span><span class="punct">&gt;</span><span class="number">1234</span><span class="punct">,</span>
+                <span class="symbol">:username=</span><span class="punct">&gt;'</span><span class="string">user</span><span class="punct">',</span>
        <span class="punct">...</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
   <span class="punct">...</span>
 <span class="keyword">end</span></pre></div></td></tr></table></div></div>

data/doc/manual-html/chapter-3.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>
@@ -355,7 +355,7 @@
 		</tr>
 		<tr>
 			<td style="vertical-align:top;text-align:center;"><code>on_request</code> </td>
-			<td> When the server sends a &#8220;channel request&#8221; to the client, this callback will be invoked. Channel requests from the server typically indicate things like the exit status of a process. This callback should take three parameters: the channel, a boolean (indicating whether or not the server wants an explicit reply to this request), and the data from the request.</td>
+			<td> When the server sends a &#8220;channel request&#8221; to the client, this callback will be invoked. Channel requests from the server typically indicate things like the exit status of a process. This callback should take four parameters: the channel, the type of request (as a string, like &#8220;exit-status&#8221;), a boolean (indicating whether or not the server wants an explicit reply to this request), and the data from the request, which will be a buffer object (see the <span class="caps">API</span> documentation for <code>Net::SSH::Util::ReaderBufferImpl</code>).</td>
 		</tr>
 		<tr>
 			<td style="vertical-align:top;text-align:center;"><code>on_success</code> </td>

data/doc/manual-html/chapter-4.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>

data/doc/manual-html/chapter-5.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>

data/doc/manual-html/chapter-6.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>

data/doc/manual-html/chapter-7.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>

data/doc/manual-html/index.html

@@ -14,8 +14,8 @@
           </div>
         </td><td valign='middle' align='right'>
           <div class="info">
-            Net::SSH Version: <strong>1.0.1</strong><br />
-            Manual Last Updated: <strong>2005-06-17 20:55 UTC</strong>
+            Net::SSH Version: <strong>1.0.2</strong><br />
+            Manual Last Updated: <strong>2005-07-27 05:13 UTC</strong>
           </div>
         </td></tr>
       </table>
@@ -216,7 +216,7 @@
   <table border='0' cellpadding='0' cellspacing='0' align='center'><tr><td>
     <ul>
       
-        <li>Updated from the (now-defunct) Hieraki version of the documentation</li>
+        <li>Corrected documentation for channel on_request callback.</li>
       
     </ul>
   </table>

data/doc/manual/manual.yml

@@ -23,7 +23,7 @@ product: !^product
     - Net::SSH Wiki: http://net-ssh.rubyforge.org/wiki/wiki.pl
 
 recent_updates:
-  - "Updated from the (now-defunct) Hieraki version of the documentation"
+  - "Corrected documentation for channel on_request callback."
 
 chapters:
 

data/doc/manual/parts/0014.txt

@@ -9,7 +9,7 @@ table(list).
 |=^. @on_eof@ | This callback is called when the server indicates that no more data will be sent _from the server_ over this channel. Your program is still welcome to send data to the server, but you are guaranteed at this point that your @on_data@ and @on_extended_data@ callbacks will no longer be called for this channel. The callback should accept a single parameter, the channel itself.|
 |=^. @on_extended_data@ | This callback is called when _extended data_ is received from the server. There are (potentially) many _types_ of extended data. The callback should accept three parameters: the channel, an integer indicating the type of the data, and the data itself.  Right now, you can pretty much count on the data type being a "1", which corresponds to the remote process's @stderr@ stream. Other data types are not defined in the SSH specification, but that does not mean some SSH servers won't try to invent their own.|
 |=^. @on_failure@ | When a request is sent over a channel (via the @send_request@ or @send_request_string@ methods), it may either succeed or fail. If it fails, this callback will be invoked. It should take a single parameter: the channel itself.|
-|=^. @on_request@ | When the server sends a "channel request" to the client, this callback will be invoked. Channel requests from the server typically indicate things like the exit status of a process. This callback should take three parameters: the channel, a boolean (indicating whether or not the server wants an explicit reply to this request), and the data from the request.|
+|=^. @on_request@ | When the server sends a "channel request" to the client, this callback will be invoked. Channel requests from the server typically indicate things like the exit status of a process. This callback should take four parameters: the channel, the type of request (as a string, like "exit-status"), a boolean (indicating whether or not the server wants an explicit reply to this request), and the data from the request, which will be a buffer object (see the API documentation for @Net::SSH::Util::ReaderBufferImpl@).|
 |=^. @on_success@ | When a request is sent over a channel (via the @send_request@ or @send_request_string@ methods), it may either succeed or fail. If it succeeds, this callback will be invoked. It should take a single parameter: the channel itself.|
 |=^. @on_window_adjust@ | When the server asks the client to adjust this channel's window size, this callback will be invoked. It should accept two parameters: the channel, and the number of bytes to add the channel's window size.|
 
@@ -29,4 +29,4 @@ Net::SSH.start( 'host' ) do |session|
 
   session.loop
 end
-}}}
+}}}

data/lib/net/ssh/connection/channel.rb

@@ -460,7 +460,7 @@ module Net
 
         # Invoked when the server sends a request packet. This in turn calls
         # the "on_request" callback.
-        event :request, :want_reply, :data
+        event :request, :type, :want_reply, :data
 
         # Invoked when the server sends confirmation of a successful operation.
         # This in turn invokes the "on_success" callback, if set.

data/lib/net/ssh/connection/driver.rb

@@ -55,7 +55,9 @@ module Net
           @channel_map = Hash.new
           @request_queue = Array.new
           @channel_open_handlers = Hash.new
+
           @data_requests = Array.new
+          @data_requests_mutex = Mutex.new
         end
 
         #--
@@ -112,7 +114,9 @@ module Net
         # maximum packet size from the client. Clients should not call this
         # method directly.
         def register_data_request( channel, data, type=nil )
-          @data_requests << DataRequest.new( channel, data, type )
+          @data_requests_mutex.synchronize do
+            @data_requests << DataRequest.new( channel, data, type )
+          end
 
           # make sure the new data request has a chance to be sent to the
           # server... Otherwise, it cannot be sent until the next time #process
@@ -350,29 +354,34 @@ module Net
 
         # Process all pending data requests.
         def process_data_requests
-          # guard against recursive/simultaneous calls
+          # guard against recursive calls
           return if @processing_data_requests
 
-          @processing_data_requests = true
-          @data_requests.map! do |req|
-            while req && req.channel.window_size > 0
-              remaining = if req.type
-                  req.channel.send_extended_data_packet( req.type, req.data )
-                else
-                  req.channel.send_data_packet( req.data )
+          # guard against simultaneous calls
+          @data_requests_mutex.synchronize do
+            begin
+              @processing_data_requests = true
+              @data_requests.map! do |req|
+                while req && req.channel.window_size > 0
+                  remaining = if req.type
+                      req.channel.send_extended_data_packet( req.type, req.data )
+                    else
+                      req.channel.send_data_packet( req.data )
+                    end
+                  if remaining
+                    req.data = remaining
+                  else
+                    req = nil
+                  end
                 end
-              if remaining
-                req.data = remaining
-              else
-                req = nil
+
+                req
               end
+              @data_requests.compact!
+            ensure
+              @processing_data_requests = false
             end
-
-            req
           end
-          @data_requests.compact!
-        ensure
-          @processing_data_requests = false
         end
 
         #--

data/lib/net/ssh/service/forward/driver.rb

@@ -248,7 +248,7 @@ module Net
             forward = @local_forwards[ key ]
             @local_forwards.delete key
 
-            forward[ :socket ].close
+            forward[ :socket ].shutdown
             forward[ :thread ].terminate
 
             true

data/lib/net/ssh/session.rb

@@ -191,7 +191,7 @@ module Net
            ( args[0][:username] || args[0][:password] ||
              args[0][:port] || args[0][:options] )
         # then
-          @username = args[0][:username] || username
+          @username = args[0][:username] || @username
           @password = args[0][:password]
 
           @options.update args.shift

data/lib/net/ssh/version.rb

@@ -20,7 +20,7 @@ module Net
 
       MAJOR = 1
       MINOR = 0
-      TINY  = 1
+      TINY  = 2
 
       STRING = [ MAJOR, MINOR, TINY ].join( "." )
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: net-ssh
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2005-06-17
+  version: 1.0.2
+date: 2005-07-26
 summary: Net::SSH is a pure-Ruby implementation of the SSH2 client protocol.
 require_paths: 
   - lib