boris 1.0.0.beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. data/LICENSE.md +9 -0
  2. data/README.md +94 -0
  3. data/boris.gemspec +28 -0
  4. data/doc/Array.html +437 -0
  5. data/doc/Boris.html +230 -0
  6. data/doc/Boris/ConnectionAlreadyActive.html +123 -0
  7. data/doc/Boris/ConnectionFailed.html +127 -0
  8. data/doc/Boris/Connector.html +794 -0
  9. data/doc/Boris/InvalidCredentials.html +131 -0
  10. data/doc/Boris/InvalidOption.html +123 -0
  11. data/doc/Boris/InvalidTargetName.html +123 -0
  12. data/doc/Boris/Lumberjack.html +466 -0
  13. data/doc/Boris/MissingCredentials.html +123 -0
  14. data/doc/Boris/NoActiveConnection.html +123 -0
  15. data/doc/Boris/NoProfileDetected.html +123 -0
  16. data/doc/Boris/Options.html +783 -0
  17. data/doc/Boris/Profiles.html +117 -0
  18. data/doc/Boris/Profiles/Linux.html +1151 -0
  19. data/doc/Boris/Profiles/RedHat.html +875 -0
  20. data/doc/Boris/Profiles/Solaris.html +1230 -0
  21. data/doc/Boris/Profiles/Structure.html +2050 -0
  22. data/doc/Boris/Profiles/UNIX.html +893 -0
  23. data/doc/Boris/Profiles/Windows.html +1846 -0
  24. data/doc/Boris/Profiles/Windows/Windows2003.html +304 -0
  25. data/doc/Boris/Profiles/Windows/Windows2008.html +379 -0
  26. data/doc/Boris/Profiles/Windows/Windows2012.html +304 -0
  27. data/doc/Boris/SNMPConnector.html +512 -0
  28. data/doc/Boris/SSHConnector.html +633 -0
  29. data/doc/Boris/Target.html +2002 -0
  30. data/doc/Boris/WMIConnector.html +1134 -0
  31. data/doc/BorisLogger.html +217 -0
  32. data/doc/Hash.html +195 -0
  33. data/doc/String.html +1246 -0
  34. data/doc/_index.html +420 -0
  35. data/doc/class_list.html +53 -0
  36. data/doc/css/common.css +1 -0
  37. data/doc/css/full_list.css +57 -0
  38. data/doc/css/style.css +328 -0
  39. data/doc/file.README.html +183 -0
  40. data/doc/file_list.html +55 -0
  41. data/doc/frames.html +28 -0
  42. data/doc/index.html +183 -0
  43. data/doc/js/app.js +214 -0
  44. data/doc/js/full_list.js +173 -0
  45. data/doc/js/jquery.js +4 -0
  46. data/doc/method_list.html +1468 -0
  47. data/doc/top-level-namespace.html +126 -0
  48. data/lib/boris.rb +30 -0
  49. data/lib/boris/connectors.rb +47 -0
  50. data/lib/boris/connectors/snmp.rb +56 -0
  51. data/lib/boris/connectors/ssh.rb +110 -0
  52. data/lib/boris/connectors/wmi.rb +186 -0
  53. data/lib/boris/errors.rb +17 -0
  54. data/lib/boris/helpers/array.rb +63 -0
  55. data/lib/boris/helpers/constants.rb +20 -0
  56. data/lib/boris/helpers/hash.rb +8 -0
  57. data/lib/boris/helpers/scrubber.rb +51 -0
  58. data/lib/boris/helpers/string.rb +130 -0
  59. data/lib/boris/lumberjack.rb +47 -0
  60. data/lib/boris/options.rb +86 -0
  61. data/lib/boris/profiles/linux/redhat.rb +77 -0
  62. data/lib/boris/profiles/linux_core.rb +216 -0
  63. data/lib/boris/profiles/unix/solaris.rb +307 -0
  64. data/lib/boris/profiles/unix_core.rb +85 -0
  65. data/lib/boris/profiles/windows/windows2003.rb +15 -0
  66. data/lib/boris/profiles/windows/windows2008.rb +23 -0
  67. data/lib/boris/profiles/windows/windows2012.rb +15 -0
  68. data/lib/boris/profiles/windows_core.rb +530 -0
  69. data/lib/boris/structure.rb +167 -0
  70. data/lib/boris/target.rb +340 -0
  71. data/test/connector_tests/test_snmp.rb +35 -0
  72. data/test/connector_tests/test_ssh.rb +51 -0
  73. data/test/connector_tests/test_wmi.rb +129 -0
  74. data/test/helper_tests/test_array.rb +25 -0
  75. data/test/helper_tests/test_hash.rb +10 -0
  76. data/test/helper_tests/test_string.rb +136 -0
  77. data/test/profile_tests/test_core_skeleton +107 -0
  78. data/test/profile_tests/test_linux_core.rb +331 -0
  79. data/test/profile_tests/test_redhat.rb +134 -0
  80. data/test/profile_tests/test_solaris.rb +523 -0
  81. data/test/profile_tests/test_unix_core.rb +117 -0
  82. data/test/profile_tests/test_windows.rb +536 -0
  83. data/test/setup_tests.rb +14 -0
  84. data/test/test_all.rb +8 -0
  85. data/test/test_options.rb +44 -0
  86. data/test/test_structure.rb +136 -0
  87. data/test/test_target.rb +146 -0
  88. metadata +241 -0
