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,2487 @@
|
|
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::Search
|
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::Search";
|
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 (S)</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">Search</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::Search
|
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::Search</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/search.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Search 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_search'>search</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span>
|
117
|
+
|
118
|
+
<span class='comment'># Basic search
|
119
|
+
</span><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>cat</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
120
|
+
|
121
|
+
<span class='comment'># Advanced search with parameters
|
122
|
+
</span><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>web assets</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
123
|
+
<span class='label'>order_by:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>date</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
124
|
+
<span class='label'>sort:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>desc</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
125
|
+
<span class='label'>fetchrows:</span> <span class='int'>20</span>
|
126
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
127
|
+
|
128
|
+
<span class='comment'># Search with previews
|
129
|
+
</span><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_search_get_previews'>search_get_previews</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>images</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
130
|
+
<span class='label'>getsizes:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>col,thm,scr</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
131
|
+
<span class='label'>fetchrows:</span> <span class='int'>10</span>
|
132
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span></code></pre>
|
133
|
+
|
134
|
+
</div>
|
135
|
+
|
136
|
+
|
137
|
+
</div>
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
142
|
+
<ul class="summary">
|
143
|
+
|
144
|
+
<li class="public ">
|
145
|
+
<span class="summary_signature">
|
146
|
+
|
147
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Client </a>
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
</span>
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
<span class="note title readonly">readonly</span>
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
<span class="summary_desc"><div class='inline'>
|
167
|
+
<p>The ResourceSpace client.</p>
|
168
|
+
</div></span>
|
169
|
+
|
170
|
+
</li>
|
171
|
+
|
172
|
+
|
173
|
+
</ul>
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
<h2>
|
180
|
+
Instance Method Summary
|
181
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
182
|
+
</h2>
|
183
|
+
|
184
|
+
<ul class="summary">
|
185
|
+
|
186
|
+
<li class="public ">
|
187
|
+
<span class="summary_signature">
|
188
|
+
|
189
|
+
<a href="#advanced_search-instance_method" title="#advanced_search (instance method)">#<strong>advanced_search</strong>(criteria = {}, options = {}) ⇒ Hash </a>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
</span>
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
<span class="summary_desc"><div class='inline'>
|
204
|
+
<p>Advanced search with multiple criteria.</p>
|
205
|
+
</div></span>
|
206
|
+
|
207
|
+
</li>
|
208
|
+
|
209
|
+
|
210
|
+
<li class="private ">
|
211
|
+
<span class="summary_signature">
|
212
|
+
|
213
|
+
<a href="#build_search_params-instance_method" title="#build_search_params (instance method)">#<strong>build_search_params</strong>(search_term, options = {}) ⇒ Hash </a>
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
</span>
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
<span class="note title private">private</span>
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
<span class="summary_desc"><div class='inline'>
|
228
|
+
<p>Build search parameters hash.</p>
|
229
|
+
</div></span>
|
230
|
+
|
231
|
+
</li>
|
232
|
+
|
233
|
+
|
234
|
+
<li class="public ">
|
235
|
+
<span class="summary_signature">
|
236
|
+
|
237
|
+
<a href="#do_search-instance_method" title="#do_search (instance method)">#<strong>do_search</strong>(search_term, options = {}) ⇒ Hash </a>
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
</span>
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
<span class="summary_desc"><div class='inline'>
|
252
|
+
<p>Perform a basic search.</p>
|
253
|
+
</div></span>
|
254
|
+
|
255
|
+
</li>
|
256
|
+
|
257
|
+
|
258
|
+
<li class="private ">
|
259
|
+
<span class="summary_signature">
|
260
|
+
|
261
|
+
<a href="#format_date-instance_method" title="#format_date (instance method)">#<strong>format_date</strong>(date) ⇒ String </a>
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
</span>
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
<span class="note title private">private</span>
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
<span class="summary_desc"><div class='inline'>
|
276
|
+
<p>Format date for ResourceSpace API.</p>
|
277
|
+
</div></span>
|
278
|
+
|
279
|
+
</li>
|
280
|
+
|
281
|
+
|
282
|
+
<li class="public ">
|
283
|
+
<span class="summary_signature">
|
284
|
+
|
285
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client) ⇒ Search </a>
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
</span>
|
290
|
+
|
291
|
+
|
292
|
+
<span class="note title constructor">constructor</span>
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
<span class="summary_desc"><div class='inline'>
|
302
|
+
<p>Initialize the search interface.</p>
|
303
|
+
</div></span>
|
304
|
+
|
305
|
+
</li>
|
306
|
+
|
307
|
+
|
308
|
+
<li class="public ">
|
309
|
+
<span class="summary_signature">
|
310
|
+
|
311
|
+
<a href="#recent_resources-instance_method" title="#recent_resources (instance method)">#<strong>recent_resources</strong>(count = 10, options = {}) ⇒ Hash </a>
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
</span>
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
<span class="summary_desc"><div class='inline'>
|
326
|
+
<p>Get recently added resources.</p>
|
327
|
+
</div></span>
|
328
|
+
|
329
|
+
</li>
|
330
|
+
|
331
|
+
|
332
|
+
<li class="public ">
|
333
|
+
<span class="summary_signature">
|
334
|
+
|
335
|
+
<a href="#search_by_collection-instance_method" title="#search_by_collection (instance method)">#<strong>search_by_collection</strong>(collection_id, options = {}) ⇒ Hash </a>
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
</span>
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
<span class="summary_desc"><div class='inline'>
|
350
|
+
<p>Search resources by collection.</p>
|
351
|
+
</div></span>
|
352
|
+
|
353
|
+
</li>
|
354
|
+
|
355
|
+
|
356
|
+
<li class="public ">
|
357
|
+
<span class="summary_signature">
|
358
|
+
|
359
|
+
<a href="#search_by_date_range-instance_method" title="#search_by_date_range (instance method)">#<strong>search_by_date_range</strong>(from_date, to_date = nil, options = {}) ⇒ Hash </a>
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
</span>
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
<span class="summary_desc"><div class='inline'>
|
374
|
+
<p>Search resources by date range.</p>
|
375
|
+
</div></span>
|
376
|
+
|
377
|
+
</li>
|
378
|
+
|
379
|
+
|
380
|
+
<li class="public ">
|
381
|
+
<span class="summary_signature">
|
382
|
+
|
383
|
+
<a href="#search_by_extension-instance_method" title="#search_by_extension (instance method)">#<strong>search_by_extension</strong>(extensions, options = {}) ⇒ Hash </a>
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
</span>
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
<span class="summary_desc"><div class='inline'>
|
398
|
+
<p>Search resources by file extension.</p>
|
399
|
+
</div></span>
|
400
|
+
|
401
|
+
</li>
|
402
|
+
|
403
|
+
|
404
|
+
<li class="public ">
|
405
|
+
<span class="summary_signature">
|
406
|
+
|
407
|
+
<a href="#search_by_ids-instance_method" title="#search_by_ids (instance method)">#<strong>search_by_ids</strong>(resource_ids, options = {}) ⇒ Hash </a>
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
</span>
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
|
421
|
+
<span class="summary_desc"><div class='inline'>
|
422
|
+
<p>Search resources by resource IDs.</p>
|
423
|
+
</div></span>
|
424
|
+
|
425
|
+
</li>
|
426
|
+
|
427
|
+
|
428
|
+
<li class="public ">
|
429
|
+
<span class="summary_signature">
|
430
|
+
|
431
|
+
<a href="#search_by_tag-instance_method" title="#search_by_tag (instance method)">#<strong>search_by_tag</strong>(tag, options = {}) ⇒ Hash </a>
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
</span>
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
<span class="summary_desc"><div class='inline'>
|
446
|
+
<p>Search resources by tag.</p>
|
447
|
+
</div></span>
|
448
|
+
|
449
|
+
</li>
|
450
|
+
|
451
|
+
|
452
|
+
<li class="public ">
|
453
|
+
<span class="summary_signature">
|
454
|
+
|
455
|
+
<a href="#search_by_title-instance_method" title="#search_by_title (instance method)">#<strong>search_by_title</strong>(title, options = {}) ⇒ Hash </a>
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
</span>
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
|
469
|
+
<span class="summary_desc"><div class='inline'>
|
470
|
+
<p>Search resources by title/name.</p>
|
471
|
+
</div></span>
|
472
|
+
|
473
|
+
</li>
|
474
|
+
|
475
|
+
|
476
|
+
<li class="public ">
|
477
|
+
<span class="summary_signature">
|
478
|
+
|
479
|
+
<a href="#search_by_user-instance_method" title="#search_by_user (instance method)">#<strong>search_by_user</strong>(username, options = {}) ⇒ Hash </a>
|
480
|
+
|
481
|
+
|
482
|
+
|
483
|
+
</span>
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
|
493
|
+
<span class="summary_desc"><div class='inline'>
|
494
|
+
<p>Search resources by user.</p>
|
495
|
+
</div></span>
|
496
|
+
|
497
|
+
</li>
|
498
|
+
|
499
|
+
|
500
|
+
<li class="public ">
|
501
|
+
<span class="summary_signature">
|
502
|
+
|
503
|
+
<a href="#search_get_previews-instance_method" title="#search_get_previews (instance method)">#<strong>search_get_previews</strong>(search_term, options = {}) ⇒ Hash </a>
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
</span>
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
<span class="summary_desc"><div class='inline'>
|
518
|
+
<p>Search and get previews in one call.</p>
|
519
|
+
</div></span>
|
520
|
+
|
521
|
+
</li>
|
522
|
+
|
523
|
+
|
524
|
+
<li class="public ">
|
525
|
+
<span class="summary_signature">
|
526
|
+
|
527
|
+
<a href="#search_web_assets-instance_method" title="#search_web_assets (instance method)">#<strong>search_web_assets</strong>(asset_type = nil, options = {}) ⇒ Hash </a>
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
</span>
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
<span class="summary_desc"><div class='inline'>
|
542
|
+
<p>Search for web assets (images, CSS, JS, fonts).</p>
|
543
|
+
</div></span>
|
544
|
+
|
545
|
+
</li>
|
546
|
+
|
547
|
+
|
548
|
+
</ul>
|
549
|
+
|
550
|
+
|
551
|
+
<div id="constructor_details" class="method_details_list">
|
552
|
+
<h2>Constructor Details</h2>
|
553
|
+
|
554
|
+
<div class="method_details first">
|
555
|
+
<h3 class="signature first" id="initialize-instance_method">
|
556
|
+
|
557
|
+
#<strong>initialize</strong>(client) ⇒ <tt><span class='object_link'><a href="" title="ResourceSpace::Search (class)">Search</a></span></tt>
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
</h3><div class="docstring">
|
564
|
+
<div class="discussion">
|
565
|
+
|
566
|
+
<p>Initialize the search interface</p>
|
567
|
+
|
568
|
+
|
569
|
+
</div>
|
570
|
+
</div>
|
571
|
+
<div class="tags">
|
572
|
+
<p class="tag_title">Parameters:</p>
|
573
|
+
<ul class="param">
|
574
|
+
|
575
|
+
<li>
|
576
|
+
|
577
|
+
<span class='name'>client</span>
|
578
|
+
|
579
|
+
|
580
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
—
|
585
|
+
<div class='inline'>
|
586
|
+
<p>ResourceSpace client instance</p>
|
587
|
+
</div>
|
588
|
+
|
589
|
+
</li>
|
590
|
+
|
591
|
+
</ul>
|
592
|
+
|
593
|
+
|
594
|
+
</div><table class="source_code">
|
595
|
+
<tr>
|
596
|
+
<td>
|
597
|
+
<pre class="lines">
|
598
|
+
|
599
|
+
|
600
|
+
31
|
601
|
+
32
|
602
|
+
33</pre>
|
603
|
+
</td>
|
604
|
+
<td>
|
605
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 31</span>
|
606
|
+
|
607
|
+
<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>
|
608
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
609
|
+
<span class='kw'>end</span></pre>
|
610
|
+
</td>
|
611
|
+
</tr>
|
612
|
+
</table>
|
613
|
+
</div>
|
614
|
+
|
615
|
+
</div>
|
616
|
+
|
617
|
+
<div id="instance_attr_details" class="attr_details">
|
618
|
+
<h2>Instance Attribute Details</h2>
|
619
|
+
|
620
|
+
|
621
|
+
<span id=""></span>
|
622
|
+
<div class="method_details first">
|
623
|
+
<h3 class="signature first" id="client-instance_method">
|
624
|
+
|
625
|
+
#<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>
|
626
|
+
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
|
631
|
+
</h3><div class="docstring">
|
632
|
+
<div class="discussion">
|
633
|
+
|
634
|
+
<p>Returns the ResourceSpace client.</p>
|
635
|
+
|
636
|
+
|
637
|
+
</div>
|
638
|
+
</div>
|
639
|
+
<div class="tags">
|
640
|
+
|
641
|
+
<p class="tag_title">Returns:</p>
|
642
|
+
<ul class="return">
|
643
|
+
|
644
|
+
<li>
|
645
|
+
|
646
|
+
|
647
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
—
|
652
|
+
<div class='inline'>
|
653
|
+
<p>the ResourceSpace client</p>
|
654
|
+
</div>
|
655
|
+
|
656
|
+
</li>
|
657
|
+
|
658
|
+
</ul>
|
659
|
+
|
660
|
+
</div><table class="source_code">
|
661
|
+
<tr>
|
662
|
+
<td>
|
663
|
+
<pre class="lines">
|
664
|
+
|
665
|
+
|
666
|
+
26
|
667
|
+
27
|
668
|
+
28</pre>
|
669
|
+
</td>
|
670
|
+
<td>
|
671
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 26</span>
|
672
|
+
|
673
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
674
|
+
<span class='ivar'>@client</span>
|
675
|
+
<span class='kw'>end</span></pre>
|
676
|
+
</td>
|
677
|
+
</tr>
|
678
|
+
</table>
|
679
|
+
</div>
|
680
|
+
|
681
|
+
</div>
|
682
|
+
|
683
|
+
|
684
|
+
<div id="instance_method_details" class="method_details_list">
|
685
|
+
<h2>Instance Method Details</h2>
|
686
|
+
|
687
|
+
|
688
|
+
<div class="method_details first">
|
689
|
+
<h3 class="signature first" id="advanced_search-instance_method">
|
690
|
+
|
691
|
+
#<strong>advanced_search</strong>(criteria = {}, options = {}) ⇒ <tt>Hash</tt>
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
|
697
|
+
</h3><div class="docstring">
|
698
|
+
<div class="discussion">
|
699
|
+
|
700
|
+
<p>Advanced search with multiple criteria</p>
|
701
|
+
|
702
|
+
|
703
|
+
</div>
|
704
|
+
</div>
|
705
|
+
<div class="tags">
|
706
|
+
<p class="tag_title">Parameters:</p>
|
707
|
+
<ul class="param">
|
708
|
+
|
709
|
+
<li>
|
710
|
+
|
711
|
+
<span class='name'>criteria</span>
|
712
|
+
|
713
|
+
|
714
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
715
|
+
|
716
|
+
|
717
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
718
|
+
|
719
|
+
|
720
|
+
—
|
721
|
+
<div class='inline'>
|
722
|
+
<p>search criteria</p>
|
723
|
+
</div>
|
724
|
+
|
725
|
+
</li>
|
726
|
+
|
727
|
+
<li>
|
728
|
+
|
729
|
+
<span class='name'>options</span>
|
730
|
+
|
731
|
+
|
732
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
733
|
+
|
734
|
+
|
735
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
736
|
+
|
737
|
+
|
738
|
+
—
|
739
|
+
<div class='inline'>
|
740
|
+
<p>search options</p>
|
741
|
+
</div>
|
742
|
+
|
743
|
+
</li>
|
744
|
+
|
745
|
+
</ul>
|
746
|
+
|
747
|
+
|
748
|
+
|
749
|
+
|
750
|
+
<p class="tag_title">Options Hash (<tt>criteria</tt>):</p>
|
751
|
+
<ul class="option">
|
752
|
+
|
753
|
+
<li>
|
754
|
+
<span class="name">:title</span>
|
755
|
+
<span class="type">(<tt>String</tt>)</span>
|
756
|
+
<span class="default">
|
757
|
+
|
758
|
+
</span>
|
759
|
+
|
760
|
+
— <div class='inline'>
|
761
|
+
<p>title search</p>
|
762
|
+
</div>
|
763
|
+
|
764
|
+
</li>
|
765
|
+
|
766
|
+
<li>
|
767
|
+
<span class="name">:tag</span>
|
768
|
+
<span class="type">(<tt>String</tt>)</span>
|
769
|
+
<span class="default">
|
770
|
+
|
771
|
+
</span>
|
772
|
+
|
773
|
+
— <div class='inline'>
|
774
|
+
<p>tag search</p>
|
775
|
+
</div>
|
776
|
+
|
777
|
+
</li>
|
778
|
+
|
779
|
+
<li>
|
780
|
+
<span class="name">:user</span>
|
781
|
+
<span class="type">(<tt>String</tt>)</span>
|
782
|
+
<span class="default">
|
783
|
+
|
784
|
+
</span>
|
785
|
+
|
786
|
+
— <div class='inline'>
|
787
|
+
<p>user search</p>
|
788
|
+
</div>
|
789
|
+
|
790
|
+
</li>
|
791
|
+
|
792
|
+
<li>
|
793
|
+
<span class="name">:extensions</span>
|
794
|
+
<span class="type">(<tt>Array<String></tt>)</span>
|
795
|
+
<span class="default">
|
796
|
+
|
797
|
+
</span>
|
798
|
+
|
799
|
+
— <div class='inline'>
|
800
|
+
<p>file extensions</p>
|
801
|
+
</div>
|
802
|
+
|
803
|
+
</li>
|
804
|
+
|
805
|
+
<li>
|
806
|
+
<span class="name">:from_date</span>
|
807
|
+
<span class="type">(<tt>String</tt>)</span>
|
808
|
+
<span class="default">
|
809
|
+
|
810
|
+
</span>
|
811
|
+
|
812
|
+
— <div class='inline'>
|
813
|
+
<p>start date</p>
|
814
|
+
</div>
|
815
|
+
|
816
|
+
</li>
|
817
|
+
|
818
|
+
<li>
|
819
|
+
<span class="name">:to_date</span>
|
820
|
+
<span class="type">(<tt>String</tt>)</span>
|
821
|
+
<span class="default">
|
822
|
+
|
823
|
+
</span>
|
824
|
+
|
825
|
+
— <div class='inline'>
|
826
|
+
<p>end date</p>
|
827
|
+
</div>
|
828
|
+
|
829
|
+
</li>
|
830
|
+
|
831
|
+
</ul>
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
|
836
|
+
<p class="tag_title">Returns:</p>
|
837
|
+
<ul class="return">
|
838
|
+
|
839
|
+
<li>
|
840
|
+
|
841
|
+
|
842
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
—
|
847
|
+
<div class='inline'>
|
848
|
+
<p>search results</p>
|
849
|
+
</div>
|
850
|
+
|
851
|
+
</li>
|
852
|
+
|
853
|
+
</ul>
|
854
|
+
|
855
|
+
</div><table class="source_code">
|
856
|
+
<tr>
|
857
|
+
<td>
|
858
|
+
<pre class="lines">
|
859
|
+
|
860
|
+
|
861
|
+
199
|
862
|
+
200
|
863
|
+
201
|
864
|
+
202
|
865
|
+
203
|
866
|
+
204
|
867
|
+
205
|
868
|
+
206
|
869
|
+
207
|
870
|
+
208
|
871
|
+
209
|
872
|
+
210
|
873
|
+
211
|
874
|
+
212
|
875
|
+
213
|
876
|
+
214
|
877
|
+
215
|
878
|
+
216
|
879
|
+
217
|
880
|
+
218
|
881
|
+
219
|
882
|
+
220
|
883
|
+
221</pre>
|
884
|
+
</td>
|
885
|
+
<td>
|
886
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 199</span>
|
887
|
+
|
888
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_advanced_search'>advanced_search</span><span class='lparen'>(</span><span class='id identifier rubyid_criteria'>criteria</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
889
|
+
<span class='id identifier rubyid_search_parts'>search_parts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
890
|
+
|
891
|
+
<span class='id identifier rubyid_search_parts'>search_parts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>title:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:title</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:title</span><span class='rbracket'>]</span>
|
892
|
+
<span class='id identifier rubyid_search_parts'>search_parts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>tag:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:tag</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:tag</span><span class='rbracket'>]</span>
|
893
|
+
<span class='id identifier rubyid_search_parts'>search_parts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>user:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span>
|
894
|
+
|
895
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:extensions</span><span class='rbracket'>]</span>
|
896
|
+
<span class='id identifier rubyid_ext_search'>ext_search</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:extensions</span><span class='rbracket'>]</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_ext'>ext</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ext'>ext</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> OR </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
897
|
+
<span class='id identifier rubyid_search_parts'>search_parts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>(</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ext_search'>ext_search</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
898
|
+
<span class='kw'>end</span>
|
899
|
+
|
900
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:from_date</span><span class='rbracket'>]</span>
|
901
|
+
<span class='id identifier rubyid_date_search'>date_search</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:from_date</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
902
|
+
<span class='id identifier rubyid_date_search'>date_search</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:to_date</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:to_date</span><span class='rbracket'>]</span>
|
903
|
+
<span class='id identifier rubyid_search_parts'>search_parts</span> <span class='op'><<</span> <span class='id identifier rubyid_date_search'>date_search</span>
|
904
|
+
<span class='kw'>end</span>
|
905
|
+
|
906
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='id identifier rubyid_search_parts'>search_parts</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> AND </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
907
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_search_term'>search_term</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>&&</span> <span class='id identifier rubyid_criteria'>criteria</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span>
|
908
|
+
|
909
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
910
|
+
<span class='kw'>end</span></pre>
|
911
|
+
</td>
|
912
|
+
</tr>
|
913
|
+
</table>
|
914
|
+
</div>
|
915
|
+
|
916
|
+
<div class="method_details ">
|
917
|
+
<h3 class="signature " id="build_search_params-instance_method">
|
918
|
+
|
919
|
+
#<strong>build_search_params</strong>(search_term, options = {}) ⇒ <tt>Hash</tt> <span class="extras">(private)</span>
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
|
924
|
+
|
925
|
+
</h3><div class="docstring">
|
926
|
+
<div class="discussion">
|
927
|
+
|
928
|
+
<p>Build search parameters hash</p>
|
929
|
+
|
930
|
+
|
931
|
+
</div>
|
932
|
+
</div>
|
933
|
+
<div class="tags">
|
934
|
+
<p class="tag_title">Parameters:</p>
|
935
|
+
<ul class="param">
|
936
|
+
|
937
|
+
<li>
|
938
|
+
|
939
|
+
<span class='name'>search_term</span>
|
940
|
+
|
941
|
+
|
942
|
+
<span class='type'>(<tt>String</tt>)</span>
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
—
|
947
|
+
<div class='inline'>
|
948
|
+
<p>search term</p>
|
949
|
+
</div>
|
950
|
+
|
951
|
+
</li>
|
952
|
+
|
953
|
+
<li>
|
954
|
+
|
955
|
+
<span class='name'>options</span>
|
956
|
+
|
957
|
+
|
958
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
959
|
+
|
960
|
+
|
961
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
962
|
+
|
963
|
+
|
964
|
+
—
|
965
|
+
<div class='inline'>
|
966
|
+
<p>search options</p>
|
967
|
+
</div>
|
968
|
+
|
969
|
+
</li>
|
970
|
+
|
971
|
+
</ul>
|
972
|
+
|
973
|
+
<p class="tag_title">Returns:</p>
|
974
|
+
<ul class="return">
|
975
|
+
|
976
|
+
<li>
|
977
|
+
|
978
|
+
|
979
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
—
|
984
|
+
<div class='inline'>
|
985
|
+
<p>parameters hash</p>
|
986
|
+
</div>
|
987
|
+
|
988
|
+
</li>
|
989
|
+
|
990
|
+
</ul>
|
991
|
+
|
992
|
+
</div><table class="source_code">
|
993
|
+
<tr>
|
994
|
+
<td>
|
995
|
+
<pre class="lines">
|
996
|
+
|
997
|
+
|
998
|
+
230
|
999
|
+
231
|
1000
|
+
232
|
1001
|
+
233
|
1002
|
+
234
|
1003
|
+
235
|
1004
|
+
236
|
1005
|
+
237
|
1006
|
+
238
|
1007
|
+
239
|
1008
|
+
240
|
1009
|
+
241
|
1010
|
+
242</pre>
|
1011
|
+
</td>
|
1012
|
+
<td>
|
1013
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 230</span>
|
1014
|
+
|
1015
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_build_search_params'>build_search_params</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1016
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_search_term'>search_term</span> <span class='rbrace'>}</span>
|
1017
|
+
|
1018
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param2</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:restypes</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:restypes</span><span class='rbracket'>]</span>
|
1019
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param3</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:order_by</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:order_by</span><span class='rbracket'>]</span>
|
1020
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param4</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:offset</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:offset</span><span class='rbracket'>]</span>
|
1021
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param5</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fetchrows</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fetchrows</span><span class='rbracket'>]</span>
|
1022
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param6</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:sort</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:sort</span><span class='rbracket'>]</span>
|
1023
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param7</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:archive</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:archive</span><span class='rbracket'>]</span>
|
1024
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param8</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:daylimit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:daylimit</span><span class='rbracket'>]</span>
|
1025
|
+
|
1026
|
+
<span class='id identifier rubyid_params'>params</span>
|
1027
|
+
<span class='kw'>end</span></pre>
|
1028
|
+
</td>
|
1029
|
+
</tr>
|
1030
|
+
</table>
|
1031
|
+
</div>
|
1032
|
+
|
1033
|
+
<div class="method_details ">
|
1034
|
+
<h3 class="signature " id="do_search-instance_method">
|
1035
|
+
|
1036
|
+
#<strong>do_search</strong>(search_term, options = {}) ⇒ <tt>Hash</tt>
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
|
1042
|
+
</h3><div class="docstring">
|
1043
|
+
<div class="discussion">
|
1044
|
+
|
1045
|
+
<p>Perform a basic search</p>
|
1046
|
+
|
1047
|
+
|
1048
|
+
</div>
|
1049
|
+
</div>
|
1050
|
+
<div class="tags">
|
1051
|
+
<p class="tag_title">Parameters:</p>
|
1052
|
+
<ul class="param">
|
1053
|
+
|
1054
|
+
<li>
|
1055
|
+
|
1056
|
+
<span class='name'>search_term</span>
|
1057
|
+
|
1058
|
+
|
1059
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1060
|
+
|
1061
|
+
|
1062
|
+
|
1063
|
+
—
|
1064
|
+
<div class='inline'>
|
1065
|
+
<p>search term</p>
|
1066
|
+
</div>
|
1067
|
+
|
1068
|
+
</li>
|
1069
|
+
|
1070
|
+
<li>
|
1071
|
+
|
1072
|
+
<span class='name'>options</span>
|
1073
|
+
|
1074
|
+
|
1075
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1076
|
+
|
1077
|
+
|
1078
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1079
|
+
|
1080
|
+
|
1081
|
+
—
|
1082
|
+
<div class='inline'>
|
1083
|
+
<p>search options</p>
|
1084
|
+
</div>
|
1085
|
+
|
1086
|
+
</li>
|
1087
|
+
|
1088
|
+
</ul>
|
1089
|
+
|
1090
|
+
|
1091
|
+
|
1092
|
+
|
1093
|
+
|
1094
|
+
|
1095
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
1096
|
+
<ul class="option">
|
1097
|
+
|
1098
|
+
<li>
|
1099
|
+
<span class="name">:restypes</span>
|
1100
|
+
<span class="type">(<tt>String</tt>)</span>
|
1101
|
+
<span class="default">
|
1102
|
+
|
1103
|
+
</span>
|
1104
|
+
|
1105
|
+
— <div class='inline'>
|
1106
|
+
<p>resource types to search (e.g., “1,2,3”)</p>
|
1107
|
+
</div>
|
1108
|
+
|
1109
|
+
</li>
|
1110
|
+
|
1111
|
+
<li>
|
1112
|
+
<span class="name">:order_by</span>
|
1113
|
+
<span class="type">(<tt>String</tt>)</span>
|
1114
|
+
<span class="default">
|
1115
|
+
|
1116
|
+
</span>
|
1117
|
+
|
1118
|
+
— <div class='inline'>
|
1119
|
+
<p>field to order by (“relevance”, “popularity”, “date”, “colour”, “country”, “title”, “file_path”, “resourceid”, “extension”, “user”, “created”)</p>
|
1120
|
+
</div>
|
1121
|
+
|
1122
|
+
</li>
|
1123
|
+
|
1124
|
+
<li>
|
1125
|
+
<span class="name">:sort</span>
|
1126
|
+
<span class="type">(<tt>String</tt>)</span>
|
1127
|
+
<span class="default">
|
1128
|
+
|
1129
|
+
</span>
|
1130
|
+
|
1131
|
+
— <div class='inline'>
|
1132
|
+
<p>sort direction (“asc” or “desc”)</p>
|
1133
|
+
</div>
|
1134
|
+
|
1135
|
+
</li>
|
1136
|
+
|
1137
|
+
<li>
|
1138
|
+
<span class="name">:offset</span>
|
1139
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1140
|
+
<span class="default">
|
1141
|
+
|
1142
|
+
</span>
|
1143
|
+
|
1144
|
+
— <div class='inline'>
|
1145
|
+
<p>starting offset for results</p>
|
1146
|
+
</div>
|
1147
|
+
|
1148
|
+
</li>
|
1149
|
+
|
1150
|
+
<li>
|
1151
|
+
<span class="name">:fetchrows</span>
|
1152
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1153
|
+
<span class="default">
|
1154
|
+
|
1155
|
+
</span>
|
1156
|
+
|
1157
|
+
— <div class='inline'>
|
1158
|
+
<p>number of results to fetch</p>
|
1159
|
+
</div>
|
1160
|
+
|
1161
|
+
</li>
|
1162
|
+
|
1163
|
+
<li>
|
1164
|
+
<span class="name">:archive</span>
|
1165
|
+
<span class="type">(<tt>String</tt>)</span>
|
1166
|
+
<span class="default">
|
1167
|
+
|
1168
|
+
</span>
|
1169
|
+
|
1170
|
+
— <div class='inline'>
|
1171
|
+
<p>archive status (“0” = live resources, “1” = archived, “2” = both)</p>
|
1172
|
+
</div>
|
1173
|
+
|
1174
|
+
</li>
|
1175
|
+
|
1176
|
+
<li>
|
1177
|
+
<span class="name">:daylimit</span>
|
1178
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1179
|
+
<span class="default">
|
1180
|
+
|
1181
|
+
</span>
|
1182
|
+
|
1183
|
+
— <div class='inline'>
|
1184
|
+
<p>only return resources modified in the last X days</p>
|
1185
|
+
</div>
|
1186
|
+
|
1187
|
+
</li>
|
1188
|
+
|
1189
|
+
</ul>
|
1190
|
+
|
1191
|
+
|
1192
|
+
<p class="tag_title">Returns:</p>
|
1193
|
+
<ul class="return">
|
1194
|
+
|
1195
|
+
<li>
|
1196
|
+
|
1197
|
+
|
1198
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1199
|
+
|
1200
|
+
|
1201
|
+
|
1202
|
+
—
|
1203
|
+
<div class='inline'>
|
1204
|
+
<p>search results</p>
|
1205
|
+
</div>
|
1206
|
+
|
1207
|
+
</li>
|
1208
|
+
|
1209
|
+
</ul>
|
1210
|
+
|
1211
|
+
</div><table class="source_code">
|
1212
|
+
<tr>
|
1213
|
+
<td>
|
1214
|
+
<pre class="lines">
|
1215
|
+
|
1216
|
+
|
1217
|
+
47
|
1218
|
+
48
|
1219
|
+
49
|
1220
|
+
50</pre>
|
1221
|
+
</td>
|
1222
|
+
<td>
|
1223
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 47</span>
|
1224
|
+
|
1225
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1226
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_build_search_params'>build_search_params</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1227
|
+
<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'>do_search</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
1228
|
+
<span class='kw'>end</span></pre>
|
1229
|
+
</td>
|
1230
|
+
</tr>
|
1231
|
+
</table>
|
1232
|
+
</div>
|
1233
|
+
|
1234
|
+
<div class="method_details ">
|
1235
|
+
<h3 class="signature " id="format_date-instance_method">
|
1236
|
+
|
1237
|
+
#<strong>format_date</strong>(date) ⇒ <tt>String</tt> <span class="extras">(private)</span>
|
1238
|
+
|
1239
|
+
|
1240
|
+
|
1241
|
+
|
1242
|
+
|
1243
|
+
</h3><div class="docstring">
|
1244
|
+
<div class="discussion">
|
1245
|
+
|
1246
|
+
<p>Format date for ResourceSpace API</p>
|
1247
|
+
|
1248
|
+
|
1249
|
+
</div>
|
1250
|
+
</div>
|
1251
|
+
<div class="tags">
|
1252
|
+
<p class="tag_title">Parameters:</p>
|
1253
|
+
<ul class="param">
|
1254
|
+
|
1255
|
+
<li>
|
1256
|
+
|
1257
|
+
<span class='name'>date</span>
|
1258
|
+
|
1259
|
+
|
1260
|
+
<span class='type'>(<tt>Date</tt>, <tt>String</tt>)</span>
|
1261
|
+
|
1262
|
+
|
1263
|
+
|
1264
|
+
—
|
1265
|
+
<div class='inline'>
|
1266
|
+
<p>date to format</p>
|
1267
|
+
</div>
|
1268
|
+
|
1269
|
+
</li>
|
1270
|
+
|
1271
|
+
</ul>
|
1272
|
+
|
1273
|
+
<p class="tag_title">Returns:</p>
|
1274
|
+
<ul class="return">
|
1275
|
+
|
1276
|
+
<li>
|
1277
|
+
|
1278
|
+
|
1279
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1280
|
+
|
1281
|
+
|
1282
|
+
|
1283
|
+
—
|
1284
|
+
<div class='inline'>
|
1285
|
+
<p>formatted date string</p>
|
1286
|
+
</div>
|
1287
|
+
|
1288
|
+
</li>
|
1289
|
+
|
1290
|
+
</ul>
|
1291
|
+
|
1292
|
+
</div><table class="source_code">
|
1293
|
+
<tr>
|
1294
|
+
<td>
|
1295
|
+
<pre class="lines">
|
1296
|
+
|
1297
|
+
|
1298
|
+
248
|
1299
|
+
249
|
1300
|
+
250
|
1301
|
+
251
|
1302
|
+
252
|
1303
|
+
253
|
1304
|
+
254
|
1305
|
+
255
|
1306
|
+
256
|
1307
|
+
257</pre>
|
1308
|
+
</td>
|
1309
|
+
<td>
|
1310
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 248</span>
|
1311
|
+
|
1312
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span>
|
1313
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_date'>date</span>
|
1314
|
+
<span class='kw'>when</span> <span class='const'>Date</span>
|
1315
|
+
<span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%Y-%m-%d</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1316
|
+
<span class='kw'>when</span> <span class='const'>Time</span>
|
1317
|
+
<span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%Y-%m-%d</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1318
|
+
<span class='kw'>else</span>
|
1319
|
+
<span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
1320
|
+
<span class='kw'>end</span>
|
1321
|
+
<span class='kw'>end</span></pre>
|
1322
|
+
</td>
|
1323
|
+
</tr>
|
1324
|
+
</table>
|
1325
|
+
</div>
|
1326
|
+
|
1327
|
+
<div class="method_details ">
|
1328
|
+
<h3 class="signature " id="recent_resources-instance_method">
|
1329
|
+
|
1330
|
+
#<strong>recent_resources</strong>(count = 10, options = {}) ⇒ <tt>Hash</tt>
|
1331
|
+
|
1332
|
+
|
1333
|
+
|
1334
|
+
|
1335
|
+
|
1336
|
+
</h3><div class="docstring">
|
1337
|
+
<div class="discussion">
|
1338
|
+
|
1339
|
+
<p>Get recently added resources</p>
|
1340
|
+
|
1341
|
+
|
1342
|
+
</div>
|
1343
|
+
</div>
|
1344
|
+
<div class="tags">
|
1345
|
+
<p class="tag_title">Parameters:</p>
|
1346
|
+
<ul class="param">
|
1347
|
+
|
1348
|
+
<li>
|
1349
|
+
|
1350
|
+
<span class='name'>count</span>
|
1351
|
+
|
1352
|
+
|
1353
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1354
|
+
|
1355
|
+
|
1356
|
+
<em class="default">(defaults to: <tt>10</tt>)</em>
|
1357
|
+
|
1358
|
+
|
1359
|
+
—
|
1360
|
+
<div class='inline'>
|
1361
|
+
<p>number of recent resources to return</p>
|
1362
|
+
</div>
|
1363
|
+
|
1364
|
+
</li>
|
1365
|
+
|
1366
|
+
<li>
|
1367
|
+
|
1368
|
+
<span class='name'>options</span>
|
1369
|
+
|
1370
|
+
|
1371
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1372
|
+
|
1373
|
+
|
1374
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1375
|
+
|
1376
|
+
|
1377
|
+
—
|
1378
|
+
<div class='inline'>
|
1379
|
+
<p>search options</p>
|
1380
|
+
</div>
|
1381
|
+
|
1382
|
+
</li>
|
1383
|
+
|
1384
|
+
</ul>
|
1385
|
+
|
1386
|
+
<p class="tag_title">Returns:</p>
|
1387
|
+
<ul class="return">
|
1388
|
+
|
1389
|
+
<li>
|
1390
|
+
|
1391
|
+
|
1392
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1393
|
+
|
1394
|
+
|
1395
|
+
|
1396
|
+
—
|
1397
|
+
<div class='inline'>
|
1398
|
+
<p>search results</p>
|
1399
|
+
</div>
|
1400
|
+
|
1401
|
+
</li>
|
1402
|
+
|
1403
|
+
</ul>
|
1404
|
+
|
1405
|
+
</div><table class="source_code">
|
1406
|
+
<tr>
|
1407
|
+
<td>
|
1408
|
+
<pre class="lines">
|
1409
|
+
|
1410
|
+
|
1411
|
+
153
|
1412
|
+
154
|
1413
|
+
155
|
1414
|
+
156</pre>
|
1415
|
+
</td>
|
1416
|
+
<td>
|
1417
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 153</span>
|
1418
|
+
|
1419
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_recent_resources'>recent_resources</span><span class='lparen'>(</span><span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>10</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1420
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>!last</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_count'>count</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1421
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1422
|
+
<span class='kw'>end</span></pre>
|
1423
|
+
</td>
|
1424
|
+
</tr>
|
1425
|
+
</table>
|
1426
|
+
</div>
|
1427
|
+
|
1428
|
+
<div class="method_details ">
|
1429
|
+
<h3 class="signature " id="search_by_collection-instance_method">
|
1430
|
+
|
1431
|
+
#<strong>search_by_collection</strong>(collection_id, options = {}) ⇒ <tt>Hash</tt>
|
1432
|
+
|
1433
|
+
|
1434
|
+
|
1435
|
+
|
1436
|
+
|
1437
|
+
</h3><div class="docstring">
|
1438
|
+
<div class="discussion">
|
1439
|
+
|
1440
|
+
<p>Search resources by collection</p>
|
1441
|
+
|
1442
|
+
|
1443
|
+
</div>
|
1444
|
+
</div>
|
1445
|
+
<div class="tags">
|
1446
|
+
<p class="tag_title">Parameters:</p>
|
1447
|
+
<ul class="param">
|
1448
|
+
|
1449
|
+
<li>
|
1450
|
+
|
1451
|
+
<span class='name'>collection_id</span>
|
1452
|
+
|
1453
|
+
|
1454
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1455
|
+
|
1456
|
+
|
1457
|
+
|
1458
|
+
—
|
1459
|
+
<div class='inline'>
|
1460
|
+
<p>collection ID</p>
|
1461
|
+
</div>
|
1462
|
+
|
1463
|
+
</li>
|
1464
|
+
|
1465
|
+
<li>
|
1466
|
+
|
1467
|
+
<span class='name'>options</span>
|
1468
|
+
|
1469
|
+
|
1470
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1471
|
+
|
1472
|
+
|
1473
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1474
|
+
|
1475
|
+
|
1476
|
+
—
|
1477
|
+
<div class='inline'>
|
1478
|
+
<p>search options</p>
|
1479
|
+
</div>
|
1480
|
+
|
1481
|
+
</li>
|
1482
|
+
|
1483
|
+
</ul>
|
1484
|
+
|
1485
|
+
<p class="tag_title">Returns:</p>
|
1486
|
+
<ul class="return">
|
1487
|
+
|
1488
|
+
<li>
|
1489
|
+
|
1490
|
+
|
1491
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1492
|
+
|
1493
|
+
|
1494
|
+
|
1495
|
+
—
|
1496
|
+
<div class='inline'>
|
1497
|
+
<p>search results</p>
|
1498
|
+
</div>
|
1499
|
+
|
1500
|
+
</li>
|
1501
|
+
|
1502
|
+
</ul>
|
1503
|
+
|
1504
|
+
</div><table class="source_code">
|
1505
|
+
<tr>
|
1506
|
+
<td>
|
1507
|
+
<pre class="lines">
|
1508
|
+
|
1509
|
+
|
1510
|
+
132
|
1511
|
+
133
|
1512
|
+
134
|
1513
|
+
135</pre>
|
1514
|
+
</td>
|
1515
|
+
<td>
|
1516
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 132</span>
|
1517
|
+
|
1518
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_collection'>search_by_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1519
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>!collection</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1520
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1521
|
+
<span class='kw'>end</span></pre>
|
1522
|
+
</td>
|
1523
|
+
</tr>
|
1524
|
+
</table>
|
1525
|
+
</div>
|
1526
|
+
|
1527
|
+
<div class="method_details ">
|
1528
|
+
<h3 class="signature " id="search_by_date_range-instance_method">
|
1529
|
+
|
1530
|
+
#<strong>search_by_date_range</strong>(from_date, to_date = nil, options = {}) ⇒ <tt>Hash</tt>
|
1531
|
+
|
1532
|
+
|
1533
|
+
|
1534
|
+
|
1535
|
+
|
1536
|
+
</h3><div class="docstring">
|
1537
|
+
<div class="discussion">
|
1538
|
+
|
1539
|
+
<p>Search resources by date range</p>
|
1540
|
+
|
1541
|
+
|
1542
|
+
</div>
|
1543
|
+
</div>
|
1544
|
+
<div class="tags">
|
1545
|
+
<p class="tag_title">Parameters:</p>
|
1546
|
+
<ul class="param">
|
1547
|
+
|
1548
|
+
<li>
|
1549
|
+
|
1550
|
+
<span class='name'>from_date</span>
|
1551
|
+
|
1552
|
+
|
1553
|
+
<span class='type'>(<tt>Date</tt>, <tt>String</tt>)</span>
|
1554
|
+
|
1555
|
+
|
1556
|
+
|
1557
|
+
—
|
1558
|
+
<div class='inline'>
|
1559
|
+
<p>start date (YYYY-MM-DD format)</p>
|
1560
|
+
</div>
|
1561
|
+
|
1562
|
+
</li>
|
1563
|
+
|
1564
|
+
<li>
|
1565
|
+
|
1566
|
+
<span class='name'>to_date</span>
|
1567
|
+
|
1568
|
+
|
1569
|
+
<span class='type'>(<tt>Date</tt>, <tt>String</tt>)</span>
|
1570
|
+
|
1571
|
+
|
1572
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1573
|
+
|
1574
|
+
|
1575
|
+
—
|
1576
|
+
<div class='inline'>
|
1577
|
+
<p>end date (YYYY-MM-DD format)</p>
|
1578
|
+
</div>
|
1579
|
+
|
1580
|
+
</li>
|
1581
|
+
|
1582
|
+
<li>
|
1583
|
+
|
1584
|
+
<span class='name'>options</span>
|
1585
|
+
|
1586
|
+
|
1587
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1588
|
+
|
1589
|
+
|
1590
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1591
|
+
|
1592
|
+
|
1593
|
+
—
|
1594
|
+
<div class='inline'>
|
1595
|
+
<p>search options</p>
|
1596
|
+
</div>
|
1597
|
+
|
1598
|
+
</li>
|
1599
|
+
|
1600
|
+
</ul>
|
1601
|
+
|
1602
|
+
<p class="tag_title">Returns:</p>
|
1603
|
+
<ul class="return">
|
1604
|
+
|
1605
|
+
<li>
|
1606
|
+
|
1607
|
+
|
1608
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1609
|
+
|
1610
|
+
|
1611
|
+
|
1612
|
+
—
|
1613
|
+
<div class='inline'>
|
1614
|
+
<p>search results</p>
|
1615
|
+
</div>
|
1616
|
+
|
1617
|
+
</li>
|
1618
|
+
|
1619
|
+
</ul>
|
1620
|
+
|
1621
|
+
</div><table class="source_code">
|
1622
|
+
<tr>
|
1623
|
+
<td>
|
1624
|
+
<pre class="lines">
|
1625
|
+
|
1626
|
+
|
1627
|
+
117
|
1628
|
+
118
|
1629
|
+
119
|
1630
|
+
120
|
1631
|
+
121
|
1632
|
+
122
|
1633
|
+
123
|
1634
|
+
124
|
1635
|
+
125</pre>
|
1636
|
+
</td>
|
1637
|
+
<td>
|
1638
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 117</span>
|
1639
|
+
|
1640
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_date_range'>search_by_date_range</span><span class='lparen'>(</span><span class='id identifier rubyid_from_date'>from_date</span><span class='comma'>,</span> <span class='id identifier rubyid_to_date'>to_date</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1641
|
+
<span class='id identifier rubyid_from_str'>from_str</span> <span class='op'>=</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_from_date'>from_date</span><span class='rparen'>)</span>
|
1642
|
+
<span class='id identifier rubyid_to_str'>to_str</span> <span class='op'>=</span> <span class='id identifier rubyid_to_date'>to_date</span> <span class='op'>?</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_to_date'>to_date</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_from_str'>from_str</span>
|
1643
|
+
|
1644
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_from_str'>from_str</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1645
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_to_str'>to_str</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_to_date'>to_date</span>
|
1646
|
+
|
1647
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1648
|
+
<span class='kw'>end</span></pre>
|
1649
|
+
</td>
|
1650
|
+
</tr>
|
1651
|
+
</table>
|
1652
|
+
</div>
|
1653
|
+
|
1654
|
+
<div class="method_details ">
|
1655
|
+
<h3 class="signature " id="search_by_extension-instance_method">
|
1656
|
+
|
1657
|
+
#<strong>search_by_extension</strong>(extensions, options = {}) ⇒ <tt>Hash</tt>
|
1658
|
+
|
1659
|
+
|
1660
|
+
|
1661
|
+
|
1662
|
+
|
1663
|
+
</h3><div class="docstring">
|
1664
|
+
<div class="discussion">
|
1665
|
+
|
1666
|
+
<p>Search resources by file extension</p>
|
1667
|
+
|
1668
|
+
|
1669
|
+
</div>
|
1670
|
+
</div>
|
1671
|
+
<div class="tags">
|
1672
|
+
<p class="tag_title">Parameters:</p>
|
1673
|
+
<ul class="param">
|
1674
|
+
|
1675
|
+
<li>
|
1676
|
+
|
1677
|
+
<span class='name'>extensions</span>
|
1678
|
+
|
1679
|
+
|
1680
|
+
<span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
|
1681
|
+
|
1682
|
+
|
1683
|
+
|
1684
|
+
—
|
1685
|
+
<div class='inline'>
|
1686
|
+
<p>file extension(s) to search for</p>
|
1687
|
+
</div>
|
1688
|
+
|
1689
|
+
</li>
|
1690
|
+
|
1691
|
+
<li>
|
1692
|
+
|
1693
|
+
<span class='name'>options</span>
|
1694
|
+
|
1695
|
+
|
1696
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1697
|
+
|
1698
|
+
|
1699
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1700
|
+
|
1701
|
+
|
1702
|
+
—
|
1703
|
+
<div class='inline'>
|
1704
|
+
<p>search options</p>
|
1705
|
+
</div>
|
1706
|
+
|
1707
|
+
</li>
|
1708
|
+
|
1709
|
+
</ul>
|
1710
|
+
|
1711
|
+
<p class="tag_title">Returns:</p>
|
1712
|
+
<ul class="return">
|
1713
|
+
|
1714
|
+
<li>
|
1715
|
+
|
1716
|
+
|
1717
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1718
|
+
|
1719
|
+
|
1720
|
+
|
1721
|
+
—
|
1722
|
+
<div class='inline'>
|
1723
|
+
<p>search results</p>
|
1724
|
+
</div>
|
1725
|
+
|
1726
|
+
</li>
|
1727
|
+
|
1728
|
+
</ul>
|
1729
|
+
|
1730
|
+
</div><table class="source_code">
|
1731
|
+
<tr>
|
1732
|
+
<td>
|
1733
|
+
<pre class="lines">
|
1734
|
+
|
1735
|
+
|
1736
|
+
104
|
1737
|
+
105
|
1738
|
+
106
|
1739
|
+
107
|
1740
|
+
108
|
1741
|
+
109</pre>
|
1742
|
+
</td>
|
1743
|
+
<td>
|
1744
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 104</span>
|
1745
|
+
|
1746
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_extension'>search_by_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_extensions'>extensions</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1747
|
+
<span class='id identifier rubyid_extensions'>extensions</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_extensions'>extensions</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
|
1748
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='id identifier rubyid_extensions'>extensions</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_ext'>ext</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ext'>ext</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> OR </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1749
|
+
|
1750
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1751
|
+
<span class='kw'>end</span></pre>
|
1752
|
+
</td>
|
1753
|
+
</tr>
|
1754
|
+
</table>
|
1755
|
+
</div>
|
1756
|
+
|
1757
|
+
<div class="method_details ">
|
1758
|
+
<h3 class="signature " id="search_by_ids-instance_method">
|
1759
|
+
|
1760
|
+
#<strong>search_by_ids</strong>(resource_ids, options = {}) ⇒ <tt>Hash</tt>
|
1761
|
+
|
1762
|
+
|
1763
|
+
|
1764
|
+
|
1765
|
+
|
1766
|
+
</h3><div class="docstring">
|
1767
|
+
<div class="discussion">
|
1768
|
+
|
1769
|
+
<p>Search resources by resource IDs</p>
|
1770
|
+
|
1771
|
+
|
1772
|
+
</div>
|
1773
|
+
</div>
|
1774
|
+
<div class="tags">
|
1775
|
+
<p class="tag_title">Parameters:</p>
|
1776
|
+
<ul class="param">
|
1777
|
+
|
1778
|
+
<li>
|
1779
|
+
|
1780
|
+
<span class='name'>resource_ids</span>
|
1781
|
+
|
1782
|
+
|
1783
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
1784
|
+
|
1785
|
+
|
1786
|
+
|
1787
|
+
—
|
1788
|
+
<div class='inline'>
|
1789
|
+
<p>array of resource IDs</p>
|
1790
|
+
</div>
|
1791
|
+
|
1792
|
+
</li>
|
1793
|
+
|
1794
|
+
<li>
|
1795
|
+
|
1796
|
+
<span class='name'>options</span>
|
1797
|
+
|
1798
|
+
|
1799
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1800
|
+
|
1801
|
+
|
1802
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1803
|
+
|
1804
|
+
|
1805
|
+
—
|
1806
|
+
<div class='inline'>
|
1807
|
+
<p>search options</p>
|
1808
|
+
</div>
|
1809
|
+
|
1810
|
+
</li>
|
1811
|
+
|
1812
|
+
</ul>
|
1813
|
+
|
1814
|
+
<p class="tag_title">Returns:</p>
|
1815
|
+
<ul class="return">
|
1816
|
+
|
1817
|
+
<li>
|
1818
|
+
|
1819
|
+
|
1820
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1821
|
+
|
1822
|
+
|
1823
|
+
|
1824
|
+
—
|
1825
|
+
<div class='inline'>
|
1826
|
+
<p>search results</p>
|
1827
|
+
</div>
|
1828
|
+
|
1829
|
+
</li>
|
1830
|
+
|
1831
|
+
</ul>
|
1832
|
+
|
1833
|
+
</div><table class="source_code">
|
1834
|
+
<tr>
|
1835
|
+
<td>
|
1836
|
+
<pre class="lines">
|
1837
|
+
|
1838
|
+
|
1839
|
+
142
|
1840
|
+
143
|
1841
|
+
144
|
1842
|
+
145
|
1843
|
+
146</pre>
|
1844
|
+
</td>
|
1845
|
+
<td>
|
1846
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 142</span>
|
1847
|
+
|
1848
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_ids'>search_by_ids</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_ids'>resource_ids</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1849
|
+
<span class='id identifier rubyid_ids'>ids</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_ids'>resource_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>:</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1850
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>!list</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ids'>ids</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1851
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1852
|
+
<span class='kw'>end</span></pre>
|
1853
|
+
</td>
|
1854
|
+
</tr>
|
1855
|
+
</table>
|
1856
|
+
</div>
|
1857
|
+
|
1858
|
+
<div class="method_details ">
|
1859
|
+
<h3 class="signature " id="search_by_tag-instance_method">
|
1860
|
+
|
1861
|
+
#<strong>search_by_tag</strong>(tag, options = {}) ⇒ <tt>Hash</tt>
|
1862
|
+
|
1863
|
+
|
1864
|
+
|
1865
|
+
|
1866
|
+
|
1867
|
+
</h3><div class="docstring">
|
1868
|
+
<div class="discussion">
|
1869
|
+
|
1870
|
+
<p>Search resources by tag</p>
|
1871
|
+
|
1872
|
+
|
1873
|
+
</div>
|
1874
|
+
</div>
|
1875
|
+
<div class="tags">
|
1876
|
+
<p class="tag_title">Parameters:</p>
|
1877
|
+
<ul class="param">
|
1878
|
+
|
1879
|
+
<li>
|
1880
|
+
|
1881
|
+
<span class='name'>tag</span>
|
1882
|
+
|
1883
|
+
|
1884
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1885
|
+
|
1886
|
+
|
1887
|
+
|
1888
|
+
—
|
1889
|
+
<div class='inline'>
|
1890
|
+
<p>tag name</p>
|
1891
|
+
</div>
|
1892
|
+
|
1893
|
+
</li>
|
1894
|
+
|
1895
|
+
<li>
|
1896
|
+
|
1897
|
+
<span class='name'>options</span>
|
1898
|
+
|
1899
|
+
|
1900
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1901
|
+
|
1902
|
+
|
1903
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1904
|
+
|
1905
|
+
|
1906
|
+
—
|
1907
|
+
<div class='inline'>
|
1908
|
+
<p>search options</p>
|
1909
|
+
</div>
|
1910
|
+
|
1911
|
+
</li>
|
1912
|
+
|
1913
|
+
</ul>
|
1914
|
+
|
1915
|
+
<p class="tag_title">Returns:</p>
|
1916
|
+
<ul class="return">
|
1917
|
+
|
1918
|
+
<li>
|
1919
|
+
|
1920
|
+
|
1921
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1922
|
+
|
1923
|
+
|
1924
|
+
|
1925
|
+
—
|
1926
|
+
<div class='inline'>
|
1927
|
+
<p>search results</p>
|
1928
|
+
</div>
|
1929
|
+
|
1930
|
+
</li>
|
1931
|
+
|
1932
|
+
</ul>
|
1933
|
+
|
1934
|
+
</div><table class="source_code">
|
1935
|
+
<tr>
|
1936
|
+
<td>
|
1937
|
+
<pre class="lines">
|
1938
|
+
|
1939
|
+
|
1940
|
+
163
|
1941
|
+
164
|
1942
|
+
165
|
1943
|
+
166</pre>
|
1944
|
+
</td>
|
1945
|
+
<td>
|
1946
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 163</span>
|
1947
|
+
|
1948
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_tag'>search_by_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1949
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>tag:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tag'>tag</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1950
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1951
|
+
<span class='kw'>end</span></pre>
|
1952
|
+
</td>
|
1953
|
+
</tr>
|
1954
|
+
</table>
|
1955
|
+
</div>
|
1956
|
+
|
1957
|
+
<div class="method_details ">
|
1958
|
+
<h3 class="signature " id="search_by_title-instance_method">
|
1959
|
+
|
1960
|
+
#<strong>search_by_title</strong>(title, options = {}) ⇒ <tt>Hash</tt>
|
1961
|
+
|
1962
|
+
|
1963
|
+
|
1964
|
+
|
1965
|
+
|
1966
|
+
</h3><div class="docstring">
|
1967
|
+
<div class="discussion">
|
1968
|
+
|
1969
|
+
<p>Search resources by title/name</p>
|
1970
|
+
|
1971
|
+
|
1972
|
+
</div>
|
1973
|
+
</div>
|
1974
|
+
<div class="tags">
|
1975
|
+
<p class="tag_title">Parameters:</p>
|
1976
|
+
<ul class="param">
|
1977
|
+
|
1978
|
+
<li>
|
1979
|
+
|
1980
|
+
<span class='name'>title</span>
|
1981
|
+
|
1982
|
+
|
1983
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1984
|
+
|
1985
|
+
|
1986
|
+
|
1987
|
+
—
|
1988
|
+
<div class='inline'>
|
1989
|
+
<p>resource title</p>
|
1990
|
+
</div>
|
1991
|
+
|
1992
|
+
</li>
|
1993
|
+
|
1994
|
+
<li>
|
1995
|
+
|
1996
|
+
<span class='name'>options</span>
|
1997
|
+
|
1998
|
+
|
1999
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2000
|
+
|
2001
|
+
|
2002
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2003
|
+
|
2004
|
+
|
2005
|
+
—
|
2006
|
+
<div class='inline'>
|
2007
|
+
<p>search options</p>
|
2008
|
+
</div>
|
2009
|
+
|
2010
|
+
</li>
|
2011
|
+
|
2012
|
+
</ul>
|
2013
|
+
|
2014
|
+
<p class="tag_title">Returns:</p>
|
2015
|
+
<ul class="return">
|
2016
|
+
|
2017
|
+
<li>
|
2018
|
+
|
2019
|
+
|
2020
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2021
|
+
|
2022
|
+
|
2023
|
+
|
2024
|
+
—
|
2025
|
+
<div class='inline'>
|
2026
|
+
<p>search results</p>
|
2027
|
+
</div>
|
2028
|
+
|
2029
|
+
</li>
|
2030
|
+
|
2031
|
+
</ul>
|
2032
|
+
|
2033
|
+
</div><table class="source_code">
|
2034
|
+
<tr>
|
2035
|
+
<td>
|
2036
|
+
<pre class="lines">
|
2037
|
+
|
2038
|
+
|
2039
|
+
183
|
2040
|
+
184
|
2041
|
+
185
|
2042
|
+
186</pre>
|
2043
|
+
</td>
|
2044
|
+
<td>
|
2045
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 183</span>
|
2046
|
+
|
2047
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_title'>search_by_title</span><span class='lparen'>(</span><span class='id identifier rubyid_title'>title</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2048
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>title:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_title'>title</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
2049
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
2050
|
+
<span class='kw'>end</span></pre>
|
2051
|
+
</td>
|
2052
|
+
</tr>
|
2053
|
+
</table>
|
2054
|
+
</div>
|
2055
|
+
|
2056
|
+
<div class="method_details ">
|
2057
|
+
<h3 class="signature " id="search_by_user-instance_method">
|
2058
|
+
|
2059
|
+
#<strong>search_by_user</strong>(username, options = {}) ⇒ <tt>Hash</tt>
|
2060
|
+
|
2061
|
+
|
2062
|
+
|
2063
|
+
|
2064
|
+
|
2065
|
+
</h3><div class="docstring">
|
2066
|
+
<div class="discussion">
|
2067
|
+
|
2068
|
+
<p>Search resources by user</p>
|
2069
|
+
|
2070
|
+
|
2071
|
+
</div>
|
2072
|
+
</div>
|
2073
|
+
<div class="tags">
|
2074
|
+
<p class="tag_title">Parameters:</p>
|
2075
|
+
<ul class="param">
|
2076
|
+
|
2077
|
+
<li>
|
2078
|
+
|
2079
|
+
<span class='name'>username</span>
|
2080
|
+
|
2081
|
+
|
2082
|
+
<span class='type'>(<tt>String</tt>)</span>
|
2083
|
+
|
2084
|
+
|
2085
|
+
|
2086
|
+
—
|
2087
|
+
<div class='inline'>
|
2088
|
+
<p>username</p>
|
2089
|
+
</div>
|
2090
|
+
|
2091
|
+
</li>
|
2092
|
+
|
2093
|
+
<li>
|
2094
|
+
|
2095
|
+
<span class='name'>options</span>
|
2096
|
+
|
2097
|
+
|
2098
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2099
|
+
|
2100
|
+
|
2101
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2102
|
+
|
2103
|
+
|
2104
|
+
—
|
2105
|
+
<div class='inline'>
|
2106
|
+
<p>search options</p>
|
2107
|
+
</div>
|
2108
|
+
|
2109
|
+
</li>
|
2110
|
+
|
2111
|
+
</ul>
|
2112
|
+
|
2113
|
+
<p class="tag_title">Returns:</p>
|
2114
|
+
<ul class="return">
|
2115
|
+
|
2116
|
+
<li>
|
2117
|
+
|
2118
|
+
|
2119
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2120
|
+
|
2121
|
+
|
2122
|
+
|
2123
|
+
—
|
2124
|
+
<div class='inline'>
|
2125
|
+
<p>search results</p>
|
2126
|
+
</div>
|
2127
|
+
|
2128
|
+
</li>
|
2129
|
+
|
2130
|
+
</ul>
|
2131
|
+
|
2132
|
+
</div><table class="source_code">
|
2133
|
+
<tr>
|
2134
|
+
<td>
|
2135
|
+
<pre class="lines">
|
2136
|
+
|
2137
|
+
|
2138
|
+
173
|
2139
|
+
174
|
2140
|
+
175
|
2141
|
+
176</pre>
|
2142
|
+
</td>
|
2143
|
+
<td>
|
2144
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 173</span>
|
2145
|
+
|
2146
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_by_user'>search_by_user</span><span class='lparen'>(</span><span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2147
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>user:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_username'>username</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
2148
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
2149
|
+
<span class='kw'>end</span></pre>
|
2150
|
+
</td>
|
2151
|
+
</tr>
|
2152
|
+
</table>
|
2153
|
+
</div>
|
2154
|
+
|
2155
|
+
<div class="method_details ">
|
2156
|
+
<h3 class="signature " id="search_get_previews-instance_method">
|
2157
|
+
|
2158
|
+
#<strong>search_get_previews</strong>(search_term, options = {}) ⇒ <tt>Hash</tt>
|
2159
|
+
|
2160
|
+
|
2161
|
+
|
2162
|
+
|
2163
|
+
|
2164
|
+
</h3><div class="docstring">
|
2165
|
+
<div class="discussion">
|
2166
|
+
|
2167
|
+
<p>Search and get previews in one call</p>
|
2168
|
+
|
2169
|
+
|
2170
|
+
</div>
|
2171
|
+
</div>
|
2172
|
+
<div class="tags">
|
2173
|
+
<p class="tag_title">Parameters:</p>
|
2174
|
+
<ul class="param">
|
2175
|
+
|
2176
|
+
<li>
|
2177
|
+
|
2178
|
+
<span class='name'>search_term</span>
|
2179
|
+
|
2180
|
+
|
2181
|
+
<span class='type'>(<tt>String</tt>)</span>
|
2182
|
+
|
2183
|
+
|
2184
|
+
|
2185
|
+
—
|
2186
|
+
<div class='inline'>
|
2187
|
+
<p>search term</p>
|
2188
|
+
</div>
|
2189
|
+
|
2190
|
+
</li>
|
2191
|
+
|
2192
|
+
<li>
|
2193
|
+
|
2194
|
+
<span class='name'>options</span>
|
2195
|
+
|
2196
|
+
|
2197
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2198
|
+
|
2199
|
+
|
2200
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2201
|
+
|
2202
|
+
|
2203
|
+
—
|
2204
|
+
<div class='inline'>
|
2205
|
+
<p>search options</p>
|
2206
|
+
</div>
|
2207
|
+
|
2208
|
+
</li>
|
2209
|
+
|
2210
|
+
</ul>
|
2211
|
+
|
2212
|
+
|
2213
|
+
|
2214
|
+
|
2215
|
+
|
2216
|
+
|
2217
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
2218
|
+
<ul class="option">
|
2219
|
+
|
2220
|
+
<li>
|
2221
|
+
<span class="name">:getsizes</span>
|
2222
|
+
<span class="type">(<tt>String</tt>)</span>
|
2223
|
+
<span class="default">
|
2224
|
+
|
2225
|
+
</span>
|
2226
|
+
|
2227
|
+
— <div class='inline'>
|
2228
|
+
<p>image sizes to include (“col,thm,scr,pre”)</p>
|
2229
|
+
</div>
|
2230
|
+
|
2231
|
+
</li>
|
2232
|
+
|
2233
|
+
<li>
|
2234
|
+
<span class="name">:order_by</span>
|
2235
|
+
<span class="type">(<tt>String</tt>)</span>
|
2236
|
+
<span class="default">
|
2237
|
+
|
2238
|
+
</span>
|
2239
|
+
|
2240
|
+
— <div class='inline'>
|
2241
|
+
<p>field to order by</p>
|
2242
|
+
</div>
|
2243
|
+
|
2244
|
+
</li>
|
2245
|
+
|
2246
|
+
<li>
|
2247
|
+
<span class="name">:sort</span>
|
2248
|
+
<span class="type">(<tt>String</tt>)</span>
|
2249
|
+
<span class="default">
|
2250
|
+
|
2251
|
+
</span>
|
2252
|
+
|
2253
|
+
— <div class='inline'>
|
2254
|
+
<p>sort direction (“asc” or “desc”)</p>
|
2255
|
+
</div>
|
2256
|
+
|
2257
|
+
</li>
|
2258
|
+
|
2259
|
+
<li>
|
2260
|
+
<span class="name">:fetchrows</span>
|
2261
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
2262
|
+
<span class="default">
|
2263
|
+
|
2264
|
+
</span>
|
2265
|
+
|
2266
|
+
— <div class='inline'>
|
2267
|
+
<p>number of results to fetch</p>
|
2268
|
+
</div>
|
2269
|
+
|
2270
|
+
</li>
|
2271
|
+
|
2272
|
+
<li>
|
2273
|
+
<span class="name">:archive</span>
|
2274
|
+
<span class="type">(<tt>String</tt>)</span>
|
2275
|
+
<span class="default">
|
2276
|
+
|
2277
|
+
</span>
|
2278
|
+
|
2279
|
+
— <div class='inline'>
|
2280
|
+
<p>archive status</p>
|
2281
|
+
</div>
|
2282
|
+
|
2283
|
+
</li>
|
2284
|
+
|
2285
|
+
</ul>
|
2286
|
+
|
2287
|
+
|
2288
|
+
<p class="tag_title">Returns:</p>
|
2289
|
+
<ul class="return">
|
2290
|
+
|
2291
|
+
<li>
|
2292
|
+
|
2293
|
+
|
2294
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2295
|
+
|
2296
|
+
|
2297
|
+
|
2298
|
+
—
|
2299
|
+
<div class='inline'>
|
2300
|
+
<p>search results with preview data</p>
|
2301
|
+
</div>
|
2302
|
+
|
2303
|
+
</li>
|
2304
|
+
|
2305
|
+
</ul>
|
2306
|
+
|
2307
|
+
</div><table class="source_code">
|
2308
|
+
<tr>
|
2309
|
+
<td>
|
2310
|
+
<pre class="lines">
|
2311
|
+
|
2312
|
+
|
2313
|
+
62
|
2314
|
+
63
|
2315
|
+
64
|
2316
|
+
65
|
2317
|
+
66
|
2318
|
+
67</pre>
|
2319
|
+
</td>
|
2320
|
+
<td>
|
2321
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 62</span>
|
2322
|
+
|
2323
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_get_previews'>search_get_previews</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2324
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_build_search_params'>build_search_params</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
2325
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param6</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:getsizes</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:getsizes</span><span class='rbracket'>]</span>
|
2326
|
+
|
2327
|
+
<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'>search_get_previews</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
2328
|
+
<span class='kw'>end</span></pre>
|
2329
|
+
</td>
|
2330
|
+
</tr>
|
2331
|
+
</table>
|
2332
|
+
</div>
|
2333
|
+
|
2334
|
+
<div class="method_details ">
|
2335
|
+
<h3 class="signature " id="search_web_assets-instance_method">
|
2336
|
+
|
2337
|
+
#<strong>search_web_assets</strong>(asset_type = nil, options = {}) ⇒ <tt>Hash</tt>
|
2338
|
+
|
2339
|
+
|
2340
|
+
|
2341
|
+
|
2342
|
+
|
2343
|
+
</h3><div class="docstring">
|
2344
|
+
<div class="discussion">
|
2345
|
+
|
2346
|
+
<p>Search for web assets (images, CSS, JS, fonts)</p>
|
2347
|
+
|
2348
|
+
|
2349
|
+
</div>
|
2350
|
+
</div>
|
2351
|
+
<div class="tags">
|
2352
|
+
<p class="tag_title">Parameters:</p>
|
2353
|
+
<ul class="param">
|
2354
|
+
|
2355
|
+
<li>
|
2356
|
+
|
2357
|
+
<span class='name'>asset_type</span>
|
2358
|
+
|
2359
|
+
|
2360
|
+
<span class='type'>(<tt>String</tt>)</span>
|
2361
|
+
|
2362
|
+
|
2363
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2364
|
+
|
2365
|
+
|
2366
|
+
—
|
2367
|
+
<div class='inline'>
|
2368
|
+
<p>type of web asset (“image”, “css”, “javascript”, “font”, “icon”)</p>
|
2369
|
+
</div>
|
2370
|
+
|
2371
|
+
</li>
|
2372
|
+
|
2373
|
+
<li>
|
2374
|
+
|
2375
|
+
<span class='name'>options</span>
|
2376
|
+
|
2377
|
+
|
2378
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2379
|
+
|
2380
|
+
|
2381
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2382
|
+
|
2383
|
+
|
2384
|
+
—
|
2385
|
+
<div class='inline'>
|
2386
|
+
<p>search options</p>
|
2387
|
+
</div>
|
2388
|
+
|
2389
|
+
</li>
|
2390
|
+
|
2391
|
+
</ul>
|
2392
|
+
|
2393
|
+
<p class="tag_title">Returns:</p>
|
2394
|
+
<ul class="return">
|
2395
|
+
|
2396
|
+
<li>
|
2397
|
+
|
2398
|
+
|
2399
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2400
|
+
|
2401
|
+
|
2402
|
+
|
2403
|
+
—
|
2404
|
+
<div class='inline'>
|
2405
|
+
<p>search results filtered for web assets</p>
|
2406
|
+
</div>
|
2407
|
+
|
2408
|
+
</li>
|
2409
|
+
|
2410
|
+
</ul>
|
2411
|
+
|
2412
|
+
</div><table class="source_code">
|
2413
|
+
<tr>
|
2414
|
+
<td>
|
2415
|
+
<pre class="lines">
|
2416
|
+
|
2417
|
+
|
2418
|
+
74
|
2419
|
+
75
|
2420
|
+
76
|
2421
|
+
77
|
2422
|
+
78
|
2423
|
+
79
|
2424
|
+
80
|
2425
|
+
81
|
2426
|
+
82
|
2427
|
+
83
|
2428
|
+
84
|
2429
|
+
85
|
2430
|
+
86
|
2431
|
+
87
|
2432
|
+
88
|
2433
|
+
89
|
2434
|
+
90
|
2435
|
+
91
|
2436
|
+
92
|
2437
|
+
93
|
2438
|
+
94
|
2439
|
+
95
|
2440
|
+
96
|
2441
|
+
97</pre>
|
2442
|
+
</td>
|
2443
|
+
<td>
|
2444
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/search.rb', line 74</span>
|
2445
|
+
|
2446
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_web_assets'>search_web_assets</span><span class='lparen'>(</span><span class='id identifier rubyid_asset_type'>asset_type</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2447
|
+
<span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
2448
|
+
|
2449
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_asset_type'>asset_type</span><span class='op'>&.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
2450
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>images</span><span class='tstring_end'>"</span></span>
|
2451
|
+
<span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:jpg OR extension:jpeg OR extension:png OR extension:gif OR extension:svg OR extension:webp</span><span class='tstring_end'>"</span></span>
|
2452
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>css</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stylesheet</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stylesheets</span><span class='tstring_end'>"</span></span>
|
2453
|
+
<span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:css</span><span class='tstring_end'>"</span></span>
|
2454
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>javascript</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>js</span><span class='tstring_end'>"</span></span>
|
2455
|
+
<span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:js</span><span class='tstring_end'>"</span></span>
|
2456
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>font</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>fonts</span><span class='tstring_end'>"</span></span>
|
2457
|
+
<span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:woff OR extension:woff2 OR extension:ttf OR extension:otf OR extension:eot</span><span class='tstring_end'>"</span></span>
|
2458
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>icon</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>icons</span><span class='tstring_end'>"</span></span>
|
2459
|
+
<span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:ico OR extension:svg</span><span class='tstring_end'>"</span></span>
|
2460
|
+
<span class='kw'>else</span>
|
2461
|
+
<span class='comment'># Search for all common web asset types
|
2462
|
+
</span> <span class='id identifier rubyid_search_terms'>search_terms</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extension:jpg OR extension:jpeg OR extension:png OR extension:gif OR extension:svg OR extension:webp OR extension:css OR extension:js OR extension:woff OR extension:woff2 OR extension:ico</span><span class='tstring_end'>"</span></span>
|
2463
|
+
<span class='kw'>end</span>
|
2464
|
+
|
2465
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>=</span> <span class='id identifier rubyid_search_terms'>search_terms</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> OR </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
2466
|
+
<span class='id identifier rubyid_search_term'>search_term</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:query</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span>
|
2467
|
+
|
2468
|
+
<span class='id identifier rubyid_do_search'>do_search</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
2469
|
+
<span class='kw'>end</span></pre>
|
2470
|
+
</td>
|
2471
|
+
</tr>
|
2472
|
+
</table>
|
2473
|
+
</div>
|
2474
|
+
|
2475
|
+
</div>
|
2476
|
+
|
2477
|
+
</div>
|
2478
|
+
|
2479
|
+
<div id="footer">
|
2480
|
+
Generated on Sat May 24 15:41:24 2025 by
|
2481
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2482
|
+
0.9.37 (ruby-3.4.4).
|
2483
|
+
</div>
|
2484
|
+
|
2485
|
+
</div>
|
2486
|
+
</body>
|
2487
|
+
</html>
|