foreman_api 0.1.3 → 0.1.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.
Files changed (55) hide show
  1. data/README.rdoc +35 -18
  2. data/doc/ForemanApi/Resources/Architecture.html +93 -136
  3. data/doc/ForemanApi/Resources/Audit.html +42 -60
  4. data/doc/ForemanApi/Resources/AuthSourceLdap.html +129 -190
  5. data/doc/ForemanApi/Resources/Bookmark.html +97 -142
  6. data/doc/ForemanApi/Resources/CommonParameter.html +93 -136
  7. data/doc/ForemanApi/Resources/ComputeResource.html +131 -190
  8. data/doc/ForemanApi/Resources/ConfigTemplate.html +145 -211
  9. data/doc/ForemanApi/Resources/Dashboard.html +21 -29
  10. data/doc/ForemanApi/Resources/Domain.html +103 -151
  11. data/doc/ForemanApi/Resources/Environment.html +89 -130
  12. data/doc/ForemanApi/Resources/FactValue.html +29 -41
  13. data/doc/ForemanApi/Resources/Home.html +32 -45
  14. data/doc/ForemanApi/Resources/Host.html +317 -251
  15. data/doc/ForemanApi/Resources/HostClass.html +55 -79
  16. data/doc/ForemanApi/Resources/Hostgroup.html +125 -184
  17. data/doc/ForemanApi/Resources/HostgroupClass.html +57 -82
  18. data/doc/ForemanApi/Resources/Image.html +109 -160
  19. data/doc/ForemanApi/Resources/Location.html +937 -0
  20. data/doc/ForemanApi/Resources/LookupKey.html +111 -163
  21. data/doc/ForemanApi/Resources/Medium.html +113 -154
  22. data/doc/ForemanApi/Resources/Model.html +101 -148
  23. data/doc/ForemanApi/Resources/OperatingSystem.html +118 -173
  24. data/doc/ForemanApi/Resources/Organization.html +937 -0
  25. data/doc/ForemanApi/Resources/Parameter.html +158 -233
  26. data/doc/ForemanApi/Resources/Ptable.html +97 -142
  27. data/doc/ForemanApi/Resources/Puppetclass.html +95 -139
  28. data/doc/ForemanApi/Resources/Report.html +68 -98
  29. data/doc/ForemanApi/Resources/Role.html +85 -124
  30. data/doc/ForemanApi/Resources/Setting.html +58 -84
  31. data/doc/ForemanApi/Resources/SmartProxy.html +91 -133
  32. data/doc/ForemanApi/Resources/Subnet.html +141 -208
  33. data/doc/ForemanApi/Resources/TemplateCombination.html +65 -94
  34. data/doc/ForemanApi/Resources/TemplateKind.html +23 -32
  35. data/doc/ForemanApi/Resources/User.html +111 -163
  36. data/doc/ForemanApi/Resources/Usergroup.html +89 -130
  37. data/doc/ForemanApi/Resources.html +6 -6
  38. data/doc/ForemanApi.html +5 -5
  39. data/doc/_index.html +18 -4
  40. data/doc/class_list.html +1 -1
  41. data/doc/css/style.css +0 -10
  42. data/doc/file.MIT-LICENSE.html +24 -29
  43. data/doc/file.README.html +81 -60
  44. data/doc/frames.html +1 -1
  45. data/doc/index.html +81 -60
  46. data/doc/method_list.html +416 -312
  47. data/doc/top-level-namespace.html +3 -3
  48. data/lib/foreman_api/base.rb +16 -8
  49. data/lib/foreman_api/documentation.json +1 -1
  50. data/lib/foreman_api/resources/host.rb +9 -0
  51. data/lib/foreman_api/resources/location.rb +59 -0
  52. data/lib/foreman_api/resources/medium.rb +2 -2
  53. data/lib/foreman_api/resources/organization.rb +59 -0
  54. data/lib/foreman_api/version.rb +1 -1
  55. metadata +7 -3
data/doc/ForemanApi/Resources/Report.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ForemanApi::Resources::Report
8
8
 
