ropenstack 1.2.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. data/.gitignore +1 -0
  2. data/README.md +2 -1
  3. data/doc/Ropenstack.html +151 -0
  4. data/doc/Ropenstack/Cinder.html +197 -0
  5. data/doc/Ropenstack/Glance.html +292 -0
  6. data/doc/Ropenstack/Keystone.html +737 -0
  7. data/doc/Ropenstack/MalformedRequestError.html +142 -0
  8. data/doc/Ropenstack/NotFoundError.html +142 -0
  9. data/doc/Ropenstack/Nova.html +562 -0
  10. data/doc/Ropenstack/OpenstackService.html +199 -0
  11. data/doc/Ropenstack/Quantum.html +830 -0
  12. data/doc/Ropenstack/Rest.html +483 -0
  13. data/doc/Ropenstack/RopenstackError.html +143 -0
  14. data/doc/Ropenstack/TimeoutError.html +142 -0
  15. data/doc/Ropenstack/UnauthorisedError.html +142 -0
  16. data/doc/created.rid +10 -0
  17. data/doc/images/add.png +0 -0
  18. data/doc/images/brick.png +0 -0
  19. data/doc/images/brick_link.png +0 -0
  20. data/doc/images/bug.png +0 -0
  21. data/doc/images/bullet_black.png +0 -0
  22. data/doc/images/bullet_toggle_minus.png +0 -0
  23. data/doc/images/bullet_toggle_plus.png +0 -0
  24. data/doc/images/date.png +0 -0
  25. data/doc/images/delete.png +0 -0
  26. data/doc/images/find.png +0 -0
  27. data/doc/images/loadingAnimation.gif +0 -0
  28. data/doc/images/macFFBgHack.png +0 -0
  29. data/doc/images/package.png +0 -0
  30. data/doc/images/page_green.png +0 -0
  31. data/doc/images/page_white_text.png +0 -0
  32. data/doc/images/page_white_width.png +0 -0
  33. data/doc/images/plugin.png +0 -0
  34. data/doc/images/ruby.png +0 -0
  35. data/doc/images/tag_blue.png +0 -0
  36. data/doc/images/tag_green.png +0 -0
  37. data/doc/images/transparent.png +0 -0
  38. data/doc/images/wrench.png +0 -0
  39. data/doc/images/wrench_orange.png +0 -0
  40. data/doc/images/zoom.png +0 -0
  41. data/doc/index.html +93 -0
  42. data/doc/js/darkfish.js +153 -0
  43. data/doc/js/jquery.js +18 -0
  44. data/doc/js/navigation.js +142 -0
  45. data/doc/js/search.js +94 -0
  46. data/doc/js/search_index.js +1 -0
  47. data/doc/js/searcher.js +228 -0
  48. data/doc/rdoc.css +543 -0
  49. data/doc/table_of_contents.html +200 -0
  50. data/lib/ropenstack.rb +18 -0
  51. data/lib/ropenstack/blockStorage.rb +25 -0
  52. data/lib/ropenstack/blockStorage/v1.rb +67 -0
  53. data/lib/ropenstack/blockStorage/v2.rb +11 -0
  54. data/lib/ropenstack/common/error.rb +12 -0
  55. data/lib/ropenstack/common/openstackservice.rb +28 -0
  56. data/lib/ropenstack/common/rest.rb +138 -0
  57. data/lib/ropenstack/compute.rb +164 -0
  58. data/lib/ropenstack/compute/v2.rb +11 -0
  59. data/lib/ropenstack/compute/v2/extensions.rb +14 -0
  60. data/lib/ropenstack/compute/v2/extensions/admin.rb +0 -0
  61. data/lib/ropenstack/compute/v2/extensions/agents.rb +0 -0
  62. data/lib/ropenstack/compute/v2/extensions/aggregates.rb +0 -0
  63. data/lib/ropenstack/compute/v2/extensions/certificates.rb +0 -0
  64. data/lib/ropenstack/compute/v2/extensions/cloudpipe.rb +0 -0
  65. data/lib/ropenstack/compute/v2/extensions/console.rb +0 -0
  66. data/lib/ropenstack/compute/v2/extensions/coverage.rb +0 -0
  67. data/lib/ropenstack/compute/v2/extensions/defaultsecuritygroup.rb +0 -0
  68. data/lib/ropenstack/compute/v2/extensions/diagnostics.rb +0 -0
  69. data/lib/ropenstack/compute/v2/extensions/extraspecs.rb +0 -0
  70. data/lib/ropenstack/compute/v2/extensions/fixedips.rb +0 -0
  71. data/lib/ropenstack/compute/v2/extensions/flavors.rb +0 -0
  72. data/lib/ropenstack/compute/v2/extensions/hosts.rb +0 -0
  73. data/lib/ropenstack/compute/v2/extensions/hypervisors.rb +0 -0
  74. data/lib/ropenstack/compute/v2/extensions/images.rb +0 -0
  75. data/lib/ropenstack/compute/v2/extensions/instanceactions.rb +0 -0
  76. data/lib/ropenstack/compute/v2/extensions/interfaces.rb +0 -0
  77. data/lib/ropenstack/compute/v2/extensions/keypairs.rb +20 -0
  78. data/lib/ropenstack/compute/v2/extensions/limits.rb +0 -0
  79. data/lib/ropenstack/compute/v2/extensions/migrations.rb +0 -0
  80. data/lib/ropenstack/compute/v2/extensions/networks.rb +0 -0
  81. data/lib/ropenstack/compute/v2/extensions/quotasets.rb +0 -0
  82. data/lib/ropenstack/compute/v2/extensions/securitygroups.rb +40 -0
  83. data/lib/ropenstack/compute/v2/extensions/servergroups.rb +0 -0
  84. data/lib/ropenstack/compute/v2/extensions/serverpassword.rb +0 -0
  85. data/lib/ropenstack/compute/v2/extensions/services.rb +0 -0
  86. data/lib/ropenstack/compute/v2/extensions/shelvedservers.rb +0 -0
  87. data/lib/ropenstack/compute/v2/extensions/usage.rb +0 -0
  88. data/lib/ropenstack/compute/v2/extensions/virtualinterfaces.rb +0 -0
  89. data/lib/ropenstack/compute/v2/extensions/volumes.rb +20 -0
  90. data/lib/ropenstack/compute/v3.rb +5 -0
  91. data/lib/ropenstack/database.rb +24 -0
  92. data/lib/ropenstack/database/v1.rb +113 -0
  93. data/lib/ropenstack/identity.rb +28 -0
  94. data/lib/ropenstack/identity/v2.rb +178 -0
  95. data/lib/ropenstack/identity/v3.rb +13 -0
  96. data/lib/ropenstack/image.rb +25 -0
  97. data/lib/ropenstack/image/v1.rb +107 -0
  98. data/lib/ropenstack/image/v2.rb +134 -0
  99. data/lib/ropenstack/networking.rb +160 -0
  100. data/lib/ropenstack/networking/v2.rb +5 -0
  101. data/lib/ropenstack/networking/v2/extensions.rb +9 -0
  102. data/lib/ropenstack/networking/v2/extensions/l3.rb +111 -0
  103. data/lib/ropenstack/networking/v2/extensions/lbaas.rb +5 -0
  104. data/lib/ropenstack/networking/v2/extensions/metering.rb +5 -0
  105. data/lib/ropenstack/networking/v2/extensions/quotas.rb +5 -0
  106. data/lib/ropenstack/networking/v2/extensions/securitygroups.rb +5 -0
  107. data/lib/ropenstack/objectStorage.rb +60 -0
  108. data/lib/ropenstack/orchestration.rb +23 -0
  109. data/lib/ropenstack/orchestration/v1.rb +162 -0
  110. data/lib/ropenstack/telemetry.rb +23 -0
  111. data/lib/ropenstack/telemetry/v2.rb +68 -0
  112. data/ropenstack.gemspec +13 -0
  113. metadata +112 -1