data/doc/Boris/SSHConnector.html ADDED
@@ -0,0 +1,633 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Boris::SSHConnector
8
+
9
+ &mdash; Documentation by YARD 0.8.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (S)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Boris.html" title="Boris (module)">Boris</a></span></span>
36
+ &raquo;
37
+ <span class="title">SSHConnector</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Boris::SSHConnector
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName"><span class='object_link'><a href="Connector.html" title="Boris::Connector (class)">Connector</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="Connector.html" title="Boris::Connector (class)">Connector</a></span></li>
82
+
83
+ <li class="next">Boris::SSHConnector</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/boris/connectors/ssh.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary</h2>
111
+
112
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Connector.html" title="Boris::Connector (class)">Connector</a></span></h3>
113
+ <p class="inherited"><span class='object_link'><a href="Connector.html#connected-instance_method" title="Boris::Connector#connected (method)">#connected</a></span>, <span class='object_link'><a href="Connector.html#host-instance_method" title="Boris::Connector#host (method)">#host</a></span>, <span class='object_link'><a href="Connector.html#options-instance_method" title="Boris::Connector#options (method)">#options</a></span>, <span class='object_link'><a href="Connector.html#reconnectable-instance_method" title="Boris::Connector#reconnectable (method)">#reconnectable</a></span></p>
114
+
115
+
116
+
117
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Lumberjack.html" title="Boris::Lumberjack (module)">Lumberjack</a></span></h3>
118
+ <p class="inherited"><span class='object_link'><a href="Lumberjack.html#logger-instance_method" title="Boris::Lumberjack#logger (method)">#logger</a></span></p>
119
+
120
+
121
+
122
+ <h2>
123
+ Instance Method Summary
124
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
125
+ </h2>
126
+
127
+ <ul class="summary">
128
+
129
+ <li class="public ">
130
+ <span class="summary_signature">
131
+
132
+ <a href="#disconnect-instance_method" title="#disconnect (instance method)">- (Object) <strong>disconnect</strong> </a>
133
+
134
+
135
+
136
+ </span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <span class="summary_desc"><div class='inline'></div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#establish_connection-instance_method" title="#establish_connection (instance method)">- (Object) <strong>establish_connection</strong> </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+ <span class="summary_desc"><div class='inline'></div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (SSHConnector) <strong>initialize</strong>(host, cred, options, logger = nil) </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+ <span class="note title constructor">constructor</span>
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <span class="summary_desc"><div class='inline'>
193
+ <p>A new instance of SSHConnector.</p>
194
+ </div></span>
195
+
196
+ </li>
197
+
198
+
199
+ <li class="public ">
200
+ <span class="summary_signature">
201
+
202
+ <a href="#value_at-instance_method" title="#value_at (instance method)">- (Object) <strong>value_at</strong>(request, request_pty = false) </a>
203
+
204
+
205
+
206
+ </span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'></div></span>
217
+
218
+ </li>
219
+
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#values_at-instance_method" title="#values_at (instance method)">- (Object) <strong>values_at</strong>(request, request_pty = false, limit = nil) </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+ <span class="summary_desc"><div class='inline'></div></span>
239
+
240
+ </li>
241
+
242
+
243
+ </ul>
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Connector.html" title="Boris::Connector (class)">Connector</a></span></h3>
256
+ <p class="inherited"><span class='object_link'><a href="Connector.html#connected%3F-instance_method" title="Boris::Connector#connected? (method)">#connected?</a></span></p>
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Lumberjack.html" title="Boris::Lumberjack (module)">Lumberjack</a></span></h3>
267
+ <p class="inherited"><span class='object_link'><a href="Lumberjack.html#debug-instance_method" title="Boris::Lumberjack#debug (method)">#debug</a></span>, <span class='object_link'><a href="Lumberjack.html#error-instance_method" title="Boris::Lumberjack#error (method)">#error</a></span>, <span class='object_link'><a href="Lumberjack.html#fatal-instance_method" title="Boris::Lumberjack#fatal (method)">#fatal</a></span>, <span class='object_link'><a href="Lumberjack.html#info-instance_method" title="Boris::Lumberjack#info (method)">#info</a></span>, <span class='object_link'><a href="Lumberjack.html#warn-instance_method" title="Boris::Lumberjack#warn (method)">#warn</a></span></p>
268
+ <div id="constructor_details" class="method_details_list">
269
+ <h2>Constructor Details</h2>
270
+
271
+ <div class="method_details first">
272
+ <h3 class="signature first" id="initialize-instance_method">
273
+
274
+ - (<tt><span class='object_link'><a href="" title="Boris::SSHConnector (class)">SSHConnector</a></span></tt>) <strong>initialize</strong>(host, cred, options, logger = nil)
275
+
276
+
277
+
278
+
279
+
280
+ </h3><div class="docstring">
281
+ <div class="discussion">
282
+
283
+ <p>A new instance of SSHConnector</p>
284
+
285
+
286
+ </div>
287
+ </div>
288
+ <div class="tags">
289
+
290
+ <p class="tag_title">Raises:</p>
291
+ <ul class="raise">
292
+
293
+ <li>
294
+
295
+
296
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
297
+
298
+
299
+
300
+ </li>
301
+
302
+ </ul>
303
+
304
+ </div><table class="source_code">
305
+ <tr>
306
+ <td>
307
+ <pre class="lines">
308
+
309
+
310
+ 5
311
+ 6
312
+ 7
313
+ 8
314
+ 9
315
+ 10
316
+ 11
317
+ 12
318
+ 13</pre>
319
+ </td>
320
+ <td>
321
+ <pre class="code"><span class="info file"># File 'lib/boris/connectors/ssh.rb', line 5</span>
322
+
323
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_cred'>cred</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_logger'>logger</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
324
+ <span class='ivar'>@ssh_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ssh_options</span><span class='rbracket'>]</span>
325
+ <span class='ivar'>@ssh_options</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@password</span> <span class='kw'>if</span> <span class='ivar'>@password</span>
326
+
327
+ <span class='id identifier rubyid_invalid_ssh_options'>invalid_ssh_options</span> <span class='op'>=</span> <span class='ivar'>@ssh_options</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='op'>-</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>VALID_OPTIONS</span>
328
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid ssh option(s): </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_invalid_ssh_options'>invalid_ssh_options</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_invalid_ssh_options'>invalid_ssh_options</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
329
+
330
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_cred'>cred</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_logger'>logger</span><span class='rparen'>)</span>
331
+ <span class='kw'>end</span></pre>
332
+ </td>
333
+ </tr>
334
+ </table>
335
+ </div>
336
+
337
+ </div>
338
+
339
+
340
+ <div id="instance_method_details" class="method_details_list">
341
+ <h2>Instance Method Details</h2>
342
+
343
+
344
+ <div class="method_details first">
345
+ <h3 class="signature first" id="disconnect-instance_method">
346
+
347
+ - (<tt>Object</tt>) <strong>disconnect</strong>
348
+
349
+
350
+
351
+
352
+
353
+ </h3><table class="source_code">
354
+ <tr>
355
+ <td>
356
+ <pre class="lines">
357
+
358
+
359
+ 15
360
+ 16
361
+ 17
362
+ 18
363
+ 19</pre>
364
+ </td>
365
+ <td>
366
+ <pre class="code"><span class="info file"># File 'lib/boris/connectors/ssh.rb', line 15</span>
367
+
368
+ <span class='kw'>def</span> <span class='id identifier rubyid_disconnect'>disconnect</span>
369
+ <span class='kw'>super</span>
370
+ <span class='ivar'>@transport</span> <span class='op'>=</span> <span class='kw'>nil</span>
371
+ <span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>connections closed</span><span class='tstring_end'>'</span></span>
372
+ <span class='kw'>end</span></pre>
373
+ </td>
374
+ </tr>
375
+ </table>
376
+ </div>
377
+
378
+ <div class="method_details ">
379
+ <h3 class="signature " id="establish_connection-instance_method">
380
+
381
+ - (<tt>Object</tt>) <strong>establish_connection</strong>
382
+
383
+
384
+
385
+
386
+
387
+ </h3><table class="source_code">
388
+ <tr>
389
+ <td>
390
+ <pre class="lines">
391
+
392
+
393
+ 21
394
+ 22
395
+ 23
396
+ 24
397
+ 25
398
+ 26
399
+ 27
400
+ 28
401
+ 29
402
+ 30
403
+ 31
404
+ 32
405
+ 33
406
+ 34
407
+ 35
408
+ 36
409
+ 37
410
+ 38
411
+ 39
412
+ 40
413
+ 41
414
+ 42
415
+ 43
416
+ 44
417
+ 45
418
+ 46</pre>
419
+ </td>
420
+ <td>
421
+ <pre class="code"><span class="info file"># File 'lib/boris/connectors/ssh.rb', line 21</span>
422
+
423
+ <span class='kw'>def</span> <span class='id identifier rubyid_establish_connection'>establish_connection</span>
424
+ <span class='kw'>super</span>
425
+
426
+ <span class='kw'>begin</span>
427
+ <span class='ivar'>@transport</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='ivar'>@host</span><span class='comma'>,</span> <span class='ivar'>@user</span><span class='comma'>,</span> <span class='ivar'>@ssh_options</span><span class='rparen'>)</span>
428
+ <span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>connection established</span><span class='tstring_end'>'</span></span>
429
+ <span class='ivar'>@connected</span> <span class='op'>=</span> <span class='ivar'>@reconnectable</span> <span class='op'>=</span> <span class='kw'>true</span>
430
+ <span class='kw'>rescue</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>AuthenticationFailed</span>
431
+ <span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>connection failed (connection made but credentials not accepted with user </span><span class='embexpr_beg'>#{</span><span class='ivar'>@user</span><span class='rbrace'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
432
+ <span class='ivar'>@reconnectable</span> <span class='op'>=</span> <span class='kw'>true</span>
433
+ <span class='kw'>rescue</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>HostKeyMismatch</span>
434
+ <span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>connection failed (host key mismatch)</span><span class='tstring_end'>'</span></span>
435
+ <span class='ivar'>@reconnectable</span> <span class='op'>=</span> <span class='kw'>false</span>
436
+ <span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_error'>error</span>
437
+ <span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>connection failed (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rbrace'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
438
+ <span class='ivar'>@reconnectable</span> <span class='op'>=</span> <span class='kw'>true</span>
439
+ <span class='kw'>end</span>
440
+
441
+ <span class='kw'>if</span> <span class='ivar'>@reconnectable</span> <span class='op'>==</span> <span class='kw'>true</span>
442
+ <span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>connection available for retry</span><span class='tstring_end'>'</span></span>
443
+ <span class='kw'>elsif</span> <span class='ivar'>@reconnectable</span> <span class='op'>==</span> <span class='kw'>false</span>
444
+ <span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>connection does not seem to be available (so we will not retry)</span><span class='tstring_end'>'</span></span>
445
+ <span class='kw'>end</span> <span class='kw'>unless</span> <span class='ivar'>@transport</span>
446
+
447
+ <span class='kw'>return</span> <span class='kw'>self</span>
448
+ <span class='kw'>end</span></pre>
449
+ </td>
450
+ </tr>
451
+ </table>
452
+ </div>
453
+
454
+ <div class="method_details ">
455
+ <h3 class="signature " id="value_at-instance_method">
456
+
457
+ - (<tt>Object</tt>) <strong>value_at</strong>(request, request_pty = false)
458
+
459
+
460
+
461
+
462
+
463
+ </h3><table class="source_code">
464
+ <tr>
465
+ <td>
466
+ <pre class="lines">
467
+
468
+
469
+ 48
470
+ 49
471
+ 50</pre>
472
+ </td>
473
+ <td>
474
+ <pre class="code"><span class="info file"># File 'lib/boris/connectors/ssh.rb', line 48</span>
475
+
476
+ <span class='kw'>def</span> <span class='id identifier rubyid_value_at'>value_at</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_request_pty'>request_pty</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
477
+ <span class='id identifier rubyid_values_at'>values_at</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_request_pty'>request_pty</span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
478
+ <span class='kw'>end</span></pre>
479
+ </td>
480
+ </tr>
481
+ </table>
482
+ </div>
483
+
484
+ <div class="method_details ">
485
+ <h3 class="signature " id="values_at-instance_method">
486
+
487
+ - (<tt>Object</tt>) <strong>values_at</strong>(request, request_pty = false, limit = nil)
488
+
489
+
490
+
491
+
492
+
493
+ </h3><table class="source_code">
494
+ <tr>
495
+ <td>
496
+ <pre class="lines">
497
+
498
+
499
+ 52
500
+ 53
501
+ 54
502
+ 55
503
+ 56
504
+ 57
505
+ 58
506
+ 59
507
+ 60
508
+ 61
509
+ 62
510
+ 63
511
+ 64
512
+ 65
513
+ 66
514
+ 67
515
+ 68
516
+ 69
517
+ 70
518
+ 71
519
+ 72
520
+ 73
521
+ 74
522
+ 75
523
+ 76
524
+ 77
525
+ 78
526
+ 79
527
+ 80
528
+ 81
529
+ 82
530
+ 83
531
+ 84
532
+ 85
533
+ 86
534
+ 87
535
+ 88
536
+ 89
537
+ 90
538
+ 91
539
+ 92
540
+ 93
541
+ 94
542
+ 95
543
+ 96
544
+ 97
545
+ 98
546
+ 99
547
+ 100
548
+ 101
549
+ 102
550
+ 103
551
+ 104
552
+ 105
553
+ 106
554
+ 107
555
+ 108</pre>
556
+ </td>
557
+ <td>
558
+ <pre class="code"><span class="info file"># File 'lib/boris/connectors/ssh.rb', line 52</span>
559
+
560
+ <span class='kw'>def</span> <span class='id identifier rubyid_values_at'>values_at</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_request_pty'>request_pty</span><span class='op'>=</span><span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_limit'>limit</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
561
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_limit'>limit</span><span class='rparen'>)</span>
562
+
563
+ <span class='id identifier rubyid_error_messages'>error_messages</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
564
+ <span class='id identifier rubyid_reconnect'>reconnect</span> <span class='op'>=</span> <span class='kw'>false</span>
565
+ <span class='id identifier rubyid_return_data'>return_data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
566
+
567
+ <span class='id identifier rubyid_chan'>chan</span> <span class='op'>=</span> <span class='ivar'>@transport</span><span class='period'>.</span><span class='id identifier rubyid_open_channel'>open_channel</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_chan'>chan</span><span class='op'>|</span>
568
+ <span class='kw'>if</span> <span class='id identifier rubyid_request_pty'>request_pty</span>
569
+ <span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>requsting pty...</span><span class='tstring_end'>'</span></span>
570
+ <span class='id identifier rubyid_chan'>chan</span><span class='period'>.</span><span class='id identifier rubyid_request_pty'>request_pty</span><span class='lparen'>(</span><span class='rparen'>)</span>
571
+ <span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pty successfully requested</span><span class='tstring_end'>'</span></span>
572
+ <span class='kw'>end</span>
573
+
574
+ <span class='id identifier rubyid_chan'>chan</span><span class='period'>.</span><span class='id identifier rubyid_on_data'>on_data</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_ch'>ch</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='op'>|</span>
575
+ <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\[sudo\] password for</span><span class='regexp_end'>/i</span></span>
576
+ <span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>system asking for password for sudo request</span><span class='tstring_end'>'</span></span>
577
+ <span class='kw'>if</span> <span class='ivar'>@password</span>
578
+ <span class='id identifier rubyid_ch'>ch</span><span class='period'>.</span><span class='id identifier rubyid_send_data'>send_data</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@password</span><span class='rbrace'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
579
+ <span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>password sent</span><span class='tstring_end'>'</span></span>
580
+ <span class='kw'>else</span>
581
+ <span class='id identifier rubyid_ch'>ch</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
582
+ <span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>channel closed (we don't have a password to supply)</span><span class='tstring_end'>&quot;</span></span>
583
+ <span class='kw'>end</span>
584
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>sorry, try again</span><span class='regexp_end'>/i</span></span>
585
+ <span class='id identifier rubyid_ch'>ch</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
586
+ <span class='id identifier rubyid_return_data'>return_data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
587
+ <span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>channel closed (we have a password to supply but system its not accepted)</span><span class='tstring_end'>&quot;</span></span>
588
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>permission denied</span><span class='regexp_end'>/i</span></span>
589
+ <span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>permission denied for this request (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\n|\s+</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
590
+ <span class='kw'>else</span>
591
+ <span class='id identifier rubyid_return_data'>return_data</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_data'>data</span>
592
+ <span class='kw'>end</span>
593
+ <span class='kw'>end</span>
594
+
595
+ <span class='comment'># called when something is written to stderr
596
+ </span> <span class='id identifier rubyid_chan'>chan</span><span class='period'>.</span><span class='id identifier rubyid_on_extended_data'>on_extended_data</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_ch'>ch</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='op'>|</span>
597
+ <span class='id identifier rubyid_error_messages'>error_messages</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\n</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
598
+ <span class='kw'>end</span>
599
+
600
+ <span class='id identifier rubyid_chan'>chan</span><span class='period'>.</span><span class='id identifier rubyid_exec'>exec</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
601
+ <span class='kw'>end</span>
602
+
603
+ <span class='id identifier rubyid_chan'>chan</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
604
+
605
+ <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_error_messages'>error_messages</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
606
+ <span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>message written to STDERR for this request (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_error_messages'>error_messages</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>. </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
607
+ <span class='kw'>end</span>
608
+
609
+ <span class='id identifier rubyid_return_data'>return_data</span> <span class='op'>=</span> <span class='id identifier rubyid_return_data'>return_data</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\n</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
610
+
611
+ <span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_return_data'>return_data</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='rbrace'>}</span><span class='tstring_content'> row(s) returned</span><span class='tstring_end'>&quot;</span></span>
612
+
613
+ <span class='id identifier rubyid_limit'>limit</span> <span class='op'>=</span> <span class='id identifier rubyid_return_data'>return_data</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='kw'>if</span> <span class='id identifier rubyid_limit'>limit</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
614
+
615
+ <span class='id identifier rubyid_return_data'>return_data</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_limit'>limit</span><span class='rbracket'>]</span>
616
+ <span class='kw'>end</span></pre>
617
+ </td>
618
+ </tr>
619
+ </table>
620
+ </div>
621
+
622
+ </div>
623
+
624
+ </div>
625
+
626
+ <div id="footer">
627
+ Generated on Sun Feb 3 16:32:43 2013 by
628
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
629
+ 0.8.3 (ruby-1.9.3).
630
+ </div>
631
+
632
+ </body>
633
+ </html>