9
- &mdash; Documentation by YARD 0.8.5.2
9
+ &mdash; Documentation by YARD 0.8.3
10
10
 
11
11
  </title>
12
12
 
@@ -164,9 +164,8 @@
164
164
 
165
165
 
166
166
 
167
- <span class="summary_desc"><div class='inline'><p>
168
- First item: parsed data; second item: raw body.
169
- </p>
167
+ <span class="summary_desc"><div class='inline'>
168
+ <p>First item: parsed data; second item: raw body.</p>
170
169
  </div></span>
171
170
 
172
171
  </li>
@@ -189,9 +188,8 @@ First item: parsed data; second item: raw body.
189
188
 
190
189
 
191
190
 
192
- <span class="summary_desc"><div class='inline'><p>
193
- First item: parsed data; second item: raw body.
194
- </p>
191
+ <span class="summary_desc"><div class='inline'>
192
+ <p>First item: parsed data; second item: raw body.</p>
195
193
  </div></span>
196
194
 
197
195
  </li>
@@ -214,9 +212,8 @@ First item: parsed data; second item: raw body.
214
212
 
215
213
 
216
214
 
217
- <span class="summary_desc"><div class='inline'><p>
218
- First item: parsed data; second item: raw body.
219
- </p>
215
+ <span class="summary_desc"><div class='inline'>
216
+ <p>First item: parsed data; second item: raw body.</p>
220
217
  </div></span>
221
218
 
222
219
  </li>
@@ -239,9 +236,8 @@ First item: parsed data; second item: raw body.
239
236
 
240
237
 
241
238
 
242
- <span class="summary_desc"><div class='inline'><p>
243
- First item: parsed data; second item: raw body.
244
- </p>
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>First item: parsed data; second item: raw body.</p>
245
241
  </div></span>
246
242
 
247
243
  </li>
@@ -279,10 +275,9 @@ First item: parsed data; second item: raw body.
279
275
  <td>
280
276
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/report.rb', line 4</span>
281
277
 
282
- <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>
283
- <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;reports&quot;</span><span class='rbrack token'>]</span>
284
- <span class='rubyid_end end kw'>end</span>
285
- </pre>
278
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
279
+ <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'>reports</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
280
+ <span class='kw'>end</span></pre>
286
281
  </td>
287
282
  </tr>
288
283
  </table>
@@ -305,9 +300,8 @@ First item: parsed data; second item: raw body.
305
300
 
306
301
  </h3><div class="docstring">
307
302
  <div class="discussion">
308
- <p>
309
- First item: parsed data; second item: raw body
310
- </p>
303
+
304
+ <p>First item: parsed data; second item: raw body</p>
311
305
 
312
306
 
313
307
  </div>
@@ -328,9 +322,8 @@ First item: parsed data; second item: raw body
328
322
 
329
323
 
330
324
  &mdash;
331
- <div class='inline'><p>
332
- a hash of params to be passed to the service
333
- </p>
325
+ <div class='inline'>
326
+ <p>a hash of params to be passed to the service</p>
334
327
  </div>
335
328
 
336
329
  </li>
@@ -347,9 +340,8 @@ a hash of params to be passed to the service
347
340
 
348
341
 
349
342
  &mdash;
350
- <div class='inline'><p>
351
- additional http headers
352
- </p>
343
+ <div class='inline'>
344
+ <p>additional http headers</p>
353
345
  </div>
354
346
 
355
347
  </li>
@@ -387,9 +379,8 @@ additional http headers
387
379
 
388
380
 
389
381
  &mdash;
390
- <div class='inline'><p>
391
- First item: parsed data; second item: raw body
392
- </p>
382
+ <div class='inline'>
383
+ <p>First item: parsed data; second item: raw body</p>
393
384
  </div>
394
385
 
395
386
  </li>
@@ -409,10 +400,9 @@ First item: parsed data; second item: raw body
409
400
  <td>
410
401
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/report.rb', line 34</span>
411
402
 
412
- <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>
413
- <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>
414
- <span class='rubyid_end end kw'>end</span>
415
- </pre>
403
+ <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>
404
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
405
+ <span class='kw'>end</span></pre>
416
406
  </td>
