foreman_api 0.1.1 → 0.1.2

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 (85) hide show
  1. data/.gitignore +3 -0
  2. data/Gemfile +2 -0
  3. data/Rakefile +0 -1
  4. data/doc/ForemanApi.html +5 -5
  5. data/doc/ForemanApi/Resources.html +6 -6
  6. data/doc/ForemanApi/Resources/Architecture.html +260 -127
  7. data/doc/ForemanApi/Resources/Audit.html +118 -51
  8. data/doc/ForemanApi/Resources/AuthSourceLdap.html +314 -163
  9. data/doc/ForemanApi/Resources/Bookmark.html +266 -131
  10. data/doc/ForemanApi/Resources/CommonParameter.html +260 -127
  11. data/doc/ForemanApi/Resources/ComputeResource.html +314 -165
  12. data/doc/ForemanApi/Resources/ConfigTemplate.html +387 -195
  13. data/doc/ForemanApi/Resources/Dashboard.html +53 -27
  14. data/doc/ForemanApi/Resources/Domain.html +275 -137
  15. data/doc/ForemanApi/Resources/Environment.html +254 -123
  16. data/doc/ForemanApi/Resources/FactValue.html +75 -32
  17. data/doc/ForemanApi/Resources/Home.html +92 -43
  18. data/doc/ForemanApi/Resources/Host.html +401 -212
  19. data/doc/ForemanApi/Resources/HostClass.html +698 -0
  20. data/doc/ForemanApi/Resources/Hostgroup.html +308 -159
  21. data/doc/ForemanApi/Resources/HostgroupClass.html +712 -0
  22. data/doc/ForemanApi/Resources/Image.html +284 -143
  23. data/doc/ForemanApi/Resources/LookupKey.html +295 -140
  24. data/doc/ForemanApi/Resources/Medium.html +278 -145
  25. data/doc/ForemanApi/Resources/Model.html +272 -135
  26. data/doc/ForemanApi/Resources/OperatingSystem.html +323 -160
  27. data/doc/ForemanApi/Resources/Parameter.html +1512 -0
  28. data/doc/ForemanApi/Resources/Ptable.html +266 -131
  29. data/doc/ForemanApi/Resources/Puppetclass.html +295 -131
  30. data/doc/ForemanApi/Resources/Report.html +311 -71
  31. data/doc/ForemanApi/Resources/Role.html +248 -119
  32. data/doc/ForemanApi/Resources/Setting.html +156 -76
  33. data/doc/ForemanApi/Resources/SmartProxy.html +257 -125
  34. data/doc/ForemanApi/Resources/Subnet.html +332 -175
  35. data/doc/ForemanApi/Resources/TemplateCombination.html +826 -0
  36. data/doc/ForemanApi/Resources/TemplateKind.html +56 -29
  37. data/doc/ForemanApi/Resources/User.html +287 -145
  38. data/doc/ForemanApi/Resources/Usergroup.html +272 -115
  39. data/doc/_index.html +32 -4
  40. data/doc/class_list.html +1 -1
  41. data/doc/css/style.css +10 -0
  42. data/doc/file.MIT-LICENSE.html +29 -24
  43. data/doc/file.README.html +60 -59
  44. data/doc/frames.html +1 -1
  45. data/doc/index.html +60 -59
  46. data/doc/method_list.html +434 -266
  47. data/doc/top-level-namespace.html +3 -3
  48. data/lib/foreman_api.rb +0 -13
  49. data/lib/foreman_api/base.rb +77 -7
  50. data/lib/foreman_api/documentation.json +1 -1
  51. data/lib/foreman_api/resources/architecture.rb +27 -32
  52. data/lib/foreman_api/resources/audit.rb +9 -10
  53. data/lib/foreman_api/resources/auth_source_ldap.rb +47 -52
  54. data/lib/foreman_api/resources/bookmark.rb +31 -36
  55. data/lib/foreman_api/resources/common_parameter.rb +27 -32
  56. data/lib/foreman_api/resources/compute_resource.rb +43 -48
  57. data/lib/foreman_api/resources/config_template.rb +43 -50
  58. data/lib/foreman_api/resources/dashboard.rb +4 -5
  59. data/lib/foreman_api/resources/domain.rb +30 -35
  60. data/lib/foreman_api/resources/environment.rb +25 -30
  61. data/lib/foreman_api/resources/fact_value.rb +5 -5
  62. data/lib/foreman_api/resources/home.rb +7 -9
  63. data/lib/foreman_api/resources/host.rb +63 -69
  64. data/lib/foreman_api/resources/host_class.rb +39 -0
  65. data/lib/foreman_api/resources/hostgroup.rb +43 -48
  66. data/lib/foreman_api/resources/hostgroup_class.rb +40 -0
  67. data/lib/foreman_api/resources/image.rb +40 -45
  68. data/lib/foreman_api/resources/lookup_key.rb +36 -40
  69. data/lib/foreman_api/resources/medium.rb +29 -34
  70. data/lib/foreman_api/resources/model.rb +31 -36
  71. data/lib/foreman_api/resources/operating_system.rb +39 -45
  72. data/lib/foreman_api/resources/parameter.rb +96 -0
  73. data/lib/foreman_api/resources/ptable.rb +29 -34
  74. data/lib/foreman_api/resources/puppetclass.rb +31 -34
  75. data/lib/foreman_api/resources/report.rb +17 -20
  76. data/lib/foreman_api/resources/role.rb +25 -30
  77. data/lib/foreman_api/resources/setting.rb +15 -18
  78. data/lib/foreman_api/resources/smart_proxy.rb +27 -32
  79. data/lib/foreman_api/resources/subnet.rb +47 -52
  80. data/lib/foreman_api/resources/template_combination.rb +21 -25
  81. data/lib/foreman_api/resources/template_kind.rb +4 -5
  82. data/lib/foreman_api/resources/user.rb +36 -41
  83. data/lib/foreman_api/resources/usergroup.rb +25 -30
  84. data/lib/foreman_api/version.rb +1 -1
  85. metadata +10 -2
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ForemanApi::Resources::Bookmark
8
8
 
