net-ssh-simple 1.6.4 → 1.6.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/README.rdoc +1 -1
  3. data/coverage/.last_run.json +1 -1
  4. data/coverage/.resultset.json +16 -10
  5. data/coverage/index.html +280 -244
  6. data/doc/Net.html +5 -5
  7. data/doc/Net/SSH.html +5 -5
  8. data/doc/Net/SSH/Simple.html +112 -96
  9. data/doc/Net/SSH/Simple/Error.html +25 -25
  10. data/doc/Net/SSH/Simple/Result.html +73 -73
  11. data/doc/_index.html +6 -6
  12. data/doc/class_list.html +2 -1
  13. data/doc/css/style.css +11 -1
  14. data/doc/file.README.html +58 -54
  15. data/doc/file_list.html +2 -1
  16. data/doc/frames.html +5 -7
  17. data/doc/index.html +58 -54
  18. data/doc/js/app.js +7 -2
  19. data/doc/js/full_list.js +7 -2
  20. data/doc/method_list.html +34 -99
  21. data/doc/top-level-namespace.html +5 -5
  22. data/lib/net/ssh/simple.rb +16 -10
  23. data/lib/net/ssh/simple/version.rb +1 -1
  24. metadata +1 -1
data/doc/js/app.js CHANGED
@@ -78,7 +78,12 @@ function framesInit() {
78
78
  if (hasFrames) {
79
79
  document.body.className = 'frames';
80
80
  $('#menu .noframes a').attr('href', document.location);
81
- window.top.document.title = $('html head title').text();
81
+ try {
82
+ window.top.document.title = $('html head title').text();
83
+ } catch(error) {
84
+ // some browsers will not allow this when serving from file://
85
+ // but we don't want to stop the world.
86
+ }
82
87
  }
83
88
  else {
84
89
  $('#menu .noframes a').text('frames').attr('href', framesUrl);
@@ -211,4 +216,4 @@ $(linkSummaries);
211
216
  $(keyboardShortcuts);
212
217
  $(summaryToggle);
213
218
  $(fixOutsideWorldLinks);
214
- $(generateTOC);
219
+ $(generateTOC);
data/doc/js/full_list.js CHANGED
@@ -17,6 +17,7 @@ function fullListSearch() {
17
17
  searchCache = [];
18
18
  $('#full_list li').each(function() {
19
19
  var link = $(this).find('.object_link a');
20
+ if (link.length === 0) return;
20
21
  var fullName = link.attr('title').split(' ')[0];
21
22
  searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
22
23
  });
@@ -41,7 +42,7 @@ function fullListSearch() {
41
42
  $('#full_list li').removeClass('found').each(function() {
42
43
 
43
44
  var link = $(this).find('.object_link a');
44
- link.text(link.text());
45
+ if (link.length > 0) link.text(link.text());
45
46
  });
46
47
  if (clicked) {
47
48
  clicked.parents('ul').each(function() {
@@ -111,6 +112,10 @@ function linkList() {
111
112
  $('#full_list li, #full_list li a:last').click(function(evt) {
112
113
  if ($(this).hasClass('toggle')) return true;
113
114
  if (this.tagName.toLowerCase() == "li") {
115
+ if ($(this).find('.object_link a').length === 0) {
116
+ $(this).children('a.toggle').click();
117
+ return false;
118
+ }
114
119
  var toggle = $(this).children('a.toggle');
115
120
  if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
116
121
  toggle.click();
@@ -120,7 +125,7 @@ function linkList() {
120
125
  if (clicked) clicked.removeClass('clicked');
121
126
  var win = window.top.frames.main ? window.top.frames.main : window.parent;
122
127
  if (this.tagName.toLowerCase() == "a") {
123
- clicked = $(this).parent('li').addClass('clicked');
128
+ clicked = $(this).parents('li').addClass('clicked');
124
129
  win.location = this.href;
125
130
  }
126
131
  else {
data/doc/method_list.html CHANGED
@@ -15,6 +15,7 @@
15
15
  <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
16
 
17
17
 
18
+ <title>Method List</title>
18
19
  <base id="base_target" target="_parent" />
19
20
  </head>
20
21
  <body>
@@ -48,265 +49,199 @@
48
49
 
49
50
  <li class="r1 ">
50
51
  <span class='object_link'><a href="Net/SSH/Simple.html#async-instance_method" title="Net::SSH::Simple#async (method)">#async</a></span>
51
-
52
- <small>Net::SSH::Simple</small>
53
-
52
+ <small>Net::SSH::Simple</small>
54
53
  </li>
55
54
 
56
55
 
57
56
  <li class="r2 ">
58
57
  <span class='object_link'><a href="Net/SSH/Simple.html#async-class_method" title="Net::SSH::Simple.async (method)">async</a></span>
59
-
60
- <small>Net::SSH::Simple</small>
61
-
58
+ <small>Net::SSH::Simple</small>
62
59
  </li>
63
60
 
64
61
 
65
62
  <li class="r1 ">
66
63
  <span class='object_link'><a href="Net/SSH/Simple.html#close-instance_method" title="Net::SSH::Simple#close (method)">#close</a></span>
67
-
68
- <small>Net::SSH::Simple</small>
69
-
64
+ <small>Net::SSH::Simple</small>
70
65
  </li>
71
66
 
72
67
 
73
68
  <li class="r2 ">
74
69
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#cmd-instance_method" title="Net::SSH::Simple::Result#cmd (method)">#cmd</a></span>
75
-
76
- <small>Net::SSH::Simple::Result</small>
77
-
70
+ <small>Net::SSH::Simple::Result</small>
78
71
  </li>
79
72
 
80
73
 
81
74
  <li class="r1 ">
82
75
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#exception-instance_method" title="Net::SSH::Simple::Result#exception (method)">#exception</a></span>
83
-
84
- <small>Net::SSH::Simple::Result</small>
85
-
76
+ <small>Net::SSH::Simple::Result</small>
86
77
  </li>
87
78
 
88
79
 
89
80
  <li class="r2 ">
90
81
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#exit_code-instance_method" title="Net::SSH::Simple::Result#exit_code (method)">#exit_code</a></span>
91
-
92
- <small>Net::SSH::Simple::Result</small>
93
-
82
+ <small>Net::SSH::Simple::Result</small>
94
83
  </li>
95
84
 
96
85
 
97
86
  <li class="r1 ">
98
87
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#exit_signal-instance_method" title="Net::SSH::Simple::Result#exit_signal (method)">#exit_signal</a></span>
99
-
100
- <small>Net::SSH::Simple::Result</small>
101
-
88
+ <small>Net::SSH::Simple::Result</small>
102
89
  </li>
103
90
 
104
91
 
105
92
  <li class="r2 ">
106
93
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#finish_at-instance_method" title="Net::SSH::Simple::Result#finish_at (method)">#finish_at</a></span>
107
-
108
- <small>Net::SSH::Simple::Result</small>
109
-
94
+ <small>Net::SSH::Simple::Result</small>
110
95
  </li>
111
96
 
112
97
 
113
98
  <li class="r1 ">
114
99
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#host-instance_method" title="Net::SSH::Simple::Result#host (method)">#host</a></span>
115
-
116
- <small>Net::SSH::Simple::Result</small>
117
-
100
+ <small>Net::SSH::Simple::Result</small>
118
101
  </li>
119
102
 
120
103
 
121
104
  <li class="r2 ">
122
105
  <span class='object_link'><a href="Net/SSH/Simple.html#initialize-instance_method" title="Net::SSH::Simple#initialize (method)">#initialize</a></span>
123
-
124
- <small>Net::SSH::Simple</small>
125
-
106
+ <small>Net::SSH::Simple</small>
126
107
  </li>
127
108
 
128
109
 
129
110
  <li class="r1 ">
130
111
  <span class='object_link'><a href="Net/SSH/Simple/Error.html#initialize-instance_method" title="Net::SSH::Simple::Error#initialize (method)">#initialize</a></span>
131
-
132
- <small>Net::SSH::Simple::Error</small>
133
-
112
+ <small>Net::SSH::Simple::Error</small>
134
113
  </li>
135
114
 
136
115
 
137
116
  <li class="r2 ">
138
117
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#last_event_at-instance_method" title="Net::SSH::Simple::Result#last_event_at (method)">#last_event_at</a></span>
139
-
140
- <small>Net::SSH::Simple::Result</small>
141
-
118
+ <small>Net::SSH::Simple::Result</small>
142
119
  </li>
143
120
 
144
121
 
145
122
  <li class="r1 ">
146
123
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#last_keepalive_at-instance_method" title="Net::SSH::Simple::Result#last_keepalive_at (method)">#last_keepalive_at</a></span>
147
-
148
- <small>Net::SSH::Simple::Result</small>
149
-
124
+ <small>Net::SSH::Simple::Result</small>
150
125
  </li>
151
126
 
152
127
 
153
128
  <li class="r2 ">
154
129
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#op-instance_method" title="Net::SSH::Simple::Result#op (method)">#op</a></span>
155
-
156
- <small>Net::SSH::Simple::Result</small>
157
-
130
+ <small>Net::SSH::Simple::Result</small>
158
131
  </li>
159
132
 
160
133
 
161
134
  <li class="r1 ">
162
135
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#opts-instance_method" title="Net::SSH::Simple::Result#opts (method)">#opts</a></span>
163
-
164
- <small>Net::SSH::Simple::Result</small>
165
-
136
+ <small>Net::SSH::Simple::Result</small>
166
137
  </li>
167
138
 
168
139
 
169
140
  <li class="r2 ">
170
141
  <span class='object_link'><a href="Net/SSH/Simple/Error.html#result-instance_method" title="Net::SSH::Simple::Error#result (method)">#result</a></span>
171
-
172
- <small>Net::SSH::Simple::Error</small>
173
-
142
+ <small>Net::SSH::Simple::Error</small>
174
143
  </li>
175
144
 
176
145
 
177
146
  <li class="r1 ">
178
147
  <span class='object_link'><a href="Net/SSH/Simple.html#result-instance_method" title="Net::SSH::Simple#result (method)">#result</a></span>
179
-
180
- <small>Net::SSH::Simple</small>
181
-
148
+ <small>Net::SSH::Simple</small>
182
149
  </li>
183
150
 
184
151
 
185
152
  <li class="r2 ">
186
153
  <span class='object_link'><a href="Net/SSH/Simple.html#scp_get-instance_method" title="Net::SSH::Simple#scp_get (method)">#scp_get</a></span>
187
-
188
- <small>Net::SSH::Simple</small>
189
-
154
+ <small>Net::SSH::Simple</small>
190
155
  </li>
191
156
 
192
157
 
193
158
  <li class="r1 ">
194
159
  <span class='object_link'><a href="Net/SSH/Simple.html#scp_get-class_method" title="Net::SSH::Simple.scp_get (method)">scp_get</a></span>
195
-
196
- <small>Net::SSH::Simple</small>
197
-
160
+ <small>Net::SSH::Simple</small>
198
161
  </li>
199
162
 
200
163
 
201
164
  <li class="r2 ">
202
165
  <span class='object_link'><a href="Net/SSH/Simple.html#scp_put-instance_method" title="Net::SSH::Simple#scp_put (method)">#scp_put</a></span>
203
-
204
- <small>Net::SSH::Simple</small>
205
-
166
+ <small>Net::SSH::Simple</small>
206
167
  </li>
207
168
 
208
169
 
209
170
  <li class="r1 ">
210
171
  <span class='object_link'><a href="Net/SSH/Simple.html#scp_put-class_method" title="Net::SSH::Simple.scp_put (method)">scp_put</a></span>
211
-
212
- <small>Net::SSH::Simple</small>
213
-
172
+ <small>Net::SSH::Simple</small>
214
173
  </li>
215
174
 
216
175
 
217
176
  <li class="r2 ">
218
177
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#sent-instance_method" title="Net::SSH::Simple::Result#sent (method)">#sent</a></span>
219
-
220
- <small>Net::SSH::Simple::Result</small>
221
-
178
+ <small>Net::SSH::Simple::Result</small>
222
179
  </li>
223
180
 
224
181
 
225
182
  <li class="r1 ">
226
183
  <span class='object_link'><a href="Net/SSH/Simple.html#ssh-class_method" title="Net::SSH::Simple.ssh (method)">ssh</a></span>
227
-
228
- <small>Net::SSH::Simple</small>
229
-
184
+ <small>Net::SSH::Simple</small>
230
185
  </li>
231
186
 
232
187
 
233
188
  <li class="r2 ">
234
189
  <span class='object_link'><a href="Net/SSH/Simple.html#ssh-instance_method" title="Net::SSH::Simple#ssh (method)">#ssh</a></span>
235
-
236
- <small>Net::SSH::Simple</small>
237
-
190
+ <small>Net::SSH::Simple</small>
238
191
  </li>
239
192
 
240
193
 
241
194
  <li class="r1 ">
242
195
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#start_at-instance_method" title="Net::SSH::Simple::Result#start_at (method)">#start_at</a></span>
243
-
244
- <small>Net::SSH::Simple::Result</small>
245
-
196
+ <small>Net::SSH::Simple::Result</small>
246
197
  </li>
247
198
 
248
199
 
249
200
  <li class="r2 ">
250
201
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#stderr-instance_method" title="Net::SSH::Simple::Result#stderr (method)">#stderr</a></span>
251
-
252
- <small>Net::SSH::Simple::Result</small>
253
-
202
+ <small>Net::SSH::Simple::Result</small>
254
203
  </li>
255
204
 
256
205
 
257
206
  <li class="r1 ">
258
207
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#stdout-instance_method" title="Net::SSH::Simple::Result#stdout (method)">#stdout</a></span>
259
-
260
- <small>Net::SSH::Simple::Result</small>
261
-
208
+ <small>Net::SSH::Simple::Result</small>
262
209
  </li>
263
210
 
264
211
 
265
212
  <li class="r2 ">
266
213
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#success-instance_method" title="Net::SSH::Simple::Result#success (method)">#success</a></span>
267
-
268
- <small>Net::SSH::Simple::Result</small>
269
-
214
+ <small>Net::SSH::Simple::Result</small>
270
215
  </li>
271
216
 
272
217
 
273
218
  <li class="r1 ">
274
219
  <span class='object_link'><a href="Net/SSH/Simple.html#sync-class_method" title="Net::SSH::Simple.sync (method)">sync</a></span>
275
-
276
- <small>Net::SSH::Simple</small>
277
-
220
+ <small>Net::SSH::Simple</small>
278
221
  </li>
279
222
 
280
223
 
281
224
  <li class="r2 ">
282
225
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#timed_out-instance_method" title="Net::SSH::Simple::Result#timed_out (method)">#timed_out</a></span>
283
-
284
- <small>Net::SSH::Simple::Result</small>
285
-
226
+ <small>Net::SSH::Simple::Result</small>
286
227
  </li>
287
228
 
288
229
 
289
230
  <li class="r1 ">
290
231
  <span class='object_link'><a href="Net/SSH/Simple/Error.html#to_s-instance_method" title="Net::SSH::Simple::Error#to_s (method)">#to_s</a></span>
291
-
292
- <small>Net::SSH::Simple::Error</small>
293
-
232
+ <small>Net::SSH::Simple::Error</small>
294
233
  </li>
295
234
 
296
235
 
297
236
  <li class="r2 ">
298
237
  <span class='object_link'><a href="Net/SSH/Simple/Result.html#total-instance_method" title="Net::SSH::Simple::Result#total (method)">#total</a></span>
299
-
300
- <small>Net::SSH::Simple::Result</small>
301
-
238
+ <small>Net::SSH::Simple::Result</small>
302
239
  </li>
303
240
 
304
241
 
305
242
  <li class="r1 ">
306
243
  <span class='object_link'><a href="Net/SSH/Simple/Error.html#wrapped-instance_method" title="Net::SSH::Simple::Error#wrapped (method)">#wrapped</a></span>
307
-
308
- <small>Net::SSH::Simple::Error</small>
309
-
244
+ <small>Net::SSH::Simple::Error</small>
310
245
  </li>
311
246
 
312
247
 
data/doc/top-level-namespace.html CHANGED
@@ -6,13 +6,13 @@
6
6
  <title>
7
7
  Top Level Namespace
8
8
 
9
- &mdash; Documentation by YARD 0.8.3
9
+ &mdash; Documentation by YARD 0.8.7.3
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
14
 
15
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
16
 
17
17
  <script type="text/javascript" charset="utf-8">
18
18
  hasFrames = window.top.frames.main ? true : false;
@@ -103,9 +103,9 @@
103
103
  </div>
104
104
 
105
105
  <div id="footer">
106
- Generated on Sun Dec 8 10:29:15 2013 by
106
+ Generated on Fri Mar 14 19:29:20 2014 by
107
107
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
108
- 0.8.3 (ruby-1.9.3).
108
+ 0.8.7.3 (ruby-2.1.1).
109
109
  </div>
110
110
 
111
111
  </body>
data/lib/net/ssh/simple.rb CHANGED
@@ -321,7 +321,7 @@ module Net
321
321
  r
322
322
  end
323
323
 
324
- #
324
+ #
325
325
  # SCP upload to a remote host.
326
326
  # The underlying Net::SSH::Simple instance will re-use
327
327
  # existing connections for optimal performance.
@@ -342,7 +342,7 @@ module Net
342
342
  # SCP download from a remote host.
343
343
  # The underlying Net::SSH::Simple instance will re-use
344
344
  # existing connections for optimal performance.
345
- #
345
+ #
346
346
  # @param [String] host Destination hostname or ip-address
347
347
  # @param [String] src Source path (on remote host)
348
348
  # @param [String] dst Destination path (on localhost)
@@ -388,7 +388,7 @@ module Net
388
388
  # @option opts [boolean] :forward_agent
389
389
  # set to true if you want the SSH agent connection to be forwarded
390
390
  #
391
- # @option opts [String/Array] :global_known_hosts_file
391
+ # @option opts [String/Array] :global_known_hosts_file
392
392
  # (['/etc/ssh/known_hosts','/etc/ssh/known_hosts2'])
393
393
  # the location of the global known hosts file.
394
394
  # Set to an array if you want to specify multiple
@@ -483,7 +483,7 @@ module Net
483
483
  # :debug, :info, :warn, :error, and :fatal are also supported and are translated
484
484
  # to the corresponding Logger constant.
485
485
  #
486
- # @see http://net-ssh.github.com/ssh/v2/api/classes/Net/SSH.html#M000002
486
+ # @see http://net-ssh.github.com/ssh/v2/api/classes/Net/SSH.html#M000002
487
487
  # Net::SSH documentation for the 'opts'-hash
488
488
  def ssh(host, cmd, opts={}, &block)
489
489
  opts = @opts.merge(opts)
@@ -491,7 +491,7 @@ module Net
491
491
  @result = Result.new(
492
492
  { :op => :ssh, :host => host, :cmd => cmd, :start_at => Time.new,
493
493
  :last_event_at => Time.new, :opts => opts, :stdout => '', :stderr => '',
494
- :success => nil
494
+ :success => nil
495
495
  } )
496
496
 
497
497
  channel = session.open_channel do |chan|
@@ -543,8 +543,8 @@ module Net
543
543
 
544
544
  #
545
545
  # Spawn a Thread to perform a sequence of ssh/scp operations.
546
- #
547
- # @param [Block] block
546
+ #
547
+ # @param [Block] block
548
548
  # @param opts (see Net::SSH::Simple#ssh)
549
549
  # @return [Thread] Thread executing the SSH-Block.
550
550
  #
@@ -583,7 +583,7 @@ module Net
583
583
  # Close and cleanup.
584
584
  #
585
585
  # @return [Net::SSH::Simple::Result] Result
586
- #
586
+ #
587
587
  def close
588
588
  Thread.current[:ssh_simple_sessions].values.each do |session|
589
589
  begin
@@ -598,15 +598,21 @@ module Net
598
598
  @result
599
599
  end
600
600
 
601
+ # set lower default timeout on 32bit ruby
602
+ MAX_TIMEOUT = ([''].pack('p').size == 8) ? 2**32 : 2**16
603
+ if MAX_TIMEOUT == 2**16 and $SUPPRESS_32BIT_WARNING.nil?
604
+ warn "WARNING: 32bit platform detected; Net::SSH::Simple timeout defaults to 65536s (~18 hours)."
605
+ warn "To suppress this warning set $SUPPRESS_32BIT_WARNING=1 before you require 'net/ssh/simple'."
606
+ end
601
607
 
602
608
  private
603
609
  EXTRA_OPTS = [:operation_timeout, :close_timeout, :keepalive_interval, :scp_src, :scp_dst]
604
610
 
605
611
  def with_session(host, opts={}, &block)
606
612
  opts[:timeout] ||= 60
607
- opts[:timeout] = 2**32 if opts[:timeout] == 0
613
+ opts[:timeout] = MAX_TIMEOUT if opts[:timeout] == 0
608
614
  opts[:operation_timeout] ||= 3600
609
- opts[:operation_timeout] = 2**32 if opts[:operation_timeout] == 0
615
+ opts[:operation_timeout] = MAX_TIMEOUT if opts[:operation_timeout] == 0
610
616
  opts[:close_timeout] ||= 5
611
617
  opts[:keepalive_interval] ||= 60
612
618
  begin