resourcespace-ruby 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardoc/checksums +10 -0
- data/.yardoc/complete +0 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/.yardopts +7 -0
- data/README.md +1 -2
- data/doc/ResourceSpace/AuthenticationError.html +159 -0
- data/doc/ResourceSpace/AuthorizationError.html +159 -0
- data/doc/ResourceSpace/Client.html +2412 -0
- data/doc/ResourceSpace/ClientError.html +159 -0
- data/doc/ResourceSpace/Collection.html +2301 -0
- data/doc/ResourceSpace/Configuration.html +1655 -0
- data/doc/ResourceSpace/ConfigurationError.html +159 -0
- data/doc/ResourceSpace/ConflictError.html +159 -0
- data/doc/ResourceSpace/Error.html +682 -0
- data/doc/ResourceSpace/Metadata.html +2222 -0
- data/doc/ResourceSpace/NetworkError.html +159 -0
- data/doc/ResourceSpace/NotFoundError.html +159 -0
- data/doc/ResourceSpace/ParseError.html +159 -0
- data/doc/ResourceSpace/QuotaExceededError.html +159 -0
- data/doc/ResourceSpace/RateLimitError.html +159 -0
- data/doc/ResourceSpace/Resource.html +2995 -0
- data/doc/ResourceSpace/Search.html +2487 -0
- data/doc/ResourceSpace/ServerError.html +159 -0
- data/doc/ResourceSpace/TimeoutError.html +159 -0
- data/doc/ResourceSpace/UploadError.html +159 -0
- data/doc/ResourceSpace/User.html +2080 -0
- data/doc/ResourceSpace/ValidationError.html +159 -0
- data/doc/ResourceSpace.html +763 -0
- data/doc/_index.html +358 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +503 -0
- data/doc/file.CHANGELOG.html +105 -0
- data/doc/file.LICENSE.html +70 -0
- data/doc/file.README.html +419 -0
- data/doc/file_list.html +69 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +419 -0
- data/doc/js/app.js +344 -0
- data/doc/js/full_list.js +242 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1142 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/resourcespace/version.rb +1 -1
- data/resourcespace-ruby-0.1.0.gem +0 -0
- data/resourcespace-ruby-0.1.1.gem +0 -0
- data/resourcespace-ruby.gemspec +5 -5
- metadata +54 -7
|
@@ -0,0 +1,2080 @@
|
|
|
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: ResourceSpace::User
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "ResourceSpace::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="../ResourceSpace.html" title="ResourceSpace (module)">ResourceSpace</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: ResourceSpace::User
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">ResourceSpace::User</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/resourcespace/user.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>User management interface for ResourceSpace API</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
<div class="examples">
|
|
113
|
+
<h4 class="tag_title">Examples:</h4>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<pre class="example code"><code><span class='id identifier rubyid_users'>users</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span>
|
|
117
|
+
|
|
118
|
+
<span class='comment'># Get user list
|
|
119
|
+
</span><span class='id identifier rubyid_all_users'>all_users</span> <span class='op'>=</span> <span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_get_users'>get_users</span>
|
|
120
|
+
|
|
121
|
+
<span class='comment'># Check permissions
|
|
122
|
+
</span><span class='id identifier rubyid_can_edit'>can_edit</span> <span class='op'>=</span> <span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>r</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
132
|
+
<ul class="summary">
|
|
133
|
+
|
|
134
|
+
<li class="public ">
|
|
135
|
+
<span class="summary_signature">
|
|
136
|
+
|
|
137
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Client </a>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</span>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<span class="note title readonly">readonly</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'>
|
|
157
|
+
<p>The ResourceSpace client.</p>
|
|
158
|
+
</div></span>
|
|
159
|
+
|
|
160
|
+
</li>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</ul>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<h2>
|
|
170
|
+
Instance Method Summary
|
|
171
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
172
|
+
</h2>
|
|
173
|
+
|
|
174
|
+
<ul class="summary">
|
|
175
|
+
|
|
176
|
+
<li class="public ">
|
|
177
|
+
<span class="summary_signature">
|
|
178
|
+
|
|
179
|
+
<a href="#admin%3F-instance_method" title="#admin? (instance method)">#<strong>admin?</strong> ⇒ Boolean </a>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="summary_desc"><div class='inline'>
|
|
194
|
+
<p>Check if current user is an admin.</p>
|
|
195
|
+
</div></span>
|
|
196
|
+
|
|
197
|
+
</li>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<li class="public ">
|
|
201
|
+
<span class="summary_signature">
|
|
202
|
+
|
|
203
|
+
<a href="#can_access_resource%3F-instance_method" title="#can_access_resource? (instance method)">#<strong>can_access_resource?</strong>(resource_id) ⇒ Boolean </a>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</span>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class="summary_desc"><div class='inline'>
|
|
218
|
+
<p>Check if user can access a specific resource.</p>
|
|
219
|
+
</div></span>
|
|
220
|
+
|
|
221
|
+
</li>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<li class="public ">
|
|
225
|
+
<span class="summary_signature">
|
|
226
|
+
|
|
227
|
+
<a href="#can_download%3F-instance_method" title="#can_download? (instance method)">#<strong>can_download?</strong> ⇒ Boolean </a>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<span class="summary_desc"><div class='inline'>
|
|
242
|
+
<p>Check if current user can download files.</p>
|
|
243
|
+
</div></span>
|
|
244
|
+
|
|
245
|
+
</li>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<li class="public ">
|
|
249
|
+
<span class="summary_signature">
|
|
250
|
+
|
|
251
|
+
<a href="#can_edit_resource%3F-instance_method" title="#can_edit_resource? (instance method)">#<strong>can_edit_resource?</strong>(resource_id) ⇒ Boolean </a>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</span>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="summary_desc"><div class='inline'>
|
|
266
|
+
<p>Check if user can edit a specific resource.</p>
|
|
267
|
+
</div></span>
|
|
268
|
+
|
|
269
|
+
</li>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<li class="public ">
|
|
273
|
+
<span class="summary_signature">
|
|
274
|
+
|
|
275
|
+
<a href="#can_edit_resources%3F-instance_method" title="#can_edit_resources? (instance method)">#<strong>can_edit_resources?</strong> ⇒ Boolean </a>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<span class="summary_desc"><div class='inline'>
|
|
290
|
+
<p>Check if current user can edit resources.</p>
|
|
291
|
+
</div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#can_manage_collections%3F-instance_method" title="#can_manage_collections? (instance method)">#<strong>can_manage_collections?</strong> ⇒ Boolean </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<span class="summary_desc"><div class='inline'>
|
|
314
|
+
<p>Check if current user can manage collections.</p>
|
|
315
|
+
</div></span>
|
|
316
|
+
|
|
317
|
+
</li>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<li class="public ">
|
|
321
|
+
<span class="summary_signature">
|
|
322
|
+
|
|
323
|
+
<a href="#can_manage_users%3F-instance_method" title="#can_manage_users? (instance method)">#<strong>can_manage_users?</strong> ⇒ Boolean </a>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</span>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="summary_desc"><div class='inline'>
|
|
338
|
+
<p>Check if current user can manage users.</p>
|
|
339
|
+
</div></span>
|
|
340
|
+
|
|
341
|
+
</li>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<li class="public ">
|
|
345
|
+
<span class="summary_signature">
|
|
346
|
+
|
|
347
|
+
<a href="#can_upload%3F-instance_method" title="#can_upload? (instance method)">#<strong>can_upload?</strong> ⇒ Boolean </a>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
</span>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<span class="summary_desc"><div class='inline'>
|
|
362
|
+
<p>Check if current user can upload files.</p>
|
|
363
|
+
</div></span>
|
|
364
|
+
|
|
365
|
+
</li>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<li class="public ">
|
|
369
|
+
<span class="summary_signature">
|
|
370
|
+
|
|
371
|
+
<a href="#capabilities-instance_method" title="#capabilities (instance method)">#<strong>capabilities</strong> ⇒ Hash </a>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</span>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<span class="summary_desc"><div class='inline'>
|
|
386
|
+
<p>Get user capabilities summary.</p>
|
|
387
|
+
</div></span>
|
|
388
|
+
|
|
389
|
+
</li>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<li class="public ">
|
|
393
|
+
<span class="summary_signature">
|
|
394
|
+
|
|
395
|
+
<a href="#check_permission-instance_method" title="#check_permission (instance method)">#<strong>check_permission</strong>(permission) ⇒ Boolean </a>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</span>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<span class="summary_desc"><div class='inline'>
|
|
410
|
+
<p>Check if current user has a permission.</p>
|
|
411
|
+
</div></span>
|
|
412
|
+
|
|
413
|
+
</li>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<li class="public ">
|
|
417
|
+
<span class="summary_signature">
|
|
418
|
+
|
|
419
|
+
<a href="#check_permissions-instance_method" title="#check_permissions (instance method)">#<strong>check_permissions</strong>(permissions) ⇒ Hash </a>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</span>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<span class="summary_desc"><div class='inline'>
|
|
434
|
+
<p>Check multiple permissions at once.</p>
|
|
435
|
+
</div></span>
|
|
436
|
+
|
|
437
|
+
</li>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<li class="public ">
|
|
441
|
+
<span class="summary_signature">
|
|
442
|
+
|
|
443
|
+
<a href="#current_user-instance_method" title="#current_user (instance method)">#<strong>current_user</strong> ⇒ Hash </a>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<span class="summary_desc"><div class='inline'>
|
|
458
|
+
<p>Get current user information.</p>
|
|
459
|
+
</div></span>
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<li class="public ">
|
|
465
|
+
<span class="summary_signature">
|
|
466
|
+
|
|
467
|
+
<a href="#get_admin_users-instance_method" title="#get_admin_users (instance method)">#<strong>get_admin_users</strong> ⇒ Array </a>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
<span class="summary_desc"><div class='inline'>
|
|
482
|
+
<p>Get users with administrative privileges.</p>
|
|
483
|
+
</div></span>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<li class="public ">
|
|
489
|
+
<span class="summary_signature">
|
|
490
|
+
|
|
491
|
+
<a href="#get_user_message-instance_method" title="#get_user_message (instance method)">#<strong>get_user_message</strong>(message_id) ⇒ Hash </a>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<span class="summary_desc"><div class='inline'>
|
|
506
|
+
<p>Get user message.</p>
|
|
507
|
+
</div></span>
|
|
508
|
+
|
|
509
|
+
</li>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
<li class="public ">
|
|
513
|
+
<span class="summary_signature">
|
|
514
|
+
|
|
515
|
+
<a href="#get_users-instance_method" title="#get_users (instance method)">#<strong>get_users</strong> ⇒ Array </a>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
</span>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<span class="summary_desc"><div class='inline'>
|
|
530
|
+
<p>Get list of users.</p>
|
|
531
|
+
</div></span>
|
|
532
|
+
|
|
533
|
+
</li>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<li class="public ">
|
|
537
|
+
<span class="summary_signature">
|
|
538
|
+
|
|
539
|
+
<a href="#get_users_by_permission-instance_method" title="#get_users_by_permission (instance method)">#<strong>get_users_by_permission</strong>(permission) ⇒ Array </a>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
</span>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class="summary_desc"><div class='inline'>
|
|
554
|
+
<p>Get users by permission.</p>
|
|
555
|
+
</div></span>
|
|
556
|
+
|
|
557
|
+
</li>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
<li class="public ">
|
|
561
|
+
<span class="summary_signature">
|
|
562
|
+
|
|
563
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client) ⇒ User </a>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
</span>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
<span class="note title constructor">constructor</span>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class="summary_desc"><div class='inline'>
|
|
580
|
+
<p>Initialize the user interface.</p>
|
|
581
|
+
</div></span>
|
|
582
|
+
|
|
583
|
+
</li>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<li class="public ">
|
|
587
|
+
<span class="summary_signature">
|
|
588
|
+
|
|
589
|
+
<a href="#login-instance_method" title="#login (instance method)">#<strong>login</strong>(username, password) ⇒ String </a>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
</span>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<span class="summary_desc"><div class='inline'>
|
|
604
|
+
<p>Login and get a session key.</p>
|
|
605
|
+
</div></span>
|
|
606
|
+
|
|
607
|
+
</li>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
<li class="public ">
|
|
611
|
+
<span class="summary_signature">
|
|
612
|
+
|
|
613
|
+
<a href="#mark_email_as_invalid-instance_method" title="#mark_email_as_invalid (instance method)">#<strong>mark_email_as_invalid</strong>(email) ⇒ Hash </a>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
</span>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<span class="summary_desc"><div class='inline'>
|
|
628
|
+
<p>Mark an email as invalid.</p>
|
|
629
|
+
</div></span>
|
|
630
|
+
|
|
631
|
+
</li>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
</ul>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<div id="constructor_details" class="method_details_list">
|
|
638
|
+
<h2>Constructor Details</h2>
|
|
639
|
+
|
|
640
|
+
<div class="method_details first">
|
|
641
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
642
|
+
|
|
643
|
+
#<strong>initialize</strong>(client) ⇒ <tt><span class='object_link'><a href="" title="ResourceSpace::User (class)">User</a></span></tt>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
</h3><div class="docstring">
|
|
650
|
+
<div class="discussion">
|
|
651
|
+
|
|
652
|
+
<p>Initialize the user interface</p>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
</div>
|
|
656
|
+
</div>
|
|
657
|
+
<div class="tags">
|
|
658
|
+
<p class="tag_title">Parameters:</p>
|
|
659
|
+
<ul class="param">
|
|
660
|
+
|
|
661
|
+
<li>
|
|
662
|
+
|
|
663
|
+
<span class='name'>client</span>
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
—
|
|
671
|
+
<div class='inline'>
|
|
672
|
+
<p>ResourceSpace client instance</p>
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
</li>
|
|
676
|
+
|
|
677
|
+
</ul>
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
</div><table class="source_code">
|
|
681
|
+
<tr>
|
|
682
|
+
<td>
|
|
683
|
+
<pre class="lines">
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
21
|
|
687
|
+
22
|
|
688
|
+
23</pre>
|
|
689
|
+
</td>
|
|
690
|
+
<td>
|
|
691
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 21</span>
|
|
692
|
+
|
|
693
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
|
|
694
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
695
|
+
<span class='kw'>end</span></pre>
|
|
696
|
+
</td>
|
|
697
|
+
</tr>
|
|
698
|
+
</table>
|
|
699
|
+
</div>
|
|
700
|
+
|
|
701
|
+
</div>
|
|
702
|
+
|
|
703
|
+
<div id="instance_attr_details" class="attr_details">
|
|
704
|
+
<h2>Instance Attribute Details</h2>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
<span id=""></span>
|
|
708
|
+
<div class="method_details first">
|
|
709
|
+
<h3 class="signature first" id="client-instance_method">
|
|
710
|
+
|
|
711
|
+
#<strong>client</strong> ⇒ <tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt> <span class="extras">(readonly)</span>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
</h3><div class="docstring">
|
|
718
|
+
<div class="discussion">
|
|
719
|
+
|
|
720
|
+
<p>Returns the ResourceSpace client.</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><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
—
|
|
738
|
+
<div class='inline'>
|
|
739
|
+
<p>the ResourceSpace client</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
|
+
16
|
|
753
|
+
17
|
|
754
|
+
18</pre>
|
|
755
|
+
</td>
|
|
756
|
+
<td>
|
|
757
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 16</span>
|
|
758
|
+
|
|
759
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
760
|
+
<span class='ivar'>@client</span>
|
|
761
|
+
<span class='kw'>end</span></pre>
|
|
762
|
+
</td>
|
|
763
|
+
</tr>
|
|
764
|
+
</table>
|
|
765
|
+
</div>
|
|
766
|
+
|
|
767
|
+
</div>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
<div id="instance_method_details" class="method_details_list">
|
|
771
|
+
<h2>Instance Method Details</h2>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<div class="method_details first">
|
|
775
|
+
<h3 class="signature first" id="admin?-instance_method">
|
|
776
|
+
|
|
777
|
+
#<strong>admin?</strong> ⇒ <tt>Boolean</tt>
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</h3><div class="docstring">
|
|
784
|
+
<div class="discussion">
|
|
785
|
+
|
|
786
|
+
<p>Check if current user is an admin</p>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
</div>
|
|
790
|
+
</div>
|
|
791
|
+
<div class="tags">
|
|
792
|
+
|
|
793
|
+
<p class="tag_title">Returns:</p>
|
|
794
|
+
<ul class="return">
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
—
|
|
804
|
+
<div class='inline'>
|
|
805
|
+
<p>true if user is admin</p>
|
|
806
|
+
</div>
|
|
807
|
+
|
|
808
|
+
</li>
|
|
809
|
+
|
|
810
|
+
</ul>
|
|
811
|
+
|
|
812
|
+
</div><table class="source_code">
|
|
813
|
+
<tr>
|
|
814
|
+
<td>
|
|
815
|
+
<pre class="lines">
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
135
|
|
819
|
+
136
|
|
820
|
+
137</pre>
|
|
821
|
+
</td>
|
|
822
|
+
<td>
|
|
823
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 135</span>
|
|
824
|
+
|
|
825
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_admin?'>admin?</span>
|
|
826
|
+
<span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>a</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
827
|
+
<span class='kw'>end</span></pre>
|
|
828
|
+
</td>
|
|
829
|
+
</tr>
|
|
830
|
+
</table>
|
|
831
|
+
</div>
|
|
832
|
+
|
|
833
|
+
<div class="method_details ">
|
|
834
|
+
<h3 class="signature " id="can_access_resource?-instance_method">
|
|
835
|
+
|
|
836
|
+
#<strong>can_access_resource?</strong>(resource_id) ⇒ <tt>Boolean</tt>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</h3><div class="docstring">
|
|
843
|
+
<div class="discussion">
|
|
844
|
+
|
|
845
|
+
<p>Check if user can access a specific resource</p>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
</div>
|
|
849
|
+
</div>
|
|
850
|
+
<div class="tags">
|
|
851
|
+
<p class="tag_title">Parameters:</p>
|
|
852
|
+
<ul class="param">
|
|
853
|
+
|
|
854
|
+
<li>
|
|
855
|
+
|
|
856
|
+
<span class='name'>resource_id</span>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
—
|
|
864
|
+
<div class='inline'>
|
|
865
|
+
<p>resource ID</p>
|
|
866
|
+
</div>
|
|
867
|
+
|
|
868
|
+
</li>
|
|
869
|
+
|
|
870
|
+
</ul>
|
|
871
|
+
|
|
872
|
+
<p class="tag_title">Returns:</p>
|
|
873
|
+
<ul class="return">
|
|
874
|
+
|
|
875
|
+
<li>
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
—
|
|
883
|
+
<div class='inline'>
|
|
884
|
+
<p>true if user can access the resource</p>
|
|
885
|
+
</div>
|
|
886
|
+
|
|
887
|
+
</li>
|
|
888
|
+
|
|
889
|
+
</ul>
|
|
890
|
+
|
|
891
|
+
</div><table class="source_code">
|
|
892
|
+
<tr>
|
|
893
|
+
<td>
|
|
894
|
+
<pre class="lines">
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
84
|
|
898
|
+
85
|
|
899
|
+
86
|
|
900
|
+
87
|
|
901
|
+
88
|
|
902
|
+
89
|
|
903
|
+
90
|
|
904
|
+
91</pre>
|
|
905
|
+
</td>
|
|
906
|
+
<td>
|
|
907
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 84</span>
|
|
908
|
+
|
|
909
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_access_resource?'>can_access_resource?</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
910
|
+
<span class='kw'>begin</span>
|
|
911
|
+
<span class='id identifier rubyid_access_level'>access_level</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_resources'>resources</span><span class='period'>.</span><span class='id identifier rubyid_get_resource_access'>get_resource_access</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
912
|
+
<span class='id identifier rubyid_access_level'>access_level</span> <span class='op'>>=</span> <span class='int'>0</span> <span class='comment'># 0 = open access, -1 = no access
|
|
913
|
+
</span> <span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="NotFoundError.html" title="ResourceSpace::NotFoundError (class)">NotFoundError</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="AuthorizationError.html" title="ResourceSpace::AuthorizationError (class)">AuthorizationError</a></span></span>
|
|
914
|
+
<span class='kw'>false</span>
|
|
915
|
+
<span class='kw'>end</span>
|
|
916
|
+
<span class='kw'>end</span></pre>
|
|
917
|
+
</td>
|
|
918
|
+
</tr>
|
|
919
|
+
</table>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
<div class="method_details ">
|
|
923
|
+
<h3 class="signature " id="can_download?-instance_method">
|
|
924
|
+
|
|
925
|
+
#<strong>can_download?</strong> ⇒ <tt>Boolean</tt>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
</h3><div class="docstring">
|
|
932
|
+
<div class="discussion">
|
|
933
|
+
|
|
934
|
+
<p>Check if current user can download files</p>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
</div>
|
|
938
|
+
</div>
|
|
939
|
+
<div class="tags">
|
|
940
|
+
|
|
941
|
+
<p class="tag_title">Returns:</p>
|
|
942
|
+
<ul class="return">
|
|
943
|
+
|
|
944
|
+
<li>
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
—
|
|
952
|
+
<div class='inline'>
|
|
953
|
+
<p>true if user can download files</p>
|
|
954
|
+
</div>
|
|
955
|
+
|
|
956
|
+
</li>
|
|
957
|
+
|
|
958
|
+
</ul>
|
|
959
|
+
|
|
960
|
+
</div><table class="source_code">
|
|
961
|
+
<tr>
|
|
962
|
+
<td>
|
|
963
|
+
<pre class="lines">
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
163
|
|
967
|
+
164
|
|
968
|
+
165</pre>
|
|
969
|
+
</td>
|
|
970
|
+
<td>
|
|
971
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 163</span>
|
|
972
|
+
|
|
973
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_download?'>can_download?</span>
|
|
974
|
+
<span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>d</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
975
|
+
<span class='kw'>end</span></pre>
|
|
976
|
+
</td>
|
|
977
|
+
</tr>
|
|
978
|
+
</table>
|
|
979
|
+
</div>
|
|
980
|
+
|
|
981
|
+
<div class="method_details ">
|
|
982
|
+
<h3 class="signature " id="can_edit_resource?-instance_method">
|
|
983
|
+
|
|
984
|
+
#<strong>can_edit_resource?</strong>(resource_id) ⇒ <tt>Boolean</tt>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
</h3><div class="docstring">
|
|
991
|
+
<div class="discussion">
|
|
992
|
+
|
|
993
|
+
<p>Check if user can edit a specific resource</p>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
</div>
|
|
997
|
+
</div>
|
|
998
|
+
<div class="tags">
|
|
999
|
+
<p class="tag_title">Parameters:</p>
|
|
1000
|
+
<ul class="param">
|
|
1001
|
+
|
|
1002
|
+
<li>
|
|
1003
|
+
|
|
1004
|
+
<span class='name'>resource_id</span>
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
—
|
|
1012
|
+
<div class='inline'>
|
|
1013
|
+
<p>resource ID</p>
|
|
1014
|
+
</div>
|
|
1015
|
+
|
|
1016
|
+
</li>
|
|
1017
|
+
|
|
1018
|
+
</ul>
|
|
1019
|
+
|
|
1020
|
+
<p class="tag_title">Returns:</p>
|
|
1021
|
+
<ul class="return">
|
|
1022
|
+
|
|
1023
|
+
<li>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
—
|
|
1031
|
+
<div class='inline'>
|
|
1032
|
+
<p>true if user can edit the resource</p>
|
|
1033
|
+
</div>
|
|
1034
|
+
|
|
1035
|
+
</li>
|
|
1036
|
+
|
|
1037
|
+
</ul>
|
|
1038
|
+
|
|
1039
|
+
</div><table class="source_code">
|
|
1040
|
+
<tr>
|
|
1041
|
+
<td>
|
|
1042
|
+
<pre class="lines">
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
97
|
|
1046
|
+
98
|
|
1047
|
+
99</pre>
|
|
1048
|
+
</td>
|
|
1049
|
+
<td>
|
|
1050
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 97</span>
|
|
1051
|
+
|
|
1052
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_edit_resource?'>can_edit_resource?</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1053
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_resources'>resources</span><span class='period'>.</span><span class='id identifier rubyid_edit_access?'>edit_access?</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1054
|
+
<span class='kw'>end</span></pre>
|
|
1055
|
+
</td>
|
|
1056
|
+
</tr>
|
|
1057
|
+
</table>
|
|
1058
|
+
</div>
|
|
1059
|
+
|
|
1060
|
+
<div class="method_details ">
|
|
1061
|
+
<h3 class="signature " id="can_edit_resources?-instance_method">
|
|
1062
|
+
|
|
1063
|
+
#<strong>can_edit_resources?</strong> ⇒ <tt>Boolean</tt>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
</h3><div class="docstring">
|
|
1070
|
+
<div class="discussion">
|
|
1071
|
+
|
|
1072
|
+
<p>Check if current user can edit resources</p>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
</div>
|
|
1076
|
+
</div>
|
|
1077
|
+
<div class="tags">
|
|
1078
|
+
|
|
1079
|
+
<p class="tag_title">Returns:</p>
|
|
1080
|
+
<ul class="return">
|
|
1081
|
+
|
|
1082
|
+
<li>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
—
|
|
1090
|
+
<div class='inline'>
|
|
1091
|
+
<p>true if user can edit resources</p>
|
|
1092
|
+
</div>
|
|
1093
|
+
|
|
1094
|
+
</li>
|
|
1095
|
+
|
|
1096
|
+
</ul>
|
|
1097
|
+
|
|
1098
|
+
</div><table class="source_code">
|
|
1099
|
+
<tr>
|
|
1100
|
+
<td>
|
|
1101
|
+
<pre class="lines">
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
170
|
|
1105
|
+
171
|
|
1106
|
+
172</pre>
|
|
1107
|
+
</td>
|
|
1108
|
+
<td>
|
|
1109
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 170</span>
|
|
1110
|
+
|
|
1111
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_edit_resources?'>can_edit_resources?</span>
|
|
1112
|
+
<span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>e</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1113
|
+
<span class='kw'>end</span></pre>
|
|
1114
|
+
</td>
|
|
1115
|
+
</tr>
|
|
1116
|
+
</table>
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
<div class="method_details ">
|
|
1120
|
+
<h3 class="signature " id="can_manage_collections?-instance_method">
|
|
1121
|
+
|
|
1122
|
+
#<strong>can_manage_collections?</strong> ⇒ <tt>Boolean</tt>
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
</h3><div class="docstring">
|
|
1129
|
+
<div class="discussion">
|
|
1130
|
+
|
|
1131
|
+
<p>Check if current user can manage collections</p>
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
</div>
|
|
1135
|
+
</div>
|
|
1136
|
+
<div class="tags">
|
|
1137
|
+
|
|
1138
|
+
<p class="tag_title">Returns:</p>
|
|
1139
|
+
<ul class="return">
|
|
1140
|
+
|
|
1141
|
+
<li>
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
—
|
|
1149
|
+
<div class='inline'>
|
|
1150
|
+
<p>true if user can manage collections</p>
|
|
1151
|
+
</div>
|
|
1152
|
+
|
|
1153
|
+
</li>
|
|
1154
|
+
|
|
1155
|
+
</ul>
|
|
1156
|
+
|
|
1157
|
+
</div><table class="source_code">
|
|
1158
|
+
<tr>
|
|
1159
|
+
<td>
|
|
1160
|
+
<pre class="lines">
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
149
|
|
1164
|
+
150
|
|
1165
|
+
151</pre>
|
|
1166
|
+
</td>
|
|
1167
|
+
<td>
|
|
1168
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 149</span>
|
|
1169
|
+
|
|
1170
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_manage_collections?'>can_manage_collections?</span>
|
|
1171
|
+
<span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>k</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1172
|
+
<span class='kw'>end</span></pre>
|
|
1173
|
+
</td>
|
|
1174
|
+
</tr>
|
|
1175
|
+
</table>
|
|
1176
|
+
</div>
|
|
1177
|
+
|
|
1178
|
+
<div class="method_details ">
|
|
1179
|
+
<h3 class="signature " id="can_manage_users?-instance_method">
|
|
1180
|
+
|
|
1181
|
+
#<strong>can_manage_users?</strong> ⇒ <tt>Boolean</tt>
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
</h3><div class="docstring">
|
|
1188
|
+
<div class="discussion">
|
|
1189
|
+
|
|
1190
|
+
<p>Check if current user can manage users</p>
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
</div>
|
|
1194
|
+
</div>
|
|
1195
|
+
<div class="tags">
|
|
1196
|
+
|
|
1197
|
+
<p class="tag_title">Returns:</p>
|
|
1198
|
+
<ul class="return">
|
|
1199
|
+
|
|
1200
|
+
<li>
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
—
|
|
1208
|
+
<div class='inline'>
|
|
1209
|
+
<p>true if user can manage users</p>
|
|
1210
|
+
</div>
|
|
1211
|
+
|
|
1212
|
+
</li>
|
|
1213
|
+
|
|
1214
|
+
</ul>
|
|
1215
|
+
|
|
1216
|
+
</div><table class="source_code">
|
|
1217
|
+
<tr>
|
|
1218
|
+
<td>
|
|
1219
|
+
<pre class="lines">
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
142
|
|
1223
|
+
143
|
|
1224
|
+
144</pre>
|
|
1225
|
+
</td>
|
|
1226
|
+
<td>
|
|
1227
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 142</span>
|
|
1228
|
+
|
|
1229
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_manage_users?'>can_manage_users?</span>
|
|
1230
|
+
<span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>u</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1231
|
+
<span class='kw'>end</span></pre>
|
|
1232
|
+
</td>
|
|
1233
|
+
</tr>
|
|
1234
|
+
</table>
|
|
1235
|
+
</div>
|
|
1236
|
+
|
|
1237
|
+
<div class="method_details ">
|
|
1238
|
+
<h3 class="signature " id="can_upload?-instance_method">
|
|
1239
|
+
|
|
1240
|
+
#<strong>can_upload?</strong> ⇒ <tt>Boolean</tt>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
</h3><div class="docstring">
|
|
1247
|
+
<div class="discussion">
|
|
1248
|
+
|
|
1249
|
+
<p>Check if current user can upload files</p>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
</div>
|
|
1253
|
+
</div>
|
|
1254
|
+
<div class="tags">
|
|
1255
|
+
|
|
1256
|
+
<p class="tag_title">Returns:</p>
|
|
1257
|
+
<ul class="return">
|
|
1258
|
+
|
|
1259
|
+
<li>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
—
|
|
1267
|
+
<div class='inline'>
|
|
1268
|
+
<p>true if user can upload files</p>
|
|
1269
|
+
</div>
|
|
1270
|
+
|
|
1271
|
+
</li>
|
|
1272
|
+
|
|
1273
|
+
</ul>
|
|
1274
|
+
|
|
1275
|
+
</div><table class="source_code">
|
|
1276
|
+
<tr>
|
|
1277
|
+
<td>
|
|
1278
|
+
<pre class="lines">
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
156
|
|
1282
|
+
157
|
|
1283
|
+
158</pre>
|
|
1284
|
+
</td>
|
|
1285
|
+
<td>
|
|
1286
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 156</span>
|
|
1287
|
+
|
|
1288
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_can_upload?'>can_upload?</span>
|
|
1289
|
+
<span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>c</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1290
|
+
<span class='kw'>end</span></pre>
|
|
1291
|
+
</td>
|
|
1292
|
+
</tr>
|
|
1293
|
+
</table>
|
|
1294
|
+
</div>
|
|
1295
|
+
|
|
1296
|
+
<div class="method_details ">
|
|
1297
|
+
<h3 class="signature " id="capabilities-instance_method">
|
|
1298
|
+
|
|
1299
|
+
#<strong>capabilities</strong> ⇒ <tt>Hash</tt>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
</h3><div class="docstring">
|
|
1306
|
+
<div class="discussion">
|
|
1307
|
+
|
|
1308
|
+
<p>Get user capabilities summary</p>
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
</div>
|
|
1312
|
+
</div>
|
|
1313
|
+
<div class="tags">
|
|
1314
|
+
|
|
1315
|
+
<p class="tag_title">Returns:</p>
|
|
1316
|
+
<ul class="return">
|
|
1317
|
+
|
|
1318
|
+
<li>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
—
|
|
1326
|
+
<div class='inline'>
|
|
1327
|
+
<p>summary of user capabilities</p>
|
|
1328
|
+
</div>
|
|
1329
|
+
|
|
1330
|
+
</li>
|
|
1331
|
+
|
|
1332
|
+
</ul>
|
|
1333
|
+
|
|
1334
|
+
</div><table class="source_code">
|
|
1335
|
+
<tr>
|
|
1336
|
+
<td>
|
|
1337
|
+
<pre class="lines">
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
177
|
|
1341
|
+
178
|
|
1342
|
+
179
|
|
1343
|
+
180
|
|
1344
|
+
181
|
|
1345
|
+
182
|
|
1346
|
+
183
|
|
1347
|
+
184
|
|
1348
|
+
185
|
|
1349
|
+
186</pre>
|
|
1350
|
+
</td>
|
|
1351
|
+
<td>
|
|
1352
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 177</span>
|
|
1353
|
+
|
|
1354
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_capabilities'>capabilities</span>
|
|
1355
|
+
<span class='lbrace'>{</span>
|
|
1356
|
+
<span class='label'>admin:</span> <span class='id identifier rubyid_admin?'>admin?</span><span class='comma'>,</span>
|
|
1357
|
+
<span class='label'>manage_users:</span> <span class='id identifier rubyid_can_manage_users?'>can_manage_users?</span><span class='comma'>,</span>
|
|
1358
|
+
<span class='label'>manage_collections:</span> <span class='id identifier rubyid_can_manage_collections?'>can_manage_collections?</span><span class='comma'>,</span>
|
|
1359
|
+
<span class='label'>upload:</span> <span class='id identifier rubyid_can_upload?'>can_upload?</span><span class='comma'>,</span>
|
|
1360
|
+
<span class='label'>download:</span> <span class='id identifier rubyid_can_download?'>can_download?</span><span class='comma'>,</span>
|
|
1361
|
+
<span class='label'>edit_resources:</span> <span class='id identifier rubyid_can_edit_resources?'>can_edit_resources?</span>
|
|
1362
|
+
<span class='rbrace'>}</span>
|
|
1363
|
+
<span class='kw'>end</span></pre>
|
|
1364
|
+
</td>
|
|
1365
|
+
</tr>
|
|
1366
|
+
</table>
|
|
1367
|
+
</div>
|
|
1368
|
+
|
|
1369
|
+
<div class="method_details ">
|
|
1370
|
+
<h3 class="signature " id="check_permission-instance_method">
|
|
1371
|
+
|
|
1372
|
+
#<strong>check_permission</strong>(permission) ⇒ <tt>Boolean</tt>
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
</h3><div class="docstring">
|
|
1379
|
+
<div class="discussion">
|
|
1380
|
+
|
|
1381
|
+
<p>Check if current user has a permission</p>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
</div>
|
|
1385
|
+
</div>
|
|
1386
|
+
<div class="tags">
|
|
1387
|
+
<p class="tag_title">Parameters:</p>
|
|
1388
|
+
<ul class="param">
|
|
1389
|
+
|
|
1390
|
+
<li>
|
|
1391
|
+
|
|
1392
|
+
<span class='name'>permission</span>
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
—
|
|
1400
|
+
<div class='inline'>
|
|
1401
|
+
<p>permission to check</p>
|
|
1402
|
+
</div>
|
|
1403
|
+
|
|
1404
|
+
</li>
|
|
1405
|
+
|
|
1406
|
+
</ul>
|
|
1407
|
+
|
|
1408
|
+
<p class="tag_title">Returns:</p>
|
|
1409
|
+
<ul class="return">
|
|
1410
|
+
|
|
1411
|
+
<li>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
—
|
|
1419
|
+
<div class='inline'>
|
|
1420
|
+
<p>true if user has permission</p>
|
|
1421
|
+
</div>
|
|
1422
|
+
|
|
1423
|
+
</li>
|
|
1424
|
+
|
|
1425
|
+
</ul>
|
|
1426
|
+
|
|
1427
|
+
</div><table class="source_code">
|
|
1428
|
+
<tr>
|
|
1429
|
+
<td>
|
|
1430
|
+
<pre class="lines">
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
44
|
|
1434
|
+
45
|
|
1435
|
+
46
|
|
1436
|
+
47</pre>
|
|
1437
|
+
</td>
|
|
1438
|
+
<td>
|
|
1439
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 44</span>
|
|
1440
|
+
|
|
1441
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='id identifier rubyid_permission'>permission</span><span class='rparen'>)</span>
|
|
1442
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>checkperm</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_permission'>permission</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1443
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>true</span><span class='tstring_end'>"</span></span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span>
|
|
1444
|
+
<span class='kw'>end</span></pre>
|
|
1445
|
+
</td>
|
|
1446
|
+
</tr>
|
|
1447
|
+
</table>
|
|
1448
|
+
</div>
|
|
1449
|
+
|
|
1450
|
+
<div class="method_details ">
|
|
1451
|
+
<h3 class="signature " id="check_permissions-instance_method">
|
|
1452
|
+
|
|
1453
|
+
#<strong>check_permissions</strong>(permissions) ⇒ <tt>Hash</tt>
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
</h3><div class="docstring">
|
|
1460
|
+
<div class="discussion">
|
|
1461
|
+
|
|
1462
|
+
<p>Check multiple permissions at once</p>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
</div>
|
|
1466
|
+
</div>
|
|
1467
|
+
<div class="tags">
|
|
1468
|
+
<p class="tag_title">Parameters:</p>
|
|
1469
|
+
<ul class="param">
|
|
1470
|
+
|
|
1471
|
+
<li>
|
|
1472
|
+
|
|
1473
|
+
<span class='name'>permissions</span>
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
<span class='type'>(<tt>Array<String></tt>)</span>
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
—
|
|
1481
|
+
<div class='inline'>
|
|
1482
|
+
<p>array of permissions to check</p>
|
|
1483
|
+
</div>
|
|
1484
|
+
|
|
1485
|
+
</li>
|
|
1486
|
+
|
|
1487
|
+
</ul>
|
|
1488
|
+
|
|
1489
|
+
<p class="tag_title">Returns:</p>
|
|
1490
|
+
<ul class="return">
|
|
1491
|
+
|
|
1492
|
+
<li>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
—
|
|
1500
|
+
<div class='inline'>
|
|
1501
|
+
<p>hash of permission => boolean pairs</p>
|
|
1502
|
+
</div>
|
|
1503
|
+
|
|
1504
|
+
</li>
|
|
1505
|
+
|
|
1506
|
+
</ul>
|
|
1507
|
+
|
|
1508
|
+
</div><table class="source_code">
|
|
1509
|
+
<tr>
|
|
1510
|
+
<td>
|
|
1511
|
+
<pre class="lines">
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
116
|
|
1515
|
+
117
|
|
1516
|
+
118
|
|
1517
|
+
119
|
|
1518
|
+
120
|
|
1519
|
+
121
|
|
1520
|
+
122</pre>
|
|
1521
|
+
</td>
|
|
1522
|
+
<td>
|
|
1523
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 116</span>
|
|
1524
|
+
|
|
1525
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_permissions'>check_permissions</span><span class='lparen'>(</span><span class='id identifier rubyid_permissions'>permissions</span><span class='rparen'>)</span>
|
|
1526
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1527
|
+
<span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_permissions'>permissions</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_permission'>permission</span><span class='op'>|</span>
|
|
1528
|
+
<span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='id identifier rubyid_permission'>permission</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_check_permission'>check_permission</span><span class='lparen'>(</span><span class='id identifier rubyid_permission'>permission</span><span class='rparen'>)</span>
|
|
1529
|
+
<span class='kw'>end</span>
|
|
1530
|
+
<span class='id identifier rubyid_result'>result</span>
|
|
1531
|
+
<span class='kw'>end</span></pre>
|
|
1532
|
+
</td>
|
|
1533
|
+
</tr>
|
|
1534
|
+
</table>
|
|
1535
|
+
</div>
|
|
1536
|
+
|
|
1537
|
+
<div class="method_details ">
|
|
1538
|
+
<h3 class="signature " id="current_user-instance_method">
|
|
1539
|
+
|
|
1540
|
+
#<strong>current_user</strong> ⇒ <tt>Hash</tt>
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
</h3><div class="docstring">
|
|
1547
|
+
<div class="discussion">
|
|
1548
|
+
|
|
1549
|
+
<p>Get current user information</p>
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
</div>
|
|
1553
|
+
</div>
|
|
1554
|
+
<div class="tags">
|
|
1555
|
+
|
|
1556
|
+
<p class="tag_title">Returns:</p>
|
|
1557
|
+
<ul class="return">
|
|
1558
|
+
|
|
1559
|
+
<li>
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
—
|
|
1567
|
+
<div class='inline'>
|
|
1568
|
+
<p>current user data</p>
|
|
1569
|
+
</div>
|
|
1570
|
+
|
|
1571
|
+
</li>
|
|
1572
|
+
|
|
1573
|
+
</ul>
|
|
1574
|
+
|
|
1575
|
+
</div><table class="source_code">
|
|
1576
|
+
<tr>
|
|
1577
|
+
<td>
|
|
1578
|
+
<pre class="lines">
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
104
|
|
1582
|
+
105
|
|
1583
|
+
106
|
|
1584
|
+
107
|
|
1585
|
+
108
|
|
1586
|
+
109
|
|
1587
|
+
110</pre>
|
|
1588
|
+
</td>
|
|
1589
|
+
<td>
|
|
1590
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 104</span>
|
|
1591
|
+
|
|
1592
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_current_user'>current_user</span>
|
|
1593
|
+
<span class='comment'># Note: ResourceSpace API doesn't have a direct "current user" endpoint
|
|
1594
|
+
</span> <span class='comment'># This would typically be implemented by getting user info based on the authenticated user
|
|
1595
|
+
</span> <span class='comment'># For now, we'll use the username from configuration and search for it
|
|
1596
|
+
</span> <span class='id identifier rubyid_users'>users</span> <span class='op'>=</span> <span class='id identifier rubyid_get_users'>get_users</span>
|
|
1597
|
+
<span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</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_user'>user</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>username</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span> <span class='rbrace'>}</span>
|
|
1598
|
+
<span class='kw'>end</span></pre>
|
|
1599
|
+
</td>
|
|
1600
|
+
</tr>
|
|
1601
|
+
</table>
|
|
1602
|
+
</div>
|
|
1603
|
+
|
|
1604
|
+
<div class="method_details ">
|
|
1605
|
+
<h3 class="signature " id="get_admin_users-instance_method">
|
|
1606
|
+
|
|
1607
|
+
#<strong>get_admin_users</strong> ⇒ <tt>Array</tt>
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
</h3><div class="docstring">
|
|
1614
|
+
<div class="discussion">
|
|
1615
|
+
|
|
1616
|
+
<p>Get users with administrative privileges</p>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
</div>
|
|
1620
|
+
</div>
|
|
1621
|
+
<div class="tags">
|
|
1622
|
+
|
|
1623
|
+
<p class="tag_title">Returns:</p>
|
|
1624
|
+
<ul class="return">
|
|
1625
|
+
|
|
1626
|
+
<li>
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
—
|
|
1634
|
+
<div class='inline'>
|
|
1635
|
+
<p>admin users</p>
|
|
1636
|
+
</div>
|
|
1637
|
+
|
|
1638
|
+
</li>
|
|
1639
|
+
|
|
1640
|
+
</ul>
|
|
1641
|
+
|
|
1642
|
+
</div><table class="source_code">
|
|
1643
|
+
<tr>
|
|
1644
|
+
<td>
|
|
1645
|
+
<pre class="lines">
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
127
|
|
1649
|
+
128
|
|
1650
|
+
129
|
|
1651
|
+
130</pre>
|
|
1652
|
+
</td>
|
|
1653
|
+
<td>
|
|
1654
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 127</span>
|
|
1655
|
+
|
|
1656
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_admin_users'>get_admin_users</span>
|
|
1657
|
+
<span class='comment'># Typically admin users have 'a' permission
|
|
1658
|
+
</span> <span class='id identifier rubyid_get_users_by_permission'>get_users_by_permission</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>a</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1659
|
+
<span class='kw'>end</span></pre>
|
|
1660
|
+
</td>
|
|
1661
|
+
</tr>
|
|
1662
|
+
</table>
|
|
1663
|
+
</div>
|
|
1664
|
+
|
|
1665
|
+
<div class="method_details ">
|
|
1666
|
+
<h3 class="signature " id="get_user_message-instance_method">
|
|
1667
|
+
|
|
1668
|
+
#<strong>get_user_message</strong>(message_id) ⇒ <tt>Hash</tt>
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
|
|
1674
|
+
</h3><div class="docstring">
|
|
1675
|
+
<div class="discussion">
|
|
1676
|
+
|
|
1677
|
+
<p>Get user message</p>
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
</div>
|
|
1681
|
+
</div>
|
|
1682
|
+
<div class="tags">
|
|
1683
|
+
<p class="tag_title">Parameters:</p>
|
|
1684
|
+
<ul class="param">
|
|
1685
|
+
|
|
1686
|
+
<li>
|
|
1687
|
+
|
|
1688
|
+
<span class='name'>message_id</span>
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
—
|
|
1696
|
+
<div class='inline'>
|
|
1697
|
+
<p>message ID</p>
|
|
1698
|
+
</div>
|
|
1699
|
+
|
|
1700
|
+
</li>
|
|
1701
|
+
|
|
1702
|
+
</ul>
|
|
1703
|
+
|
|
1704
|
+
<p class="tag_title">Returns:</p>
|
|
1705
|
+
<ul class="return">
|
|
1706
|
+
|
|
1707
|
+
<li>
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
—
|
|
1715
|
+
<div class='inline'>
|
|
1716
|
+
<p>message details</p>
|
|
1717
|
+
</div>
|
|
1718
|
+
|
|
1719
|
+
</li>
|
|
1720
|
+
|
|
1721
|
+
</ul>
|
|
1722
|
+
|
|
1723
|
+
</div><table class="source_code">
|
|
1724
|
+
<tr>
|
|
1725
|
+
<td>
|
|
1726
|
+
<pre class="lines">
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
76
|
|
1730
|
+
77
|
|
1731
|
+
78</pre>
|
|
1732
|
+
</td>
|
|
1733
|
+
<td>
|
|
1734
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 76</span>
|
|
1735
|
+
|
|
1736
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_user_message'>get_user_message</span><span class='lparen'>(</span><span class='id identifier rubyid_message_id'>message_id</span><span class='rparen'>)</span>
|
|
1737
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>get_user_message</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_message_id'>message_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1738
|
+
<span class='kw'>end</span></pre>
|
|
1739
|
+
</td>
|
|
1740
|
+
</tr>
|
|
1741
|
+
</table>
|
|
1742
|
+
</div>
|
|
1743
|
+
|
|
1744
|
+
<div class="method_details ">
|
|
1745
|
+
<h3 class="signature " id="get_users-instance_method">
|
|
1746
|
+
|
|
1747
|
+
#<strong>get_users</strong> ⇒ <tt>Array</tt>
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
</h3><div class="docstring">
|
|
1754
|
+
<div class="discussion">
|
|
1755
|
+
|
|
1756
|
+
<p>Get list of users</p>
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
</div>
|
|
1760
|
+
</div>
|
|
1761
|
+
<div class="tags">
|
|
1762
|
+
|
|
1763
|
+
<p class="tag_title">Returns:</p>
|
|
1764
|
+
<ul class="return">
|
|
1765
|
+
|
|
1766
|
+
<li>
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
—
|
|
1774
|
+
<div class='inline'>
|
|
1775
|
+
<p>array of user data</p>
|
|
1776
|
+
</div>
|
|
1777
|
+
|
|
1778
|
+
</li>
|
|
1779
|
+
|
|
1780
|
+
</ul>
|
|
1781
|
+
|
|
1782
|
+
</div><table class="source_code">
|
|
1783
|
+
<tr>
|
|
1784
|
+
<td>
|
|
1785
|
+
<pre class="lines">
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
28
|
|
1789
|
+
29
|
|
1790
|
+
30</pre>
|
|
1791
|
+
</td>
|
|
1792
|
+
<td>
|
|
1793
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 28</span>
|
|
1794
|
+
|
|
1795
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_users'>get_users</span>
|
|
1796
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>get_users</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1797
|
+
<span class='kw'>end</span></pre>
|
|
1798
|
+
</td>
|
|
1799
|
+
</tr>
|
|
1800
|
+
</table>
|
|
1801
|
+
</div>
|
|
1802
|
+
|
|
1803
|
+
<div class="method_details ">
|
|
1804
|
+
<h3 class="signature " id="get_users_by_permission-instance_method">
|
|
1805
|
+
|
|
1806
|
+
#<strong>get_users_by_permission</strong>(permission) ⇒ <tt>Array</tt>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
</h3><div class="docstring">
|
|
1813
|
+
<div class="discussion">
|
|
1814
|
+
|
|
1815
|
+
<p>Get users by permission</p>
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
</div>
|
|
1819
|
+
</div>
|
|
1820
|
+
<div class="tags">
|
|
1821
|
+
<p class="tag_title">Parameters:</p>
|
|
1822
|
+
<ul class="param">
|
|
1823
|
+
|
|
1824
|
+
<li>
|
|
1825
|
+
|
|
1826
|
+
<span class='name'>permission</span>
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
—
|
|
1834
|
+
<div class='inline'>
|
|
1835
|
+
<p>permission to check</p>
|
|
1836
|
+
</div>
|
|
1837
|
+
|
|
1838
|
+
</li>
|
|
1839
|
+
|
|
1840
|
+
</ul>
|
|
1841
|
+
|
|
1842
|
+
<p class="tag_title">Returns:</p>
|
|
1843
|
+
<ul class="return">
|
|
1844
|
+
|
|
1845
|
+
<li>
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
—
|
|
1853
|
+
<div class='inline'>
|
|
1854
|
+
<p>users with the specified permission</p>
|
|
1855
|
+
</div>
|
|
1856
|
+
|
|
1857
|
+
</li>
|
|
1858
|
+
|
|
1859
|
+
</ul>
|
|
1860
|
+
|
|
1861
|
+
</div><table class="source_code">
|
|
1862
|
+
<tr>
|
|
1863
|
+
<td>
|
|
1864
|
+
<pre class="lines">
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
36
|
|
1868
|
+
37
|
|
1869
|
+
38</pre>
|
|
1870
|
+
</td>
|
|
1871
|
+
<td>
|
|
1872
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 36</span>
|
|
1873
|
+
|
|
1874
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_users_by_permission'>get_users_by_permission</span><span class='lparen'>(</span><span class='id identifier rubyid_permission'>permission</span><span class='rparen'>)</span>
|
|
1875
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>get_users_by_permission</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_permission'>permission</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1876
|
+
<span class='kw'>end</span></pre>
|
|
1877
|
+
</td>
|
|
1878
|
+
</tr>
|
|
1879
|
+
</table>
|
|
1880
|
+
</div>
|
|
1881
|
+
|
|
1882
|
+
<div class="method_details ">
|
|
1883
|
+
<h3 class="signature " id="login-instance_method">
|
|
1884
|
+
|
|
1885
|
+
#<strong>login</strong>(username, password) ⇒ <tt>String</tt>
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
</h3><div class="docstring">
|
|
1892
|
+
<div class="discussion">
|
|
1893
|
+
|
|
1894
|
+
<p>Login and get a session key</p>
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
</div>
|
|
1898
|
+
</div>
|
|
1899
|
+
<div class="tags">
|
|
1900
|
+
<p class="tag_title">Parameters:</p>
|
|
1901
|
+
<ul class="param">
|
|
1902
|
+
|
|
1903
|
+
<li>
|
|
1904
|
+
|
|
1905
|
+
<span class='name'>username</span>
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
—
|
|
1913
|
+
<div class='inline'>
|
|
1914
|
+
<p>username</p>
|
|
1915
|
+
</div>
|
|
1916
|
+
|
|
1917
|
+
</li>
|
|
1918
|
+
|
|
1919
|
+
<li>
|
|
1920
|
+
|
|
1921
|
+
<span class='name'>password</span>
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
—
|
|
1929
|
+
<div class='inline'>
|
|
1930
|
+
<p>password</p>
|
|
1931
|
+
</div>
|
|
1932
|
+
|
|
1933
|
+
</li>
|
|
1934
|
+
|
|
1935
|
+
</ul>
|
|
1936
|
+
|
|
1937
|
+
<p class="tag_title">Returns:</p>
|
|
1938
|
+
<ul class="return">
|
|
1939
|
+
|
|
1940
|
+
<li>
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
—
|
|
1948
|
+
<div class='inline'>
|
|
1949
|
+
<p>session key for subsequent requests</p>
|
|
1950
|
+
</div>
|
|
1951
|
+
|
|
1952
|
+
</li>
|
|
1953
|
+
|
|
1954
|
+
</ul>
|
|
1955
|
+
|
|
1956
|
+
</div><table class="source_code">
|
|
1957
|
+
<tr>
|
|
1958
|
+
<td>
|
|
1959
|
+
<pre class="lines">
|
|
1960
|
+
|
|
1961
|
+
|
|
1962
|
+
54
|
|
1963
|
+
55
|
|
1964
|
+
56
|
|
1965
|
+
57
|
|
1966
|
+
58
|
|
1967
|
+
59
|
|
1968
|
+
60
|
|
1969
|
+
61
|
|
1970
|
+
62</pre>
|
|
1971
|
+
</td>
|
|
1972
|
+
<td>
|
|
1973
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 54</span>
|
|
1974
|
+
|
|
1975
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
|
|
1976
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>login</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
1977
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_username'>username</span><span class='comma'>,</span>
|
|
1978
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_password'>password</span>
|
|
1979
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1980
|
+
|
|
1981
|
+
<span class='comment'># The response should be a session key
|
|
1982
|
+
</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>key</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>session_key</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_response'>response</span>
|
|
1983
|
+
<span class='kw'>end</span></pre>
|
|
1984
|
+
</td>
|
|
1985
|
+
</tr>
|
|
1986
|
+
</table>
|
|
1987
|
+
</div>
|
|
1988
|
+
|
|
1989
|
+
<div class="method_details ">
|
|
1990
|
+
<h3 class="signature " id="mark_email_as_invalid-instance_method">
|
|
1991
|
+
|
|
1992
|
+
#<strong>mark_email_as_invalid</strong>(email) ⇒ <tt>Hash</tt>
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
</h3><div class="docstring">
|
|
1999
|
+
<div class="discussion">
|
|
2000
|
+
|
|
2001
|
+
<p>Mark an email as invalid</p>
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
</div>
|
|
2005
|
+
</div>
|
|
2006
|
+
<div class="tags">
|
|
2007
|
+
<p class="tag_title">Parameters:</p>
|
|
2008
|
+
<ul class="param">
|
|
2009
|
+
|
|
2010
|
+
<li>
|
|
2011
|
+
|
|
2012
|
+
<span class='name'>email</span>
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
—
|
|
2020
|
+
<div class='inline'>
|
|
2021
|
+
<p>email address to mark as invalid</p>
|
|
2022
|
+
</div>
|
|
2023
|
+
|
|
2024
|
+
</li>
|
|
2025
|
+
|
|
2026
|
+
</ul>
|
|
2027
|
+
|
|
2028
|
+
<p class="tag_title">Returns:</p>
|
|
2029
|
+
<ul class="return">
|
|
2030
|
+
|
|
2031
|
+
<li>
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
—
|
|
2039
|
+
<div class='inline'>
|
|
2040
|
+
<p>response</p>
|
|
2041
|
+
</div>
|
|
2042
|
+
|
|
2043
|
+
</li>
|
|
2044
|
+
|
|
2045
|
+
</ul>
|
|
2046
|
+
|
|
2047
|
+
</div><table class="source_code">
|
|
2048
|
+
<tr>
|
|
2049
|
+
<td>
|
|
2050
|
+
<pre class="lines">
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
68
|
|
2054
|
+
69
|
|
2055
|
+
70</pre>
|
|
2056
|
+
</td>
|
|
2057
|
+
<td>
|
|
2058
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/user.rb', line 68</span>
|
|
2059
|
+
|
|
2060
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_mark_email_as_invalid'>mark_email_as_invalid</span><span class='lparen'>(</span><span class='id identifier rubyid_email'>email</span><span class='rparen'>)</span>
|
|
2061
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>mark_email_as_invalid</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_email'>email</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2062
|
+
<span class='kw'>end</span></pre>
|
|
2063
|
+
</td>
|
|
2064
|
+
</tr>
|
|
2065
|
+
</table>
|
|
2066
|
+
</div>
|
|
2067
|
+
|
|
2068
|
+
</div>
|
|
2069
|
+
|
|
2070
|
+
</div>
|
|
2071
|
+
|
|
2072
|
+
<div id="footer">
|
|
2073
|
+
Generated on Sat May 24 15:41:23 2025 by
|
|
2074
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2075
|
+
0.9.37 (ruby-3.4.4).
|
|
2076
|
+
</div>
|
|
2077
|
+
|
|
2078
|
+
</div>
|
|
2079
|
+
</body>
|
|
2080
|
+
</html>
|