9
- &mdash; Documentation by YARD 0.8.3
9
+ &mdash; Documentation by YARD 0.8.5.2
10
10
 
11
11
  </title>
12
12
 
@@ -150,7 +150,7 @@
150
150
  <li class="public ">
151
151
  <span class="summary_signature">
152
152
 
153
- <a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong>(params = { }, headers = { }) </a>
153
+ <a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
154
154
 
155
155
 
156
156
 
@@ -164,7 +164,10 @@
164
164
 
165
165
 
166
166
 
167
- <span class="summary_desc"><div class='inline'></div></span>
167
+ <span class="summary_desc"><div class='inline'><p>
168
+ First item: parsed data; second item: raw body.
169
+ </p>
170
+ </div></span>
168
171
 
169
172
  </li>
170
173
 
@@ -172,7 +175,7 @@
172
175
  <li class="public ">
173
176
  <span class="summary_signature">
174
177
 
175
- <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(params = { }, headers = { }) </a>
178
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
176
179
 
177
180
 
178
181
 
@@ -186,7 +189,10 @@
186
189
 
187
190
 
188
191
 
189
- <span class="summary_desc"><div class='inline'></div></span>
192
+ <span class="summary_desc"><div class='inline'><p>
193
+ First item: parsed data; second item: raw body.
194
+ </p>
195
+ </div></span>
190
196
 
191
197
  </li>
192
198
 
@@ -194,7 +200,7 @@
194
200
  <li class="public ">
195
201
  <span class="summary_signature">
196
202
 
197
- <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong>(params = { }, headers = { }) </a>
203
+ <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
198
204
 
199
205
 
200
206
 
@@ -208,7 +214,10 @@
208
214
 
209
215
 
210
216
 
211
- <span class="summary_desc"><div class='inline'></div></span>
217
+ <span class="summary_desc"><div class='inline'><p>
218
+ First item: parsed data; second item: raw body.
219
+ </p>
220
+ </div></span>
212
221
 
213
222
  </li>
214
223
 
@@ -216,7 +225,7 @@
216
225
  <li class="public ">
217
226
  <span class="summary_signature">
218
227
 
219
- <a href="#show-instance_method" title="#show (instance method)">- (Object) <strong>show</strong>(params = { }, headers = { }) </a>
228
+ <a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
220
229
 
221
230
 
222
231
 
@@ -230,7 +239,10 @@
230
239
 
231
240
 
232
241
 
233
- <span class="summary_desc"><div class='inline'></div></span>
242
+ <span class="summary_desc"><div class='inline'><p>
243
+ First item: parsed data; second item: raw body.
244
+ </p>
245
+ </div></span>
234
246
 
