foreman_api 0.0.10 → 0.0.11

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 (84) hide show
  1. data/.yardopts +4 -0
  2. data/Gemfile +5 -0
  3. data/README.rdoc +23 -4
  4. data/doc/ForemanApi/Resources/Architecture.html +902 -0
  5. data/doc/ForemanApi/Resources/Audit.html +500 -0
  6. data/doc/ForemanApi/Resources/AuthSourceLdap.html +916 -0
  7. data/doc/ForemanApi/Resources/Bookmark.html +884 -0
  8. data/doc/ForemanApi/Resources/CommonParameter.html +902 -0
  9. data/doc/ForemanApi/Resources/ComputeResource.html +940 -0
  10. data/doc/ForemanApi/Resources/ConfigTemplate.html +1160 -0
  11. data/doc/ForemanApi/Resources/Dashboard.html +336 -0
  12. data/doc/ForemanApi/Resources/Domain.html +914 -0
  13. data/doc/ForemanApi/Resources/Environment.html +898 -0
  14. data/doc/ForemanApi/Resources/FactValue.html +375 -0
  15. data/doc/ForemanApi/Resources/Home.html +417 -0
  16. data/doc/ForemanApi/Resources/Host.html +1091 -0
  17. data/doc/ForemanApi/Resources/Hostgroup.html +934 -0
  18. data/doc/ForemanApi/Resources/Image.html +963 -0
  19. data/doc/ForemanApi/Resources/LookupKey.html +918 -0
  20. data/doc/ForemanApi/Resources/Medium.html +920 -0
  21. data/doc/ForemanApi/Resources/Model.html +910 -0
  22. data/doc/ForemanApi/Resources/OperatingSystem.html +1057 -0
  23. data/doc/ForemanApi/Resources/Ptable.html +906 -0
  24. data/doc/ForemanApi/Resources/Puppetclass.html +898 -0
  25. data/doc/ForemanApi/Resources/Report.html +625 -0
  26. data/doc/ForemanApi/Resources/Role.html +872 -0
  27. data/doc/ForemanApi/Resources/Setting.html +641 -0
  28. data/doc/ForemanApi/Resources/SmartProxy.html +889 -0
  29. data/doc/ForemanApi/Resources/Subnet.html +954 -0
  30. data/doc/ForemanApi/Resources/TemplateKind.html +349 -0
  31. data/doc/ForemanApi/Resources/User.html +920 -0
  32. data/doc/ForemanApi/Resources/Usergroup.html +872 -0
  33. data/doc/ForemanApi/Resources.html +117 -0
  34. data/doc/ForemanApi.html +117 -0
  35. data/doc/_index.html +449 -0
  36. data/doc/class_list.html +53 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +57 -0
  39. data/doc/css/style.css +328 -0
  40. data/doc/file.MIT-LICENSE.html +93 -0
  41. data/doc/file.README.html +129 -0
  42. data/doc/file_list.html +58 -0
  43. data/doc/frames.html +28 -0
  44. data/doc/index.html +129 -0
  45. data/doc/js/app.js +214 -0
  46. data/doc/js/full_list.js +173 -0
  47. data/doc/js/jquery.js +4 -0
  48. data/doc/method_list.html +1300 -0
  49. data/doc/top-level-namespace.html +112 -0
  50. data/foreman_api.gemspec +5 -2
  51. data/lib/foreman_api/base.rb +129 -0
  52. data/lib/foreman_api/resources/architecture.rb +17 -7
  53. data/lib/foreman_api/resources/audit.rb +7 -4
  54. data/lib/foreman_api/resources/auth_source_ldap.rb +35 -7
  55. data/lib/foreman_api/resources/bookmark.rb +19 -7
  56. data/lib/foreman_api/resources/common_parameter.rb +17 -7
  57. data/lib/foreman_api/resources/compute_resource.rb +33 -7
  58. data/lib/foreman_api/resources/config_template.rb +28 -9
  59. data/lib/foreman_api/resources/dashboard.rb +3 -3
  60. data/lib/foreman_api/resources/domain.rb +21 -7
  61. data/lib/foreman_api/resources/environment.rb +15 -7
  62. data/lib/foreman_api/resources/fact_value.rb +6 -3
  63. data/lib/foreman_api/resources/home.rb +2 -4
  64. data/lib/foreman_api/resources/host.rb +50 -8
  65. data/lib/foreman_api/resources/hostgroup.rb +33 -7
  66. data/lib/foreman_api/resources/image.rb +30 -7
  67. data/lib/foreman_api/resources/lookup_key.rb +25 -7
  68. data/lib/foreman_api/resources/medium.rb +19 -7
  69. data/lib/foreman_api/resources/model.rb +21 -7
  70. data/lib/foreman_api/resources/operating_system.rb +26 -8
  71. data/lib/foreman_api/resources/ptable.rb +19 -7
  72. data/lib/foreman_api/resources/puppetclass.rb +15 -7
  73. data/lib/foreman_api/resources/report.rb +8 -5
  74. data/lib/foreman_api/resources/role.rb +13 -7
  75. data/lib/foreman_api/resources/setting.rb +11 -5
  76. data/lib/foreman_api/resources/smart_proxy.rb +16 -7
  77. data/lib/foreman_api/resources/subnet.rb +39 -7
  78. data/lib/foreman_api/resources/template_kind.rb +4 -3
  79. data/lib/foreman_api/resources/user.rb +26 -7
  80. data/lib/foreman_api/resources/usergroup.rb +13 -7
  81. data/lib/foreman_api/rest_client_oauth.rb +19 -0
  82. data/lib/foreman_api/version.rb +1 -1
  83. data/lib/foreman_api.rb +6 -10
  84. metadata +51 -18