417
407
  </tr>
418
408
  </table>
@@ -429,9 +419,8 @@ First item: parsed data; second item: raw body
429
419
 
430
420
  </h3><div class="docstring">
431
421
  <div class="discussion">
432
- <p>
433
- First item: parsed data; second item: raw body
434
- </p>
422
+
423
+ <p>First item: parsed data; second item: raw body</p>
435
424
 
436
425
 
437
426
  </div>
@@ -452,9 +441,8 @@ First item: parsed data; second item: raw body
452
441
 
453
442
 
454
443
  &mdash;
455
- <div class='inline'><p>
456
- a hash of params to be passed to the service
457
- </p>
444
+ <div class='inline'>
445
+ <p>a hash of params to be passed to the service</p>
458
446
  </div>
459
447
 
460
448
  </li>
@@ -471,9 +459,8 @@ a hash of params to be passed to the service
471
459
 
472
460
 
473
461
  &mdash;
474
- <div class='inline'><p>
475
- additional http headers
476
- </p>
462
+ <div class='inline'>
463
+ <p>additional http headers</p>
477
464
  </div>
478
465
 
479
466
  </li>
@@ -493,9 +480,8 @@ additional http headers
493
480
 
494
481
  </span>
495
482
 
496
- &mdash; <div class='inline'><p>
497
- Sort results
498
- </p>
483
+ &mdash; <div class='inline'>
484
+ <p>Sort results</p>
499
485
  </div>
500
486
 
501
487
  </li>
@@ -507,9 +493,8 @@ Sort results
507
493
 
508
494
  </span>
509
495
 
510
- &mdash; <div class='inline'><p>
511
- Paginate results
512
- </p>
496
+ &mdash; <div class='inline'>
497
+ <p>Paginate results</p>
513
498
  </div>
514
499
 
515
500
  </li>
@@ -521,9 +506,8 @@ Paginate results
521
506
 
522
507
  </span>
523
508
 
524
- &mdash; <div class='inline'><p>
525
- Number of entries per request
526
- </p>
509
+ &mdash; <div class='inline'>
510
+ <p>Number of entries per request</p>
527
511
  </div>
528
512
 
529
513
  </li>
@@ -535,9 +519,8 @@ Number of entries per request
535
519
 
536
520
  </span>
537
521
 
538
- &mdash; <div class='inline'><p>
539
- Filter results
540
- </p>
522
+ &mdash; <div class='inline'>
523
+ <p>Filter results</p>
541
524
  </div>
542
525
 
543
526
  </li>
@@ -558,9 +541,8 @@ Filter results
558
541
 
559
542
 
560
543
  &mdash;
561
- <div class='inline'><p>
562
- First item: parsed data; second item: raw body
563
- </p>
544
+ <div class='inline'>
545
+ <p>First item: parsed data; second item: raw body</p>
564
546
  </div>
565
547
 
566
548
  </li>
@@ -580,10 +562,9 @@ First item: parsed data; second item: raw body
580
562
  <td>
581
563
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/report.rb', line 16</span>
582
564
 
583
- <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>
584
- <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>
585
- <span class='rubyid_end end kw'>end</span>
586
- </pre>
565
+ <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>
566
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
567
+ <span class='kw'>end</span></pre>
587
568
  </td>
588
569
  </tr>
589
570
  </table>
@@ -600,9 +581,8 @@ First item: parsed data; second item: raw body
600
581
 
601
582
  </h3><div class="docstring">
602
583
  <div class="discussion">
603
- <p>
604
- First item: parsed data; second item: raw body
605
- </p>
584
+
585
+ <p>First item: parsed data; second item: raw body</p>
606
586
 
607
587
 
608
588
  </div>
@@ -623,9 +603,8 @@ First item: parsed data; second item: raw body
623
603
 
624
604
 
625
605
  &mdash;
626
- <div class='inline'><p>
627
- a hash of params to be passed to the service
628
- </p>
606
+ <div class='inline'>
607
+ <p>a hash of params to be passed to the service</p>
629
608
  </div>
630
609
 
631
610
  </li>