235
247
  </li>
236
248
 
@@ -238,7 +250,7 @@
238
250
  <li class="public ">
239
251
  <span class="summary_signature">
240
252
 
241
- <a href="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</strong>(params = { }, headers = { }) </a>
253
+ <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
242
254
 
243
255
 
244
256
 
@@ -252,7 +264,10 @@
252
264
 
253
265
 
254
266
 
255
- <span class="summary_desc"><div class='inline'></div></span>
267
+ <span class="summary_desc"><div class='inline'><p>
268
+ First item: parsed data; second item: raw body.
269
+ </p>
270
+ </div></span>
256
271
 
257
272
  </li>
258
273
 
@@ -289,9 +304,10 @@
289
304
  <td>
290
305
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 4</span>
291
306
 
292
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
293
- <span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bookmarks</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
294
- <span class='kw'>end</span></pre>
307
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
308
+ <span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>&quot;bookmarks&quot;</span><span class='rbrack token'>]</span>
309
+ <span class='rubyid_end end kw'>end</span>
310
+ </pre>
295
311
  </td>
296
312
  </tr>
297
313
  </table>
@@ -306,7 +322,7 @@
306
322
  <div class="method_details first">
307
323
  <h3 class="signature first" id="create-instance_method">
308
324
 
309
- - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
325
+ - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
310
326
 
311
327
 
312
328
 
@@ -314,7 +330,10 @@
314
330
 
315
331
  </h3><div class="docstring">
316
332
  <div class="discussion">
317
-
333
+ <p>
334
+ First item: parsed data; second item: raw body
335
+ </p>
336
+
318
337
 
319
338
  </div>
320
339
  </div>
@@ -330,12 +349,13 @@
330
349
  <span class='type'>(<tt>Hash</tt>)</span>
331
350
 
332
351
 
333
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
352
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
334
353
 
335
354
 
336
355
  &mdash;
337
- <div class='inline'>
338
- <p>a hash of params to be passed to the service</p>
356
+ <div class='inline'><p>
357
+ a hash of params to be passed to the service
358
+ </p>
339
359
  </div>
340
360
 
341
361
  </li>
@@ -348,12 +368,13 @@
348
368
  <span class='type'>(<tt>Hash</tt>)</span>
349
369
 
350
370
 
351
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
371
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
352
372
 
353
373
 
354
374
  &mdash;
355
- <div class='inline'>
356
- <p>additional http headers</p>
375
+ <div class='inline'><p>
376
+ additional http headers
377
+ </p>
357
378
  </div>
358
379
 
359
380
  </li>
@@ -373,17 +394,23 @@
373
394
 
374
395
  </span>
375
396
 
376
- &mdash; <div class='inline'>
377
- <p>allowed keys are:</p>
378
- <ul><li>
379
- <p>controller [String],</p>
380
- </li><li>
381
- <p>name [String],</p>
382
- </li><li>
383
- <p>public [String],</p>
384
- </li><li>
385
- <p>query [String],</p>
386
- </li></ul>
397
+ &mdash; <div class='inline'><p>
398
+ allowed keys are:
399
+ </p>
400
+ <ul>
401
+ <li>controller [String]
402
+
403
+ </li>
404
+ <li>name [String]
405
+
406
+ </li>
407
+ <li>public [String]
408
+
409
+ </li>
410
+ <li>query [String]
411
+
412
+ </li>
413
+ </ul>
387
414
  </div>
388
415
 
389
416
  </li>
@@ -393,6 +420,25 @@
393
420
 
394
421
 
395
422
 
423
+ <p class="tag_title">Returns:</p>
424
+ <ul class="return">
425
+
426
+ <li>
427
+
428
+
429
+ <span class='type'>(<tt>Array</tt>)</span>
430
+
431
+
432
+
433
+ &mdash;
434
+ <div class='inline'><p>
435
+ First item: parsed data; second item: raw body
436
+ </p>
437
+ </div>
438
+
439
+ </li>
440
+
441
+ </ul>
396
442
 
397
443
  </div><table class="source_code">
398
444
  <tr>
@@ -400,20 +446,17 @@
400
446
  <pre class="lines">
401
447
 
402
448
 
449
+ 37
403
450
  38
404
- 39
405
- 40
406
- 41
407
- 42</pre>
451
+ 39</pre>
408
452
  </td>