@@ -0,0 +1,737 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Ropenstack::Keystone - 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/ropenstack/keystone.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">OpenstackService
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-new">::new</a>
74
+
75
+ <li><a href="#method-i-addEndpoint">#addEndpoint</a>
76
+
77
+ <li><a href="#method-i-addToServices">#addToServices</a>
78
+
79
+ <li><a href="#method-i-admin">#admin</a>
80
+
81
+ <li><a href="#method-i-authenticate">#authenticate</a>
82
+
83
+ <li><a href="#method-i-getEndpoints">#getEndpoints</a>
84
+
85
+ <li><a href="#method-i-getServices">#getServices</a>
86
+
87
+ <li><a href="#method-i-raw">#raw</a>
88
+
89
+ <li><a href="#method-i-scope_token">#scope_token</a>
90
+
91
+ <li><a href="#method-i-services">#services</a>
92
+
93
+ <li><a href="#method-i-tenant_id">#tenant_id</a>
94
+
95
+ <li><a href="#method-i-tenant_list">#tenant_list</a>
96
+
97
+ <li><a href="#method-i-tenant_name">#tenant_name</a>
98
+
99
+ <li><a href="#method-i-token">#token</a>
100
+
101
+ <li><a href="#method-i-token_metadata">#token_metadata</a>
102
+
103
+ <li><a href="#method-i-user">#user</a>
104
+
105
+ </ul>
106
+ </nav>
107
+
108
+ </div>
109
+
110
+ <div id="project-metadata">
111
+
112
+ <nav id="classindex-section" class="section project-section">
113
+ <h3 class="section-header">Class and Module Index</h3>
114
+
115
+ <ul class="link-list">
116
+
117
+ <li><a href="../Ropenstack.html">Ropenstack</a>
118
+
119
+ <li><a href="../Ropenstack/Cinder.html">Ropenstack::Cinder</a>
120
+
121
+ <li><a href="../Ropenstack/Glance.html">Ropenstack::Glance</a>
122
+
123
+ <li><a href="../Ropenstack/Keystone.html">Ropenstack::Keystone</a>
124
+
125
+ <li><a href="../Ropenstack/MalformedRequestError.html">Ropenstack::MalformedRequestError</a>
126
+
127
+ <li><a href="../Ropenstack/NotFoundError.html">Ropenstack::NotFoundError</a>
128
+
129
+ <li><a href="../Ropenstack/Nova.html">Ropenstack::Nova</a>
130
+
131
+ <li><a href="../Ropenstack/OpenstackService.html">Ropenstack::OpenstackService</a>
132
+
133
+ <li><a href="../Ropenstack/Quantum.html">Ropenstack::Quantum</a>
134
+
135
+ <li><a href="../Ropenstack/Rest.html">Ropenstack::Rest</a>
136
+
137
+ <li><a href="../Ropenstack/RopenstackError.html">Ropenstack::RopenstackError</a>
138
+
139
+ <li><a href="../Ropenstack/TimeoutError.html">Ropenstack::TimeoutError</a>
140
+
141
+ <li><a href="../Ropenstack/UnauthorisedError.html">Ropenstack::UnauthorisedError</a>
142
+
143
+ </ul>
144
+ </nav>
145
+
146
+ </div>
147
+ </nav>
148
+
149
+ <div id="documentation">
150
+ <h1 class="class">class Ropenstack::Keystone</h1>
151
+
152
+ <div id="description" class="description">
153
+ <ul><li>
154
+ <p>Name: <a href="Keystone.html">Keystone</a></p>
155
+ </li><li>
156
+ <p>Description: An implementation of the <a href="Keystone.html">Keystone</a>
157
+ API Client in Ruby</p>
158
+ </li><li>
159
+ <p>Author: Sam ‘Tehsmash’ Betts</p>
160
+ </li><li>
161
+ <p>Date: 01/15/2013</p>
162
+ </li></ul>
163
+
164
+ </div><!-- description -->
165
+
166
+
167
+
168
+
169
+ <section id="5Buntitled-5D" class="documentation-section">
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+ <!-- Methods -->
179
+
180
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
181
+ <h3 class="section-header">Public Class Methods</h3>
182
+
183
+
184
+ <div id="method-c-new" class="method-detail ">
185
+
186
+ <div class="method-heading">
187
+ <span class="method-name">new</span><span
188
+ class="method-args">(address, port, token = nil)</span>
189
+ <span class="method-click-advice">click to toggle source</span>
190
+ </div>
191
+
192
+
193
+ <div class="method-description">
194
+
195
+ <p>Overide of the initialize function to allow users to provide keystone
196
+ address and port outside of a URI which then gets passed on to the super
197
+ function. Handles taking a token differently so that it lines up with the
198
+ data format that keystone using. This is required for get_token() function.</p>
199
+
200
+
201
+
202
+ <div class="method-source-code" id="new-source">
203
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 18</span>
204
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">address</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">token</span> = <span class="ruby-keyword">nil</span>)
205
+ <span class="ruby-keyword">super</span>(<span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">&quot;http://&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">address</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;:&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;/v2.0&quot;</span>), <span class="ruby-identifier">token</span>)
206
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">token</span>.<span class="ruby-identifier">nil?</span>
207
+ <span class="ruby-ivar">@data</span> = { <span class="ruby-string">&quot;access&quot;</span> =<span class="ruby-operator">&gt;</span> { <span class="ruby-string">&quot;token&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-identifier">token</span> } } }
208
+ <span class="ruby-keyword">end</span>
209
+ <span class="ruby-keyword">end</span></pre>
210
+ </div><!-- new-source -->
211
+
212
+ </div>
213
+
214
+
215
+
216
+
217
+ </div><!-- new-method -->
218
+
219
+
220
+ </section><!-- public-class-method-details -->
221
+
222
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
223
+ <h3 class="section-header">Public Instance Methods</h3>
224
+
225
+
226
+ <div id="method-i-addEndpoint" class="method-detail ">
227
+
228
+ <div class="method-heading">
229
+ <span class="method-name">addEndpoint</span><span
230
+ class="method-args">(region, service_id, publicurl, adminurl, internalurl)</span>
231
+ <span class="method-click-advice">click to toggle source</span>
232
+ </div>
233
+
234
+
235
+ <div class="method-description">
236
+
237
+ <p>Add an endpoint list</p>
238
+
239
+
240
+
241
+ <div class="method-source-code" id="addEndpoint-source">
242
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 151</span>
243
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">addEndpoint</span>(<span class="ruby-identifier">region</span>, <span class="ruby-identifier">service_id</span>, <span class="ruby-identifier">publicurl</span>, <span class="ruby-identifier">adminurl</span>, <span class="ruby-identifier">internalurl</span>)
244
+ <span class="ruby-identifier">data</span> = {
245
+ <span class="ruby-string">'endpoint'</span> =<span class="ruby-operator">&gt;</span> {
246
+ <span class="ruby-string">'region'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">region</span>,
247
+ <span class="ruby-string">'service_id'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">service_id</span>,
248
+ <span class="ruby-string">'publicurl'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">publicurl</span>,
249
+ <span class="ruby-string">'adminurl'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">adminurl</span>,
250
+ <span class="ruby-string">'internalurl'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">internalurl</span>
251
+ }
252
+ }
253
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/endpoints&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-identifier">token</span>())
254
+ <span class="ruby-keyword">end</span></pre>
255
+ </div><!-- addEndpoint-source -->
256
+
257
+ </div>
258
+
259
+
260
+
261
+
262
+ </div><!-- addEndpoint-method -->
263
+
264
+
265
+ <div id="method-i-addToServices" class="method-detail ">
266
+
267
+ <div class="method-heading">
268
+ <span class="method-name">addToServices</span><span
269
+ class="method-args">(name, type, description)</span>
270
+ <span class="method-click-advice">click to toggle source</span>
271
+ </div>
272
+
273
+
274
+ <div class="method-description">
275
+
276
+ <p>Add a service to the keystone services directory</p>
277
+
278
+
279
+
280
+ <div class="method-source-code" id="addToServices-source">
281
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 130</span>
282
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">addToServices</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">description</span>)
283
+ <span class="ruby-identifier">data</span> = {
284
+ <span class="ruby-string">'OS-KSADM:service'</span> =<span class="ruby-operator">&gt;</span> {
285
+ <span class="ruby-string">'name'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>,
286
+ <span class="ruby-string">'type'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">type</span>,
287
+ <span class="ruby-string">'description'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">description</span>
288
+ }
289
+ }
290
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/OS-KSADM/services&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-identifier">token</span>())
291
+ <span class="ruby-keyword">end</span></pre>
292
+ </div><!-- addToServices-source -->
293
+
294
+ </div>
295
+
296
+
297
+
298
+
299
+ </div><!-- addToServices-method -->
300
+
301
+
302
+ <div id="method-i-admin" class="method-detail ">
303
+
304
+ <div class="method-heading">
305
+ <span class="method-name">admin</span><span
306
+ class="method-args">()</span>
307
+ <span class="method-click-advice">click to toggle source</span>
308
+ </div>
309
+
310
+
311
+ <div class="method-description">
312
+
313
+ <p>Returns true if a user is admin.</p>
314
+
315
+
316
+
317
+ <div class="method-source-code" id="admin-source">
318
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 94</span>
319
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">admin</span>()
320
+ <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;user&quot;</span>][<span class="ruby-string">&quot;roles&quot;</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">role</span><span class="ruby-operator">|</span>
321
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">role</span>[<span class="ruby-string">&quot;name&quot;</span>].<span class="ruby-identifier">eql?</span>(<span class="ruby-string">&quot;admin&quot;</span>)
322
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
323
+ <span class="ruby-keyword">end</span>
324
+ <span class="ruby-keyword">end</span>
325
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
326
+ <span class="ruby-keyword">end</span></pre>
327
+ </div><!-- admin-source -->
328
+
329
+ </div>
330
+
331
+
332
+
333
+
334
+ </div><!-- admin-method -->
335
+
336
+
337
+ <div id="method-i-authenticate" class="method-detail ">
338
+
339
+ <div class="method-heading">
340
+ <span class="method-name">authenticate</span><span
341
+ class="method-args">(username, password, token = nil, tenant = nil)</span>
342
+ <span class="method-click-advice">click to toggle source</span>
343
+ </div>
344
+
345
+
346
+ <div class="method-description">
347
+
348
+ <p>Authenticate via keystone, unless a token and tenant are defined then a
349
+ unscoped token is returned with all associated data and stored in the
350
+ @data variable. Does not return anything, but all data is accessible
351
+ through accessor methods.</p>
352
+
353
+
354
+
355
+ <div class="method-source-code" id="authenticate-source">
356
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 30</span>
357
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">authenticate</span>(<span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">token</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">tenant</span> = <span class="ruby-keyword">nil</span>)
358
+ <span class="ruby-identifier">data</span> = {
359
+ <span class="ruby-string">&quot;auth&quot;</span> =<span class="ruby-operator">&gt;</span> {
360
+ <span class="ruby-string">&quot;passwordCredentials&quot;</span> =<span class="ruby-operator">&gt;</span> {
361
+ <span class="ruby-string">&quot;username&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">username</span>,
362
+ <span class="ruby-string">&quot;password&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">password</span>
363
+ }
364
+ }
365
+ }
366
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tenant</span>.<span class="ruby-identifier">nil?</span>
367
+ <span class="ruby-identifier">data</span>[<span class="ruby-string">&quot;auth&quot;</span>][<span class="ruby-string">&quot;tenantName&quot;</span>] = <span class="ruby-identifier">tenant</span>
368
+ <span class="ruby-keyword">end</span>
369
+ <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/tokens&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-identifier">token</span>)
370
+ <span class="ruby-keyword">end</span></pre>
371
+ </div><!-- authenticate-source -->
372
+
373
+ </div>
374
+
375
+
376
+
377
+
378
+ </div><!-- authenticate-method -->
379
+
380
+
381
+ <div id="method-i-getEndpoints" class="method-detail ">
382
+
383
+ <div class="method-heading">
384
+ <span class="method-name">getEndpoints</span><span
385
+ class="method-args">()</span>
386
+ <span class="method-click-advice">click to toggle source</span>
387
+ </div>
388
+
389
+
390
+ <div class="method-description">
391
+
392
+ <p>Get the endpoint list</p>
393
+
394
+
395
+
396
+ <div class="method-source-code" id="getEndpoints-source">
397
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 167</span>
398
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">getEndpoints</span>()
399
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/endpoints&quot;</span>), <span class="ruby-identifier">token</span>())
400
+ <span class="ruby-keyword">end</span></pre>
401
+ </div><!-- getEndpoints-source -->
402
+
403
+ </div>
404
+
405
+
406
+
407
+
408
+ </div><!-- getEndpoints-method -->
409
+
410
+
411
+ <div id="method-i-getServices" class="method-detail ">
412
+
413
+ <div class="method-heading">
414
+ <span class="method-name">getServices</span><span
415
+ class="method-args">()</span>
416
+ <span class="method-click-advice">click to toggle source</span>
417
+ </div>
418
+
419
+
420
+ <div class="method-description">
421
+
422
+ <p>Get list of services</p>
423
+
424
+
425
+
426
+ <div class="method-source-code" id="getServices-source">
427
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 144</span>
428
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">getServices</span>()
429
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/OS-KSADM/services&quot;</span>), <span class="ruby-identifier">token</span>())
430
+ <span class="ruby-keyword">end</span></pre>
431
+ </div><!-- getServices-source -->
432
+
433
+ </div>
434
+
435
+
436
+
437
+
438
+ </div><!-- getServices-method -->
439
+
440
+
441
+ <div id="method-i-raw" class="method-detail ">
442
+
443
+ <div class="method-heading">
444
+ <span class="method-name">raw</span><span
445
+ class="method-args">()</span>
446
+ <span class="method-click-advice">click to toggle source</span>
447
+ </div>
448
+
449
+
450
+ <div class="method-description">
451
+
452
+ <p>Return the raw @data hash with all the data from authentication.</p>
453
+
454
+
455
+
456
+ <div class="method-source-code" id="raw-source">
457
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 65</span>
458
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">raw</span>()
459
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>
460
+ <span class="ruby-keyword">end</span></pre>
461
+ </div><!-- raw-source -->
462
+
463
+ </div>
464
+
465
+
466
+
467
+
468
+ </div><!-- raw-method -->
469
+
470
+
471
+ <div id="method-i-scope_token" class="method-detail ">
472
+
473
+ <div class="method-heading">
474
+ <span class="method-name">scope_token</span><span
475
+ class="method-args">(para1, para2 = nil, para3 = nil)</span>
476
+ <span class="method-click-advice">click to toggle source</span>
477
+ </div>
478
+
479
+
480
+ <div class="method-description">
481
+
482
+ <p>Scope token provides two ways to call it:</p>
483
+
484
+ <pre class="ruby"><span class="ruby-identifier">scope_token</span>(<span class="ruby-identifier">tenantName</span>) =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Just</span> <span class="ruby-identifier">using</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">current</span> <span class="ruby-identifier">token</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">a</span> <span class="ruby-identifier">tenantName</span> <span class="ruby-identifier">it</span>
485
+ <span class="ruby-identifier">scopes</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">token</span>. <span class="ruby-constant">Token</span> <span class="ruby-identifier">stays</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">same</span>.
486
+ <span class="ruby-identifier">scope_token</span>(<span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">tenantName</span>) =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">This</span> <span class="ruby-identifier">uses</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">username</span> <span class="ruby-keyword">and</span>
487
+ <span class="ruby-identifier">password</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">reauthenticate</span> <span class="ruby-identifier">with</span> <span class="ruby-identifier">a</span> <span class="ruby-identifier">tenant</span>. <span class="ruby-constant">The</span>
488
+ <span class="ruby-identifier">token</span> <span class="ruby-identifier">changes</span>.
489
+ </pre>
490
+
491
+
492
+
493
+ <div class="method-source-code" id="scope_token-source">
494
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 53</span>
495
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">scope_token</span>(<span class="ruby-identifier">para1</span>, <span class="ruby-identifier">para2</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">para3</span> = <span class="ruby-keyword">nil</span>)
496
+ <span class="ruby-keyword">if</span> ( <span class="ruby-identifier">para2</span>.<span class="ruby-identifier">nil?</span> )
497
+ <span class="ruby-identifier">data</span> = { <span class="ruby-string">&quot;auth&quot;</span> =<span class="ruby-operator">&gt;</span> { <span class="ruby-string">&quot;tenantName&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">para1</span>, <span class="ruby-string">&quot;token&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-identifier">token</span>() } } }
498
+ <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/tokens&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-identifier">token</span>())
499
+ <span class="ruby-keyword">else</span>
500
+ <span class="ruby-identifier">authenticate</span>(<span class="ruby-identifier">para1</span>, <span class="ruby-identifier">para2</span>, <span class="ruby-identifier">token</span>(), <span class="ruby-identifier">para3</span>)
501
+ <span class="ruby-keyword">end</span>
502
+ <span class="ruby-keyword">end</span></pre>
503
+ </div><!-- scope_token-source -->
504
+
505
+ </div>
506
+
507
+
508
+
509
+
510
+ </div><!-- scope_token-method -->
511
+
512
+
513
+ <div id="method-i-services" class="method-detail ">
514
+
515
+ <div class="method-heading">
516
+ <span class="method-name">services</span><span
517
+ class="method-args">()</span>
518
+ <span class="method-click-advice">click to toggle source</span>
519
+ </div>
520
+
521
+
522
+ <div class="method-description">
523
+
524
+ <p>Get the service catalog returned by <a href="Keystone.html">Keystone</a> on
525
+ authentication.</p>
526
+
527
+
528
+
529
+ <div class="method-source-code" id="services-source">
530
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 106</span>
531
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">services</span>()
532
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;serviceCatalog&quot;</span>]
533
+ <span class="ruby-keyword">end</span></pre>
534
+ </div><!-- services-source -->
535
+
536
+ </div>
537
+
538
+
539
+
540
+
541
+ </div><!-- services-method -->
542
+
543
+
544
+ <div id="method-i-tenant_id" class="method-detail ">
545
+
546
+ <div class="method-heading">
547
+ <span class="method-name">tenant_id</span><span
548
+ class="method-args">()</span>
549
+ <span class="method-click-advice">click to toggle source</span>
550
+ </div>
551
+
552
+
553
+ <div class="method-description">
554
+
555
+ <p>Get the tenant id from the @data</p>
556
+
557
+
558
+
559
+ <div class="method-source-code" id="tenant_id-source">
560
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 113</span>
561
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">tenant_id</span>()
562
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;token&quot;</span>][<span class="ruby-string">&quot;tenant&quot;</span>][<span class="ruby-string">&quot;id&quot;</span>]
563
+ <span class="ruby-keyword">end</span></pre>
564
+ </div><!-- tenant_id-source -->
565
+
566
+ </div>
567
+
568
+
569
+
570
+
571
+ </div><!-- tenant_id-method -->
572
+
573
+
574
+ <div id="method-i-tenant_list" class="method-detail ">
575
+
576
+ <div class="method-heading">
577
+ <span class="method-name">tenant_list</span><span
578
+ class="method-args">()</span>
579
+ <span class="method-click-advice">click to toggle source</span>
580
+ </div>
581
+
582
+
583
+ <div class="method-description">
584
+
585
+ <p>Separate <a href="Keystone.html">Keystone</a> Calls</p>
586
+
587
+
588
+
589
+ <div class="method-source-code" id="tenant_list-source">
590
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 123</span>
591
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">tenant_list</span>()
592
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">'/tenants'</span>), <span class="ruby-identifier">token</span>())
593
+ <span class="ruby-keyword">end</span></pre>
594
+ </div><!-- tenant_list-source -->
595
+
596
+ </div>
597
+
598
+
599
+
600
+
601
+ </div><!-- tenant_list-method -->
602
+
603
+
604
+ <div id="method-i-tenant_name" class="method-detail ">
605
+
606
+ <div class="method-heading">
607
+ <span class="method-name">tenant_name</span><span
608
+ class="method-args">()</span>
609
+ <span class="method-click-advice">click to toggle source</span>
610
+ </div>
611
+
612
+
613
+ <div class="method-description">
614
+
615
+
616
+
617
+
618
+
619
+ <div class="method-source-code" id="tenant_name-source">
620
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 117</span>
621
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">tenant_name</span>()
622
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;token&quot;</span>][<span class="ruby-string">&quot;tenant&quot;</span>][<span class="ruby-string">&quot;name&quot;</span>]
623
+ <span class="ruby-keyword">end</span></pre>
624
+ </div><!-- tenant_name-source -->
625
+
626
+ </div>
627
+
628
+
629
+
630
+
631
+ </div><!-- tenant_name-method -->
632
+
633
+
634
+ <div id="method-i-token" class="method-detail ">
635
+
636
+ <div class="method-heading">
637
+ <span class="method-name">token</span><span
638
+ class="method-args">()</span>
639
+ <span class="method-click-advice">click to toggle source</span>
640
+ </div>
641
+
642
+
643
+ <div class="method-description">
644
+
645
+ <p>Gets the authentication token from the hash and returns it as a string.</p>
646
+
647
+
648
+
649
+ <div class="method-source-code" id="token-source">
650
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 72</span>
651
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">token</span>()
652
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;token&quot;</span>][<span class="ruby-string">&quot;id&quot;</span>]
653
+ <span class="ruby-keyword">end</span></pre>
654
+ </div><!-- token-source -->
655
+
656
+ </div>
657
+
658
+
659
+
660
+
661
+ </div><!-- token-method -->
662
+
663
+
664
+ <div id="method-i-token_metadata" class="method-detail ">
665
+
666
+ <div class="method-heading">
667
+ <span class="method-name">token_metadata</span><span
668
+ class="method-args">()</span>
669
+ <span class="method-click-advice">click to toggle source</span>
670
+ </div>
671
+
672
+
673
+ <div class="method-description">
674
+
675
+ <p>This returns the token and all metadata associated with the token,
676
+ including the tenant information.</p>
677
+
678
+
679
+
680
+ <div class="method-source-code" id="token_metadata-source">
681
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 80</span>
682
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">token_metadata</span>()
683
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;token&quot;</span>]
684
+ <span class="ruby-keyword">end</span></pre>
685
+ </div><!-- token_metadata-source -->
686
+
687
+ </div>
688
+
689
+
690
+
691
+
692
+ </div><!-- token_metadata-method -->
693
+
694
+
695
+ <div id="method-i-user" class="method-detail ">
696
+
697
+ <div class="method-heading">
698
+ <span class="method-name">user</span><span
699
+ class="method-args">()</span>
700
+ <span class="method-click-advice">click to toggle source</span>
701
+ </div>
702
+
703
+
704
+ <div class="method-description">
705
+
706
+ <p>Return the user hash from the authentication data</p>
707
+
708
+
709
+
710
+ <div class="method-source-code" id="user-source">
711
+ <pre><span class="ruby-comment"># File lib/ropenstack/keystone.rb, line 87</span>
712
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">user</span>()
713
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-string">&quot;access&quot;</span>][<span class="ruby-string">&quot;user&quot;</span>]
714
+ <span class="ruby-keyword">end</span></pre>
715
+ </div><!-- user-source -->
716
+
717
+ </div>
718
+
719
+
720
+
721
+
722
+ </div><!-- user-method -->
723
+
724
+
725
+ </section><!-- public-instance-method-details -->
726
+
727
+ </section><!-- 5Buntitled-5D -->
728
+
729
+ </div><!-- documentation -->
730
+
731
+
732
+ <footer id="validator-badges">
733
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
734
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
735
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
736
+ </footer>
737
+