@@ -642,9 +621,8 @@ a hash of params to be passed to the service
642
621
 
643
622
 
644
623
  &mdash;
645
- <div class='inline'><p>
646
- additional http headers
647
- </p>
624
+ <div class='inline'>
625
+ <p>additional http headers</p>
648
626
  </div>
649
627
 
650
628
  </li>
@@ -673,9 +651,8 @@ additional http headers
673
651
 
674
652
  </span>
675
653
 
676
- &mdash; <div class='inline'><p>
677
- Part of <tt>/api/hosts/:host_id/reports/last</tt> path
678
- </p>
654
+ &mdash; <div class='inline'>
655
+ <p>Part of <tt>/api/hosts/:host_id/reports/last</tt> path</p>
679
656
  </div>
680
657
 
681
658
  </li>
@@ -696,9 +673,8 @@ Part of <tt>/api/hosts/:host_id/reports/last</tt> path
696
673
 
697
674
 
698
675
  &mdash;
699
- <div class='inline'><p>
700
- First item: parsed data; second item: raw body
701
- </p>
676
+ <div class='inline'>
677
+ <p>First item: parsed data; second item: raw body</p>
702
678
  </div>
703
679
 
704
680
  </li>
@@ -718,10 +694,9 @@ First item: parsed data; second item: raw body
718
694
  <td>
719
695
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/report.rb', line 44</span>
720
696
 
721
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_last identifier id'>last</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>
722
- <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>
723
- <span class='rubyid_end end kw'>end</span>
724
- </pre>
697
+ <span class='kw'>def</span> <span class='id identifier rubyid_last'>last</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>
698
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
699
+ <span class='kw'>end</span></pre>
725
700
  </td>
726
701
  </tr>
727
702
  </table>
@@ -738,9 +713,8 @@ First item: parsed data; second item: raw body
738
713
 
739
714
  </h3><div class="docstring">
740
715
  <div class="discussion">
741
- <p>
742
- First item: parsed data; second item: raw body
743
- </p>
716
+
717
+ <p>First item: parsed data; second item: raw body</p>
744
718
 
745
719
 
746
720
  </div>
@@ -761,9 +735,8 @@ First item: parsed data; second item: raw body
761
735
 
762
736
 
763
737
  &mdash;
764
- <div class='inline'><p>
765
- a hash of params to be passed to the service
766
- </p>
738
+ <div class='inline'>
739
+ <p>a hash of params to be passed to the service</p>
767
740
  </div>
768
741
 
769
742
  </li>
@@ -780,9 +753,8 @@ a hash of params to be passed to the service
780
753
 
781
754
 
782
755
  &mdash;
783
- <div class='inline'><p>
784
- additional http headers
785
- </p>
756
+ <div class='inline'>
757
+ <p>additional http headers</p>
786
758
  </div>
787
759
 
788
760
  </li>
@@ -820,9 +792,8 @@ additional http headers
820
792
 
821
793
 
822
794
  &mdash;
823
- <div class='inline'><p>
824
- First item: parsed data; second item: raw body
825
- </p>
795
+ <div class='inline'>
796
+ <p>First item: parsed data; second item: raw body</p>
826
797
  </div>
827
798
 
828
799
  </li>
@@ -842,10 +813,9 @@ First item: parsed data; second item: raw body
842
813
  <td>
843
814
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/report.rb', line 25</span>
844
815
 
845
- <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>
846
- <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>
847
- <span class='rubyid_end end kw'>end</span>
848
- </pre>
816
+ <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>
817
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
818
+ <span class='kw'>end</span></pre>
849
819
  </td>
850
820
  </tr>
851
821
  </table>
@@ -856,9 +826,9 @@ First item: parsed data; second item: raw body
856
826
  </div>
857
827
 
858
828
  <div id="footer">
859
- Generated on Tue Mar 19 09:50:24 2013 by
829
+ Generated on Thu Jun 20 12:05:21 2013 by
860
830
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
861
- 0.8.5.2 (ruby-1.8.7).
831
+ 0.8.3 (ruby-1.9.3).
862
832
  </div>
863
833
 
864
834
  </body>