katello_api 0.0.1 → 0.0.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 +2 -0
- data/Gemfile +2 -0
- data/README.rdoc +0 -4
- data/doc/KatelloApi/Base.html +831 -0
- data/doc/KatelloApi/Generator/Base.html +671 -0
- data/doc/KatelloApi/Generator.html +115 -0
- data/doc/KatelloApi/Resources/ActivationKey.html +1757 -0
- data/doc/KatelloApi/Resources/Architecture.html +1007 -0
- data/doc/KatelloApi/Resources/Changeset.html +1413 -0
- data/doc/KatelloApi/Resources/ChangesetsContent.html +2674 -0
- data/doc/KatelloApi/Resources/ComputeResource.html +1067 -0
- data/doc/KatelloApi/Resources/ConfigTemplate.html +1361 -0
- data/doc/KatelloApi/Resources/ContentView.html +938 -0
- data/doc/KatelloApi/Resources/ContentViewDefinition.html +1629 -0
- data/doc/KatelloApi/Resources/Crl.html +367 -0
- data/doc/KatelloApi/Resources/Distribution.html +560 -0
- data/doc/KatelloApi/Resources/Distributor.html +1892 -0
- data/doc/KatelloApi/Resources/Domain.html +1066 -0
- data/doc/KatelloApi/Resources/Environment.html +1645 -0
- data/doc/KatelloApi/Resources/Erratum.html +632 -0
- data/doc/KatelloApi/Resources/GpgKey.html +1220 -0
- data/doc/KatelloApi/Resources/HardwareModel.html +1025 -0
- data/doc/KatelloApi/Resources/Organization.html +1062 -0
- data/doc/KatelloApi/Resources/Package.html +728 -0
- data/doc/KatelloApi/Resources/Permission.html +1021 -0
- data/doc/KatelloApi/Resources/Ping.html +625 -0
- data/doc/KatelloApi/Resources/Product.html +1845 -0
- data/doc/KatelloApi/Resources/Provider.html +2237 -0
- data/doc/KatelloApi/Resources/Repository.html +1976 -0
- data/doc/KatelloApi/Resources/RepositorySet.html +770 -0
- data/doc/KatelloApi/Resources/Role.html +1257 -0
- data/doc/KatelloApi/Resources/RoleLdapGroup.html +728 -0
- data/doc/KatelloApi/Resources/SmartProxy.html +1054 -0
- data/doc/KatelloApi/Resources/Statu.html +367 -0
- data/doc/KatelloApi/Resources/Subnet.html +1007 -0
- data/doc/KatelloApi/Resources/Subscription.html +1064 -0
- data/doc/KatelloApi/Resources/Sync.html +826 -0
- data/doc/KatelloApi/Resources/SyncPlan.html +1148 -0
- data/doc/KatelloApi/Resources/System.html +3576 -0
- data/doc/KatelloApi/Resources/SystemGroup.html +2006 -0
- data/doc/KatelloApi/Resources/SystemGroupErratum.html +602 -0
- data/doc/KatelloApi/Resources/SystemGroupPackage.html +826 -0
- data/doc/KatelloApi/Resources/SystemPackage.html +770 -0
- data/doc/KatelloApi/Resources/Task.html +546 -0
- data/doc/KatelloApi/Resources/Template.html +1573 -0
- data/doc/KatelloApi/Resources/TemplatesContent.html +2268 -0
- data/doc/KatelloApi/Resources/Uebercert.html +406 -0
- data/doc/KatelloApi/Resources/User.html +1846 -0
- data/doc/KatelloApi/Resources.html +117 -0
- data/doc/KatelloApi.html +365 -0
- data/doc/_index.html +539 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +338 -0
- data/doc/file.README.html +127 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +127 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +2548 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/katello_api/base.rb +61 -6
- data/lib/katello_api/documentation.json +1 -0
- data/lib/katello_api/resources/activation_key.rb +51 -48
- data/lib/katello_api/resources/architecture.rb +19 -24
- data/lib/katello_api/resources/changeset.rb +39 -37
- data/lib/katello_api/resources/changesets_content.rb +64 -57
- data/lib/katello_api/resources/compute_resource.rb +37 -42
- data/lib/katello_api/resources/config_template.rb +40 -44
- data/lib/katello_api/resources/content_view.rb +14 -17
- data/lib/katello_api/resources/content_view_definition.rb +34 -42
- data/lib/katello_api/resources/crl.rb +3 -4
- data/lib/katello_api/resources/distribution.rb +8 -8
- data/lib/katello_api/resources/distributor.rb +35 -37
- data/lib/katello_api/resources/domain.rb +28 -32
- data/lib/katello_api/resources/environment.rb +38 -44
- data/lib/katello_api/resources/erratum.rb +9 -8
- data/lib/katello_api/resources/gpg_key.rb +28 -33
- data/lib/katello_api/resources/hardware_model.rb +25 -30
- data/lib/katello_api/resources/organization.rb +24 -26
- data/lib/katello_api/resources/package.rb +9 -12
- data/lib/katello_api/resources/permission.rb +21 -19
- data/lib/katello_api/resources/ping.rb +9 -12
- data/lib/katello_api/resources/product.rb +34 -43
- data/lib/katello_api/resources/provider.rb +55 -66
- data/lib/katello_api/resources/repository.rb +44 -55
- data/lib/katello_api/resources/repository_set.rb +9 -12
- data/lib/katello_api/resources/role.rb +35 -33
- data/lib/katello_api/resources/role_ldap_group.rb +10 -12
- data/lib/katello_api/resources/smart_proxy.rb +24 -28
- data/lib/katello_api/resources/statu.rb +3 -4
- data/lib/katello_api/resources/subnet.rb +19 -24
- data/lib/katello_api/resources/subscription.rb +16 -21
- data/lib/katello_api/resources/sync.rb +9 -12
- data/lib/katello_api/resources/sync_plan.rb +28 -33
- data/lib/katello_api/resources/system.rb +81 -90
- data/lib/katello_api/resources/system_group.rb +47 -57
- data/lib/katello_api/resources/system_group_erratum.rb +6 -8
- data/lib/katello_api/resources/system_group_package.rb +15 -18
- data/lib/katello_api/resources/system_package.rb +12 -15
- data/lib/katello_api/resources/task.rb +6 -8
- data/lib/katello_api/resources/template.rb +39 -47
- data/lib/katello_api/resources/templates_content.rb +40 -52
- data/lib/katello_api/resources/uebercert.rb +4 -4
- data/lib/katello_api/resources/user.rb +47 -50
- data/lib/katello_api/version.rb +1 -1
- data/lib/katello_api.rb +0 -13
- metadata +68 -4
|
@@ -0,0 +1,831 @@
|
|
|
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=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: KatelloApi::Base
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
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 (B)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../KatelloApi.html" title="KatelloApi (module)">KatelloApi</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Base</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: KatelloApi::Base
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">KatelloApi::Base</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
|
97
|
+
<dd class="r2 last">lib/katello_api/base.rb</dd>
|
|
98
|
+
|
|
99
|
+
</dl>
|
|
100
|
+
<div class="clear"></div>
|
|
101
|
+
|
|
102
|
+
<div id="subclasses">
|
|
103
|
+
<h2>Direct Known Subclasses</h2>
|
|
104
|
+
<p class="children"><span class='object_link'><a href="Resources/ActivationKey.html" title="KatelloApi::Resources::ActivationKey (class)">Resources::ActivationKey</a></span>, <span class='object_link'><a href="Resources/Architecture.html" title="KatelloApi::Resources::Architecture (class)">Resources::Architecture</a></span>, <span class='object_link'><a href="Resources/Changeset.html" title="KatelloApi::Resources::Changeset (class)">Resources::Changeset</a></span>, <span class='object_link'><a href="Resources/ChangesetsContent.html" title="KatelloApi::Resources::ChangesetsContent (class)">Resources::ChangesetsContent</a></span>, <span class='object_link'><a href="Resources/ComputeResource.html" title="KatelloApi::Resources::ComputeResource (class)">Resources::ComputeResource</a></span>, <span class='object_link'><a href="Resources/ConfigTemplate.html" title="KatelloApi::Resources::ConfigTemplate (class)">Resources::ConfigTemplate</a></span>, <span class='object_link'><a href="Resources/ContentView.html" title="KatelloApi::Resources::ContentView (class)">Resources::ContentView</a></span>, <span class='object_link'><a href="Resources/ContentViewDefinition.html" title="KatelloApi::Resources::ContentViewDefinition (class)">Resources::ContentViewDefinition</a></span>, <span class='object_link'><a href="Resources/Crl.html" title="KatelloApi::Resources::Crl (class)">Resources::Crl</a></span>, <span class='object_link'><a href="Resources/Distribution.html" title="KatelloApi::Resources::Distribution (class)">Resources::Distribution</a></span>, <span class='object_link'><a href="Resources/Distributor.html" title="KatelloApi::Resources::Distributor (class)">Resources::Distributor</a></span>, <span class='object_link'><a href="Resources/Domain.html" title="KatelloApi::Resources::Domain (class)">Resources::Domain</a></span>, <span class='object_link'><a href="Resources/Environment.html" title="KatelloApi::Resources::Environment (class)">Resources::Environment</a></span>, <span class='object_link'><a href="Resources/Erratum.html" title="KatelloApi::Resources::Erratum (class)">Resources::Erratum</a></span>, <span class='object_link'><a href="Resources/GpgKey.html" title="KatelloApi::Resources::GpgKey (class)">Resources::GpgKey</a></span>, <span class='object_link'><a href="Resources/HardwareModel.html" title="KatelloApi::Resources::HardwareModel (class)">Resources::HardwareModel</a></span>, <span class='object_link'><a href="Resources/Organization.html" title="KatelloApi::Resources::Organization (class)">Resources::Organization</a></span>, <span class='object_link'><a href="Resources/Package.html" title="KatelloApi::Resources::Package (class)">Resources::Package</a></span>, <span class='object_link'><a href="Resources/Permission.html" title="KatelloApi::Resources::Permission (class)">Resources::Permission</a></span>, <span class='object_link'><a href="Resources/Ping.html" title="KatelloApi::Resources::Ping (class)">Resources::Ping</a></span>, <span class='object_link'><a href="Resources/Product.html" title="KatelloApi::Resources::Product (class)">Resources::Product</a></span>, <span class='object_link'><a href="Resources/Provider.html" title="KatelloApi::Resources::Provider (class)">Resources::Provider</a></span>, <span class='object_link'><a href="Resources/Repository.html" title="KatelloApi::Resources::Repository (class)">Resources::Repository</a></span>, <span class='object_link'><a href="Resources/RepositorySet.html" title="KatelloApi::Resources::RepositorySet (class)">Resources::RepositorySet</a></span>, <span class='object_link'><a href="Resources/Role.html" title="KatelloApi::Resources::Role (class)">Resources::Role</a></span>, <span class='object_link'><a href="Resources/RoleLdapGroup.html" title="KatelloApi::Resources::RoleLdapGroup (class)">Resources::RoleLdapGroup</a></span>, <span class='object_link'><a href="Resources/SmartProxy.html" title="KatelloApi::Resources::SmartProxy (class)">Resources::SmartProxy</a></span>, <span class='object_link'><a href="Resources/Statu.html" title="KatelloApi::Resources::Statu (class)">Resources::Statu</a></span>, <span class='object_link'><a href="Resources/Subnet.html" title="KatelloApi::Resources::Subnet (class)">Resources::Subnet</a></span>, <span class='object_link'><a href="Resources/Subscription.html" title="KatelloApi::Resources::Subscription (class)">Resources::Subscription</a></span>, <span class='object_link'><a href="Resources/Sync.html" title="KatelloApi::Resources::Sync (class)">Resources::Sync</a></span>, <span class='object_link'><a href="Resources/SyncPlan.html" title="KatelloApi::Resources::SyncPlan (class)">Resources::SyncPlan</a></span>, <span class='object_link'><a href="Resources/System.html" title="KatelloApi::Resources::System (class)">Resources::System</a></span>, <span class='object_link'><a href="Resources/SystemGroup.html" title="KatelloApi::Resources::SystemGroup (class)">Resources::SystemGroup</a></span>, <span class='object_link'><a href="Resources/SystemGroupErratum.html" title="KatelloApi::Resources::SystemGroupErratum (class)">Resources::SystemGroupErratum</a></span>, <span class='object_link'><a href="Resources/SystemGroupPackage.html" title="KatelloApi::Resources::SystemGroupPackage (class)">Resources::SystemGroupPackage</a></span>, <span class='object_link'><a href="Resources/SystemPackage.html" title="KatelloApi::Resources::SystemPackage (class)">Resources::SystemPackage</a></span>, <span class='object_link'><a href="Resources/Task.html" title="KatelloApi::Resources::Task (class)">Resources::Task</a></span>, <span class='object_link'><a href="Resources/Template.html" title="KatelloApi::Resources::Template (class)">Resources::Template</a></span>, <span class='object_link'><a href="Resources/TemplatesContent.html" title="KatelloApi::Resources::TemplatesContent (class)">Resources::TemplatesContent</a></span>, <span class='object_link'><a href="Resources/Uebercert.html" title="KatelloApi::Resources::Uebercert (class)">Resources::Uebercert</a></span>, <span class='object_link'><a href="Resources/User.html" title="KatelloApi::Resources::User (class)">Resources::User</a></span></p>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<h2>Constant Summary</h2>
|
|
108
|
+
|
|
109
|
+
<dl class="constants">
|
|
110
|
+
|
|
111
|
+
<dt id="API_VERSION-constant" class="">API_VERSION =
|
|
112
|
+
|
|
113
|
+
</dt>
|
|
114
|
+
<dd><pre class="code"><span class='string val'>"1.0"</span>
|
|
115
|
+
</pre></dd>
|
|
116
|
+
|
|
117
|
+
</dl>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
124
|
+
<ul class="summary">
|
|
125
|
+
|
|
126
|
+
<li class="public ">
|
|
127
|
+
<span class="summary_signature">
|
|
128
|
+
|
|
129
|
+
<a href="#client-instance_method" title="#client (instance method)">- (Object) <strong>client</strong> </a>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<span class="note title readonly">readonly</span>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
149
|
+
Returns the value of attribute client.
|
|
150
|
+
</p>
|
|
151
|
+
</div></span>
|
|
152
|
+
|
|
153
|
+
</li>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<li class="public ">
|
|
157
|
+
<span class="summary_signature">
|
|
158
|
+
|
|
159
|
+
<a href="#config-instance_method" title="#config (instance method)">- (Object) <strong>config</strong> </a>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<span class="note title readonly">readonly</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
179
|
+
Returns the value of attribute config.
|
|
180
|
+
</p>
|
|
181
|
+
</div></span>
|
|
182
|
+
|
|
183
|
+
</li>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</ul>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<h2>
|
|
193
|
+
Class Method Summary
|
|
194
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
195
|
+
</h2>
|
|
196
|
+
|
|
197
|
+
<ul class="summary">
|
|
198
|
+
|
|
199
|
+
<li class="public ">
|
|
200
|
+
<span class="summary_signature">
|
|
201
|
+
|
|
202
|
+
<a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
</span>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
217
|
+
|
|
218
|
+
</li>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<li class="public ">
|
|
222
|
+
<span class="summary_signature">
|
|
223
|
+
|
|
224
|
+
<a href="#method_doc-class_method" title="method_doc (class method)">+ (Object) <strong>method_doc</strong>(method) </a>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
239
|
+
|
|
240
|
+
</li>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<li class="public ">
|
|
244
|
+
<span class="summary_signature">
|
|
245
|
+
|
|
246
|
+
<a href="#validation_hash-class_method" title="validation_hash (class method)">+ (Object) <strong>validation_hash</strong>(method) </a>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</span>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
261
|
+
|
|
262
|
+
</li>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
</ul>
|
|
266
|
+
|
|
267
|
+
<h2>
|
|
268
|
+
Instance Method Summary
|
|
269
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
270
|
+
</h2>
|
|
271
|
+
|
|
272
|
+
<ul class="summary">
|
|
273
|
+
|
|
274
|
+
<li class="public ">
|
|
275
|
+
<span class="summary_signature">
|
|
276
|
+
|
|
277
|
+
<a href="#http_call-instance_method" title="#http_call (instance method)">- (Object) <strong>http_call</strong>(http_method, path, params = { }, headers = { }) </a>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</span>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Base) <strong>initialize</strong>(config, options = { }) </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<span class="note title constructor">constructor</span>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
316
|
+
A new instance of Base.
|
|
317
|
+
</p>
|
|
318
|
+
</div></span>
|
|
319
|
+
|
|
320
|
+
</li>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<li class="public ">
|
|
324
|
+
<span class="summary_signature">
|
|
325
|
+
|
|
326
|
+
<a href="#perform_call-instance_method" title="#perform_call (instance method)">- (Object) <strong>perform_call</strong>(method_name, params, headers) </a>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
</span>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
341
|
+
|
|
342
|
+
</li>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
<li class="public ">
|
|
346
|
+
<span class="summary_signature">
|
|
347
|
+
|
|
348
|
+
<a href="#validate_params%21-instance_method" title="#validate_params! (instance method)">- (Object) <strong>validate_params!</strong>(params, rules) </a>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
</span>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
363
|
+
|
|
364
|
+
</li>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</ul>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<div id="constructor_details" class="method_details_list">
|
|
371
|
+
<h2>Constructor Details</h2>
|
|
372
|
+
|
|
373
|
+
<div class="method_details first">
|
|
374
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
375
|
+
|
|
376
|
+
- (<tt><span class='object_link'><a href="" title="KatelloApi::Base (class)">Base</a></span></tt>) <strong>initialize</strong>(config, options = { })
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</h3><div class="docstring">
|
|
383
|
+
<div class="discussion">
|
|
384
|
+
<p>
|
|
385
|
+
A new instance of Base
|
|
386
|
+
</p>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</div>
|
|
390
|
+
</div>
|
|
391
|
+
<div class="tags">
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
</div><table class="source_code">
|
|
395
|
+
<tr>
|
|
396
|
+
<td>
|
|
397
|
+
<pre class="lines">
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
31
|
|
401
|
+
32
|
|
402
|
+
33
|
|
403
|
+
34
|
|
404
|
+
35
|
|
405
|
+
36
|
|
406
|
+
37
|
|
407
|
+
38
|
|
408
|
+
39
|
|
409
|
+
40
|
|
410
|
+
41
|
|
411
|
+
42</pre>
|
|
412
|
+
</td>
|
|
413
|
+
<td>
|
|
414
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 31</span>
|
|
415
|
+
|
|
416
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_config identifier id'>config</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
417
|
+
<span class='rubyid_@client ivar id'>@client</span> <span class='assign token'>=</span> <span class='rubyid_RestClient constant id'>RestClient</span><span class='colon2 op'>::</span><span class='rubyid_Resource constant id'>Resource</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span>
|
|
418
|
+
<span class='rubyid_config identifier id'>config</span><span class='lbrack token'>[</span><span class='symbol val'>:base_url</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
419
|
+
<span class='lbrace token'>{</span> <span class='symbol val'>:user</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_config identifier id'>config</span><span class='lbrack token'>[</span><span class='symbol val'>:username</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
420
|
+
<span class='symbol val'>:password</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_config identifier id'>config</span><span class='lbrack token'>[</span><span class='symbol val'>:password</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
421
|
+
<span class='symbol val'>:oauth</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_config identifier id'>config</span><span class='lbrack token'>[</span><span class='symbol val'>:oauth</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
422
|
+
<span class='symbol val'>:headers</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:content_type</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'application/json'</span><span class='comma token'>,</span>
|
|
423
|
+
<span class='symbol val'>:accept</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"application/json;version=#{API_VERSION}"</span><span class='comma token'>,</span>
|
|
424
|
+
<span class='string val'>'HTTP_KATELLO_USER'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'admin'</span> <span class='rbrace token'>}</span>
|
|
425
|
+
<span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_merge identifier id'>merge</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
|
426
|
+
<span class='rubyid_@config ivar id'>@config</span> <span class='assign token'>=</span> <span class='rubyid_config identifier id'>config</span>
|
|
427
|
+
<span class='rubyid_end end kw'>end</span>
|
|
428
|
+
</pre>
|
|
429
|
+
</td>
|
|
430
|
+
</tr>
|
|
431
|
+
</table>
|
|
432
|
+
</div>
|
|
433
|
+
|
|
434
|
+
</div>
|
|
435
|
+
|
|
436
|
+
<div id="instance_attr_details" class="attr_details">
|
|
437
|
+
<h2>Instance Attribute Details</h2>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span id=""></span>
|
|
441
|
+
<div class="method_details first">
|
|
442
|
+
<h3 class="signature first" id="client-instance_method">
|
|
443
|
+
|
|
444
|
+
- (<tt>Object</tt>) <strong>client</strong> <span class="extras">(readonly)</span>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</h3><div class="docstring">
|
|
451
|
+
<div class="discussion">
|
|
452
|
+
<p>
|
|
453
|
+
Returns the value of attribute client
|
|
454
|
+
</p>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</div>
|
|
458
|
+
</div>
|
|
459
|
+
<div class="tags">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</div><table class="source_code">
|
|
463
|
+
<tr>
|
|
464
|
+
<td>
|
|
465
|
+
<pre class="lines">
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
29
|
|
469
|
+
30
|
|
470
|
+
31</pre>
|
|
471
|
+
</td>
|
|
472
|
+
<td>
|
|
473
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 29</span>
|
|
474
|
+
|
|
475
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_client identifier id'>client</span>
|
|
476
|
+
<span class='rubyid_@client ivar id'>@client</span>
|
|
477
|
+
<span class='rubyid_end end kw'>end</span>
|
|
478
|
+
</pre>
|
|
479
|
+
</td>
|
|
480
|
+
</tr>
|
|
481
|
+
</table>
|
|
482
|
+
</div>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<span id=""></span>
|
|
486
|
+
<div class="method_details ">
|
|
487
|
+
<h3 class="signature " id="config-instance_method">
|
|
488
|
+
|
|
489
|
+
- (<tt>Object</tt>) <strong>config</strong> <span class="extras">(readonly)</span>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
</h3><div class="docstring">
|
|
496
|
+
<div class="discussion">
|
|
497
|
+
<p>
|
|
498
|
+
Returns the value of attribute config
|
|
499
|
+
</p>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
</div>
|
|
503
|
+
</div>
|
|
504
|
+
<div class="tags">
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</div><table class="source_code">
|
|
508
|
+
<tr>
|
|
509
|
+
<td>
|
|
510
|
+
<pre class="lines">
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
29
|
|
514
|
+
30
|
|
515
|
+
31</pre>
|
|
516
|
+
</td>
|
|
517
|
+
<td>
|
|
518
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 29</span>
|
|
519
|
+
|
|
520
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_config identifier id'>config</span>
|
|
521
|
+
<span class='rubyid_@config ivar id'>@config</span>
|
|
522
|
+
<span class='rubyid_end end kw'>end</span>
|
|
523
|
+
</pre>
|
|
524
|
+
</td>
|
|
525
|
+
</tr>
|
|
526
|
+
</table>
|
|
527
|
+
</div>
|
|
528
|
+
|
|
529
|
+
</div>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<div id="class_method_details" class="method_details_list">
|
|
533
|
+
<h2>Class Method Details</h2>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<div class="method_details first">
|
|
537
|
+
<h3 class="signature first" id="doc-class_method">
|
|
538
|
+
|
|
539
|
+
+ (<tt>Object</tt>) <strong>doc</strong>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</h3><div class="docstring">
|
|
546
|
+
<div class="discussion">
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</div>
|
|
551
|
+
<div class="tags">
|
|
552
|
+
|
|
553
|
+
<p class="tag_title">Raises:</p>
|
|
554
|
+
<ul class="raise">
|
|
555
|
+
|
|
556
|
+
<li>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</li>
|
|
564
|
+
|
|
565
|
+
</ul>
|
|
566
|
+
|
|
567
|
+
</div><table class="source_code">
|
|
568
|
+
<tr>
|
|
569
|
+
<td>
|
|
570
|
+
<pre class="lines">
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
67
|
|
574
|
+
68
|
|
575
|
+
69</pre>
|
|
576
|
+
</td>
|
|
577
|
+
<td>
|
|
578
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 67</span>
|
|
579
|
+
|
|
580
|
+
<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>
|
|
581
|
+
<span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_NotImplementedError constant id'>NotImplementedError</span>
|
|
582
|
+
<span class='rubyid_end end kw'>end</span>
|
|
583
|
+
</pre>
|
|
584
|
+
</td>
|
|
585
|
+
</tr>
|
|
586
|
+
</table>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
<div class="method_details ">
|
|
590
|
+
<h3 class="signature " id="method_doc-class_method">
|
|
591
|
+
|
|
592
|
+
+ (<tt>Object</tt>) <strong>method_doc</strong>(method)
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
</h3><table class="source_code">
|
|
599
|
+
<tr>
|
|
600
|
+
<td>
|
|
601
|
+
<pre class="lines">
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
75
|
|
605
|
+
76
|
|
606
|
+
77</pre>
|
|
607
|
+
</td>
|
|
608
|
+
<td>
|
|
609
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 75</span>
|
|
610
|
+
|
|
611
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_method_doc identifier id'>method_doc</span><span class='lparen token'>(</span><span class='rubyid_method identifier id'>method</span><span class='rparen token'>)</span>
|
|
612
|
+
<span class='rubyid_method_docs identifier id'>method_docs</span><span class='lbrack token'>[</span><span class='rubyid_method identifier id'>method</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span><span class='rbrack token'>]</span>
|
|
613
|
+
<span class='rubyid_end end kw'>end</span>
|
|
614
|
+
</pre>
|
|
615
|
+
</td>
|
|
616
|
+
</tr>
|
|
617
|
+
</table>
|
|
618
|
+
</div>
|
|
619
|
+
|
|
620
|
+
<div class="method_details ">
|
|
621
|
+
<h3 class="signature " id="validation_hash-class_method">
|
|
622
|
+
|
|
623
|
+
+ (<tt>Object</tt>) <strong>validation_hash</strong>(method)
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
</h3><table class="source_code">
|
|
630
|
+
<tr>
|
|
631
|
+
<td>
|
|
632
|
+
<pre class="lines">
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
71
|
|
636
|
+
72
|
|
637
|
+
73</pre>
|
|
638
|
+
</td>
|
|
639
|
+
<td>
|
|
640
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 71</span>
|
|
641
|
+
|
|
642
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_validation_hash identifier id'>validation_hash</span><span class='lparen token'>(</span><span class='rubyid_method identifier id'>method</span><span class='rparen token'>)</span>
|
|
643
|
+
<span class='rubyid_validation_hashes identifier id'>validation_hashes</span><span class='lbrack token'>[</span><span class='rubyid_method identifier id'>method</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span><span class='rbrack token'>]</span>
|
|
644
|
+
<span class='rubyid_end end kw'>end</span>
|
|
645
|
+
</pre>
|
|
646
|
+
</td>
|
|
647
|
+
</tr>
|
|
648
|
+
</table>
|
|
649
|
+
</div>
|
|
650
|
+
|
|
651
|
+
</div>
|
|
652
|
+
|
|
653
|
+
<div id="instance_method_details" class="method_details_list">
|
|
654
|
+
<h2>Instance Method Details</h2>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<div class="method_details first">
|
|
658
|
+
<h3 class="signature first" id="http_call-instance_method">
|
|
659
|
+
|
|
660
|
+
- (<tt>Object</tt>) <strong>http_call</strong>(http_method, path, params = { }, headers = { })
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
</h3><table class="source_code">
|
|
667
|
+
<tr>
|
|
668
|
+
<td>
|
|
669
|
+
<pre class="lines">
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
53
|
|
673
|
+
54
|
|
674
|
+
55
|
|
675
|
+
56
|
|
676
|
+
57
|
|
677
|
+
58
|
|
678
|
+
59
|
|
679
|
+
60
|
|
680
|
+
61
|
|
681
|
+
62
|
|
682
|
+
63
|
|
683
|
+
64
|
|
684
|
+
65</pre>
|
|
685
|
+
</td>
|
|
686
|
+
<td>
|
|
687
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 53</span>
|
|
688
|
+
|
|
689
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_http_call identifier id'>http_call</span><span class='lparen token'>(</span><span class='rubyid_http_method identifier id'>http_method</span><span class='comma token'>,</span> <span class='rubyid_path identifier id'>path</span><span class='comma 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>
|
|
690
|
+
<span class='rubyid_headers identifier id'>headers</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span> <span class='rbrace token'>}</span>
|
|
691
|
+
|
|
692
|
+
<span class='rubyid_args identifier id'>args</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rubyid_http_method identifier id'>http_method</span><span class='rbrack token'>]</span>
|
|
693
|
+
<span class='rubyid_if if kw'>if</span> <span class='dstring node'>%w[post put]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_http_method identifier id'>http_method</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span><span class='rparen token'>)</span>
|
|
694
|
+
<span class='rubyid_args identifier id'>args</span> <span class='lshft op'><<</span> <span class='rubyid_params identifier id'>params</span><span class='dot token'>.</span><span class='rubyid_to_json identifier id'>to_json</span>
|
|
695
|
+
<span class='rubyid_else else kw'>else</span>
|
|
696
|
+
<span class='rubyid_headers identifier id'>headers</span><span class='lbrack token'>[</span><span class='symbol val'>:params</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_params identifier id'>params</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_params identifier id'>params</span>
|
|
697
|
+
<span class='rubyid_end end kw'>end</span>
|
|
698
|
+
|
|
699
|
+
<span class='rubyid_args identifier id'>args</span> <span class='lshft op'><<</span> <span class='rubyid_headers identifier id'>headers</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_headers identifier id'>headers</span>
|
|
700
|
+
<span class='rubyid_process_data identifier id'>process_data</span> <span class='rubyid_client identifier id'>client</span><span class='lbrack token'>[</span><span class='rubyid_path identifier id'>path</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='rubyid_args identifier id'>args</span><span class='rparen token'>)</span>
|
|
701
|
+
<span class='rubyid_end end kw'>end</span>
|
|
702
|
+
</pre>
|
|
703
|
+
</td>
|
|
704
|
+
</tr>
|
|
705
|
+
</table>
|
|
706
|
+
</div>
|
|
707
|
+
|
|
708
|
+
<div class="method_details ">
|
|
709
|
+
<h3 class="signature " id="perform_call-instance_method">
|
|
710
|
+
|
|
711
|
+
- (<tt>Object</tt>) <strong>perform_call</strong>(method_name, params, headers)
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
</h3><table class="source_code">
|
|
718
|
+
<tr>
|
|
719
|
+
<td>
|
|
720
|
+
<pre class="lines">
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
44
|
|
724
|
+
45
|
|
725
|
+
46
|
|
726
|
+
47
|
|
727
|
+
48
|
|
728
|
+
49
|
|
729
|
+
50
|
|
730
|
+
51</pre>
|
|
731
|
+
</td>
|
|
732
|
+
<td>
|
|
733
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 44</span>
|
|
734
|
+
|
|
735
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid_method_name identifier id'>method_name</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>
|
|
736
|
+
<span class='rubyid_method_doc identifier id'>method_doc</span> <span class='assign token'>=</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_method_doc identifier id'>method_doc</span><span class='lparen token'>(</span><span class='rubyid_method_name identifier id'>method_name</span><span class='rparen token'>)</span>
|
|
737
|
+
<span class='rubyid_check_params identifier id'>check_params</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='symbol val'>:allowed</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_method_doc identifier id'>method_doc</span><span class='lbrack token'>[</span><span class='string val'>'params'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_any? fid id'>any?</span><span class='comma token'>,</span> <span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_method_name identifier id'>method_name</span>
|
|
738
|
+
<span class='rubyid_method_apis identifier id'>method_apis</span> <span class='assign token'>=</span> <span class='rubyid_method_doc identifier id'>method_doc</span><span class='lbrack token'>[</span><span class='string val'>'apis'</span><span class='rbrack token'>]</span>
|
|
739
|
+
<span class='rubyid_api identifier id'>api</span> <span class='assign token'>=</span> <span class='rubyid_find_suitable_api_call identifier id'>find_suitable_api_call</span><span class='lparen token'>(</span><span class='rubyid_method_apis identifier id'>method_apis</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='rparen token'>)</span>
|
|
740
|
+
<span class='rubyid_url identifier id'>url</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='rubyid_fill_params_in_url identifier id'>fill_params_in_url</span> <span class='rubyid_api identifier id'>api</span><span class='lbrack token'>[</span><span class='string val'>'api_url'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span>
|
|
741
|
+
<span class='rubyid_return return kw'>return</span> <span class='rubyid_http_call identifier id'>http_call</span><span class='lparen token'>(</span><span class='rubyid_api identifier id'>api</span><span class='lbrack token'>[</span><span class='string val'>'http_method'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_downcase identifier id'>downcase</span><span class='comma token'>,</span> <span class='rubyid_url identifier id'>url</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>
|
|
742
|
+
<span class='rubyid_end end kw'>end</span>
|
|
743
|
+
</pre>
|
|
744
|
+
</td>
|
|
745
|
+
</tr>
|
|
746
|
+
</table>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
<div class="method_details ">
|
|
750
|
+
<h3 class="signature " id="validate_params!-instance_method">
|
|
751
|
+
|
|
752
|
+
- (<tt>Object</tt>) <strong>validate_params!</strong>(params, rules)
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
</h3><div class="docstring">
|
|
759
|
+
<div class="discussion">
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
</div>
|
|
763
|
+
</div>
|
|
764
|
+
<div class="tags">
|
|
765
|
+
|
|
766
|
+
<p class="tag_title">Raises:</p>
|
|
767
|
+
<ul class="raise">
|
|
768
|
+
|
|
769
|
+
<li>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
</li>
|
|
777
|
+
|
|
778
|
+
</ul>
|
|
779
|
+
|
|
780
|
+
</div><table class="source_code">
|
|
781
|
+
<tr>
|
|
782
|
+
<td>
|
|
783
|
+
<pre class="lines">
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
79
|
|
787
|
+
80
|
|
788
|
+
81
|
|
789
|
+
82
|
|
790
|
+
83
|
|
791
|
+
84
|
|
792
|
+
85
|
|
793
|
+
86
|
|
794
|
+
87
|
|
795
|
+
88
|
|
796
|
+
89
|
|
797
|
+
90</pre>
|
|
798
|
+
</td>
|
|
799
|
+
<td>
|
|
800
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/base.rb', line 79</span>
|
|
801
|
+
|
|
802
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_validate_params! fid id'>validate_params!</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_rules identifier id'>rules</span><span class='rparen token'>)</span>
|
|
803
|
+
<span class='rubyid_return return kw'>return</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_params identifier id'>params</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Hash constant id'>Hash</span><span class='rparen token'>)</span>
|
|
804
|
+
|
|
805
|
+
<span class='rubyid_invalid_keys identifier id'>invalid_keys</span> <span class='assign token'>=</span> <span class='rubyid_params identifier id'>params</span><span class='dot token'>.</span><span class='rubyid_keys identifier id'>keys</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span><span class='lparen token'>(</span><span class='bitand op'>&</span><span class='symbol val'>:to_s</span><span class='rparen token'>)</span> <span class='minus op'>-</span> <span class='lparen token'>(</span><span class='rubyid_rules identifier id'>rules</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Hash constant id'>Hash</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_rules identifier id'>rules</span><span class='dot token'>.</span><span class='rubyid_keys identifier id'>keys</span> <span class='colon op'>:</span> <span class='rubyid_rules identifier id'>rules</span><span class='rparen token'>)</span>
|
|
806
|
+
<span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='dstring node'>"Invalid keys: #{invalid_keys.join(", ")}"</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_invalid_keys identifier id'>invalid_keys</span><span class='dot token'>.</span><span class='rubyid_empty? fid id'>empty?</span>
|
|
807
|
+
|
|
808
|
+
<span class='rubyid_if if kw'>if</span> <span class='rubyid_rules identifier id'>rules</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_Hash constant id'>Hash</span>
|
|
809
|
+
<span class='rubyid_rules identifier id'>rules</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_key identifier id'>key</span><span class='comma token'>,</span> <span class='rubyid_sub_keys identifier id'>sub_keys</span><span class='bitor op'>|</span>
|
|
810
|
+
<span class='rubyid_validate_params! fid id'>validate_params!</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='rubyid_key identifier id'>key</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_sub_keys identifier id'>sub_keys</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='rubyid_key identifier id'>key</span><span class='rbrack token'>]</span>
|
|
811
|
+
<span class='rubyid_end end kw'>end</span>
|
|
812
|
+
<span class='rubyid_end end kw'>end</span>
|
|
813
|
+
<span class='rubyid_end end kw'>end</span>
|
|
814
|
+
</pre>
|
|
815
|
+
</td>
|
|
816
|
+
</tr>
|
|
817
|
+
</table>
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
</div>
|
|
821
|
+
|
|
822
|
+
</div>
|
|
823
|
+
|
|
824
|
+
<div id="footer">
|
|
825
|
+
Generated on Mon Mar 18 14:17:40 2013 by
|
|
826
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
827
|
+
0.8.5.2 (ruby-1.8.7).
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
</body>
|
|
831
|
+
</html>
|