zabby 0.0.2 → 0.0.4
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.
- data/ChangeLog.rdoc +17 -0
- data/README.rdoc +8 -6
- data/Rakefile +4 -2
- data/TODO.rdoc +12 -0
- data/doc/Zabby.html +9 -9
- data/doc/Zabby/AuthenticationError.html +1 -1
- data/doc/Zabby/Config.html +2 -2
- data/doc/Zabby/ConfigurationError.html +1 -1
- data/doc/Zabby/Connection.html +3 -3
- data/doc/Zabby/ResponseCodeError.html +1 -1
- data/doc/Zabby/Runner.html +142 -201
- data/doc/Zabby/ZObject.html +480 -0
- data/doc/_index.html +14 -1
- data/doc/class_list.html +1 -1
- data/doc/file.ChangeLog.html +91 -0
- data/doc/file.LICENSE.html +1 -1
- data/doc/file.README.html +52 -15
- data/doc/file.TODO.html +99 -0
- data/doc/file_list.html +6 -0
- data/doc/index.html +52 -15
- data/doc/method_list.html +70 -46
- data/doc/top-level-namespace.html +1 -1
- data/lib/zabby/runner.rb +28 -3
- data/lib/zabby/version.rb +1 -1
- data/lib/zabby/zobject.rb +5 -1
- metadata +8 -3
|
@@ -0,0 +1,480 @@
|
|
|
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=fr_fr" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Zabby::ZObject
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.7.4
|
|
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
|
+
relpath = '..';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="../_index.html">Index (Z)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Zabby.html" title="Zabby (module)">Zabby</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">ZObject</span>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<div id="search">
|
|
46
|
+
|
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
48
|
+
|
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
50
|
+
|
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<div class="clear"></div>
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<iframe id="search_frame"></iframe>
|
|
58
|
+
|
|
59
|
+
<div id="content"><h1>Class: Zabby::ZObject
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</h1>
|
|
64
|
+
|
|
65
|
+
<dl class="box">
|
|
66
|
+
|
|
67
|
+
<dt class="r1">Inherits:</dt>
|
|
68
|
+
<dd class="r1">
|
|
69
|
+
<span class="inheritName">Object</span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next">Zabby::ZObject</li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
78
|
+
|
|
79
|
+
</dd>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<dt class="r2 last">Defined in:</dt>
|
|
90
|
+
<dd class="r2 last">lib/zabby/zobject.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
<p>
|
|
98
|
+
Definition of the Zabbix Objects as provided by the Zabbix API
|
|
99
|
+
</p>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
</div>
|
|
104
|
+
<div class="tags">
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
110
|
+
<ul class="summary">
|
|
111
|
+
|
|
112
|
+
<li class="public ">
|
|
113
|
+
<span class="summary_signature">
|
|
114
|
+
|
|
115
|
+
<a href="#zmethods-instance_method" title="#zmethods (instance method)">- (Object) <strong>zmethods</strong> </a>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
</span>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<span class="note title readonly">readonly</span>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
132
|
+
Returns the value of attribute zmethods.
|
|
133
|
+
</p>
|
|
134
|
+
</div></span>
|
|
135
|
+
|
|
136
|
+
</li>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#zname-instance_method" title="#zname (instance method)">- (Object) <strong>zname</strong> </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="note title readonly">readonly</span>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
159
|
+
Returns the value of attribute zname.
|
|
160
|
+
</p>
|
|
161
|
+
</div></span>
|
|
162
|
+
|
|
163
|
+
</li>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</ul>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<h2>
|
|
173
|
+
Instance Method Summary
|
|
174
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
175
|
+
</h2>
|
|
176
|
+
|
|
177
|
+
<ul class="summary">
|
|
178
|
+
|
|
179
|
+
<li class="public ">
|
|
180
|
+
<span class="summary_signature">
|
|
181
|
+
|
|
182
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (ZObject) <strong>initialize</strong>(zname, zmethods) </a>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</span>
|
|
187
|
+
|
|
188
|
+
<span class="note title constructor">constructor</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
198
|
+
Define the Zabbix object name and associated methods.
|
|
199
|
+
</p>
|
|
200
|
+
</div></span>
|
|
201
|
+
|
|
202
|
+
</li>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<li class="public ">
|
|
206
|
+
<span class="summary_signature">
|
|
207
|
+
|
|
208
|
+
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(zmethod, *args, &block) </a>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
222
|
+
Simulate methods on the object.
|
|
223
|
+
</p>
|
|
224
|
+
</div></span>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
</ul>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
<div id="constructor_details" class="method_details_list">
|
|
233
|
+
<h2>Constructor Details</h2>
|
|
234
|
+
|
|
235
|
+
<div class="method_details first">
|
|
236
|
+
<p class="signature first" id="initialize-instance_method">
|
|
237
|
+
|
|
238
|
+
- (<tt><span class='object_link'><a href="" title="Zabby::ZObject (class)">ZObject</a></span></tt>) <strong>initialize</strong>(zname, zmethods)
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
</p><div class="docstring">
|
|
243
|
+
<div class="discussion">
|
|
244
|
+
<p>
|
|
245
|
+
Define the Zabbix object name and associated methods
|
|
246
|
+
</p>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</div>
|
|
250
|
+
</div>
|
|
251
|
+
<div class="tags">
|
|
252
|
+
<h3>Parameters:</h3>
|
|
253
|
+
<ul class="param">
|
|
254
|
+
|
|
255
|
+
<li>
|
|
256
|
+
|
|
257
|
+
<span class='name'>zname</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
—
|
|
265
|
+
<div class='inline'><p>
|
|
266
|
+
Zabbix Object name
|
|
267
|
+
</p>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
</li>
|
|
271
|
+
|
|
272
|
+
<li>
|
|
273
|
+
|
|
274
|
+
<span class='name'>zmethods</span>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
—
|
|
282
|
+
<div class='inline'><p>
|
|
283
|
+
List of associated methods
|
|
284
|
+
</p>
|
|
285
|
+
</div>
|
|
286
|
+
|
|
287
|
+
</li>
|
|
288
|
+
|
|
289
|
+
</ul>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</div><table class="source_code">
|
|
293
|
+
<tr>
|
|
294
|
+
<td>
|
|
295
|
+
<pre class="lines">
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
15
|
|
299
|
+
16
|
|
300
|
+
17
|
|
301
|
+
18</pre>
|
|
302
|
+
</td>
|
|
303
|
+
<td>
|
|
304
|
+
<pre class="code"><span class="info file"># File 'lib/zabby/zobject.rb', line 15</span>
|
|
305
|
+
|
|
306
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_zname identifier id'>zname</span><span class='comma token'>,</span> <span class='rubyid_zmethods identifier id'>zmethods</span><span class='rparen token'>)</span>
|
|
307
|
+
<span class='rubyid_@zname ivar id'>@zname</span> <span class='assign token'>=</span> <span class='rubyid_zname identifier id'>zname</span>
|
|
308
|
+
<span class='rubyid_@zmethods ivar id'>@zmethods</span> <span class='assign token'>=</span> <span class='rubyid_zmethods identifier id'>zmethods</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_f identifier id'>f</span><span class='bitor op'>|</span> <span class='rubyid_f identifier id'>f</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> <span class='rbrace token'>}</span>
|
|
309
|
+
<span class='rubyid_end end kw'>end</span>
|
|
310
|
+
</pre>
|
|
311
|
+
</td>
|
|
312
|
+
</tr>
|
|
313
|
+
</table>
|
|
314
|
+
</div>
|
|
315
|
+
|
|
316
|
+
</div>
|
|
317
|
+
<div id="method_missing_details" class="method_details_list">
|
|
318
|
+
<h2>Dynamic Method Handling</h2>
|
|
319
|
+
<p class="notice this">
|
|
320
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
321
|
+
|
|
322
|
+
</p>
|
|
323
|
+
|
|
324
|
+
<div class="method_details first">
|
|
325
|
+
<p class="signature first" id="method_missing-instance_method">
|
|
326
|
+
|
|
327
|
+
- (<tt>Object</tt>) <strong>method_missing</strong>(zmethod, *args, &block)
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
</p><div class="docstring">
|
|
332
|
+
<div class="discussion">
|
|
333
|
+
<p>
|
|
334
|
+
Simulate methods on the object. For example: "host.get",
|
|
335
|
+
"item.create".. The instance variable @zmethods is the list of
|
|
336
|
+
valid methods.
|
|
337
|
+
</p>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</div>
|
|
341
|
+
</div>
|
|
342
|
+
<div class="tags">
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
</div><table class="source_code">
|
|
346
|
+
<tr>
|
|
347
|
+
<td>
|
|
348
|
+
<pre class="lines">
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
23
|
|
352
|
+
24
|
|
353
|
+
25
|
|
354
|
+
26
|
|
355
|
+
27
|
|
356
|
+
28
|
|
357
|
+
29</pre>
|
|
358
|
+
</td>
|
|
359
|
+
<td>
|
|
360
|
+
<pre class="code"><span class="info file"># File 'lib/zabby/zobject.rb', line 23</span>
|
|
361
|
+
|
|
362
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_method_missing identifier id'>method_missing</span><span class='lparen token'>(</span><span class='rubyid_zmethod identifier id'>zmethod</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='rubyid_args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
|
|
363
|
+
<span class='rubyid_if if kw'>if</span> <span class='rubyid_@zmethods ivar id'>@zmethods</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span> <span class='rubyid_zmethod identifier id'>zmethod</span>
|
|
364
|
+
<span class='rubyid_Zabby constant id'>Zabby</span><span class='colon2 op'>::</span><span class='rubyid_Runner constant id'>Runner</span><span class='dot token'>.</span><span class='rubyid_instance identifier id'>instance</span><span class='dot token'>.</span><span class='rubyid_connection identifier id'>connection</span><span class='dot token'>.</span><span class='rubyid_perform_request identifier id'>perform_request</span><span class='lparen token'>(</span><span class='rubyid_@zname ivar id'>@zname</span><span class='comma token'>,</span> <span class='rubyid_zmethod identifier id'>zmethod</span><span class='comma token'>,</span> <span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span><span class='rparen token'>)</span>
|
|
365
|
+
<span class='rubyid_else else kw'>else</span>
|
|
366
|
+
<span class='rubyid_super super kw'>super</span>
|
|
367
|
+
<span class='rubyid_end end kw'>end</span>
|
|
368
|
+
<span class='rubyid_end end kw'>end</span>
|
|
369
|
+
</pre>
|
|
370
|
+
</td>
|
|
371
|
+
</tr>
|
|
372
|
+
</table>
|
|
373
|
+
</div>
|
|
374
|
+
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
<div id="instance_attr_details" class="attr_details">
|
|
378
|
+
<h2>Instance Attribute Details</h2>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
<span id=""></span>
|
|
382
|
+
<span id="zmethods-instance_method"></span>
|
|
383
|
+
<div class="method_details first">
|
|
384
|
+
<p class="signature first" id="zmethods-instance_method">
|
|
385
|
+
|
|
386
|
+
- (<tt>Object</tt>) <strong>zmethods</strong> <span class="extras">(readonly)</span>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</p><div class="docstring">
|
|
391
|
+
<div class="discussion">
|
|
392
|
+
<p>
|
|
393
|
+
Returns the value of attribute zmethods
|
|
394
|
+
</p>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
</div>
|
|
398
|
+
</div>
|
|
399
|
+
<div class="tags">
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
</div><table class="source_code">
|
|
403
|
+
<tr>
|
|
404
|
+
<td>
|
|
405
|
+
<pre class="lines">
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
9
|
|
409
|
+
10
|
|
410
|
+
11</pre>
|
|
411
|
+
</td>
|
|
412
|
+
<td>
|
|
413
|
+
<pre class="code"><span class="info file"># File 'lib/zabby/zobject.rb', line 9</span>
|
|
414
|
+
|
|
415
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_zmethods identifier id'>zmethods</span>
|
|
416
|
+
<span class='rubyid_@zmethods ivar id'>@zmethods</span>
|
|
417
|
+
<span class='rubyid_end end kw'>end</span>
|
|
418
|
+
</pre>
|
|
419
|
+
</td>
|
|
420
|
+
</tr>
|
|
421
|
+
</table>
|
|
422
|
+
</div>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<span id=""></span>
|
|
426
|
+
<span id="zname-instance_method"></span>
|
|
427
|
+
<div class="method_details ">
|
|
428
|
+
<p class="signature " id="zname-instance_method">
|
|
429
|
+
|
|
430
|
+
- (<tt>Object</tt>) <strong>zname</strong> <span class="extras">(readonly)</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</p><div class="docstring">
|
|
435
|
+
<div class="discussion">
|
|
436
|
+
<p>
|
|
437
|
+
Returns the value of attribute zname
|
|
438
|
+
</p>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
</div>
|
|
442
|
+
</div>
|
|
443
|
+
<div class="tags">
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</div><table class="source_code">
|
|
447
|
+
<tr>
|
|
448
|
+
<td>
|
|
449
|
+
<pre class="lines">
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
9
|
|
453
|
+
10
|
|
454
|
+
11</pre>
|
|
455
|
+
</td>
|
|
456
|
+
<td>
|
|
457
|
+
<pre class="code"><span class="info file"># File 'lib/zabby/zobject.rb', line 9</span>
|
|
458
|
+
|
|
459
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_zname identifier id'>zname</span>
|
|
460
|
+
<span class='rubyid_@zname ivar id'>@zname</span>
|
|
461
|
+
<span class='rubyid_end end kw'>end</span>
|
|
462
|
+
</pre>
|
|
463
|
+
</td>
|
|
464
|
+
</tr>
|
|
465
|
+
</table>
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</div>
|
|
472
|
+
|
|
473
|
+
<div id="footer">
|
|
474
|
+
Generated on Wed Dec 21 12:25:12 2011 by
|
|
475
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
476
|
+
0.7.4 (ruby-1.8.7).
|
|
477
|
+
</div>
|
|
478
|
+
|
|
479
|
+
</body>
|
|
480
|
+
</html>
|