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.
- data/.gitignore +3 -0
- data/Gemfile +2 -0
- data/Rakefile +0 -1
- data/doc/ForemanApi.html +5 -5
- data/doc/ForemanApi/Resources.html +6 -6
- data/doc/ForemanApi/Resources/Architecture.html +260 -127
- data/doc/ForemanApi/Resources/Audit.html +118 -51
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +314 -163
- data/doc/ForemanApi/Resources/Bookmark.html +266 -131
- data/doc/ForemanApi/Resources/CommonParameter.html +260 -127
- data/doc/ForemanApi/Resources/ComputeResource.html +314 -165
- data/doc/ForemanApi/Resources/ConfigTemplate.html +387 -195
- data/doc/ForemanApi/Resources/Dashboard.html +53 -27
- data/doc/ForemanApi/Resources/Domain.html +275 -137
- data/doc/ForemanApi/Resources/Environment.html +254 -123
- data/doc/ForemanApi/Resources/FactValue.html +75 -32
- data/doc/ForemanApi/Resources/Home.html +92 -43
- data/doc/ForemanApi/Resources/Host.html +401 -212
- data/doc/ForemanApi/Resources/HostClass.html +698 -0
- data/doc/ForemanApi/Resources/Hostgroup.html +308 -159
- data/doc/ForemanApi/Resources/HostgroupClass.html +712 -0
- data/doc/ForemanApi/Resources/Image.html +284 -143
- data/doc/ForemanApi/Resources/LookupKey.html +295 -140
- data/doc/ForemanApi/Resources/Medium.html +278 -145
- data/doc/ForemanApi/Resources/Model.html +272 -135
- data/doc/ForemanApi/Resources/OperatingSystem.html +323 -160
- data/doc/ForemanApi/Resources/Parameter.html +1512 -0
- data/doc/ForemanApi/Resources/Ptable.html +266 -131
- data/doc/ForemanApi/Resources/Puppetclass.html +295 -131
- data/doc/ForemanApi/Resources/Report.html +311 -71
- data/doc/ForemanApi/Resources/Role.html +248 -119
- data/doc/ForemanApi/Resources/Setting.html +156 -76
- data/doc/ForemanApi/Resources/SmartProxy.html +257 -125
- data/doc/ForemanApi/Resources/Subnet.html +332 -175
- data/doc/ForemanApi/Resources/TemplateCombination.html +826 -0
- data/doc/ForemanApi/Resources/TemplateKind.html +56 -29
- data/doc/ForemanApi/Resources/User.html +287 -145
- data/doc/ForemanApi/Resources/Usergroup.html +272 -115
- data/doc/_index.html +32 -4
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +10 -0
- data/doc/file.MIT-LICENSE.html +29 -24
- data/doc/file.README.html +60 -59
- data/doc/frames.html +1 -1
- data/doc/index.html +60 -59
- data/doc/method_list.html +434 -266
- data/doc/top-level-namespace.html +3 -3
- data/lib/foreman_api.rb +0 -13
- data/lib/foreman_api/base.rb +77 -7
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/architecture.rb +27 -32
- data/lib/foreman_api/resources/audit.rb +9 -10
- data/lib/foreman_api/resources/auth_source_ldap.rb +47 -52
- data/lib/foreman_api/resources/bookmark.rb +31 -36
- data/lib/foreman_api/resources/common_parameter.rb +27 -32
- data/lib/foreman_api/resources/compute_resource.rb +43 -48
- data/lib/foreman_api/resources/config_template.rb +43 -50
- data/lib/foreman_api/resources/dashboard.rb +4 -5
- data/lib/foreman_api/resources/domain.rb +30 -35
- data/lib/foreman_api/resources/environment.rb +25 -30
- data/lib/foreman_api/resources/fact_value.rb +5 -5
- data/lib/foreman_api/resources/home.rb +7 -9
- data/lib/foreman_api/resources/host.rb +63 -69
- data/lib/foreman_api/resources/host_class.rb +39 -0
- data/lib/foreman_api/resources/hostgroup.rb +43 -48
- data/lib/foreman_api/resources/hostgroup_class.rb +40 -0
- data/lib/foreman_api/resources/image.rb +40 -45
- data/lib/foreman_api/resources/lookup_key.rb +36 -40
- data/lib/foreman_api/resources/medium.rb +29 -34
- data/lib/foreman_api/resources/model.rb +31 -36
- data/lib/foreman_api/resources/operating_system.rb +39 -45
- data/lib/foreman_api/resources/parameter.rb +96 -0
- data/lib/foreman_api/resources/ptable.rb +29 -34
- data/lib/foreman_api/resources/puppetclass.rb +31 -34
- data/lib/foreman_api/resources/report.rb +17 -20
- data/lib/foreman_api/resources/role.rb +25 -30
- data/lib/foreman_api/resources/setting.rb +15 -18
- data/lib/foreman_api/resources/smart_proxy.rb +27 -32
- data/lib/foreman_api/resources/subnet.rb +47 -52
- data/lib/foreman_api/resources/template_combination.rb +21 -25
- data/lib/foreman_api/resources/template_kind.rb +4 -5
- data/lib/foreman_api/resources/user.rb +36 -41
- data/lib/foreman_api/resources/usergroup.rb +25 -30
- data/lib/foreman_api/version.rb +1 -1
- metadata +10 -2
data/doc/_index.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<head>
|
|
5
5
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
6
|
<title>
|
|
7
|
-
Documentation by YARD 0.8.
|
|
7
|
+
Documentation by YARD 0.8.5.2
|
|
8
8
|
|
|
9
9
|
</title>
|
|
10
10
|
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
|
|
57
57
|
<iframe id="search_frame"></iframe>
|
|
58
58
|
|
|
59
|
-
<div id="content"><h1 class="noborder title">Documentation by YARD 0.8.
|
|
59
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.8.5.2</h1>
|
|
60
60
|
<div id="listing">
|
|
61
61
|
<h1 class="alphaindex">Alphabetic Index</h1>
|
|
62
62
|
|
|
@@ -231,6 +231,13 @@
|
|
|
231
231
|
|
|
232
232
|
</li>
|
|
233
233
|
|
|
234
|
+
<li>
|
|
235
|
+
<span class='object_link'><a href="ForemanApi/Resources/HostClass.html" title="ForemanApi::Resources::HostClass (class)">HostClass</a></span>
|
|
236
|
+
|
|
237
|
+
<small>(ForemanApi::Resources)</small>
|
|
238
|
+
|
|
239
|
+
</li>
|
|
240
|
+
|
|
234
241
|
<li>
|
|
235
242
|
<span class='object_link'><a href="ForemanApi/Resources/Hostgroup.html" title="ForemanApi::Resources::Hostgroup (class)">Hostgroup</a></span>
|
|
236
243
|
|
|
@@ -238,6 +245,13 @@
|
|
|
238
245
|
|
|
239
246
|
</li>
|
|
240
247
|
|
|
248
|
+
<li>
|
|
249
|
+
<span class='object_link'><a href="ForemanApi/Resources/HostgroupClass.html" title="ForemanApi::Resources::HostgroupClass (class)">HostgroupClass</a></span>
|
|
250
|
+
|
|
251
|
+
<small>(ForemanApi::Resources)</small>
|
|
252
|
+
|
|
253
|
+
</li>
|
|
254
|
+
|
|
241
255
|
</ul>
|
|
242
256
|
</ul>
|
|
243
257
|
|
|
@@ -316,6 +330,13 @@
|
|
|
316
330
|
<li class="letter">P</li>
|
|
317
331
|
<ul>
|
|
318
332
|
|
|
333
|
+
<li>
|
|
334
|
+
<span class='object_link'><a href="ForemanApi/Resources/Parameter.html" title="ForemanApi::Resources::Parameter (class)">Parameter</a></span>
|
|
335
|
+
|
|
336
|
+
<small>(ForemanApi::Resources)</small>
|
|
337
|
+
|
|
338
|
+
</li>
|
|
339
|
+
|
|
319
340
|
<li>
|
|
320
341
|
<span class='object_link'><a href="ForemanApi/Resources/Ptable.html" title="ForemanApi::Resources::Ptable (class)">Ptable</a></span>
|
|
321
342
|
|
|
@@ -396,6 +417,13 @@
|
|
|
396
417
|
<li class="letter">T</li>
|
|
397
418
|
<ul>
|
|
398
419
|
|
|
420
|
+
<li>
|
|
421
|
+
<span class='object_link'><a href="ForemanApi/Resources/TemplateCombination.html" title="ForemanApi::Resources::TemplateCombination (class)">TemplateCombination</a></span>
|
|
422
|
+
|
|
423
|
+
<small>(ForemanApi::Resources)</small>
|
|
424
|
+
|
|
425
|
+
</li>
|
|
426
|
+
|
|
399
427
|
<li>
|
|
400
428
|
<span class='object_link'><a href="ForemanApi/Resources/TemplateKind.html" title="ForemanApi::Resources::TemplateKind (class)">TemplateKind</a></span>
|
|
401
429
|
|
|
@@ -440,9 +468,9 @@
|
|
|
440
468
|
</div>
|
|
441
469
|
|
|
442
470
|
<div id="footer">
|
|
443
|
-
Generated on
|
|
471
|
+
Generated on Tue Mar 19 09:50:22 2013 by
|
|
444
472
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
445
|
-
0.8.
|
|
473
|
+
0.8.5.2 (ruby-1.8.7).
|
|
446
474
|
</div>
|
|
447
475
|
|
|
448
476
|
</body>
|
data/doc/class_list.html
CHANGED
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
|
|
46
46
|
<ul id="full_list" class="class">
|
|
47
47
|
<li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
|
|
48
|
-
<li><a class='toggle'></a> <span class='object_link'><a href="ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="ForemanApi/Resources.html" title="ForemanApi::Resources (module)">Resources</a></span><small class='search_info'>ForemanApi</small></li><ul><li><span class='object_link'><a href="ForemanApi/Resources/Architecture.html" title="ForemanApi::Resources::Architecture (class)">Architecture</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Audit.html" title="ForemanApi::Resources::Audit (class)">Audit</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/AuthSourceLdap.html" title="ForemanApi::Resources::AuthSourceLdap (class)">AuthSourceLdap</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Bookmark.html" title="ForemanApi::Resources::Bookmark (class)">Bookmark</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/CommonParameter.html" title="ForemanApi::Resources::CommonParameter (class)">CommonParameter</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/ComputeResource.html" title="ForemanApi::Resources::ComputeResource (class)">ComputeResource</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/ConfigTemplate.html" title="ForemanApi::Resources::ConfigTemplate (class)">ConfigTemplate</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Dashboard.html" title="ForemanApi::Resources::Dashboard (class)">Dashboard</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Domain.html" title="ForemanApi::Resources::Domain (class)">Domain</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Environment.html" title="ForemanApi::Resources::Environment (class)">Environment</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/FactValue.html" title="ForemanApi::Resources::FactValue (class)">FactValue</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Home.html" title="ForemanApi::Resources::Home (class)">Home</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Host.html" title="ForemanApi::Resources::Host (class)">Host</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Hostgroup.html" title="ForemanApi::Resources::Hostgroup (class)">Hostgroup</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Image.html" title="ForemanApi::Resources::Image (class)">Image</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/LookupKey.html" title="ForemanApi::Resources::LookupKey (class)">LookupKey</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Medium.html" title="ForemanApi::Resources::Medium (class)">Medium</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Model.html" title="ForemanApi::Resources::Model (class)">Model</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/OperatingSystem.html" title="ForemanApi::Resources::OperatingSystem (class)">OperatingSystem</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Ptable.html" title="ForemanApi::Resources::Ptable (class)">Ptable</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Puppetclass.html" title="ForemanApi::Resources::Puppetclass (class)">Puppetclass</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Report.html" title="ForemanApi::Resources::Report (class)">Report</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Role.html" title="ForemanApi::Resources::Role (class)">Role</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Setting.html" title="ForemanApi::Resources::Setting (class)">Setting</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/SmartProxy.html" title="ForemanApi::Resources::SmartProxy (class)">SmartProxy</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Subnet.html" title="ForemanApi::Resources::Subnet (class)">Subnet</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/TemplateKind.html" title="ForemanApi::Resources::TemplateKind (class)">TemplateKind</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/User.html" title="ForemanApi::Resources::User (class)">User</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Usergroup.html" title="ForemanApi::Resources::Usergroup (class)">Usergroup</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li></ul></ul>
|
|
48
|
+
<li><a class='toggle'></a> <span class='object_link'><a href="ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="ForemanApi/Resources.html" title="ForemanApi::Resources (module)">Resources</a></span><small class='search_info'>ForemanApi</small></li><ul><li><span class='object_link'><a href="ForemanApi/Resources/Architecture.html" title="ForemanApi::Resources::Architecture (class)">Architecture</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Audit.html" title="ForemanApi::Resources::Audit (class)">Audit</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/AuthSourceLdap.html" title="ForemanApi::Resources::AuthSourceLdap (class)">AuthSourceLdap</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Bookmark.html" title="ForemanApi::Resources::Bookmark (class)">Bookmark</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/CommonParameter.html" title="ForemanApi::Resources::CommonParameter (class)">CommonParameter</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/ComputeResource.html" title="ForemanApi::Resources::ComputeResource (class)">ComputeResource</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/ConfigTemplate.html" title="ForemanApi::Resources::ConfigTemplate (class)">ConfigTemplate</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Dashboard.html" title="ForemanApi::Resources::Dashboard (class)">Dashboard</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Domain.html" title="ForemanApi::Resources::Domain (class)">Domain</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Environment.html" title="ForemanApi::Resources::Environment (class)">Environment</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/FactValue.html" title="ForemanApi::Resources::FactValue (class)">FactValue</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Home.html" title="ForemanApi::Resources::Home (class)">Home</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Host.html" title="ForemanApi::Resources::Host (class)">Host</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/HostClass.html" title="ForemanApi::Resources::HostClass (class)">HostClass</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Hostgroup.html" title="ForemanApi::Resources::Hostgroup (class)">Hostgroup</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/HostgroupClass.html" title="ForemanApi::Resources::HostgroupClass (class)">HostgroupClass</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Image.html" title="ForemanApi::Resources::Image (class)">Image</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/LookupKey.html" title="ForemanApi::Resources::LookupKey (class)">LookupKey</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Medium.html" title="ForemanApi::Resources::Medium (class)">Medium</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Model.html" title="ForemanApi::Resources::Model (class)">Model</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/OperatingSystem.html" title="ForemanApi::Resources::OperatingSystem (class)">OperatingSystem</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Parameter.html" title="ForemanApi::Resources::Parameter (class)">Parameter</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Ptable.html" title="ForemanApi::Resources::Ptable (class)">Ptable</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Puppetclass.html" title="ForemanApi::Resources::Puppetclass (class)">Puppetclass</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Report.html" title="ForemanApi::Resources::Report (class)">Report</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Role.html" title="ForemanApi::Resources::Role (class)">Role</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Setting.html" title="ForemanApi::Resources::Setting (class)">Setting</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/SmartProxy.html" title="ForemanApi::Resources::SmartProxy (class)">SmartProxy</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Subnet.html" title="ForemanApi::Resources::Subnet (class)">Subnet</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/TemplateCombination.html" title="ForemanApi::Resources::TemplateCombination (class)">TemplateCombination</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/TemplateKind.html" title="ForemanApi::Resources::TemplateKind (class)">TemplateKind</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/User.html" title="ForemanApi::Resources::User (class)">User</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li><li><span class='object_link'><a href="ForemanApi/Resources/Usergroup.html" title="ForemanApi::Resources::Usergroup (class)">Usergroup</a></span> < Base<small class='search_info'>ForemanApi::Resources</small></li></ul></ul>
|
|
49
49
|
|
|
50
50
|
</ul>
|
|
51
51
|
</div>
|
data/doc/css/style.css
CHANGED
|
@@ -27,6 +27,16 @@ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right;
|
|
|
27
27
|
.rdoc-term { padding-right: 25px; font-weight: bold; }
|
|
28
28
|
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
|
|
29
29
|
|
|
30
|
+
/* style for <table> */
|
|
31
|
+
#filecontents table, .docstring table { border-collapse: collapse; }
|
|
32
|
+
#filecontents table th, #filecontents table td,
|
|
33
|
+
.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
|
|
34
|
+
#filecontents table tr:nth-child(odd),
|
|
35
|
+
.docstring table tr:nth-child(odd) { background: #eee; }
|
|
36
|
+
#filecontents table tr:nth-child(even),
|
|
37
|
+
.docstring table tr:nth-child(even) { background: #fff; }
|
|
38
|
+
#filecontents table th, .docstring table th { background: #fff; }
|
|
39
|
+
|
|
30
40
|
/* style for <ul> */
|
|
31
41
|
#filecontents li > p, .docstring li > p { margin: 0px; }
|
|
32
42
|
#filecontents ul, .docstring ul { padding-left: 20px; }
|
data/doc/file.MIT-LICENSE.html
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
3
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
4
|
<head>
|
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
6
|
<title>
|
|
7
7
|
File: MIT-LICENSE
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.8.
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -61,32 +61,37 @@
|
|
|
61
61
|
|
|
62
62
|
<iframe id="search_frame"></iframe>
|
|
63
63
|
|
|
64
|
-
<div id="content"><div id='filecontents'>
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
<p>
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
64
|
+
<div id="content"><div id='filecontents'><p>
|
|
65
|
+
Copyright 2012 Red Hat, Inc.
|
|
66
|
+
</p>
|
|
67
|
+
<p>
|
|
68
|
+
Permission is hereby granted, free of charge, to any person obtaining a
|
|
69
|
+
copy of this software and associated documentation files (the
|
|
70
|
+
"Software"), to deal in the Software without restriction,
|
|
71
|
+
including without limitation the rights to use, copy, modify, merge,
|
|
72
|
+
publish, distribute, sublicense, and/or sell copies of the Software, and to
|
|
73
|
+
permit persons to whom the Software is furnished to do so, subject to the
|
|
74
|
+
following conditions:
|
|
75
|
+
</p>
|
|
76
|
+
<p>
|
|
77
|
+
The above copyright notice and this permission notice shall be included in
|
|
78
|
+
all copies or substantial portions of the Software.
|
|
79
|
+
</p>
|
|
80
|
+
<p>
|
|
81
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
82
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
83
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
|
|
84
|
+
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
|
85
|
+
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
86
|
+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
87
|
+
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
88
|
+
</p>
|
|
84
89
|
</div></div>
|
|
85
90
|
|
|
86
91
|
<div id="footer">
|
|
87
|
-
Generated on
|
|
92
|
+
Generated on Tue Mar 19 09:50:22 2013 by
|
|
88
93
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
89
|
-
0.8.
|
|
94
|
+
0.8.5.2 (ruby-1.8.7).
|
|
90
95
|
</div>
|
|
91
96
|
|
|
92
97
|
</body>
|
data/doc/file.README.html
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
3
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
4
|
<head>
|
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
6
|
<title>
|
|
7
7
|
File: README
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.8.
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -61,68 +61,69 @@
|
|
|
61
61
|
|
|
62
62
|
<iframe id="search_frame"></iframe>
|
|
63
63
|
|
|
64
|
-
<div id="content"><div id='filecontents'>
|
|
65
|
-
<
|
|
66
|
-
|
|
67
|
-
<
|
|
68
|
-
|
|
69
|
-
<
|
|
70
|
-
<span class=
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
<span class=
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
<p>The bindings brings support for new versioned API which is not complete
|
|
64
|
+
<div id="content"><div id='filecontents'><h1>Foreman API bindings for Ruby</h1>
|
|
65
|
+
<h2>Summary</h2>
|
|
66
|
+
<pre class="code ruby"><code class="ruby">
|
|
67
|
+
<span class='rubyid_require identifier id'>require</span> <span class='string val'>'foreman_api'</span>
|
|
68
|
+
<span class='rubyid_architectures identifier id'>architectures</span> <span class='assign token'>=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='colon2 op'>::</span><span class='rubyid_Resources constant id'>Resources</span><span class='colon2 op'>::</span><span class='rubyid_Architecture constant id'>Architecture</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:base_url</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'http://localhost:3000'</span><span class='comma token'>,</span>
|
|
69
|
+
<span class='symbol val'>:username</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'admin'</span><span class='comma token'>,</span>
|
|
70
|
+
<span class='symbol val'>:password</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'changeme'</span><span class='rparen token'>)</span>
|
|
71
|
+
|
|
72
|
+
<span class='rubyid_pp identifier id'>pp</span> <span class='rubyid_architectures identifier id'>architectures</span><span class='dot token'>.</span><span class='rubyid_index identifier id'>index</span>
|
|
73
|
+
<span class='lbrack token'>[</span><span class='lbrack token'>[</span><span class='lbrace token'>{</span><span class='string val'>"architecture"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='string val'>"id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='string val'>"name"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"i386"</span><span class='rbrace token'>}</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
74
|
+
<span class='lbrace token'>{</span><span class='string val'>"architecture"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='string val'>"id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='integer val'>9</span><span class='comma token'>,</span> <span class='string val'>"name"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"ppc"</span><span class='rbrace token'>}</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
75
|
+
<span class='lbrace token'>{</span><span class='string val'>"architecture"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='string val'>"id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='string val'>"name"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"x86_64"</span><span class='rbrace token'>}</span><span class='rbrace token'>}</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
76
|
+
<span class='string val'>"[{\"architecture\":{\"name\":\"i386\",\"id\":5}},{\"architecture\":{\"name\":\"ppc\",\"id\":9}},{\"architecture\":{\"name\":\"x86_64\",\"id\":14}}]"</span><span class='rbrack token'>]</span>
|
|
77
|
+
<span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_nil nil kw'>nil</span>
|
|
78
|
+
</code></pre>
|
|
79
|
+
<h2>Description</h2>
|
|
80
|
+
<p>
|
|
81
|
+
This gem contains Foreman API bindings for the Ruby language. The bindings
|
|
82
|
+
are generated from API documentation using
|
|
83
|
+
Apidoc[https://github.com/Pajk/apipie-rails] tool.
|
|
84
|
+
</p>
|
|
85
|
+
<p>
|
|
86
|
+
The bindings brings support for new versioned API which is not complete
|
|
89
87
|
yet. The number of supported controllers is limited but more are coming
|
|
90
|
-
soon
|
|
91
|
-
|
|
92
|
-
<h3
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
needs a running Foreman instance to load the apidoc.json
|
|
96
|
-
|
|
97
|
-
<p>
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
<
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
<
|
|
108
|
-
|
|
109
|
-
<
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
</
|
|
116
|
-
|
|
117
|
-
<
|
|
118
|
-
|
|
119
|
-
<
|
|
88
|
+
soon.
|
|
89
|
+
</p>
|
|
90
|
+
<h3>Regenerating bindings</h3>
|
|
91
|
+
<p>
|
|
92
|
+
The code for generating the bindings is a part of this repo. The generator
|
|
93
|
+
needs a running Foreman instance to load the apidoc.json.
|
|
94
|
+
</p>
|
|
95
|
+
<p>
|
|
96
|
+
Usage:
|
|
97
|
+
</p>
|
|
98
|
+
<pre class="code ruby"><code class="ruby">
|
|
99
|
+
<span class='rubyid_bin identifier id'>bin</span><span class='div op'>/</span><span class='rubyid_generate identifier id'>generate</span><span class='dot token'>.</span><span class='rubyid_rb identifier id'>rb</span> <span class='minus op'>-</span><span class='rubyid_h identifier id'>h</span>
|
|
100
|
+
<span class='rubyid_Script constant id'>Script</span> <span class='rubyid_for for kw'>for</span> <span class='rubyid_generating identifier id'>generating</span> <span class='rubyid_API constant id'>API</span> <span class='rubyid_bindings identifier id'>bindings</span> <span class='rubyid_for for kw'>for</span> <span class='rubyid_Foreman constant id'>Foreman</span> <span class='rubyid_API constant id'>API</span> <span class='rubyid_from identifier id'>from</span> <span class='rubyid_Apipie constant id'>Apipie</span> <span class='rubyid_docs identifier id'>docs</span><span class='dot token'>.</span>
|
|
101
|
+
<span class='minus op'>-</span><span class='rubyid_u identifier id'>u</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='rubyid_url identifier id'>url</span> <span class='rubyid_FOREMAN_APIDOC_URL constant id'>FOREMAN_APIDOC_URL</span> <span class='rubyid_By constant id'>By</span> <span class='rubyid_default identifier id'>default</span> <span class='rubyid_http identifier id'>http</span><span class='symbol val'>:/</span><span class='regexp val'>/localhost:3000/</span><span class='rubyid_apidoc identifier id'>apidoc</span>
|
|
102
|
+
<span class='minus op'>-</span><span class='rubyid_h identifier id'>h</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='rubyid_help identifier id'>help</span>
|
|
103
|
+
</code></pre>
|
|
104
|
+
<p>
|
|
105
|
+
Only files under <tt>lib/foreman_api/resources</tt> are touched by the generator.
|
|
106
|
+
</p>
|
|
107
|
+
<h3>Authentication</h3>
|
|
108
|
+
<p>
|
|
109
|
+
Foreman API supports authentication with username/password and OAuth. For
|
|
110
|
+
use of OAuth with the bindings you only have to change the params
|
|
111
|
+
</p>
|
|
112
|
+
<pre class="code ruby"><code class="ruby">
|
|
113
|
+
<span class='rubyid_architectures identifier id'>architectures</span> <span class='assign token'>=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='colon2 op'>::</span><span class='rubyid_Resources constant id'>Resources</span><span class='colon2 op'>::</span><span class='rubyid_Architecture constant id'>Architecture</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:base_url</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'http://localhost:3000'</span><span class='comma token'>,</span>
|
|
114
|
+
<span class='symbol val'>:oauth</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:consumer_key</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'mykey'</span><span class='comma token'>,</span>
|
|
115
|
+
<span class='symbol val'>:consumer_secret</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'shhhh'</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
116
|
+
</code></pre>
|
|
117
|
+
<h2>License</h2>
|
|
118
|
+
<p>
|
|
119
|
+
The bindings are released under MIT license
|
|
120
|
+
</p>
|
|
120
121
|
</div></div>
|
|
121
122
|
|
|
122
123
|
<div id="footer">
|
|
123
|
-
Generated on
|
|
124
|
+
Generated on Tue Mar 19 09:50:22 2013 by
|
|
124
125
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
125
|
-
0.8.
|
|
126
|
+
0.8.5.2 (ruby-1.8.7).
|
|
126
127
|
</div>
|
|
127
128
|
|
|
128
129
|
</body>
|
data/doc/frames.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
5
|
<head>
|
|
6
6
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|
7
|
-
<title>Documentation by YARD 0.8.
|
|
7
|
+
<title>Documentation by YARD 0.8.5.2</title>
|
|
8
8
|
</head>
|
|
9
9
|
<script type="text/javascript" charset="utf-8">
|
|
10
10
|
window.onload = function() {
|
data/doc/index.html
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
3
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
4
|
<head>
|
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
6
|
<title>
|
|
7
7
|
File: README
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.8.
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -61,68 +61,69 @@
|
|
|
61
61
|
|
|
62
62
|
<iframe id="search_frame"></iframe>
|
|
63
63
|
|
|
64
|
-
<div id="content"><div id='filecontents'>
|
|
65
|
-
<
|
|
66
|
-
|
|
67
|
-
<
|
|
68
|
-
|
|
69
|
-
<
|
|
70
|
-
<span class=
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
<span class=
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
<p>The bindings brings support for new versioned API which is not complete
|
|
64
|
+
<div id="content"><div id='filecontents'><h1>Foreman API bindings for Ruby</h1>
|
|
65
|
+
<h2>Summary</h2>
|
|
66
|
+
<pre class="code ruby"><code class="ruby">
|
|
67
|
+
<span class='rubyid_require identifier id'>require</span> <span class='string val'>'foreman_api'</span>
|
|
68
|
+
<span class='rubyid_architectures identifier id'>architectures</span> <span class='assign token'>=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='colon2 op'>::</span><span class='rubyid_Resources constant id'>Resources</span><span class='colon2 op'>::</span><span class='rubyid_Architecture constant id'>Architecture</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:base_url</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'http://localhost:3000'</span><span class='comma token'>,</span>
|
|
69
|
+
<span class='symbol val'>:username</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'admin'</span><span class='comma token'>,</span>
|
|
70
|
+
<span class='symbol val'>:password</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'changeme'</span><span class='rparen token'>)</span>
|
|
71
|
+
|
|
72
|
+
<span class='rubyid_pp identifier id'>pp</span> <span class='rubyid_architectures identifier id'>architectures</span><span class='dot token'>.</span><span class='rubyid_index identifier id'>index</span>
|
|
73
|
+
<span class='lbrack token'>[</span><span class='lbrack token'>[</span><span class='lbrace token'>{</span><span class='string val'>"architecture"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='string val'>"id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='string val'>"name"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"i386"</span><span class='rbrace token'>}</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
74
|
+
<span class='lbrace token'>{</span><span class='string val'>"architecture"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='string val'>"id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='integer val'>9</span><span class='comma token'>,</span> <span class='string val'>"name"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"ppc"</span><span class='rbrace token'>}</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
75
|
+
<span class='lbrace token'>{</span><span class='string val'>"architecture"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='string val'>"id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='string val'>"name"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"x86_64"</span><span class='rbrace token'>}</span><span class='rbrace token'>}</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
76
|
+
<span class='string val'>"[{\"architecture\":{\"name\":\"i386\",\"id\":5}},{\"architecture\":{\"name\":\"ppc\",\"id\":9}},{\"architecture\":{\"name\":\"x86_64\",\"id\":14}}]"</span><span class='rbrack token'>]</span>
|
|
77
|
+
<span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_nil nil kw'>nil</span>
|
|
78
|
+
</code></pre>
|
|
79
|
+
<h2>Description</h2>
|
|
80
|
+
<p>
|
|
81
|
+
This gem contains Foreman API bindings for the Ruby language. The bindings
|
|
82
|
+
are generated from API documentation using
|
|
83
|
+
Apidoc[https://github.com/Pajk/apipie-rails] tool.
|
|
84
|
+
</p>
|
|
85
|
+
<p>
|
|
86
|
+
The bindings brings support for new versioned API which is not complete
|
|
89
87
|
yet. The number of supported controllers is limited but more are coming
|
|
90
|
-
soon
|
|
91
|
-
|
|
92
|
-
<h3
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
needs a running Foreman instance to load the apidoc.json
|
|
96
|
-
|
|
97
|
-
<p>
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
<
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
<
|
|
108
|
-
|
|
109
|
-
<
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
</
|
|
116
|
-
|
|
117
|
-
<
|
|
118
|
-
|
|
119
|
-
<
|
|
88
|
+
soon.
|
|
89
|
+
</p>
|
|
90
|
+
<h3>Regenerating bindings</h3>
|
|
91
|
+
<p>
|
|
92
|
+
The code for generating the bindings is a part of this repo. The generator
|
|
93
|
+
needs a running Foreman instance to load the apidoc.json.
|
|
94
|
+
</p>
|
|
95
|
+
<p>
|
|
96
|
+
Usage:
|
|
97
|
+
</p>
|
|
98
|
+
<pre class="code ruby"><code class="ruby">
|
|
99
|
+
<span class='rubyid_bin identifier id'>bin</span><span class='div op'>/</span><span class='rubyid_generate identifier id'>generate</span><span class='dot token'>.</span><span class='rubyid_rb identifier id'>rb</span> <span class='minus op'>-</span><span class='rubyid_h identifier id'>h</span>
|
|
100
|
+
<span class='rubyid_Script constant id'>Script</span> <span class='rubyid_for for kw'>for</span> <span class='rubyid_generating identifier id'>generating</span> <span class='rubyid_API constant id'>API</span> <span class='rubyid_bindings identifier id'>bindings</span> <span class='rubyid_for for kw'>for</span> <span class='rubyid_Foreman constant id'>Foreman</span> <span class='rubyid_API constant id'>API</span> <span class='rubyid_from identifier id'>from</span> <span class='rubyid_Apipie constant id'>Apipie</span> <span class='rubyid_docs identifier id'>docs</span><span class='dot token'>.</span>
|
|
101
|
+
<span class='minus op'>-</span><span class='rubyid_u identifier id'>u</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='rubyid_url identifier id'>url</span> <span class='rubyid_FOREMAN_APIDOC_URL constant id'>FOREMAN_APIDOC_URL</span> <span class='rubyid_By constant id'>By</span> <span class='rubyid_default identifier id'>default</span> <span class='rubyid_http identifier id'>http</span><span class='symbol val'>:/</span><span class='regexp val'>/localhost:3000/</span><span class='rubyid_apidoc identifier id'>apidoc</span>
|
|
102
|
+
<span class='minus op'>-</span><span class='rubyid_h identifier id'>h</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='rubyid_help identifier id'>help</span>
|
|
103
|
+
</code></pre>
|
|
104
|
+
<p>
|
|
105
|
+
Only files under <tt>lib/foreman_api/resources</tt> are touched by the generator.
|
|
106
|
+
</p>
|
|
107
|
+
<h3>Authentication</h3>
|
|
108
|
+
<p>
|
|
109
|
+
Foreman API supports authentication with username/password and OAuth. For
|
|
110
|
+
use of OAuth with the bindings you only have to change the params
|
|
111
|
+
</p>
|
|
112
|
+
<pre class="code ruby"><code class="ruby">
|
|
113
|
+
<span class='rubyid_architectures identifier id'>architectures</span> <span class='assign token'>=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='colon2 op'>::</span><span class='rubyid_Resources constant id'>Resources</span><span class='colon2 op'>::</span><span class='rubyid_Architecture constant id'>Architecture</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:base_url</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'http://localhost:3000'</span><span class='comma token'>,</span>
|
|
114
|
+
<span class='symbol val'>:oauth</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:consumer_key</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'mykey'</span><span class='comma token'>,</span>
|
|
115
|
+
<span class='symbol val'>:consumer_secret</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'shhhh'</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
116
|
+
</code></pre>
|
|
117
|
+
<h2>License</h2>
|
|
118
|
+
<p>
|
|
119
|
+
The bindings are released under MIT license
|
|
120
|
+
</p>
|
|
120
121
|
</div></div>
|
|
121
122
|
|
|
122
123
|
<div id="footer">
|
|
123
|
-
Generated on
|
|
124
|
+
Generated on Tue Mar 19 09:50:22 2013 by
|
|
124
125
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
125
|
-
0.8.
|
|
126
|
+
0.8.5.2 (ruby-1.8.7).
|
|
126
127
|
</div>
|
|
127
128
|
|
|
128
129
|
</body>
|