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,1830 @@
|
|
|
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::Role
|
|
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::Role";
|
|
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 (R)</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">Role</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::Role
|
|
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::Role</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/role.rb</dd>
|
|
102
|
+
</dl>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
|
107
|
+
<div class="discussion">
|
|
108
|
+
|
|
109
|
+
<p>A role on your DataCentred account.</p>
|
|
110
|
+
|
|
111
|
+
<p>Roles allow simple setup of user permissions via the creation of roles,
|
|
112
|
+
then assigning those roles to users.</p>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tags">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
125
|
+
<ul class="summary">
|
|
126
|
+
|
|
127
|
+
<li class="public ">
|
|
128
|
+
<span class="summary_signature">
|
|
129
|
+
|
|
130
|
+
<a href="#admin-instance_method" title="#admin (instance method)">#<strong>admin</strong> ⇒ Boolean </a>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</span>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'>
|
|
148
|
+
<p>The current value of admin.</p>
|
|
149
|
+
</div></span>
|
|
150
|
+
|
|
151
|
+
</li>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<li class="public ">
|
|
155
|
+
<span class="summary_signature">
|
|
156
|
+
|
|
157
|
+
<a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> ⇒ Time </a>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</span>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<span class="note title readonly">readonly</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="summary_desc"><div class='inline'>
|
|
177
|
+
<p>The current value of created_at.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ String </a>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="summary_desc"><div class='inline'>
|
|
204
|
+
<p>The current value of id.</p>
|
|
205
|
+
</div></span>
|
|
206
|
+
|
|
207
|
+
</li>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<li class="public ">
|
|
211
|
+
<span class="summary_signature">
|
|
212
|
+
|
|
213
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ String </a>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
</span>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="summary_desc"><div class='inline'>
|
|
231
|
+
<p>The current value of name.</p>
|
|
232
|
+
</div></span>
|
|
233
|
+
|
|
234
|
+
</li>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<li class="public ">
|
|
238
|
+
<span class="summary_signature">
|
|
239
|
+
|
|
240
|
+
<a href="#permissions-instance_method" title="#permissions (instance method)">#<strong>permissions</strong> ⇒ [String] </a>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</span>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class="summary_desc"><div class='inline'>
|
|
258
|
+
<p>The current value of permissions.</p>
|
|
259
|
+
</div></span>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<li class="public ">
|
|
265
|
+
<span class="summary_signature">
|
|
266
|
+
|
|
267
|
+
<a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> ⇒ Time </a>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</span>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<span class="note title readonly">readonly</span>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<span class="summary_desc"><div class='inline'>
|
|
287
|
+
<p>The current value of updated_at.</p>
|
|
288
|
+
</div></span>
|
|
289
|
+
|
|
290
|
+
</li>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
</ul>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<h2>
|
|
300
|
+
Class Method Summary
|
|
301
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
302
|
+
</h2>
|
|
303
|
+
|
|
304
|
+
<ul class="summary">
|
|
305
|
+
|
|
306
|
+
<li class="public ">
|
|
307
|
+
<span class="summary_signature">
|
|
308
|
+
|
|
309
|
+
<a href="#add_user-class_method" title="add_user (class method)">.<strong>add_user</strong>(role_id:, user_id:) ⇒ Boolean </a>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
</span>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<span class="summary_desc"><div class='inline'>
|
|
324
|
+
<p>Add new user to this role, giving them the associated permissions.</p>
|
|
325
|
+
</div></span>
|
|
326
|
+
|
|
327
|
+
</li>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<li class="public ">
|
|
331
|
+
<span class="summary_signature">
|
|
332
|
+
|
|
333
|
+
<a href="#all-class_method" title="all (class method)">.<strong>all</strong> ⇒ [Role] </a>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<span class="summary_desc"><div class='inline'>
|
|
348
|
+
<p>List all available roles.</p>
|
|
349
|
+
</div></span>
|
|
350
|
+
|
|
351
|
+
</li>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<li class="public ">
|
|
355
|
+
<span class="summary_signature">
|
|
356
|
+
|
|
357
|
+
<a href="#create-class_method" title="create (class method)">.<strong>create</strong>(params) ⇒ Role </a>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</span>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<span class="summary_desc"><div class='inline'>
|
|
372
|
+
<p>Create a new role.</p>
|
|
373
|
+
</div></span>
|
|
374
|
+
|
|
375
|
+
</li>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
<li class="public ">
|
|
379
|
+
<span class="summary_signature">
|
|
380
|
+
|
|
381
|
+
<a href="#destroy-class_method" title="destroy (class method)">.<strong>destroy</strong>(id) ⇒ Boolean </a>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</span>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
<span class="summary_desc"><div class='inline'>
|
|
396
|
+
<p>Permanently remove the specified role.</p>
|
|
397
|
+
</div></span>
|
|
398
|
+
|
|
399
|
+
</li>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<li class="public ">
|
|
403
|
+
<span class="summary_signature">
|
|
404
|
+
|
|
405
|
+
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(id) ⇒ Role </a>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
</span>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<span class="summary_desc"><div class='inline'>
|
|
420
|
+
<p>Find a role by unique ID.</p>
|
|
421
|
+
</div></span>
|
|
422
|
+
|
|
423
|
+
</li>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<li class="public ">
|
|
427
|
+
<span class="summary_signature">
|
|
428
|
+
|
|
429
|
+
<a href="#remove_user-class_method" title="remove_user (class method)">.<strong>remove_user</strong>(role_id:, user_id:) ⇒ Boolean </a>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
</span>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<span class="summary_desc"><div class='inline'>
|
|
444
|
+
<p>Remove user from this role, revoking the associated permissions.</p>
|
|
445
|
+
</div></span>
|
|
446
|
+
|
|
447
|
+
</li>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<li class="public ">
|
|
451
|
+
<span class="summary_signature">
|
|
452
|
+
|
|
453
|
+
<a href="#update-class_method" title="update (class method)">.<strong>update</strong>(id, params) ⇒ Role </a>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</span>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<span class="summary_desc"><div class='inline'>
|
|
468
|
+
<p>Update a role by unique ID.</p>
|
|
469
|
+
</div></span>
|
|
470
|
+
|
|
471
|
+
</li>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
<li class="public ">
|
|
475
|
+
<span class="summary_signature">
|
|
476
|
+
|
|
477
|
+
<a href="#users-class_method" title="users (class method)">.<strong>users</strong>(id) ⇒ [User] </a>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
</span>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<span class="summary_desc"><div class='inline'>
|
|
492
|
+
<p>List all users assigned to this role.</p>
|
|
493
|
+
</div></span>
|
|
494
|
+
|
|
495
|
+
</li>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
</ul>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Datacentred::Model::Base (class)">Base</a></span></h3>
|
|
511
|
+
<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="Datacentred::Model::Base#initialize (method)">#initialize</a></span></p>
|
|
512
|
+
|
|
513
|
+
<div id="constructor_details" class="method_details_list">
|
|
514
|
+
<h2>Constructor Details</h2>
|
|
515
|
+
|
|
516
|
+
<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>
|
|
517
|
+
|
|
518
|
+
</div>
|
|
519
|
+
|
|
520
|
+
<div id="instance_attr_details" class="attr_details">
|
|
521
|
+
<h2>Instance Attribute Details</h2>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<span id="admin=-instance_method"></span>
|
|
525
|
+
<div class="method_details first">
|
|
526
|
+
<h3 class="signature first" id="admin-instance_method">
|
|
527
|
+
|
|
528
|
+
#<strong>admin</strong> ⇒ <tt>Boolean</tt>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
</h3><div class="docstring">
|
|
535
|
+
<div class="discussion">
|
|
536
|
+
|
|
537
|
+
<p>Returns the current value of admin</p>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
</div>
|
|
541
|
+
</div>
|
|
542
|
+
<div class="tags">
|
|
543
|
+
|
|
544
|
+
<p class="tag_title">Returns:</p>
|
|
545
|
+
<ul class="return">
|
|
546
|
+
|
|
547
|
+
<li>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
—
|
|
555
|
+
<div class='inline'>
|
|
556
|
+
<p>the current value of admin</p>
|
|
557
|
+
</div>
|
|
558
|
+
|
|
559
|
+
</li>
|
|
560
|
+
|
|
561
|
+
</ul>
|
|
562
|
+
|
|
563
|
+
</div><table class="source_code">
|
|
564
|
+
<tr>
|
|
565
|
+
<td>
|
|
566
|
+
<pre class="lines">
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
13
|
|
570
|
+
14
|
|
571
|
+
15</pre>
|
|
572
|
+
</td>
|
|
573
|
+
<td>
|
|
574
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 13</span>
|
|
575
|
+
|
|
576
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_admin'>admin</span>
|
|
577
|
+
<span class='ivar'>@admin</span>
|
|
578
|
+
<span class='kw'>end</span></pre>
|
|
579
|
+
</td>
|
|
580
|
+
</tr>
|
|
581
|
+
</table>
|
|
582
|
+
</div>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<span id=""></span>
|
|
586
|
+
<div class="method_details ">
|
|
587
|
+
<h3 class="signature " id="created_at-instance_method">
|
|
588
|
+
|
|
589
|
+
#<strong>created_at</strong> ⇒ <tt>Time</tt> <span class="extras">(readonly)</span>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
</h3><div class="docstring">
|
|
596
|
+
<div class="discussion">
|
|
597
|
+
|
|
598
|
+
<p>Returns the current value of created_at</p>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
</div>
|
|
602
|
+
</div>
|
|
603
|
+
<div class="tags">
|
|
604
|
+
|
|
605
|
+
<p class="tag_title">Returns:</p>
|
|
606
|
+
<ul class="return">
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<span class='type'>(<tt>Time</tt>)</span>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
—
|
|
616
|
+
<div class='inline'>
|
|
617
|
+
<p>the current value of created_at</p>
|
|
618
|
+
</div>
|
|
619
|
+
|
|
620
|
+
</li>
|
|
621
|
+
|
|
622
|
+
</ul>
|
|
623
|
+
|
|
624
|
+
</div><table class="source_code">
|
|
625
|
+
<tr>
|
|
626
|
+
<td>
|
|
627
|
+
<pre class="lines">
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
13
|
|
631
|
+
14
|
|
632
|
+
15</pre>
|
|
633
|
+
</td>
|
|
634
|
+
<td>
|
|
635
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 13</span>
|
|
636
|
+
|
|
637
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
|
638
|
+
<span class='ivar'>@created_at</span>
|
|
639
|
+
<span class='kw'>end</span></pre>
|
|
640
|
+
</td>
|
|
641
|
+
</tr>
|
|
642
|
+
</table>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
<span id="id=-instance_method"></span>
|
|
647
|
+
<div class="method_details ">
|
|
648
|
+
<h3 class="signature " id="id-instance_method">
|
|
649
|
+
|
|
650
|
+
#<strong>id</strong> ⇒ <tt>String</tt>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</h3><div class="docstring">
|
|
657
|
+
<div class="discussion">
|
|
658
|
+
|
|
659
|
+
<p>Returns the current value of id</p>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
</div>
|
|
663
|
+
</div>
|
|
664
|
+
<div class="tags">
|
|
665
|
+
|
|
666
|
+
<p class="tag_title">Returns:</p>
|
|
667
|
+
<ul class="return">
|
|
668
|
+
|
|
669
|
+
<li>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
—
|
|
677
|
+
<div class='inline'>
|
|
678
|
+
<p>the current value of id</p>
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
</li>
|
|
682
|
+
|
|
683
|
+
</ul>
|
|
684
|
+
|
|
685
|
+
</div><table class="source_code">
|
|
686
|
+
<tr>
|
|
687
|
+
<td>
|
|
688
|
+
<pre class="lines">
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
13
|
|
692
|
+
14
|
|
693
|
+
15</pre>
|
|
694
|
+
</td>
|
|
695
|
+
<td>
|
|
696
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 13</span>
|
|
697
|
+
|
|
698
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
|
699
|
+
<span class='ivar'>@id</span>
|
|
700
|
+
<span class='kw'>end</span></pre>
|
|
701
|
+
</td>
|
|
702
|
+
</tr>
|
|
703
|
+
</table>
|
|
704
|
+
</div>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
<span id="name=-instance_method"></span>
|
|
708
|
+
<div class="method_details ">
|
|
709
|
+
<h3 class="signature " id="name-instance_method">
|
|
710
|
+
|
|
711
|
+
#<strong>name</strong> ⇒ <tt>String</tt>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
</h3><div class="docstring">
|
|
718
|
+
<div class="discussion">
|
|
719
|
+
|
|
720
|
+
<p>Returns the current value of name</p>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
</div>
|
|
724
|
+
</div>
|
|
725
|
+
<div class="tags">
|
|
726
|
+
|
|
727
|
+
<p class="tag_title">Returns:</p>
|
|
728
|
+
<ul class="return">
|
|
729
|
+
|
|
730
|
+
<li>
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
—
|
|
738
|
+
<div class='inline'>
|
|
739
|
+
<p>the current value of name</p>
|
|
740
|
+
</div>
|
|
741
|
+
|
|
742
|
+
</li>
|
|
743
|
+
|
|
744
|
+
</ul>
|
|
745
|
+
|
|
746
|
+
</div><table class="source_code">
|
|
747
|
+
<tr>
|
|
748
|
+
<td>
|
|
749
|
+
<pre class="lines">
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
13
|
|
753
|
+
14
|
|
754
|
+
15</pre>
|
|
755
|
+
</td>
|
|
756
|
+
<td>
|
|
757
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 13</span>
|
|
758
|
+
|
|
759
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
760
|
+
<span class='ivar'>@name</span>
|
|
761
|
+
<span class='kw'>end</span></pre>
|
|
762
|
+
</td>
|
|
763
|
+
</tr>
|
|
764
|
+
</table>
|
|
765
|
+
</div>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
<span id="permissions=-instance_method"></span>
|
|
769
|
+
<div class="method_details ">
|
|
770
|
+
<h3 class="signature " id="permissions-instance_method">
|
|
771
|
+
|
|
772
|
+
#<strong>permissions</strong> ⇒ <tt>[String]</tt>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</h3><div class="docstring">
|
|
779
|
+
<div class="discussion">
|
|
780
|
+
|
|
781
|
+
<p>Returns the current value of permissions</p>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
</div>
|
|
785
|
+
</div>
|
|
786
|
+
<div class="tags">
|
|
787
|
+
|
|
788
|
+
<p class="tag_title">Returns:</p>
|
|
789
|
+
<ul class="return">
|
|
790
|
+
|
|
791
|
+
<li>
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
<span class='type'>(<tt>[String]</tt>)</span>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
—
|
|
799
|
+
<div class='inline'>
|
|
800
|
+
<p>the current value of permissions</p>
|
|
801
|
+
</div>
|
|
802
|
+
|
|
803
|
+
</li>
|
|
804
|
+
|
|
805
|
+
</ul>
|
|
806
|
+
|
|
807
|
+
</div><table class="source_code">
|
|
808
|
+
<tr>
|
|
809
|
+
<td>
|
|
810
|
+
<pre class="lines">
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
13
|
|
814
|
+
14
|
|
815
|
+
15</pre>
|
|
816
|
+
</td>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 13</span>
|
|
819
|
+
|
|
820
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_permissions'>permissions</span>
|
|
821
|
+
<span class='ivar'>@permissions</span>
|
|
822
|
+
<span class='kw'>end</span></pre>
|
|
823
|
+
</td>
|
|
824
|
+
</tr>
|
|
825
|
+
</table>
|
|
826
|
+
</div>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
<span id=""></span>
|
|
830
|
+
<div class="method_details ">
|
|
831
|
+
<h3 class="signature " id="updated_at-instance_method">
|
|
832
|
+
|
|
833
|
+
#<strong>updated_at</strong> ⇒ <tt>Time</tt> <span class="extras">(readonly)</span>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
</h3><div class="docstring">
|
|
840
|
+
<div class="discussion">
|
|
841
|
+
|
|
842
|
+
<p>Returns the current value of updated_at</p>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
</div>
|
|
846
|
+
</div>
|
|
847
|
+
<div class="tags">
|
|
848
|
+
|
|
849
|
+
<p class="tag_title">Returns:</p>
|
|
850
|
+
<ul class="return">
|
|
851
|
+
|
|
852
|
+
<li>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
<span class='type'>(<tt>Time</tt>)</span>
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
—
|
|
860
|
+
<div class='inline'>
|
|
861
|
+
<p>the current value of updated_at</p>
|
|
862
|
+
</div>
|
|
863
|
+
|
|
864
|
+
</li>
|
|
865
|
+
|
|
866
|
+
</ul>
|
|
867
|
+
|
|
868
|
+
</div><table class="source_code">
|
|
869
|
+
<tr>
|
|
870
|
+
<td>
|
|
871
|
+
<pre class="lines">
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
13
|
|
875
|
+
14
|
|
876
|
+
15</pre>
|
|
877
|
+
</td>
|
|
878
|
+
<td>
|
|
879
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 13</span>
|
|
880
|
+
|
|
881
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
|
882
|
+
<span class='ivar'>@updated_at</span>
|
|
883
|
+
<span class='kw'>end</span></pre>
|
|
884
|
+
</td>
|
|
885
|
+
</tr>
|
|
886
|
+
</table>
|
|
887
|
+
</div>
|
|
888
|
+
|
|
889
|
+
</div>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
<div id="class_method_details" class="method_details_list">
|
|
893
|
+
<h2>Class Method Details</h2>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
<div class="method_details first">
|
|
897
|
+
<h3 class="signature first" id="add_user-class_method">
|
|
898
|
+
|
|
899
|
+
.<strong>add_user</strong>(role_id:, user_id:) ⇒ <tt>Boolean</tt>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
</h3><div class="docstring">
|
|
906
|
+
<div class="discussion">
|
|
907
|
+
|
|
908
|
+
<p>Add new user to this role, giving them the associated permissions.</p>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
</div>
|
|
912
|
+
</div>
|
|
913
|
+
<div class="tags">
|
|
914
|
+
<p class="tag_title">Parameters:</p>
|
|
915
|
+
<ul class="param">
|
|
916
|
+
|
|
917
|
+
<li>
|
|
918
|
+
|
|
919
|
+
<span class='name'>role_id</span>
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
—
|
|
927
|
+
<div class='inline'>
|
|
928
|
+
<p>The unique identifier for this role.</p>
|
|
929
|
+
</div>
|
|
930
|
+
|
|
931
|
+
</li>
|
|
932
|
+
|
|
933
|
+
<li>
|
|
934
|
+
|
|
935
|
+
<span class='name'>user_id</span>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
—
|
|
943
|
+
<div class='inline'>
|
|
944
|
+
<p>The unique identifier for this user.</p>
|
|
945
|
+
</div>
|
|
946
|
+
|
|
947
|
+
</li>
|
|
948
|
+
|
|
949
|
+
</ul>
|
|
950
|
+
|
|
951
|
+
<p class="tag_title">Returns:</p>
|
|
952
|
+
<ul class="return">
|
|
953
|
+
|
|
954
|
+
<li>
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
—
|
|
962
|
+
<div class='inline'>
|
|
963
|
+
<p>Confirms that user was added (or is already present).</p>
|
|
964
|
+
</div>
|
|
965
|
+
|
|
966
|
+
</li>
|
|
967
|
+
|
|
968
|
+
</ul>
|
|
969
|
+
<p class="tag_title">Raises:</p>
|
|
970
|
+
<ul class="raise">
|
|
971
|
+
|
|
972
|
+
<li>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
—
|
|
980
|
+
<div class='inline'>
|
|
981
|
+
<p>Raised if the role or user couldn't be found.</p>
|
|
982
|
+
</div>
|
|
983
|
+
|
|
984
|
+
</li>
|
|
985
|
+
|
|
986
|
+
<li>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
—
|
|
994
|
+
<div class='inline'>
|
|
995
|
+
<p>Raised if credentials aren't valid.</p>
|
|
996
|
+
</div>
|
|
997
|
+
|
|
998
|
+
</li>
|
|
999
|
+
|
|
1000
|
+
</ul>
|
|
1001
|
+
|
|
1002
|
+
</div><table class="source_code">
|
|
1003
|
+
<tr>
|
|
1004
|
+
<td>
|
|
1005
|
+
<pre class="lines">
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
83
|
|
1009
|
+
84
|
|
1010
|
+
85
|
|
1011
|
+
86</pre>
|
|
1012
|
+
</td>
|
|
1013
|
+
<td>
|
|
1014
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 83</span>
|
|
1015
|
+
|
|
1016
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_user'>add_user</span><span class='lparen'>(</span><span class='label'>role_id:</span><span class='comma'>,</span> <span class='label'>user_id:</span><span class='rparen'>)</span>
|
|
1017
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_add_user'><span class='object_link'><a href="../Request/Roles.html#add_user-class_method" title="Datacentred::Request::Roles.add_user (method)">add_user</a></span></span> <span class='id identifier rubyid_role_id'>role_id</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span>
|
|
1018
|
+
<span class='kw'>true</span>
|
|
1019
|
+
<span class='kw'>end</span></pre>
|
|
1020
|
+
</td>
|
|
1021
|
+
</tr>
|
|
1022
|
+
</table>
|
|
1023
|
+
</div>
|
|
1024
|
+
|
|
1025
|
+
<div class="method_details ">
|
|
1026
|
+
<h3 class="signature " id="all-class_method">
|
|
1027
|
+
|
|
1028
|
+
.<strong>all</strong> ⇒ <tt>[<span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span>]</tt>
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
</h3><div class="docstring">
|
|
1035
|
+
<div class="discussion">
|
|
1036
|
+
|
|
1037
|
+
<p>List all available roles.</p>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
</div>
|
|
1041
|
+
</div>
|
|
1042
|
+
<div class="tags">
|
|
1043
|
+
|
|
1044
|
+
<p class="tag_title">Returns:</p>
|
|
1045
|
+
<ul class="return">
|
|
1046
|
+
|
|
1047
|
+
<li>
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
<span class='type'>(<tt>[<span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span>]</tt>)</span>
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
—
|
|
1055
|
+
<div class='inline'>
|
|
1056
|
+
<p>A collection of all roles on this account.</p>
|
|
1057
|
+
</div>
|
|
1058
|
+
|
|
1059
|
+
</li>
|
|
1060
|
+
|
|
1061
|
+
</ul>
|
|
1062
|
+
<p class="tag_title">Raises:</p>
|
|
1063
|
+
<ul class="raise">
|
|
1064
|
+
|
|
1065
|
+
<li>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
—
|
|
1073
|
+
<div class='inline'>
|
|
1074
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1075
|
+
</div>
|
|
1076
|
+
|
|
1077
|
+
</li>
|
|
1078
|
+
|
|
1079
|
+
</ul>
|
|
1080
|
+
|
|
1081
|
+
</div><table class="source_code">
|
|
1082
|
+
<tr>
|
|
1083
|
+
<td>
|
|
1084
|
+
<pre class="lines">
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
29
|
|
1088
|
+
30
|
|
1089
|
+
31</pre>
|
|
1090
|
+
</td>
|
|
1091
|
+
<td>
|
|
1092
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 29</span>
|
|
1093
|
+
|
|
1094
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span>
|
|
1095
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_list'><span class='object_link'><a href="../Request/Roles.html#list-class_method" title="Datacentred::Request::Roles.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_role'>role</span><span class='op'>|</span> <span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_role'>role</span> <span class='rbrace'>}</span>
|
|
1096
|
+
<span class='kw'>end</span></pre>
|
|
1097
|
+
</td>
|
|
1098
|
+
</tr>
|
|
1099
|
+
</table>
|
|
1100
|
+
</div>
|
|
1101
|
+
|
|
1102
|
+
<div class="method_details ">
|
|
1103
|
+
<h3 class="signature " id="create-class_method">
|
|
1104
|
+
|
|
1105
|
+
.<strong>create</strong>(params) ⇒ <tt><span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span></tt>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
</h3><div class="docstring">
|
|
1112
|
+
<div class="discussion">
|
|
1113
|
+
|
|
1114
|
+
<p>Create a new role.</p>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
</div>
|
|
1118
|
+
</div>
|
|
1119
|
+
<div class="tags">
|
|
1120
|
+
<p class="tag_title">Parameters:</p>
|
|
1121
|
+
<ul class="param">
|
|
1122
|
+
|
|
1123
|
+
<li>
|
|
1124
|
+
|
|
1125
|
+
<span class='name'>params</span>
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
—
|
|
1133
|
+
<div class='inline'>
|
|
1134
|
+
<p>Role attributes.</p>
|
|
1135
|
+
</div>
|
|
1136
|
+
|
|
1137
|
+
</li>
|
|
1138
|
+
|
|
1139
|
+
</ul>
|
|
1140
|
+
|
|
1141
|
+
<p class="tag_title">Returns:</p>
|
|
1142
|
+
<ul class="return">
|
|
1143
|
+
|
|
1144
|
+
<li>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span></tt>)</span>
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
—
|
|
1152
|
+
<div class='inline'>
|
|
1153
|
+
<p>New role.</p>
|
|
1154
|
+
</div>
|
|
1155
|
+
|
|
1156
|
+
</li>
|
|
1157
|
+
|
|
1158
|
+
</ul>
|
|
1159
|
+
<p class="tag_title">Raises:</p>
|
|
1160
|
+
<ul class="raise">
|
|
1161
|
+
|
|
1162
|
+
<li>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/UnprocessableEntity.html" title="Datacentred::Errors::UnprocessableEntity (class)">Errors::UnprocessableEntity</a></span></tt>)</span>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
—
|
|
1170
|
+
<div class='inline'>
|
|
1171
|
+
<p>Raised if validations fail for the supplied attributes.</p>
|
|
1172
|
+
</div>
|
|
1173
|
+
|
|
1174
|
+
</li>
|
|
1175
|
+
|
|
1176
|
+
<li>
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
—
|
|
1184
|
+
<div class='inline'>
|
|
1185
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1186
|
+
</div>
|
|
1187
|
+
|
|
1188
|
+
</li>
|
|
1189
|
+
|
|
1190
|
+
</ul>
|
|
1191
|
+
|
|
1192
|
+
</div><table class="source_code">
|
|
1193
|
+
<tr>
|
|
1194
|
+
<td>
|
|
1195
|
+
<pre class="lines">
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
21
|
|
1199
|
+
22
|
|
1200
|
+
23</pre>
|
|
1201
|
+
</td>
|
|
1202
|
+
<td>
|
|
1203
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 21</span>
|
|
1204
|
+
|
|
1205
|
+
<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>
|
|
1206
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Request/Roles.html#create-class_method" title="Datacentred::Request::Roles.create (method)">create</a></span></span> <span class='id identifier rubyid_params'>params</span>
|
|
1207
|
+
<span class='kw'>end</span></pre>
|
|
1208
|
+
</td>
|
|
1209
|
+
</tr>
|
|
1210
|
+
</table>
|
|
1211
|
+
</div>
|
|
1212
|
+
|
|
1213
|
+
<div class="method_details ">
|
|
1214
|
+
<h3 class="signature " id="destroy-class_method">
|
|
1215
|
+
|
|
1216
|
+
.<strong>destroy</strong>(id) ⇒ <tt>Boolean</tt>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
</h3><div class="docstring">
|
|
1223
|
+
<div class="discussion">
|
|
1224
|
+
|
|
1225
|
+
<p>Permanently remove the specified role.</p>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
</div>
|
|
1229
|
+
</div>
|
|
1230
|
+
<div class="tags">
|
|
1231
|
+
<p class="tag_title">Parameters:</p>
|
|
1232
|
+
<ul class="param">
|
|
1233
|
+
|
|
1234
|
+
<li>
|
|
1235
|
+
|
|
1236
|
+
<span class='name'>id</span>
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
—
|
|
1244
|
+
<div class='inline'>
|
|
1245
|
+
<p>The unique identifier for this role.</p>
|
|
1246
|
+
</div>
|
|
1247
|
+
|
|
1248
|
+
</li>
|
|
1249
|
+
|
|
1250
|
+
</ul>
|
|
1251
|
+
|
|
1252
|
+
<p class="tag_title">Returns:</p>
|
|
1253
|
+
<ul class="return">
|
|
1254
|
+
|
|
1255
|
+
<li>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
—
|
|
1263
|
+
<div class='inline'>
|
|
1264
|
+
<p>Confirms the role was destroyed.</p>
|
|
1265
|
+
</div>
|
|
1266
|
+
|
|
1267
|
+
</li>
|
|
1268
|
+
|
|
1269
|
+
</ul>
|
|
1270
|
+
<p class="tag_title">Raises:</p>
|
|
1271
|
+
<ul class="raise">
|
|
1272
|
+
|
|
1273
|
+
<li>
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
—
|
|
1281
|
+
<div class='inline'>
|
|
1282
|
+
<p>Raised if the role couldn't be found.</p>
|
|
1283
|
+
</div>
|
|
1284
|
+
|
|
1285
|
+
</li>
|
|
1286
|
+
|
|
1287
|
+
<li>
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/UnprocessableEntity.html" title="Datacentred::Errors::UnprocessableEntity (class)">Errors::UnprocessableEntity</a></span></tt>)</span>
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
—
|
|
1295
|
+
<div class='inline'>
|
|
1296
|
+
<p>Raised if validations fail for the specifed role.</p>
|
|
1297
|
+
</div>
|
|
1298
|
+
|
|
1299
|
+
</li>
|
|
1300
|
+
|
|
1301
|
+
<li>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
—
|
|
1309
|
+
<div class='inline'>
|
|
1310
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1311
|
+
</div>
|
|
1312
|
+
|
|
1313
|
+
</li>
|
|
1314
|
+
|
|
1315
|
+
</ul>
|
|
1316
|
+
|
|
1317
|
+
</div><table class="source_code">
|
|
1318
|
+
<tr>
|
|
1319
|
+
<td>
|
|
1320
|
+
<pre class="lines">
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
62
|
|
1324
|
+
63
|
|
1325
|
+
64
|
|
1326
|
+
65</pre>
|
|
1327
|
+
</td>
|
|
1328
|
+
<td>
|
|
1329
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 62</span>
|
|
1330
|
+
|
|
1331
|
+
<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>
|
|
1332
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_destroy'><span class='object_link'><a href="../Request/Roles.html#destroy-class_method" title="Datacentred::Request::Roles.destroy (method)">destroy</a></span></span> <span class='id identifier rubyid_id'>id</span>
|
|
1333
|
+
<span class='kw'>true</span>
|
|
1334
|
+
<span class='kw'>end</span></pre>
|
|
1335
|
+
</td>
|
|
1336
|
+
</tr>
|
|
1337
|
+
</table>
|
|
1338
|
+
</div>
|
|
1339
|
+
|
|
1340
|
+
<div class="method_details ">
|
|
1341
|
+
<h3 class="signature " id="find-class_method">
|
|
1342
|
+
|
|
1343
|
+
.<strong>find</strong>(id) ⇒ <tt><span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span></tt>
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
</h3><div class="docstring">
|
|
1350
|
+
<div class="discussion">
|
|
1351
|
+
|
|
1352
|
+
<p>Find a role by unique ID.</p>
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
</div>
|
|
1356
|
+
</div>
|
|
1357
|
+
<div class="tags">
|
|
1358
|
+
<p class="tag_title">Parameters:</p>
|
|
1359
|
+
<ul class="param">
|
|
1360
|
+
|
|
1361
|
+
<li>
|
|
1362
|
+
|
|
1363
|
+
<span class='name'>id</span>
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
—
|
|
1371
|
+
<div class='inline'>
|
|
1372
|
+
<p>The unique identifier for this role.</p>
|
|
1373
|
+
</div>
|
|
1374
|
+
|
|
1375
|
+
</li>
|
|
1376
|
+
|
|
1377
|
+
</ul>
|
|
1378
|
+
|
|
1379
|
+
<p class="tag_title">Returns:</p>
|
|
1380
|
+
<ul class="return">
|
|
1381
|
+
|
|
1382
|
+
<li>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span></tt>)</span>
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
—
|
|
1390
|
+
<div class='inline'>
|
|
1391
|
+
<p>The role, if it exists.</p>
|
|
1392
|
+
</div>
|
|
1393
|
+
|
|
1394
|
+
</li>
|
|
1395
|
+
|
|
1396
|
+
</ul>
|
|
1397
|
+
<p class="tag_title">Raises:</p>
|
|
1398
|
+
<ul class="raise">
|
|
1399
|
+
|
|
1400
|
+
<li>
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
—
|
|
1408
|
+
<div class='inline'>
|
|
1409
|
+
<p>Raised if the role couldn't be found.</p>
|
|
1410
|
+
</div>
|
|
1411
|
+
|
|
1412
|
+
</li>
|
|
1413
|
+
|
|
1414
|
+
<li>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
—
|
|
1422
|
+
<div class='inline'>
|
|
1423
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1424
|
+
</div>
|
|
1425
|
+
|
|
1426
|
+
</li>
|
|
1427
|
+
|
|
1428
|
+
</ul>
|
|
1429
|
+
|
|
1430
|
+
</div><table class="source_code">
|
|
1431
|
+
<tr>
|
|
1432
|
+
<td>
|
|
1433
|
+
<pre class="lines">
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
39
|
|
1437
|
+
40
|
|
1438
|
+
41</pre>
|
|
1439
|
+
</td>
|
|
1440
|
+
<td>
|
|
1441
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 39</span>
|
|
1442
|
+
|
|
1443
|
+
<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>
|
|
1444
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_show'><span class='object_link'><a href="../Request/Roles.html#show-class_method" title="Datacentred::Request::Roles.show (method)">show</a></span></span> <span class='id identifier rubyid_id'>id</span>
|
|
1445
|
+
<span class='kw'>end</span></pre>
|
|
1446
|
+
</td>
|
|
1447
|
+
</tr>
|
|
1448
|
+
</table>
|
|
1449
|
+
</div>
|
|
1450
|
+
|
|
1451
|
+
<div class="method_details ">
|
|
1452
|
+
<h3 class="signature " id="remove_user-class_method">
|
|
1453
|
+
|
|
1454
|
+
.<strong>remove_user</strong>(role_id:, user_id:) ⇒ <tt>Boolean</tt>
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
</h3><div class="docstring">
|
|
1461
|
+
<div class="discussion">
|
|
1462
|
+
|
|
1463
|
+
<p>Remove user from this role, revoking the associated permissions.</p>
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
</div>
|
|
1467
|
+
</div>
|
|
1468
|
+
<div class="tags">
|
|
1469
|
+
<p class="tag_title">Parameters:</p>
|
|
1470
|
+
<ul class="param">
|
|
1471
|
+
|
|
1472
|
+
<li>
|
|
1473
|
+
|
|
1474
|
+
<span class='name'>role_id</span>
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
—
|
|
1482
|
+
<div class='inline'>
|
|
1483
|
+
<p>The unique identifier for this role.</p>
|
|
1484
|
+
</div>
|
|
1485
|
+
|
|
1486
|
+
</li>
|
|
1487
|
+
|
|
1488
|
+
<li>
|
|
1489
|
+
|
|
1490
|
+
<span class='name'>user_id</span>
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
—
|
|
1498
|
+
<div class='inline'>
|
|
1499
|
+
<p>The unique identifier for this user.</p>
|
|
1500
|
+
</div>
|
|
1501
|
+
|
|
1502
|
+
</li>
|
|
1503
|
+
|
|
1504
|
+
</ul>
|
|
1505
|
+
|
|
1506
|
+
<p class="tag_title">Returns:</p>
|
|
1507
|
+
<ul class="return">
|
|
1508
|
+
|
|
1509
|
+
<li>
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
—
|
|
1517
|
+
<div class='inline'>
|
|
1518
|
+
<p>Confirms that user was removed (or is already absent).</p>
|
|
1519
|
+
</div>
|
|
1520
|
+
|
|
1521
|
+
</li>
|
|
1522
|
+
|
|
1523
|
+
</ul>
|
|
1524
|
+
<p class="tag_title">Raises:</p>
|
|
1525
|
+
<ul class="raise">
|
|
1526
|
+
|
|
1527
|
+
<li>
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
—
|
|
1535
|
+
<div class='inline'>
|
|
1536
|
+
<p>Raised if the role or user coundn't be found.</p>
|
|
1537
|
+
</div>
|
|
1538
|
+
|
|
1539
|
+
</li>
|
|
1540
|
+
|
|
1541
|
+
<li>
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
—
|
|
1549
|
+
<div class='inline'>
|
|
1550
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1551
|
+
</div>
|
|
1552
|
+
|
|
1553
|
+
</li>
|
|
1554
|
+
|
|
1555
|
+
</ul>
|
|
1556
|
+
|
|
1557
|
+
</div><table class="source_code">
|
|
1558
|
+
<tr>
|
|
1559
|
+
<td>
|
|
1560
|
+
<pre class="lines">
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
95
|
|
1564
|
+
96
|
|
1565
|
+
97
|
|
1566
|
+
98</pre>
|
|
1567
|
+
</td>
|
|
1568
|
+
<td>
|
|
1569
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 95</span>
|
|
1570
|
+
|
|
1571
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_user'>remove_user</span><span class='lparen'>(</span><span class='label'>role_id:</span><span class='comma'>,</span> <span class='label'>user_id:</span><span class='rparen'>)</span>
|
|
1572
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_remove_user'><span class='object_link'><a href="../Request/Roles.html#remove_user-class_method" title="Datacentred::Request::Roles.remove_user (method)">remove_user</a></span></span> <span class='id identifier rubyid_role_id'>role_id</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span>
|
|
1573
|
+
<span class='kw'>true</span>
|
|
1574
|
+
<span class='kw'>end</span></pre>
|
|
1575
|
+
</td>
|
|
1576
|
+
</tr>
|
|
1577
|
+
</table>
|
|
1578
|
+
</div>
|
|
1579
|
+
|
|
1580
|
+
<div class="method_details ">
|
|
1581
|
+
<h3 class="signature " id="update-class_method">
|
|
1582
|
+
|
|
1583
|
+
.<strong>update</strong>(id, params) ⇒ <tt><span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span></tt>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
</h3><div class="docstring">
|
|
1590
|
+
<div class="discussion">
|
|
1591
|
+
|
|
1592
|
+
<p>Update a role by unique ID.</p>
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
</div>
|
|
1596
|
+
</div>
|
|
1597
|
+
<div class="tags">
|
|
1598
|
+
<p class="tag_title">Parameters:</p>
|
|
1599
|
+
<ul class="param">
|
|
1600
|
+
|
|
1601
|
+
<li>
|
|
1602
|
+
|
|
1603
|
+
<span class='name'>id</span>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
—
|
|
1611
|
+
<div class='inline'>
|
|
1612
|
+
<p>The unique identifier for this role.</p>
|
|
1613
|
+
</div>
|
|
1614
|
+
|
|
1615
|
+
</li>
|
|
1616
|
+
|
|
1617
|
+
<li>
|
|
1618
|
+
|
|
1619
|
+
<span class='name'>params</span>
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
—
|
|
1627
|
+
<div class='inline'>
|
|
1628
|
+
<p>Role attributes.</p>
|
|
1629
|
+
</div>
|
|
1630
|
+
|
|
1631
|
+
</li>
|
|
1632
|
+
|
|
1633
|
+
</ul>
|
|
1634
|
+
|
|
1635
|
+
<p class="tag_title">Returns:</p>
|
|
1636
|
+
<ul class="return">
|
|
1637
|
+
|
|
1638
|
+
<li>
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Datacentred::Model::Role (class)">Role</a></span></tt>)</span>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
—
|
|
1646
|
+
<div class='inline'>
|
|
1647
|
+
<p>The updated role.</p>
|
|
1648
|
+
</div>
|
|
1649
|
+
|
|
1650
|
+
</li>
|
|
1651
|
+
|
|
1652
|
+
</ul>
|
|
1653
|
+
<p class="tag_title">Raises:</p>
|
|
1654
|
+
<ul class="raise">
|
|
1655
|
+
|
|
1656
|
+
<li>
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/UnprocessableEntity.html" title="Datacentred::Errors::UnprocessableEntity (class)">Errors::UnprocessableEntity</a></span></tt>)</span>
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
—
|
|
1664
|
+
<div class='inline'>
|
|
1665
|
+
<p>Raised if validations fail for the supplied attributes.</p>
|
|
1666
|
+
</div>
|
|
1667
|
+
|
|
1668
|
+
</li>
|
|
1669
|
+
|
|
1670
|
+
<li>
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/NotFound.html" title="Datacentred::Errors::NotFound (class)">Errors::NotFound</a></span></tt>)</span>
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
—
|
|
1678
|
+
<div class='inline'>
|
|
1679
|
+
<p>Raised if the role doesn't exist.</p>
|
|
1680
|
+
</div>
|
|
1681
|
+
|
|
1682
|
+
</li>
|
|
1683
|
+
|
|
1684
|
+
<li>
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
—
|
|
1692
|
+
<div class='inline'>
|
|
1693
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1694
|
+
</div>
|
|
1695
|
+
|
|
1696
|
+
</li>
|
|
1697
|
+
|
|
1698
|
+
</ul>
|
|
1699
|
+
|
|
1700
|
+
</div><table class="source_code">
|
|
1701
|
+
<tr>
|
|
1702
|
+
<td>
|
|
1703
|
+
<pre class="lines">
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
51
|
|
1707
|
+
52
|
|
1708
|
+
53</pre>
|
|
1709
|
+
</td>
|
|
1710
|
+
<td>
|
|
1711
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 51</span>
|
|
1712
|
+
|
|
1713
|
+
<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>
|
|
1714
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_update'><span class='object_link'><a href="../Request/Roles.html#update-class_method" title="Datacentred::Request::Roles.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>
|
|
1715
|
+
<span class='kw'>end</span></pre>
|
|
1716
|
+
</td>
|
|
1717
|
+
</tr>
|
|
1718
|
+
</table>
|
|
1719
|
+
</div>
|
|
1720
|
+
|
|
1721
|
+
<div class="method_details ">
|
|
1722
|
+
<h3 class="signature " id="users-class_method">
|
|
1723
|
+
|
|
1724
|
+
.<strong>users</strong>(id) ⇒ <tt>[<span class='object_link'><a href="User.html" title="Datacentred::Model::User (class)">User</a></span>]</tt>
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
</h3><div class="docstring">
|
|
1731
|
+
<div class="discussion">
|
|
1732
|
+
|
|
1733
|
+
<p>List all users assigned to this role.</p>
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
</div>
|
|
1737
|
+
</div>
|
|
1738
|
+
<div class="tags">
|
|
1739
|
+
<p class="tag_title">Parameters:</p>
|
|
1740
|
+
<ul class="param">
|
|
1741
|
+
|
|
1742
|
+
<li>
|
|
1743
|
+
|
|
1744
|
+
<span class='name'>id</span>
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
—
|
|
1752
|
+
<div class='inline'>
|
|
1753
|
+
<p>The unique identifier for this role.</p>
|
|
1754
|
+
</div>
|
|
1755
|
+
|
|
1756
|
+
</li>
|
|
1757
|
+
|
|
1758
|
+
</ul>
|
|
1759
|
+
|
|
1760
|
+
<p class="tag_title">Returns:</p>
|
|
1761
|
+
<ul class="return">
|
|
1762
|
+
|
|
1763
|
+
<li>
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
<span class='type'>(<tt>[<span class='object_link'><a href="User.html" title="Datacentred::Model::User (class)">User</a></span>]</tt>)</span>
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
—
|
|
1771
|
+
<div class='inline'>
|
|
1772
|
+
<p>A collection of the role's users.</p>
|
|
1773
|
+
</div>
|
|
1774
|
+
|
|
1775
|
+
</li>
|
|
1776
|
+
|
|
1777
|
+
</ul>
|
|
1778
|
+
<p class="tag_title">Raises:</p>
|
|
1779
|
+
<ul class="raise">
|
|
1780
|
+
|
|
1781
|
+
<li>
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Errors/Unauthorized.html" title="Datacentred::Errors::Unauthorized (class)">Errors::Unauthorized</a></span></tt>)</span>
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
—
|
|
1789
|
+
<div class='inline'>
|
|
1790
|
+
<p>Raised if credentials aren't valid.</p>
|
|
1791
|
+
</div>
|
|
1792
|
+
|
|
1793
|
+
</li>
|
|
1794
|
+
|
|
1795
|
+
</ul>
|
|
1796
|
+
|
|
1797
|
+
</div><table class="source_code">
|
|
1798
|
+
<tr>
|
|
1799
|
+
<td>
|
|
1800
|
+
<pre class="lines">
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
72
|
|
1804
|
+
73
|
|
1805
|
+
74</pre>
|
|
1806
|
+
</td>
|
|
1807
|
+
<td>
|
|
1808
|
+
<pre class="code"><span class="info file"># File 'lib/datacentred/model/role.rb', line 72</span>
|
|
1809
|
+
|
|
1810
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
1811
|
+
<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/Roles.html" title="Datacentred::Request::Roles (class)">Roles</a></span></span><span class='period'>.</span><span class='id identifier rubyid_list_users'><span class='object_link'><a href="../Request/Roles.html#list_users-class_method" title="Datacentred::Request::Roles.list_users (method)">list_users</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</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>
|
|
1812
|
+
<span class='kw'>end</span></pre>
|
|
1813
|
+
</td>
|
|
1814
|
+
</tr>
|
|
1815
|
+
</table>
|
|
1816
|
+
</div>
|
|
1817
|
+
|
|
1818
|
+
</div>
|
|
1819
|
+
|
|
1820
|
+
</div>
|
|
1821
|
+
|
|
1822
|
+
<div id="footer">
|
|
1823
|
+
Generated on Fri Sep 15 16:27:42 2017 by
|
|
1824
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1825
|
+
0.9.9 (ruby-2.3.1).
|
|
1826
|
+
</div>
|
|
1827
|
+
|
|
1828
|
+
</div>
|
|
1829
|
+
</body>
|
|
1830
|
+
</html>
|