data/doc/css/style.css ADDED
@@ -0,0 +1,328 @@
1
+ body {
2
+ padding: 0 20px;
3
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
4
+ font-size: 13px;
5
+ }
6
+ body.frames { padding: 0 5px; }
7
+ h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
8
+ h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
9
+ h1.title { margin-bottom: 10px; }
10
+ h1.alphaindex { margin-top: 0; font-size: 22px; }
11
+ h2 {
12
+ padding: 0;
13
+ padding-bottom: 3px;
14
+ border-bottom: 1px #aaa solid;
15
+ font-size: 1.4em;
16
+ margin: 1.8em 0 0.5em;
17
+ }
18
+ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
19
+ .clear { clear: both; }
20
+ .inline { display: inline; }
21
+ .inline p:first-child { display: inline; }
22
+ .docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
23
+ .docstring h1 { font-size: 1.2em; }
24
+ .docstring h2 { font-size: 1.1em; }
25
+ .docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
26
+ .summary_desc .object_link, .docstring .object_link { font-family: monospace; }
27
+ .rdoc-term { padding-right: 25px; font-weight: bold; }
28
+ .rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
29
+
30
+ /* style for <ul> */
31
+ #filecontents li > p, .docstring li > p { margin: 0px; }
32
+ #filecontents ul, .docstring ul { padding-left: 20px; }
33
+ /* style for <dl> */
34
+ #filecontents dl, .docstring dl { border: 1px solid #ccc; }
35
+ #filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
36
+ #filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
37
+ #filecontents dd > p, .docstring dd > p { margin: 0px; }
38
+
39
+ .note {
40
+ color: #222;
41
+ -moz-border-radius: 3px; -webkit-border-radius: 3px;
42
+ background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
43
+ display: block;
44
+ }
45
+ .note.todo { background: #ffffc5; border-color: #ececaa; }
46
+ .note.returns_void { background: #efefef; }
47
+ .note.deprecated { background: #ffe5e5; border-color: #e9dada; }
48
+ .note.private { background: #ffffc5; border-color: #ececaa; }
49
+ .note.title { padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
50
+ .summary_signature + .note.title { margin-left: 7px; }
51
+ h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
52
+ .note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
53
+ .note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
54
+ .note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
55
+ .note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
56
+ .note.title.not_defined_here { background: transparent; border: none; font-style: italic; }
57
+ .discussion .note { margin-top: 6px; }
58
+ .discussion .note:first-child { margin-top: 0; }
59
+
60
+ h3.inherited {
61
+ font-style: italic;
62
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
63
+ font-weight: normal;
64
+ padding: 0;
65
+ margin: 0;
66
+ margin-top: 12px;
67
+ margin-bottom: 3px;
68
+ font-size: 13px;
69
+ }
70
+ p.inherited {
71
+ padding: 0;
72
+ margin: 0;
73
+ margin-left: 25px;
74
+ }
75
+
76
+ #filecontents dl.box, dl.box {
77
+ border: 0;
78
+ width: 520px;
79
+ font-size: 1em;
80
+ }
81
+ #filecontents dl.box dt, dl.box dt {
82
+ float: left;
83
+ display: block;
84
+ width: 100px;
85
+ margin: 0;
86
+ text-align: right;
87
+ font-weight: bold;
88
+ background: transparent;
89
+ border: 1px solid #aaa;
90
+ border-width: 1px 0px 0px 1px;
91
+ padding: 6px 0;
92
+ padding-right: 10px;
93
+ }
94
+ #filecontents dl.box dd, dl.box dd {
95
+ float: left;
96
+ display: block;
97
+ width: 380px;
98
+ margin: 0;
99
+ padding: 6px 0;
100
+ padding-right: 20px;
101
+ border: 1px solid #aaa;
102
+ border-width: 1px 1px 0 0;
103
+ }
104
+ #filecontents dl.box .last, dl.box .last {
105
+ border-bottom: 1px solid #aaa;
106
+ }
107
+ #filecontents dl.box .r1, dl.box .r1 { background: #eee; }
108
+
109
+ ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
110
+ .index_inline_list { padding-left: 0; font-size: 1.1em; }
111
+ .index_inline_list li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
112
+
113
+ dl.constants { margin-left: 40px; }
114
+ dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
115
+ dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
116
+
117
+ .summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
118
+ .summary_desc tt { font-size: 0.9em; }
119
+ dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
120
+ dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
121
+ dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
122
+ dl.constants .discussion *:first-child { margin-top: 0; }
123
+ dl.constants .discussion *:last-child { margin-bottom: 0; }
124
+
125
+ .method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
126
+ .method_details.first { border: 0; }
127
+ p.signature, h3.signature {
128
+ font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
129
+ padding: 6px 10px; margin-top: 18px;
130
+ background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
131
+ }
132
+ p.signature tt,
133
+ h3.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
134
+ p.signature .overload,
135
+ h3.signature .overload { display: block; }
136
+ p.signature .extras,
137
+ h3.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
138
+ p.signature .not_defined_here,
139
+ h3.signature .not_defined_here,
140
+ p.signature .aliases,
141
+ h3.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
142
+ p.signature .aliases .names,
143
+ h3.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
144
+
145
+ .tags .tag_title { font-size: 1em; margin-bottom: 0; font-weight: bold; }
146
+ .tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
147
+ .tags ul li { margin-bottom: 3px; }
148
+ .tags ul .name { font-family: monospace; font-weight: bold; }
149
+ .tags ul .note { padding: 3px 6px; }
150
+ .tags { margin-bottom: 12px; }
151
+
152
+ .tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; }
153
+ .tags .examples .inline p { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
154
+
155
+ .tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
156
+ .tags .overload .overload_item .signature {
157
+ padding: 2px 8px;
158
+ background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
159
+ }
160
+ .tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
161
+ .tags .overload .docstring { margin-top: 15px; }
162
+
163
+ .defines { display: none; }
164
+
165
+ #method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
166
+
167
+ .showSource { font-size: 0.9em; }
168
+ .showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
169
+
170
+ #content a:link, #content a:visited { text-decoration: none; color: #05a; }
171
+ #content a:hover { background: #ffffa5; }
172
+ div.docstring, p.docstring { margin-right: 6em; }
173
+
174
+ ul.summary {
175
+ list-style: none;
176
+ font-family: monospace;
177
+ font-size: 1em;
178
+ line-height: 1.5em;
179
+ }
180
+ ul.summary a:link, ul.summary a:visited {
181
+ text-decoration: none; font-size: 1.1em;
182
+ }
183
+ ul.summary li { margin-bottom: 5px; }
184
+ .summary .summary_signature {
185
+ padding: 1px 10px;
186
+ background: #eaeaff; border: 1px solid #dfdfe5;
187
+ -moz-border-radius: 3px; -webkit-border-radius: 3px;
188
+ }
189
+ .summary_signature:hover { background: #eeeeff; cursor: pointer; }
190
+ ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
191
+ ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
192
+ #content .summary_signature:hover a:link,
193
+ #content .summary_signature:hover a:visited {
194
+ background: transparent;
195
+ color: #48f;
196
+ }
197
+
198
+ p.inherited a { font-family: monospace; font-size: 0.9em; }
199
+ p.inherited { word-spacing: 5px; font-size: 1.2em; }
200
+
201
+ p.children { font-size: 1.2em; }
202
+ p.children a { font-size: 0.9em; }
203
+ p.children strong { font-size: 0.8em; }
204
+ p.children strong.modules { padding-left: 5px; }
205
+
206
+ ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
207
+ ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
208
+ ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
209
+ ul.fullTree li:first-child { padding-top: 0; background: transparent; }
210
+ ul.fullTree li:last-child { padding-bottom: 0; }
211
+ .showAll ul.fullTree { display: block; }
212
+ .showAll .inheritName { display: none; }
213
+
214
+ #search { position: absolute; right: 14px; top: 0px; }
215
+ #search a:link, #search a:visited {
216
+ display: block; float: left; margin-right: 4px;
217
+ padding: 8px 10px; text-decoration: none; color: #05a;
218
+ border: 1px solid #d8d8e5;
219
+ -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
220
+ -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
221
+ background: #eaf0ff;
222
+ -webkit-box-shadow: -1px 1px 3px #ddd;
223
+ }
224
+ #search a:hover { background: #f5faff; color: #06b; }
225
+ #search a.active {
226
+ background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
227
+ -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
228
+ -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
229
+ }
230
+ #search a.inactive { color: #999; }
231
+ .frames #search { display: none; }
232
+ .inheritanceTree, .toggleDefines { float: right; }
233
+
234
+ #menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
235
+ #menu .title, #menu a { font-size: 0.7em; }
236
+ #menu .title a { font-size: 1em; }
237
+ #menu .title { color: #555; }
238
+ #menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
239
+ #menu a:hover { color: #05a; }
240
+ #menu .noframes { display: inline; }
241
+ .frames #menu .noframes { display: inline; float: right; }
242
+
243
+ #footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
244
+ #footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
245
+ #footer a:hover { color: #05a; }
246
+
247
+ #listing ul.alpha { font-size: 1.1em; }
248
+ #listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
249
+ #listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
250
+ #listing ul.alpha ul { margin: 0; padding-left: 15px; }
251
+ #listing ul small { color: #666; font-size: 0.7em; }
252
+
253
+ li.r1 { background: #f0f0f0; }
254
+ li.r2 { background: #fafafa; }
255
+
256
+ #search_frame {
257
+ z-index: 9999;
258
+ background: #fff;
259
+ display: none;
260
+ position: absolute;
261
+ top: 36px;
262
+ right: 18px;
263
+ width: 500px;
264
+ height: 80%;
265
+ overflow-y: scroll;
266
+ border: 1px solid #999;
267
+ border-collapse: collapse;
268
+ -webkit-box-shadow: -7px 5px 25px #aaa;
269
+ -moz-box-shadow: -7px 5px 25px #aaa;
270
+ -moz-border-radius: 2px;
271
+ -webkit-border-radius: 2px;
272
+ }
273
+
274
+ #content ul.summary li.deprecated .summary_signature a:link,
275
+ #content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
276
+
277
+ #toc {
278
+ padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
279
+ max-width: 300px;
280
+ -webkit-box-shadow: -2px 2px 6px #bbb;
281
+ -moz-box-shadow: -2px 2px 6px #bbb;
282
+ z-index: 5000;
283
+ position: relative;
284
+ }
285
+ #toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
286
+ #toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }
287
+ #toc .title { margin: 0; }
288
+ #toc ol { padding-left: 1.8em; }
289
+ #toc li { font-size: 1.1em; line-height: 1.7em; }
290
+ #toc > ol > li { font-size: 1.1em; font-weight: bold; }
291
+ #toc ol > ol { font-size: 0.9em; }
292
+ #toc ol ol > ol { padding-left: 2.3em; }
293
+ #toc ol + li { margin-top: 0.3em; }
294
+ #toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; }
295
+ #filecontents h1 + #toc.nofloat { margin-top: 0; }
296
+
297
+ /* syntax highlighting */
298
+ .source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
299
+ #filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
300
+ #filecontents pre.code, .docstring pre.code { display: block; }
301
+ .source_code .lines { padding-right: 12px; color: #555; text-align: right; }
302
+ #filecontents pre.code, .docstring pre.code,
303
+ .tags pre.example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
304
+ pre.code { color: #000; }
305
+ pre.code .info.file { color: #555; }
306
+ pre.code .val { color: #036A07; }
307
+ pre.code .tstring_content,
308
+ pre.code .heredoc_beg, pre.code .heredoc_end,
309
+ pre.code .qwords_beg, pre.code .qwords_end,
310
+ pre.code .tstring, pre.code .dstring { color: #036A07; }
311
+ pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
312
+ pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
313
+ pre.code .dot + pre.code .id,
314
+ pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
315
+ pre.code .comment { color: #0066FF; }
316
+ pre.code .const, pre.code .constant { color: #585CF6; }
317
+ pre.code .symbol { color: #C5060B; }
318
+ pre.code .kw,
319
+ pre.code .label,
320
+ pre.code .rubyid_require,
321
+ pre.code .rubyid_extend,
322
+ pre.code .rubyid_include { color: #0000FF; }
323
+ pre.code .ivar { color: #318495; }
324
+ pre.code .gvar,
325
+ pre.code .rubyid_backref,
326
+ pre.code .rubyid_nth_ref { color: #6D79DE; }
327
+ pre.code .regexp, .dregexp { color: #036A07; }
328
+ pre.code a { border-bottom: 1px dotted #bbf; }
@@ -0,0 +1,93 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
6
+ <title>
7
+ File: MIT-LICENSE
8
+
9
+ &mdash; Documentation by YARD 0.8.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: MIT-LICENSE</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'>
65
+ <p>Copyright 2012 Red Hat, Inc.</p>
66
+
67
+ <p>Permission is hereby granted, free of charge, to any person obtaining a
68
+ copy of this software and associated documentation files (the "Software"),
69
+ to deal in the Software without restriction, including without limitation
70
+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
71
+ and/or sell copies of the Software, and to permit persons to whom the
72
+ Software is furnished to do so, subject to the following conditions:</p>
73
+
74
+ <p>The above copyright notice and this permission notice shall be included in
75
+ all copies or substantial portions of the Software.</p>
76
+
77
+ <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
78
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
79
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
80
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
81
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
82
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
83
+ DEALINGS IN THE SOFTWARE.</p>
84
+ </div></div>
85
+
86
+ <div id="footer">
87
+ Generated on Mon Jan 21 15:44:34 2013 by
88
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
89
+ 0.8.3 (ruby-1.9.3).
90
+ </div>
91
+
92
+ </body>
93
+ </html>
@@ -0,0 +1,129 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.8.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'>
65
+ <h1 id="label-Foreman+API+bindings+for+Ruby">Foreman API bindings for Ruby</h1>
66
+
67
+ <h2 id="label-Summary">Summary</h2>
68
+
69
+ <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'foreman_api'</span>
70
+ <span class="ruby-identifier">architectures</span> = <span class="ruby-constant">ForemanApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Resources</span><span class="ruby-operator">::</span><span class="ruby-constant">Architecture</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">base_url</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'http://localhost:3000'</span>,
71
+ :<span class="ruby-identifier">username</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'admin'</span>,
72
+ :<span class="ruby-identifier">password</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'changeme'</span>)
73
+
74
+ <span class="ruby-identifier">pp</span> <span class="ruby-identifier">architectures</span>.<span class="ruby-identifier">index</span>
75
+ [[{<span class="ruby-string">&quot;architecture&quot;</span>=<span class="ruby-operator">&gt;</span>{<span class="ruby-string">&quot;id&quot;</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value">5</span>, <span class="ruby-string">&quot;name&quot;</span>=<span class="ruby-operator">&gt;</span><span class="ruby-string">&quot;i386&quot;</span>}},
76
+ {<span class="ruby-string">&quot;architecture&quot;</span>=<span class="ruby-operator">&gt;</span>{<span class="ruby-string">&quot;id&quot;</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value">9</span>, <span class="ruby-string">&quot;name&quot;</span>=<span class="ruby-operator">&gt;</span><span class="ruby-string">&quot;ppc&quot;</span>}},
77
+ {<span class="ruby-string">&quot;architecture&quot;</span>=<span class="ruby-operator">&gt;</span>{<span class="ruby-string">&quot;id&quot;</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value">14</span>, <span class="ruby-string">&quot;name&quot;</span>=<span class="ruby-operator">&gt;</span><span class="ruby-string">&quot;x86_64&quot;</span>}}],
78
+ <span class="ruby-string">&quot;[{\&quot;architecture\&quot;:{\&quot;name\&quot;:\&quot;i386\&quot;,\&quot;id\&quot;:5}},{\&quot;architecture\&quot;:{\&quot;name\&quot;:\&quot;ppc\&quot;,\&quot;id\&quot;:9}},{\&quot;architecture\&quot;:{\&quot;name\&quot;:\&quot;x86_64\&quot;,\&quot;id\&quot;:14}}]&quot;</span>]
79
+ =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword">nil</span>
80
+ </pre>
81
+
82
+ <h2 id="label-Description">Description</h2>
83
+
84
+ <p>This gem contains Foreman API bindings for the Ruby language. The bindings
85
+ are generated from API documentation using <a
86
+ href="https://github.com/Pajk/apipie-rails">Apidoc</a> tool.</p>
87
+
88
+ <p>The bindings brings support for new versioned API which is not complete
89
+ yet. The number of supported controllers is limited but more are coming
90
+ soon.</p>
91
+
92
+ <h3 id="label-Regenerating+bindings">Regenerating bindings</h3>
93
+
94
+ <p>The code for generating the bindings is a part of this repo. The generator
95
+ needs a running Foreman instance to load the apidoc.json.</p>
96
+
97
+ <p>Usage:</p>
98
+
99
+ <pre class="code ruby"><code>bin/generate.rb -h
100
+ Script for generating API bindings for Foreman API from Apipie docs.
101
+ -u, --url FOREMAN_APIDOC_URL By default http://localhost:3000/apidoc
102
+ -h, --help</code></pre>
103
+
104
+ <p>Only files under <code>lib/foreman_api/resources</code> are touched by the
105
+ generator.</p>
106
+
107
+ <h3 id="label-Authentication">Authentication</h3>
108
+
109
+ <p>Foreman API supports authentication with username/password and OAuth. For
110
+ use of OAuth with the bindings you only have to change the params</p>
111
+
112
+ <pre class="ruby"><span class="ruby-identifier">architectures</span> = <span class="ruby-constant">ForemanApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Resources</span><span class="ruby-operator">::</span><span class="ruby-constant">Architecture</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">base_url</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'http://localhost:3000'</span>,
113
+ :<span class="ruby-identifier">oauth</span> =<span class="ruby-operator">&gt;</span> { :<span class="ruby-identifier">consumer_key</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'mykey'</span>,
114
+ :<span class="ruby-identifier">consumer_secret</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'shhhh'</span> })
115
+ </pre>
116
+
117
+ <h2 id="label-License">License</h2>
118
+
119
+ <p>The bindings are released under MIT license</p>
120
+ </div></div>
121
+
122
+ <div id="footer">
123
+ Generated on Mon Jan 21 15:44:34 2013 by
124
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
125
+ 0.8.3 (ruby-1.9.3).
126
+ </div>
127
+
128
+ </body>
129
+ </html>
@@ -0,0 +1,58 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html>
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <base id="base_target" target="_parent" />
19
+ </head>
20
+ <body>
21
+ <script type="text/javascript" charset="utf-8">
22
+ if (window.top.frames.main) {
23
+ document.getElementById('base_target').target = 'main';
24
+ document.body.className = 'frames';
25
+ }
26
+ </script>
27
+ <div id="content">
28
+ <h1 id="full_list_header">File List</h1>
29
+ <div id="nav">
30
+
31
+ <span><a target="_self" href="class_list.html">
32
+ Classes
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="method_list.html">
36
+ Methods
37
+ </a></span>
38
+
39
+ <span><a target="_self" href="file_list.html">
40
+ Files
41
+ </a></span>
42
+
43
+ </div>
44
+ <div id="search">Search: <input type="text" /></div>
45
+
46
+ <ul id="full_list" class="file">
47
+
48
+
49
+ <li class="r1"><a href="index.html" title="README">README</a></li>
50
+
51
+
52
+ <li class="r2"><a href="file.MIT-LICENSE.html" title="MIT-LICENSE">MIT-LICENSE</a></li>
53
+
54
+
55
+ </ul>
56
+ </div>
57
+ </body>
58
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,28 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
+
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
+ <title>Documentation by YARD 0.8.3</title>
8
+ </head>
9
+ <script type="text/javascript" charset="utf-8">
10
+ window.onload = function() {
11
+ var match = window.location.hash.match(/^#!(.+)/);
12
+ var name = 'index.html';
13
+ if (match) {
14
+ name = unescape(match[1]);
15
+ }
16
+ document.writeln('<frameset cols="20%,*">' +
17
+ '<frame name="list" src="class_list.html" />' +
18
+ '<frame name="main" src="' + name + '" />' +
19
+ '</frameset>');
20
+ }
21
+ </script>
22
+ <noscript>
23
+ <frameset cols="20%,*">
24
+ <frame name="list" src="class_list.html" />
25
+ <frame name="main" src="index.html" />
26
+ </frameset>
27
+ </noscript>
28
+ </html>