409
453
  <td>
410
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 38</span>
454
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 37</span>
411
455
 
412
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
413
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
414
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/bookmarks</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
415
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
416
- <span class='kw'>end</span></pre>
456
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
457
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
458
+ <span class='rubyid_end end kw'>end</span>
459
+ </pre>
417
460
  </td>
418
461
  </tr>
419
462
  </table>
@@ -422,7 +465,7 @@
422
465
  <div class="method_details ">
423
466
  <h3 class="signature " id="destroy-instance_method">
424
467
 
425
- - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
468
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
426
469
 
427
470
 
428
471
 
@@ -430,7 +473,10 @@
430
473
 
431
474
  </h3><div class="docstring">
432
475
  <div class="discussion">
433
-
476
+ <p>
477
+ First item: parsed data; second item: raw body
478
+ </p>
479
+
434
480
 
435
481
  </div>
436
482
  </div>
@@ -446,12 +492,13 @@
446
492
  <span class='type'>(<tt>Hash</tt>)</span>
447
493
 
448
494
 
449
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
495
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
450
496
 
451
497
 
452
498
  &mdash;
453
- <div class='inline'>
454
- <p>a hash of params to be passed to the service</p>
499
+ <div class='inline'><p>
500
+ a hash of params to be passed to the service
501
+ </p>
455
502
  </div>
456
503
 
457
504
  </li>
@@ -464,12 +511,13 @@
464
511
  <span class='type'>(<tt>Hash</tt>)</span>
465
512
 
466
513
 
467
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
514
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
468
515
 
469
516
 
470
517
  &mdash;
471
- <div class='inline'>
472
- <p>additional http headers</p>
518
+ <div class='inline'><p>
519
+ additional http headers
520
+ </p>
473
521
  </div>
474
522
 
475
523
  </li>
@@ -496,6 +544,25 @@
496
544
 
497
545
 
498
546
 
547
+ <p class="tag_title">Returns:</p>
548
+ <ul class="return">
549
+
550
+ <li>
551
+
552
+
553
+ <span class='type'>(<tt>Array</tt>)</span>
554
+
555
+
556
+
557
+ &mdash;
558
+ <div class='inline'><p>
559
+ First item: parsed data; second item: raw body
560
+ </p>
561
+ </div>
562
+
563
+ </li>
564
+
565
+ </ul>
499
566
 
500
567
  </div><table class="source_code">
501
568
  <tr>
@@ -503,20 +570,17 @@
503
570
  <pre class="lines">
504
571
 
505
572
 
506
- 64
507
- 65
508
- 66
509
- 67
510
- 68</pre>
573
+ 61
574
+ 62
575
+ 63</pre>
511
576
  </td>
512
577
  <td>
513
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 64</span>
578
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 61</span>
514
579
 
515
- <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
516
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
517
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/bookmarks/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
518
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
519
- <span class='kw'>end</span></pre>
580
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
581
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
582
+ <span class='rubyid_end end kw'>end</span>
583
+ </pre>
520
584
  </td>
521
585
  </tr>
522
586
  </table>
@@ -525,7 +589,7 @@
525
589
  <div class="method_details ">
526
590
  <h3 class="signature " id="index-instance_method">
527
591
 
528
- - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
592
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
529
593
 
530
594
 
531
595
 
@@ -533,7 +597,10 @@
533
597
 
534
598
  </h3><div class="docstring">
535
599
  <div class="discussion">
536
-
600
+ <p>
601
+ First item: parsed data; second item: raw body
602
+ </p>
603
+
537
604
 
538
605
  </div>
539
606
  </div>
@@ -549,12 +616,13 @@
549
616
  <span class='type'>(<tt>Hash</tt>)</span>
550
617
 
551
618
 
552
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
619
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
553
620
 
554
621
 
555
622
  &mdash;
556
- <div class='inline'>
557
- <p>a hash of params to be passed to the service</p>
623
+ <div class='inline'><p>
624
+ a hash of params to be passed to the service
625
+ </p>
558
626
  </div>
559
627
 
560
628
  </li>
@@ -567,12 +635,13 @@
567
635
  <span class='type'>(<tt>Hash</tt>)</span>
568
636
 
569
637
 
570
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
638
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
571
639
 
572
640
 
573
641
  &mdash;
