datacentred 0.1.1pre → 1.1.1
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.
- checksums.yaml +4 -4
- data/.codeclimate.yml +11 -0
- data/.coveralls.yml +1 -0
- data/.gitignore +9 -0
- data/.rubocop.yml +2 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +46 -0
- data/Gemfile.lock +39 -2
- data/LICENSE +21 -0
- data/README.md +160 -2
- data/circle.yml +0 -2
- data/datacentred.gemspec +17 -14
- data/docs/Datacentred.html +537 -0
- data/docs/Datacentred/Errors.html +260 -0
- data/docs/Datacentred/Errors/Error.html +139 -0
- data/docs/Datacentred/Errors/NotFound.html +145 -0
- data/docs/Datacentred/Errors/Unauthorized.html +149 -0
- data/docs/Datacentred/Errors/UnprocessableEntity.html +145 -0
- data/docs/Datacentred/Model.html +128 -0
- data/docs/Datacentred/Model/Base.html +255 -0
- data/docs/Datacentred/Model/Project.html +1729 -0
- data/docs/Datacentred/Model/Role.html +1830 -0
- data/docs/Datacentred/Model/Usage.html +510 -0
- data/docs/Datacentred/Model/User.html +832 -0
- data/docs/Datacentred/Model/Version.html +451 -0
- data/docs/Datacentred/Project.html +142 -0
- data/docs/Datacentred/Request.html +128 -0
- data/docs/Datacentred/Request/Base.html +675 -0
- data/docs/Datacentred/Request/Projects.html +1286 -0
- data/docs/Datacentred/Request/Roles.html +1286 -0
- data/docs/Datacentred/Request/Usage.html +315 -0
- data/docs/Datacentred/Request/Users.html +841 -0
- data/docs/Datacentred/Request/Versions.html +258 -0
- data/docs/Datacentred/Response.html +410 -0
- data/docs/Datacentred/Role.html +142 -0
- data/docs/Datacentred/Usage.html +142 -0
- data/docs/Datacentred/User.html +142 -0
- data/docs/Datacentred/Version.html +142 -0
- data/docs/_index.html +349 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +492 -0
- data/docs/file.README.html +231 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +231 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +643 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/datacentred.rb +65 -12
- data/lib/datacentred/error.rb +37 -15
- data/lib/datacentred/model/base.rb +21 -0
- data/lib/datacentred/model/project.rb +90 -31
- data/lib/datacentred/model/role.rb +89 -31
- data/lib/datacentred/model/usage.rb +16 -9
- data/lib/datacentred/model/user.rb +54 -22
- data/lib/datacentred/model/version.rb +17 -8
- data/lib/datacentred/request/base.rb +68 -31
- data/lib/datacentred/request/projects.rb +92 -24
- data/lib/datacentred/request/roles.rb +92 -24
- data/lib/datacentred/request/usage.rb +10 -1
- data/lib/datacentred/request/users.rb +58 -15
- data/lib/datacentred/request/versions.rb +13 -1
- data/lib/datacentred/response.rb +6 -2
- data/test/integration/authorization_test.rb +30 -0
- data/test/integration/projects_test.rb +11 -11
- data/test/integration/roles_test.rb +17 -17
- data/test/integration/usage_test.rb +8 -8
- data/test/integration/users_test.rb +23 -19
- data/test/integration/versions_test.rb +1 -2
- data/test/test_helper.rb +8 -5
- data/test/vcr_cassettes/not_authorized.yml +57 -0
- data/test/vcr_cassettes/unexpected_error.yml +56 -0
- metadata +115 -9
|
@@ -0,0 +1,832 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Datacentred::Model::User
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Datacentred::Model::User";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (U)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Datacentred.html" title="Datacentred (module)">Datacentred</a></span></span> » <span class='title'><span class='object_link'><a href="../Model.html" title="Datacentred::Model (module)">Model</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">User</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Datacentred::Model::User
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="Base.html" title="Datacentred::Model::Base (class)">Base</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">RecursiveOpenStruct</li>
|
|
78
|
+
|
|
79
|
+
<li class="next"><span class='object_link'><a href="Base.html" title="Datacentred::Model::Base (class)">Base</a></span></li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Datacentred::Model::User</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<dl>
|
|
100
|
+
<dt>Defined in:</dt>
|
|
101
|
+
<dd>lib/datacentred/model/user.rb</dd>
|
|
102
|
+
</dl>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
|
107
|
+
<div class="discussion">
|
|
108
|
+
|
|
109
|
+
<p>A user on your DataCentred account.</p>
|
|
110
|
+
|
|
111
|
+
<p>Users are team members with the ability to log into your DataCentred
|
|
112
|
+
account.</p>
|
|
113
|
+
|
|
114
|
+
<p>All users created in your DataCented account are backed by a corresponding
|
|
115
|
+
user in OpenStack's identity service (Keystone).</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
<div class="tags">
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2>
|
|
132
|
+
Class Method Summary
|
|
133
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
134
|
+
</h2>
|
|
135
|
+
|
|
136
|
+
<ul class="summary">
|
|
137
|
+
|
|
138
|
+
<li class="public ">
|
|
139
|
+
<span class="summary_signature">
|
|
140
|
+
|
|
141
|
+
<a href="#all-class_method" title="all (class method)">.<strong>all</strong> ⇒ [User] </a>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</span>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<span class="summary_desc"><div class='inline'>
|
|
156
|
+
<p>List all available users.</p>
|
|
157
|
+
</div></span>
|
|
158
|
+
|
|
159
|
+
</li>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<li class="public ">
|
|
163
|
+
<span class="summary_signature">
|
|
164
|
+
|
|
165
|
+
<a href="#create-class_method" title="create (class method)">.<strong>create</strong>(params) ⇒ Object </a>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</span>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<span class="summary_desc"><div class='inline'>
|
|
180
|
+
<p>Create a new user.</p>
|
|
181
|
+
</div></span>
|
|
182
|
+
|
|
183
|
+
</li>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<li class="public ">
|
|
187
|
+
<span class="summary_signature">
|
|
188
|
+
|
|
189
|
+
<a href="#destroy-class_method" title="destroy (class method)">.<strong>destroy</strong>(id) ⇒ Boolean </a>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
</span>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="summary_desc"><div class='inline'>
|
|
204
|
+
<p>Permanently remove the specified user.</p>
|
|
205
|
+
</div></span>
|
|
206
|
+
|
|
207
|
+
</li>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<li class="public ">
|
|
211
|
+
<span class="summary_signature">
|
|
212
|
+
|
|
213
|
+
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(id) ⇒ User </a>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
</span>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<span class="summary_desc"><div class='inline'>
|
|
228
|
+
<p>Find a user by unique ID.</p>
|
|
229
|
+
</div></span>
|
|
230
|
+
|
|
231
|
+
</li>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<li class="public ">
|
|
235
|
+
<span class="summary_signature">
|
|
236
|
+
|
|
237
|
+
<a href="#update-class_method" title="update (class method)">.<strong>update</strong>(id, params) ⇒ User </a>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
</span>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<span class="summary_desc"><div class='inline'>
|
|
252
|
+
<p>Update a user by unique ID.</p>
|
|
253
|
+
</div></span>
|
|
254
|
+
|
|
255
|
+
</li>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</ul>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Datacentred::Model::Base (class)">Base</a></span></h3>
|
|
271
|
+
<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="Datacentred::Model::Base#initialize (method)">#initialize</a></span></p>
|
|
272
|
+
|
|
273
|
+
<div id="constructor_details" class="method_details_list">
|
|
274
|
+
<h2>Constructor Details</h2>
|
|
275
|
+
|
|
276
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Datacentred::Model::Base#initialize (method)">Datacentred::Model::Base</a></span></p>
|
|
277
|
+
|
|
278
|
+
</div>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<div id="class_method_details" class="method_details_list">
|
|
282
|
+
<h2>Class Method Details</h2>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<div class="method_details first">
|
|
286
|
+
<h3 class="signature first" id="all-class_method">
|
|
287
|
+
|
|
288
|
+
.<strong>all</strong> ⇒ <tt>[<span class='object_link'><a href="" title="Datacentred::Model::User (class)">User</a></span>]</tt>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
</h3><div class="docstring">
|
|
295
|
+
<div class="discussion">
|
|
296
|
+
|
|
297
|
+
<p>List all available users.</p>
|
|
298
|
+
|
|
299
|
+
<p> @raise [Errors::Unauthorized] Raised if credentials aren't valid.</p>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
</div>
|
|
303
|
+
</div>
|
|
304
|
+
<div class="tags">
|
|
305
|
+
|
|
306
|
+
<p class="tag_title">Returns:</p>
|
|
307
|
+
<ul class="return">
|
|
308
|
+
|
|
309
|
+
<li>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span class='type'>(<tt>[<span class='object_link'><a href="" title="Datacentred::Model::User (class)">User</a></span>]</tt>)</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
—
|
|
317
|
+
<div class='inline'>
|
|
318
|
+
<p>A collection of all users on this account.</p>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</li>
|
|
322
|
+
|
|
323
|
+
</ul>
|
|
324
|
+
|
|
325
|
+
</div><table class="source_code">
|
|
326
|
+
<tr>
|
|
327
|
+
<td>
|
|
328
|
+
<pre class="lines">
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
24
|
|
332
|
+
25
|
|
333
|
+
26</pre>
|
|
334
|
+
</td>
|
|
335
|
+
<td>
|
|
336
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/user.rb', line 24</span>
|
|
337
|
+
|
|
338
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span>
|
|
339
|
+
<span class='const'><span class='object_link'><a href="../Request.html" title="Datacentred::Request (module)">Request</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Request/Users.html" title="Datacentred::Request::Users (class)">Users</a></span></span><span class='period'>.</span><span class='id identifier rubyid_list'><span class='object_link'><a href="../Request/Users.html#list-class_method" title="Datacentred::Request::Users.list (method)">list</a></span></span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_user'>user</span><span class='op'>|</span> <span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_user'>user</span> <span class='rbrace'>}</span>
|
|
340
|
+
<span class='kw'>end</span></pre>
|
|
341
|
+
</td>
|
|
342
|
+
</tr>
|
|
343
|
+
</table>
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
<div class="method_details ">
|
|
347
|
+
<h3 class="signature " id="create-class_method">
|
|
348
|
+
|
|
349
|
+
.<strong>create</strong>(params) ⇒ <tt>Object</tt>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</h3><div class="docstring">
|
|
356
|
+
<div class="discussion">
|
|
357
|
+
|
|
358
|
+
<p>Create a new user.</p>
|
|
359
|
+
|
|
360
|
+
<p> @return [User] New user.</p>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</div>
|
|
364
|
+
</div>
|
|
365
|
+
<div class="tags">
|
|
366
|
+
<p class="tag_title">Parameters:</p>
|
|
367
|
+
<ul class="param">
|
|
368
|
+
|
|
369
|
+
<li>
|
|
370
|
+
|
|
371
|
+
<span class='name'>params</span>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
—
|
|
379
|
+
<div class='inline'>
|
|
380
|
+
<p>User attributes.</p>
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
</li>
|
|
384
|
+
|
|
385
|
+
</ul>
|
|
386
|
+
|
|
387
|
+
<p class="tag_title">Raises:</p>
|
|
388
|
+
<ul class="raise">
|
|
389
|
+
|
|
390
|
+
<li>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/UnprocessableEntity.html" title="Datacentred::Errors::UnprocessableEntity (class)">Errors::UnprocessableEntity</a></span></tt>)</span>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
—
|
|
398
|
+
<div class='inline'>
|
|
399
|
+
<p>Raised if validations fail for the supplied attributes.</p>
|
|
400
|
+
</div>
|
|
401
|
+
|
|
402
|
+
</li>
|
|
403
|
+
|
|
404
|
+
<li>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
—
|
|
412
|
+
<div class='inline'>
|
|
413
|
+
<p>Raised if credentials aren't valid.</p>
|
|
414
|
+
</div>
|
|
415
|
+
|
|
416
|
+
</li>
|
|
417
|
+
|
|
418
|
+
</ul>
|
|
419
|
+
|
|
420
|
+
</div><table class="source_code">
|
|
421
|
+
<tr>
|
|
422
|
+
<td>
|
|
423
|
+
<pre class="lines">
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
16
|
|
427
|
+
17
|
|
428
|
+
18</pre>
|
|
429
|
+
</td>
|
|
430
|
+
<td>
|
|
431
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/user.rb', line 16</span>
|
|
432
|
+
|
|
433
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
434
|
+
<span class='id identifier rubyid_new'>new</span> <span class='const'><span class='object_link'><a href="../Request.html" title="Datacentred::Request (module)">Request</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Request/Users.html" title="Datacentred::Request::Users (class)">Users</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Request/Users.html#create-class_method" title="Datacentred::Request::Users.create (method)">create</a></span></span> <span class='id identifier rubyid_params'>params</span>
|
|
435
|
+
<span class='kw'>end</span></pre>
|
|
436
|
+
</td>
|
|
437
|
+
</tr>
|
|
438
|
+
</table>
|
|
439
|
+
</div>
|
|
440
|
+
|
|
441
|
+
<div class="method_details ">
|
|
442
|
+
<h3 class="signature " id="destroy-class_method">
|
|
443
|
+
|
|
444
|
+
.<strong>destroy</strong>(id) ⇒ <tt>Boolean</tt>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</h3><div class="docstring">
|
|
451
|
+
<div class="discussion">
|
|
452
|
+
|
|
453
|
+
<p>Permanently remove the specified user.</p>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</div>
|
|
457
|
+
</div>
|
|
458
|
+
<div class="tags">
|
|
459
|
+
<p class="tag_title">Parameters:</p>
|
|
460
|
+
<ul class="param">
|
|
461
|
+
|
|
462
|
+
<li>
|
|
463
|
+
|
|
464
|
+
<span class='name'>id</span>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
—
|
|
472
|
+
<div class='inline'>
|
|
473
|
+
<p>The unique identifier for this user.</p>
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
</li>
|
|
477
|
+
|
|
478
|
+
</ul>
|
|
479
|
+
|
|
480
|
+
<p class="tag_title">Returns:</p>
|
|
481
|
+
<ul class="return">
|
|
482
|
+
|
|
483
|
+
<li>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
—
|
|
491
|
+
<div class='inline'>
|
|
492
|
+
<p>Confirms the user was destroyed.</p>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
</li>
|
|
496
|
+
|
|
497
|
+
</ul>
|
|
498
|
+
<p class="tag_title">Raises:</p>
|
|
499
|
+
<ul class="raise">
|
|
500
|
+
|
|
501
|
+
<li>
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
—
|
|
509
|
+
<div class='inline'>
|
|
510
|
+
<p>Raised if the user couldn't be found.</p>
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
</li>
|
|
514
|
+
|
|
515
|
+
<li>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/UnprocessableEntity.html" title="Datacentred::Errors::UnprocessableEntity (class)">Errors::UnprocessableEntity</a></span></tt>)</span>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
—
|
|
523
|
+
<div class='inline'>
|
|
524
|
+
<p>Raised if validations fail for the specified user.</p>
|
|
525
|
+
</div>
|
|
526
|
+
|
|
527
|
+
</li>
|
|
528
|
+
|
|
529
|
+
<li>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
—
|
|
537
|
+
<div class='inline'>
|
|
538
|
+
<p>Raised if credentials aren't valid.</p>
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
</li>
|
|
542
|
+
|
|
543
|
+
</ul>
|
|
544
|
+
|
|
545
|
+
</div><table class="source_code">
|
|
546
|
+
<tr>
|
|
547
|
+
<td>
|
|
548
|
+
<pre class="lines">
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
57
|
|
552
|
+
58
|
|
553
|
+
59
|
|
554
|
+
60</pre>
|
|
555
|
+
</td>
|
|
556
|
+
<td>
|
|
557
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/user.rb', line 57</span>
|
|
558
|
+
|
|
559
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
560
|
+
<span class='const'><span class='object_link'><a href="../Request.html" title="Datacentred::Request (module)">Request</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Request/Users.html" title="Datacentred::Request::Users (class)">Users</a></span></span><span class='period'>.</span><span class='id identifier rubyid_destroy'><span class='object_link'><a href="../Request/Users.html#destroy-class_method" title="Datacentred::Request::Users.destroy (method)">destroy</a></span></span> <span class='id identifier rubyid_id'>id</span>
|
|
561
|
+
<span class='kw'>true</span>
|
|
562
|
+
<span class='kw'>end</span></pre>
|
|
563
|
+
</td>
|
|
564
|
+
</tr>
|
|
565
|
+
</table>
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
<div class="method_details ">
|
|
569
|
+
<h3 class="signature " id="find-class_method">
|
|
570
|
+
|
|
571
|
+
.<strong>find</strong>(id) ⇒ <tt><span class='object_link'><a href="" title="Datacentred::Model::User (class)">User</a></span></tt>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
</h3><div class="docstring">
|
|
578
|
+
<div class="discussion">
|
|
579
|
+
|
|
580
|
+
<p>Find a user by unique ID.</p>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</div>
|
|
584
|
+
</div>
|
|
585
|
+
<div class="tags">
|
|
586
|
+
<p class="tag_title">Parameters:</p>
|
|
587
|
+
<ul class="param">
|
|
588
|
+
|
|
589
|
+
<li>
|
|
590
|
+
|
|
591
|
+
<span class='name'>id</span>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
—
|
|
599
|
+
<div class='inline'>
|
|
600
|
+
<p>The unique identifier for this user.</p>
|
|
601
|
+
</div>
|
|
602
|
+
|
|
603
|
+
</li>
|
|
604
|
+
|
|
605
|
+
</ul>
|
|
606
|
+
|
|
607
|
+
<p class="tag_title">Returns:</p>
|
|
608
|
+
<ul class="return">
|
|
609
|
+
|
|
610
|
+
<li>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Datacentred::Model::User (class)">User</a></span></tt>)</span>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
—
|
|
618
|
+
<div class='inline'>
|
|
619
|
+
<p>The user, if it exists.</p>
|
|
620
|
+
</div>
|
|
621
|
+
|
|
622
|
+
</li>
|
|
623
|
+
|
|
624
|
+
</ul>
|
|
625
|
+
<p class="tag_title">Raises:</p>
|
|
626
|
+
<ul class="raise">
|
|
627
|
+
|
|
628
|
+
<li>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
—
|
|
636
|
+
<div class='inline'>
|
|
637
|
+
<p>Raised if the user couldn't be found.</p>
|
|
638
|
+
</div>
|
|
639
|
+
|
|
640
|
+
</li>
|
|
641
|
+
|
|
642
|
+
<li>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
—
|
|
650
|
+
<div class='inline'>
|
|
651
|
+
<p>Raised if credentials aren't valid.</p>
|
|
652
|
+
</div>
|
|
653
|
+
|
|
654
|
+
</li>
|
|
655
|
+
|
|
656
|
+
</ul>
|
|
657
|
+
|
|
658
|
+
</div><table class="source_code">
|
|
659
|
+
<tr>
|
|
660
|
+
<td>
|
|
661
|
+
<pre class="lines">
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
34
|
|
665
|
+
35
|
|
666
|
+
36</pre>
|
|
667
|
+
</td>
|
|
668
|
+
<td>
|
|
669
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/user.rb', line 34</span>
|
|
670
|
+
|
|
671
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
672
|
+
<span class='id identifier rubyid_new'>new</span> <span class='const'><span class='object_link'><a href="../Request.html" title="Datacentred::Request (module)">Request</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Request/Users.html" title="Datacentred::Request::Users (class)">Users</a></span></span><span class='period'>.</span><span class='id identifier rubyid_show'><span class='object_link'><a href="../Request/Users.html#show-class_method" title="Datacentred::Request::Users.show (method)">show</a></span></span> <span class='id identifier rubyid_id'>id</span>
|
|
673
|
+
<span class='kw'>end</span></pre>
|
|
674
|
+
</td>
|
|
675
|
+
</tr>
|
|
676
|
+
</table>
|
|
677
|
+
</div>
|
|
678
|
+
|
|
679
|
+
<div class="method_details ">
|
|
680
|
+
<h3 class="signature " id="update-class_method">
|
|
681
|
+
|
|
682
|
+
.<strong>update</strong>(id, params) ⇒ <tt><span class='object_link'><a href="" title="Datacentred::Model::User (class)">User</a></span></tt>
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
</h3><div class="docstring">
|
|
689
|
+
<div class="discussion">
|
|
690
|
+
|
|
691
|
+
<p>Update a user by unique ID.</p>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
</div>
|
|
695
|
+
</div>
|
|
696
|
+
<div class="tags">
|
|
697
|
+
<p class="tag_title">Parameters:</p>
|
|
698
|
+
<ul class="param">
|
|
699
|
+
|
|
700
|
+
<li>
|
|
701
|
+
|
|
702
|
+
<span class='name'>id</span>
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
—
|
|
710
|
+
<div class='inline'>
|
|
711
|
+
<p>The unique identifier for this user.</p>
|
|
712
|
+
</div>
|
|
713
|
+
|
|
714
|
+
</li>
|
|
715
|
+
|
|
716
|
+
<li>
|
|
717
|
+
|
|
718
|
+
<span class='name'>params</span>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
—
|
|
726
|
+
<div class='inline'>
|
|
727
|
+
<p>User attributes.</p>
|
|
728
|
+
</div>
|
|
729
|
+
|
|
730
|
+
</li>
|
|
731
|
+
|
|
732
|
+
</ul>
|
|
733
|
+
|
|
734
|
+
<p class="tag_title">Returns:</p>
|
|
735
|
+
<ul class="return">
|
|
736
|
+
|
|
737
|
+
<li>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Datacentred::Model::User (class)">User</a></span></tt>)</span>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
—
|
|
745
|
+
<div class='inline'>
|
|
746
|
+
<p>The updated user.</p>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</li>
|
|
750
|
+
|
|
751
|
+
</ul>
|
|
752
|
+
<p class="tag_title">Raises:</p>
|
|
753
|
+
<ul class="raise">
|
|
754
|
+
|
|
755
|
+
<li>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/UnprocessableEntity.html" title="Datacentred::Errors::UnprocessableEntity (class)">Errors::UnprocessableEntity</a></span></tt>)</span>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
—
|
|
763
|
+
<div class='inline'>
|
|
764
|
+
<p>Raised if validations fail for the supplied attributes.</p>
|
|
765
|
+
</div>
|
|
766
|
+
|
|
767
|
+
</li>
|
|
768
|
+
|
|
769
|
+
<li>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
—
|
|
777
|
+
<div class='inline'>
|
|
778
|
+
<p>Raised if the user couldn't be found.</p>
|
|
779
|
+
</div>
|
|
780
|
+
|
|
781
|
+
</li>
|
|
782
|
+
|
|
783
|
+
<li>
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
—
|
|
791
|
+
<div class='inline'>
|
|
792
|
+
<p>Raised if credentials aren't valid.</p>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
</li>
|
|
796
|
+
|
|
797
|
+
</ul>
|
|
798
|
+
|
|
799
|
+
</div><table class="source_code">
|
|
800
|
+
<tr>
|
|
801
|
+
<td>
|
|
802
|
+
<pre class="lines">
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
46
|
|
806
|
+
47
|
|
807
|
+
48</pre>
|
|
808
|
+
</td>
|
|
809
|
+
<td>
|
|
810
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/user.rb', line 46</span>
|
|
811
|
+
|
|
812
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
813
|
+
<span class='id identifier rubyid_new'>new</span> <span class='const'><span class='object_link'><a href="../Request.html" title="Datacentred::Request (module)">Request</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Request/Users.html" title="Datacentred::Request::Users (class)">Users</a></span></span><span class='period'>.</span><span class='id identifier rubyid_update'><span class='object_link'><a href="../Request/Users.html#update-class_method" title="Datacentred::Request::Users.update (method)">update</a></span></span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
|
|
814
|
+
<span class='kw'>end</span></pre>
|
|
815
|
+
</td>
|
|
816
|
+
</tr>
|
|
817
|
+
</table>
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
</div>
|
|
821
|
+
|
|
822
|
+
</div>
|
|
823
|
+
|
|
824
|
+
<div id="footer">
|
|
825
|
+
Generated on Fri Sep 15 16:27:42 2017 by
|
|
826
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
827
|
+
0.9.9 (ruby-2.3.1).
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
</div>
|
|
831
|
+
</body>
|
|
832
|
+
</html>
|