rhc-rest 0.0.7
Sign up to get free protection for your applications and to get access to all the features.
- data/COPYRIGHT +1 -0
- data/Gemfile +4 -0
- data/LICENSE +11 -0
- data/Rakefile +1 -0
- data/bin/sample-usage.rb +124 -0
- data/doc/Gemfile.html +119 -0
- data/doc/Rakefile.html +117 -0
- data/doc/Rhc/Rest/Application.html +571 -0
- data/doc/Rhc/Rest/BaseException.html +226 -0
- data/doc/Rhc/Rest/Cartridge.html +475 -0
- data/doc/Rhc/Rest/Client.html +609 -0
- data/doc/Rhc/Rest/ClientErrorException.html +167 -0
- data/doc/Rhc/Rest/Domain.html +457 -0
- data/doc/Rhc/Rest/Key.html +378 -0
- data/doc/Rhc/Rest/RequestDeniedException.html +166 -0
- data/doc/Rhc/Rest/ResourceAccessException.html +161 -0
- data/doc/Rhc/Rest/ResourceNotFoundException.html +166 -0
- data/doc/Rhc/Rest/ServerErrorException.html +161 -0
- data/doc/Rhc/Rest/ServiceUnavailableException.html +167 -0
- data/doc/Rhc/Rest/UnAuthorizedException.html +167 -0
- data/doc/Rhc/Rest/User.html +354 -0
- data/doc/Rhc/Rest/ValidationException.html +255 -0
- data/doc/Rhc/Rest.html +410 -0
- data/doc/Rhc.html +329 -0
- data/doc/created.rid +13 -0
- data/doc/doc/created.rid +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +112 -0
- data/doc/js/darkfish.js +153 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +543 -0
- data/doc/table_of_contents.html +198 -0
- data/lib/rhc-rest/application.rb +81 -0
- data/lib/rhc-rest/cartridge.rb +64 -0
- data/lib/rhc-rest/client.rb +122 -0
- data/lib/rhc-rest/domain.rb +56 -0
- data/lib/rhc-rest/exceptions/exceptions.rb +73 -0
- data/lib/rhc-rest/key.rb +34 -0
- data/lib/rhc-rest/user.rb +41 -0
- data/lib/rhc-rest/version.rb +5 -0
- data/lib/rhc-rest.rb +155 -0
- data/rhc-rest.gemspec +26 -0
- data/rhc-rest.spec +79 -0
- metadata +162 -0
|
@@ -0,0 +1,609 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>class Rhc::Rest::Client - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../../";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="../../index.html">Home</a>
|
|
28
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/rhc-rest/client.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link">Object
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
65
|
+
|
|
66
|
+
<!-- Included Modules -->
|
|
67
|
+
<nav id="includes-section" class="section">
|
|
68
|
+
<h3 class="section-header">Included Modules</h3>
|
|
69
|
+
|
|
70
|
+
<ul class="link-list">
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<li><a class="include" href="../Rest.html">Rhc::Rest</a>
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
</nav>
|
|
78
|
+
|
|
79
|
+
<!-- Method Quickref -->
|
|
80
|
+
<nav id="method-list-section" class="section">
|
|
81
|
+
<h3 class="section-header">Methods</h3>
|
|
82
|
+
|
|
83
|
+
<ul class="link-list">
|
|
84
|
+
|
|
85
|
+
<li><a href="#method-c-new">::new</a>
|
|
86
|
+
|
|
87
|
+
<li><a href="#method-i-add_domain">#add_domain</a>
|
|
88
|
+
|
|
89
|
+
<li><a href="#method-i-cartridges">#cartridges</a>
|
|
90
|
+
|
|
91
|
+
<li><a href="#method-i-close">#close</a>
|
|
92
|
+
|
|
93
|
+
<li><a href="#method-i-domains">#domains</a>
|
|
94
|
+
|
|
95
|
+
<li><a href="#method-i-find_application">#find_application</a>
|
|
96
|
+
|
|
97
|
+
<li><a href="#method-i-find_cartridge">#find_cartridge</a>
|
|
98
|
+
|
|
99
|
+
<li><a href="#method-i-find_domain">#find_domain</a>
|
|
100
|
+
|
|
101
|
+
<li><a href="#method-i-find_key">#find_key</a>
|
|
102
|
+
|
|
103
|
+
<li><a href="#method-i-logout">#logout</a>
|
|
104
|
+
|
|
105
|
+
<li><a href="#method-i-user">#user</a>
|
|
106
|
+
|
|
107
|
+
</ul>
|
|
108
|
+
</nav>
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
<div id="project-metadata">
|
|
113
|
+
<nav id="fileindex-section" class="section project-section">
|
|
114
|
+
<h3 class="section-header">Pages</h3>
|
|
115
|
+
|
|
116
|
+
<ul>
|
|
117
|
+
|
|
118
|
+
<li class="file"><a href="../../Gemfile.html">Gemfile</a>
|
|
119
|
+
|
|
120
|
+
<li class="file"><a href="../../Rakefile.html">Rakefile</a>
|
|
121
|
+
|
|
122
|
+
</ul>
|
|
123
|
+
</nav>
|
|
124
|
+
|
|
125
|
+
<nav id="classindex-section" class="section project-section">
|
|
126
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
127
|
+
|
|
128
|
+
<ul class="link-list">
|
|
129
|
+
|
|
130
|
+
<li><a href="../../Rhc.html">Rhc</a>
|
|
131
|
+
|
|
132
|
+
<li><a href="../../Rhc/Rest.html">Rhc::Rest</a>
|
|
133
|
+
|
|
134
|
+
<li><a href="../../Rhc/Rest/Application.html">Rhc::Rest::Application</a>
|
|
135
|
+
|
|
136
|
+
<li><a href="../../Rhc/Rest/BaseException.html">Rhc::Rest::BaseException</a>
|
|
137
|
+
|
|
138
|
+
<li><a href="../../Rhc/Rest/Cartridge.html">Rhc::Rest::Cartridge</a>
|
|
139
|
+
|
|
140
|
+
<li><a href="../../Rhc/Rest/Client.html">Rhc::Rest::Client</a>
|
|
141
|
+
|
|
142
|
+
<li><a href="../../Rhc/Rest/ClientErrorException.html">Rhc::Rest::ClientErrorException</a>
|
|
143
|
+
|
|
144
|
+
<li><a href="../../Rhc/Rest/Domain.html">Rhc::Rest::Domain</a>
|
|
145
|
+
|
|
146
|
+
<li><a href="../../Rhc/Rest/Key.html">Rhc::Rest::Key</a>
|
|
147
|
+
|
|
148
|
+
<li><a href="../../Rhc/Rest/RequestDeniedException.html">Rhc::Rest::RequestDeniedException</a>
|
|
149
|
+
|
|
150
|
+
<li><a href="../../Rhc/Rest/ResourceAccessException.html">Rhc::Rest::ResourceAccessException</a>
|
|
151
|
+
|
|
152
|
+
<li><a href="../../Rhc/Rest/ResourceNotFoundException.html">Rhc::Rest::ResourceNotFoundException</a>
|
|
153
|
+
|
|
154
|
+
<li><a href="../../Rhc/Rest/ServerErrorException.html">Rhc::Rest::ServerErrorException</a>
|
|
155
|
+
|
|
156
|
+
<li><a href="../../Rhc/Rest/ServiceUnavailableException.html">Rhc::Rest::ServiceUnavailableException</a>
|
|
157
|
+
|
|
158
|
+
<li><a href="../../Rhc/Rest/UnAuthorizedException.html">Rhc::Rest::UnAuthorizedException</a>
|
|
159
|
+
|
|
160
|
+
<li><a href="../../Rhc/Rest/User.html">Rhc::Rest::User</a>
|
|
161
|
+
|
|
162
|
+
<li><a href="../../Rhc/Rest/ValidationException.html">Rhc::Rest::ValidationException</a>
|
|
163
|
+
|
|
164
|
+
</ul>
|
|
165
|
+
</nav>
|
|
166
|
+
|
|
167
|
+
</div>
|
|
168
|
+
</nav>
|
|
169
|
+
|
|
170
|
+
<div id="documentation">
|
|
171
|
+
<h1 class="class">class Rhc::Rest::Client</h1>
|
|
172
|
+
|
|
173
|
+
<div id="description" class="description">
|
|
174
|
+
|
|
175
|
+
</div><!-- description -->
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<!-- Methods -->
|
|
190
|
+
|
|
191
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
192
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<div id="method-c-new" class="method-detail ">
|
|
196
|
+
|
|
197
|
+
<div class="method-heading">
|
|
198
|
+
<span class="method-name">new</span><span
|
|
199
|
+
class="method-args">(end_point, username, password)</span>
|
|
200
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
201
|
+
</div>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
<div class="method-description">
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<div class="method-source-code" id="new-source">
|
|
211
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 26</span>
|
|
212
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">end_point</span>, <span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>)
|
|
213
|
+
<span class="ruby-identifier">@@end_point</span> = <span class="ruby-identifier">end_point</span>
|
|
214
|
+
<span class="ruby-ivar">@username</span> = <span class="ruby-identifier">username</span>
|
|
215
|
+
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
|
|
216
|
+
<span class="ruby-identifier">request</span> = <span class="ruby-constant">RestClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">@@end_point</span> <span class="ruby-operator">+</span> <span class="ruby-string">"/api"</span>, <span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-value">:get</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">@@headers</span>, <span class="ruby-value">:username</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@username</span>, <span class="ruby-value">:password</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">password</span>)
|
|
217
|
+
<span class="ruby-keyword">begin</span>
|
|
218
|
+
<span class="ruby-keyword">begin</span>
|
|
219
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">execute</span>
|
|
220
|
+
<span class="ruby-identifier">result</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">response</span>)
|
|
221
|
+
<span class="ruby-ivar">@links</span> = <span class="ruby-identifier">send</span>(<span class="ruby-identifier">request</span>)
|
|
222
|
+
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">RestClient</span><span class="ruby-operator">::</span><span class="ruby-constant">ExceptionWithResponse</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
|
223
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">response</span>
|
|
224
|
+
<span class="ruby-keyword">end</span>
|
|
225
|
+
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
|
226
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ResourceAccessException</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Resource could not be accessed:#{e.message}"</span>)
|
|
227
|
+
<span class="ruby-keyword">end</span>
|
|
228
|
+
<span class="ruby-keyword">end</span></pre>
|
|
229
|
+
</div><!-- new-source -->
|
|
230
|
+
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</div><!-- new-method -->
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</section><!-- public-class-method-details -->
|
|
240
|
+
|
|
241
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
242
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<div id="method-i-add_domain" class="method-detail ">
|
|
246
|
+
|
|
247
|
+
<div class="method-heading">
|
|
248
|
+
<span class="method-name">add_domain</span><span
|
|
249
|
+
class="method-args">(namespace)</span>
|
|
250
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<div class="method-description">
|
|
255
|
+
|
|
256
|
+
<p>Add <a href="Domain.html">Domain</a></p>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<div class="method-source-code" id="add_domain-source">
|
|
261
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 45</span>
|
|
262
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_domain</span>(<span class="ruby-identifier">namespace</span>)
|
|
263
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Adding domain #{namespace}"</span>
|
|
264
|
+
<span class="ruby-identifier">url</span> = <span class="ruby-identifier">@@end_point</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@links</span>[<span class="ruby-string">'ADD_DOMAIN'</span>][<span class="ruby-string">'href'</span>]
|
|
265
|
+
<span class="ruby-identifier">method</span> = <span class="ruby-ivar">@links</span>[<span class="ruby-string">'ADD_DOMAIN'</span>][<span class="ruby-string">'method'</span>]
|
|
266
|
+
<span class="ruby-identifier">payload</span> = {<span class="ruby-value">:namespace</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">namespace</span>}
|
|
267
|
+
<span class="ruby-identifier">request</span> = <span class="ruby-constant">RestClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>, <span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">method</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">@@headers</span>, <span class="ruby-value">:payload</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">payload</span>)
|
|
268
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">send</span>(<span class="ruby-identifier">request</span>)
|
|
269
|
+
<span class="ruby-keyword">end</span></pre>
|
|
270
|
+
</div><!-- add_domain-source -->
|
|
271
|
+
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</div><!-- add_domain-method -->
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<div id="method-i-cartridges" class="method-detail ">
|
|
281
|
+
|
|
282
|
+
<div class="method-heading">
|
|
283
|
+
<span class="method-name">cartridges</span><span
|
|
284
|
+
class="method-args">()</span>
|
|
285
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
286
|
+
</div>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<div class="method-description">
|
|
290
|
+
|
|
291
|
+
<p>Get all <a href="Cartridge.html">Cartridge</a></p>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<div class="method-source-code" id="cartridges-source">
|
|
296
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 92</span>
|
|
297
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">cartridges</span>
|
|
298
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">"Getting all cartridges"</span>
|
|
299
|
+
<span class="ruby-identifier">url</span> = <span class="ruby-identifier">@@end_point</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@links</span>[<span class="ruby-string">'LIST_CARTRIDGES'</span>][<span class="ruby-string">'href'</span>]
|
|
300
|
+
<span class="ruby-identifier">method</span> = <span class="ruby-ivar">@links</span>[<span class="ruby-string">'LIST_CARTRIDGES'</span>][<span class="ruby-string">'method'</span>]
|
|
301
|
+
<span class="ruby-identifier">request</span> = <span class="ruby-constant">RestClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>, <span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">method</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">@@headers</span>)
|
|
302
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">send</span>(<span class="ruby-identifier">request</span>)
|
|
303
|
+
<span class="ruby-keyword">end</span></pre>
|
|
304
|
+
</div><!-- cartridges-source -->
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</div><!-- cartridges-method -->
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<div id="method-i-close" class="method-detail method-alias">
|
|
315
|
+
|
|
316
|
+
<div class="method-heading">
|
|
317
|
+
<span class="method-name">close</span><span
|
|
318
|
+
class="method-args">()</span>
|
|
319
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<div class="method-description">
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<div class="aliases">
|
|
335
|
+
Alias for: <a href="Client.html#method-i-logout">logout</a>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
</div><!-- close-method -->
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<div id="method-i-domains" class="method-detail ">
|
|
342
|
+
|
|
343
|
+
<div class="method-heading">
|
|
344
|
+
<span class="method-name">domains</span><span
|
|
345
|
+
class="method-args">()</span>
|
|
346
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<div class="method-description">
|
|
351
|
+
|
|
352
|
+
<p>Get all <a href="Domain.html">Domain</a></p>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<div class="method-source-code" id="domains-source">
|
|
357
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 55</span>
|
|
358
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">domains</span>
|
|
359
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">"Getting all domains"</span>
|
|
360
|
+
<span class="ruby-identifier">url</span> = <span class="ruby-identifier">@@end_point</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@links</span>[<span class="ruby-string">'LIST_DOMAINS'</span>][<span class="ruby-string">'href'</span>]
|
|
361
|
+
<span class="ruby-identifier">method</span> = <span class="ruby-ivar">@links</span>[<span class="ruby-string">'LIST_DOMAINS'</span>][<span class="ruby-string">'method'</span>]
|
|
362
|
+
<span class="ruby-identifier">request</span> = <span class="ruby-constant">RestClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>, <span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">method</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">@@headers</span>)
|
|
363
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">send</span>(<span class="ruby-identifier">request</span>)
|
|
364
|
+
<span class="ruby-keyword">end</span></pre>
|
|
365
|
+
</div><!-- domains-source -->
|
|
366
|
+
|
|
367
|
+
</div>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</div><!-- domains-method -->
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<div id="method-i-find_application" class="method-detail ">
|
|
376
|
+
|
|
377
|
+
<div class="method-heading">
|
|
378
|
+
<span class="method-name">find_application</span><span
|
|
379
|
+
class="method-args">(name)</span>
|
|
380
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<div class="method-description">
|
|
385
|
+
|
|
386
|
+
<p>Find <a href="Application.html">Application</a> by name</p>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<div class="method-source-code" id="find_application-source">
|
|
391
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 77</span>
|
|
392
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_application</span>(<span class="ruby-identifier">name</span>)
|
|
393
|
+
<span class="ruby-identifier">ogger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Finding application #{name}"</span>
|
|
394
|
+
<span class="ruby-identifier">filtered</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
|
|
395
|
+
<span class="ruby-identifier">domains</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">domain</span><span class="ruby-operator">|</span>
|
|
396
|
+
<span class="ruby-comment">#TODO do a regex caomparison</span>
|
|
397
|
+
<span class="ruby-identifier">domain</span>.<span class="ruby-identifier">applications</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">app</span><span class="ruby-operator">|</span>
|
|
398
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">app</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>
|
|
399
|
+
<span class="ruby-identifier">filtered</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">app</span>)
|
|
400
|
+
<span class="ruby-keyword">end</span>
|
|
401
|
+
<span class="ruby-keyword">end</span>
|
|
402
|
+
<span class="ruby-keyword">end</span>
|
|
403
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">filtered</span>
|
|
404
|
+
<span class="ruby-keyword">end</span></pre>
|
|
405
|
+
</div><!-- find_application-source -->
|
|
406
|
+
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
</div><!-- find_application-method -->
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<div id="method-i-find_cartridge" class="method-detail ">
|
|
416
|
+
|
|
417
|
+
<div class="method-heading">
|
|
418
|
+
<span class="method-name">find_cartridge</span><span
|
|
419
|
+
class="method-args">(name)</span>
|
|
420
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
421
|
+
</div>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
<div class="method-description">
|
|
425
|
+
|
|
426
|
+
<p>Find <a href="Cartridge.html">Cartridge</a> by name</p>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
<div class="method-source-code" id="find_cartridge-source">
|
|
431
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 101</span>
|
|
432
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_cartridge</span>(<span class="ruby-identifier">name</span>)
|
|
433
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Finding cartridge #{name}"</span>
|
|
434
|
+
<span class="ruby-identifier">filtered</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
|
|
435
|
+
<span class="ruby-identifier">cartridges</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cart</span><span class="ruby-operator">|</span>
|
|
436
|
+
<span class="ruby-comment">#TODO do a regex caomparison</span>
|
|
437
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">cart</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>
|
|
438
|
+
<span class="ruby-identifier">filtered</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">cart</span>)
|
|
439
|
+
<span class="ruby-keyword">end</span>
|
|
440
|
+
<span class="ruby-keyword">end</span>
|
|
441
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">filtered</span>
|
|
442
|
+
<span class="ruby-keyword">end</span></pre>
|
|
443
|
+
</div><!-- find_cartridge-source -->
|
|
444
|
+
|
|
445
|
+
</div>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</div><!-- find_cartridge-method -->
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
<div id="method-i-find_domain" class="method-detail ">
|
|
454
|
+
|
|
455
|
+
<div class="method-heading">
|
|
456
|
+
<span class="method-name">find_domain</span><span
|
|
457
|
+
class="method-args">(namespace)</span>
|
|
458
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
459
|
+
</div>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<div class="method-description">
|
|
463
|
+
|
|
464
|
+
<p>Find <a href="Domain.html">Domain</a> by namesapce</p>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<div class="method-source-code" id="find_domain-source">
|
|
469
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 64</span>
|
|
470
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_domain</span>(<span class="ruby-identifier">namespace</span>)
|
|
471
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Finding domain #{namespace}"</span>
|
|
472
|
+
<span class="ruby-identifier">filtered</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
|
|
473
|
+
<span class="ruby-identifier">domains</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">domain</span><span class="ruby-operator">|</span>
|
|
474
|
+
<span class="ruby-comment">#TODO do a regex caomparison</span>
|
|
475
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">domain</span>.<span class="ruby-identifier">namespace</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">namespace</span>
|
|
476
|
+
<span class="ruby-identifier">filtered</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">domain</span>)
|
|
477
|
+
<span class="ruby-keyword">end</span>
|
|
478
|
+
<span class="ruby-keyword">end</span>
|
|
479
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">filtered</span>
|
|
480
|
+
<span class="ruby-keyword">end</span></pre>
|
|
481
|
+
</div><!-- find_domain-source -->
|
|
482
|
+
|
|
483
|
+
</div>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</div><!-- find_domain-method -->
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<div id="method-i-find_key" class="method-detail ">
|
|
492
|
+
|
|
493
|
+
<div class="method-heading">
|
|
494
|
+
<span class="method-name">find_key</span><span
|
|
495
|
+
class="method-args">(name)</span>
|
|
496
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
497
|
+
</div>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<div class="method-description">
|
|
501
|
+
|
|
502
|
+
<p>find <a href="Key.html">Key</a> by name</p>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
<div class="method-source-code" id="find_key-source">
|
|
507
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 122</span>
|
|
508
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_key</span>(<span class="ruby-identifier">name</span>)
|
|
509
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Finding key #{name}"</span>
|
|
510
|
+
<span class="ruby-identifier">filtered</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
|
|
511
|
+
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
|
|
512
|
+
<span class="ruby-comment">#TODO do a regex caomparison</span>
|
|
513
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>
|
|
514
|
+
<span class="ruby-identifier">filtered</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">key</span>)
|
|
515
|
+
<span class="ruby-keyword">end</span>
|
|
516
|
+
<span class="ruby-keyword">end</span>
|
|
517
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">filtered</span>
|
|
518
|
+
<span class="ruby-keyword">end</span></pre>
|
|
519
|
+
</div><!-- find_key-source -->
|
|
520
|
+
|
|
521
|
+
</div>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
</div><!-- find_key-method -->
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<div id="method-i-logout" class="method-detail ">
|
|
530
|
+
|
|
531
|
+
<div class="method-heading">
|
|
532
|
+
<span class="method-name">logout</span><span
|
|
533
|
+
class="method-args">()</span>
|
|
534
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
535
|
+
</div>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
<div class="method-description">
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<div class="method-source-code" id="logout-source">
|
|
545
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 134</span>
|
|
546
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">logout</span>
|
|
547
|
+
<span class="ruby-comment">#TODO logout</span>
|
|
548
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">"Logout/Close client"</span>
|
|
549
|
+
<span class="ruby-keyword">end</span></pre>
|
|
550
|
+
</div><!-- logout-source -->
|
|
551
|
+
|
|
552
|
+
</div>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
<div class="aliases">
|
|
556
|
+
Also aliased as: <a href="Client.html#method-i-close">close</a>
|
|
557
|
+
</div>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</div><!-- logout-method -->
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
<div id="method-i-user" class="method-detail ">
|
|
565
|
+
|
|
566
|
+
<div class="method-heading">
|
|
567
|
+
<span class="method-name">user</span><span
|
|
568
|
+
class="method-args">()</span>
|
|
569
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
570
|
+
</div>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<div class="method-description">
|
|
574
|
+
|
|
575
|
+
<p>Get <a href="User.html">User</a> info</p>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<div class="method-source-code" id="user-source">
|
|
580
|
+
<pre><span class="ruby-comment"># File lib/rhc-rest/client.rb, line 114</span>
|
|
581
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user</span>
|
|
582
|
+
<span class="ruby-identifier">url</span> = <span class="ruby-identifier">@@end_point</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@links</span>[<span class="ruby-string">'GET_USER'</span>][<span class="ruby-string">'href'</span>]
|
|
583
|
+
<span class="ruby-identifier">method</span> = <span class="ruby-ivar">@links</span>[<span class="ruby-string">'GET_USER'</span>][<span class="ruby-string">'method'</span>]
|
|
584
|
+
<span class="ruby-identifier">request</span> = <span class="ruby-constant">RestClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>, <span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">method</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">@@headers</span>)
|
|
585
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">send</span>(<span class="ruby-identifier">request</span>)
|
|
586
|
+
<span class="ruby-keyword">end</span></pre>
|
|
587
|
+
</div><!-- user-source -->
|
|
588
|
+
|
|
589
|
+
</div>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
</div><!-- user-method -->
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
</section><!-- public-instance-method-details -->
|
|
598
|
+
|
|
599
|
+
</section><!-- 5Buntitled-5D -->
|
|
600
|
+
|
|
601
|
+
</div><!-- documentation -->
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<footer id="validator-badges">
|
|
605
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
606
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
607
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
608
|
+
</footer>
|
|
609
|
+
|