574
- <div class='inline'>
575
- <p>additional http headers</p>
642
+ <div class='inline'><p>
643
+ additional http headers
644
+ </p>
576
645
  </div>
577
646
 
578
647
  </li>
@@ -592,8 +661,9 @@
592
661
 
593
662
  </span>
594
663
 
595
- &mdash; <div class='inline'>
596
- <p>Paginate results</p>
664
+ &mdash; <div class='inline'><p>
665
+ Paginate results
666
+ </p>
597
667
  </div>
598
668
 
599
669
  </li>
@@ -605,8 +675,9 @@
605
675
 
606
676
  </span>
607
677
 
608
- &mdash; <div class='inline'>
609
- <p>Number of entries per request</p>
678
+ &mdash; <div class='inline'><p>
679
+ Number of entries per request
680
+ </p>
610
681
  </div>
611
682
 
612
683
  </li>
@@ -616,6 +687,25 @@
616
687
 
617
688
 
618
689
 
690
+ <p class="tag_title">Returns:</p>
691
+ <ul class="return">
692
+
693
+ <li>
694
+
695
+
696
+ <span class='type'>(<tt>Array</tt>)</span>
697
+
698
+
699
+
700
+ &mdash;
701
+ <div class='inline'><p>
702
+ First item: parsed data; second item: raw body
703
+ </p>
704
+ </div>
705
+
706
+ </li>
707
+
708
+ </ul>
619
709
 
620
710
  </div><table class="source_code">
621
711
  <tr>
@@ -623,20 +713,17 @@
623
713
  <pre class="lines">
624
714
 
625
715
 
626
- 13
627
716
  14
628
717
  15
629
- 16
630
- 17</pre>
718
+ 16</pre>
631
719
  </td>
632
720
  <td>
633
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 13</span>
721
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 14</span>
634
722
 
635
- <span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
636
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
637
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/bookmarks</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
638
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
639
- <span class='kw'>end</span></pre>
723
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
724
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
725
+ <span class='rubyid_end end kw'>end</span>
726
+ </pre>
640
727
  </td>
641
728
  </tr>
642
729
  </table>
@@ -645,7 +732,7 @@
645
732
  <div class="method_details ">
646
733
  <h3 class="signature " id="show-instance_method">
647
734
 
648
- - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
735
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
649
736
 
650
737
 
651
738
 
@@ -653,7 +740,10 @@
653
740
 
654
741
  </h3><div class="docstring">
655
742
  <div class="discussion">
656
-
743
+ <p>
744
+ First item: parsed data; second item: raw body
745
+ </p>
746
+
657
747
 
658
748
  </div>
659
749
  </div>
@@ -669,12 +759,13 @@
669
759
  <span class='type'>(<tt>Hash</tt>)</span>
670
760
 
671
761
 
672
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
762
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
673
763
 
674
764
 
675
765
  &mdash;
676
- <div class='inline'>
677
- <p>a hash of params to be passed to the service</p>
766
+ <div class='inline'><p>
767
+ a hash of params to be passed to the service
768
+ </p>
678
769
  </div>
679
770
 
680
771
  </li>
@@ -687,12 +778,13 @@
687
778
  <span class='type'>(<tt>Hash</tt>)</span>
688
779
 
689
780
 
690
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
781
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
691
782
 
692
783
 
693
784
  &mdash;
694
- <div class='inline'>
695
- <p>additional http headers</p>
785
+ <div class='inline'><p>
786
+ additional http headers
787
+ </p>
696
788
  </div>
697
789
 
698
790
  </li>
@@ -719,6 +811,25 @@
719
811
 
720
812
 
721
813
 
814
+ <p class="tag_title">Returns:</p>
815
+ <ul class="return">
816
+
817
+ <li>
818
+
819
+
820
+ <span class='type'>(<tt>Array</tt>)</span>
821
+
822
+
823
+
824
+ &mdash;
825
+ <div class='inline'><p>
826
+ First item: parsed data; second item: raw body
827
+ </p>
828
+ </div>
829
+
830
+ </li>
831
+
832
+ </ul>
722
833
 
723
834
  </div><table class="source_code">
724
835
  <tr>
@@ -728,18 +839,15 @@
728
839
 
729
840
  23
730
841
  24
731
- 25
732
- 26
733
- 27</pre>
842
+ 25</pre>
734
843
  </td>
735
844
  <td>
736
845
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 23</span>
737
846
 
738
- <span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
739
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
740
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/bookmarks/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
741
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
742
- <span class='kw'>end</span></pre>
847
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
848
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
849
+ <span class='rubyid_end end kw'>end</span>
850
+ </pre>
743
851
  </td>
744
852
  </tr>
745
853
  </table>
@@ -748,7 +856,7 @@
748
856
  <div class="method_details ">
749
857
  <h3 class="signature " id="update-instance_method">
750
858
 
751
- - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
859
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
752
860
 
753
861
 
754
862
 
@@ -756,7 +864,10 @@
756
864
 
757
865
  </h3><div class="docstring">
758
866
  <div class="discussion">
759
-
867
+ <p>
868
+ First item: parsed data; second item: raw body
869
+ </p>
870
+
760
871
 
761
872
  </div>
762
873
  </div>
@@ -772,12 +883,13 @@
772
883
  <span class='type'>(<tt>Hash</tt>)</span>
773
884
 
774
885
 
775
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
886
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
776
887
 
777
888
 
778
889
  &mdash;
779
- <div class='inline'>
780
- <p>a hash of params to be passed to the service</p>
890
+ <div class='inline'><p>
891
+ a hash of params to be passed to the service
892
+ </p>
781
893
  </div>
782
894
 
783
895
  </li>
@@ -790,12 +902,13 @@
790
902
  <span class='type'>(<tt>Hash</tt>)</span>
791
903
 
792
904
 
793
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
905
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
794
906
 
795
907
 
796
908
  &mdash;
797
- <div class='inline'>
798
- <p>additional http headers</p>
909
+ <div class='inline'><p>
910
+ additional http headers
911
+ </p>
799
912
  </div>
800
913
 
801
914
  </li>
@@ -824,17 +937,23 @@
824
937
 
825
938
  </span>
826
939
 
827
- &mdash; <div class='inline'>
828
- <p>allowed keys are:</p>
829
- <ul><li>
830
- <p>controller [String],</p>
831
- </li><li>
832
- <p>name [String],</p>
833
- </li><li>
834
- <p>public [String],</p>
835
- </li><li>
836
- <p>query [String],</p>
837
- </li></ul>
940
+ &mdash; <div class='inline'><p>
941
+ allowed keys are:
942
+ </p>
943
+ <ul>
944
+ <li>controller [String]
945
+
946
+ </li>
947
+ <li>name [String]
948
+
949
+ </li>
950
+ <li>public [String]
951
+
952
+ </li>
953
+ <li>query [String]
954
+
955
+ </li>
956
+ </ul>
838
957
  </div>
839
958
 
840
959
  </li>
@@ -844,6 +963,25 @@
844
963
 
845
964
 
846
965
 
966
+ <p class="tag_title">Returns:</p>
967
+ <ul class="return">
968
+
969
+ <li>
970
+
971
+
972
+ <span class='type'>(<tt>Array</tt>)</span>
973
+
974
+
975
+
976
+ &mdash;
977
+ <div class='inline'><p>
978
+ First item: parsed data; second item: raw body
979
+ </p>
980
+ </div>
981
+
982
+ </li>
983
+
984
+ </ul>
847
985
 
848
986
  </div><table class="source_code">
849
987
  <tr>
@@ -851,20 +989,17 @@
851
989
  <pre class="lines">
852
990
 
853
991
 
854
- 54
855
- 55
856
- 56
857
- 57
858
- 58</pre>
992
+ 52
993
+ 53
994
+ 54</pre>
859
995
  </td>
860
996
  <td>
861
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 54</span>
997
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/bookmark.rb', line 52</span>
862
998
 
863
- <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
864
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
865
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/bookmarks/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
866
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
867
- <span class='kw'>end</span></pre>
999
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
1000
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
1001
+ <span class='rubyid_end end kw'>end</span>
1002
+ </pre>
868
1003
  </td>
869
1004
  </tr>
870
1005
  </table>
@@ -875,9 +1010,9 @@
875
1010
  </div>
876
1011
 
877
1012
  <div id="footer">
878
- Generated on Mon Jan 21 15:44:35 2013 by
1013
+ Generated on Tue Mar 19 09:50:25 2013 by
879
1014
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
880
- 0.8.3 (ruby-1.9.3).
1015
+ 0.8.5.2 (ruby-1.8.7).
881
1016
  </div>
882
1017
 
883
1018
  </body>