kabk 0.2.0
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.
Potentially problematic release.
This version of kabk might be problematic. Click here for more details.
- checksums.yaml +7 -0
- data/CHANGELOG.md +27 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +108 -0
- data/Kabk_logo.svg +33 -0
- data/LICENSE +21 -0
- data/README.md +101 -0
- data/doc/Kabk/Adapters/Base.html +854 -0
- data/doc/Kabk/Adapters/SequelAdapter.html +948 -0
- data/doc/Kabk/Adapters.html +120 -0
- data/doc/Kabk/ApiError.html +511 -0
- data/doc/Kabk/Auth/JwtStrategy.html +551 -0
- data/doc/Kabk/Auth.html +118 -0
- data/doc/Kabk/Concurrency.html +297 -0
- data/doc/Kabk/ConcurrencyConflictError.html +225 -0
- data/doc/Kabk/Error.html +140 -0
- data/doc/Kabk/ExportHandler.html +381 -0
- data/doc/Kabk/Field.html +2160 -0
- data/doc/Kabk/ForbiddenError.html +225 -0
- data/doc/Kabk/InvalidFieldError.html +136 -0
- data/doc/Kabk/InvalidOldPasswordError.html +225 -0
- data/doc/Kabk/NotFoundError.html +225 -0
- data/doc/Kabk/QueryBuilder.html +551 -0
- data/doc/Kabk/Registry.html +608 -0
- data/doc/Kabk/RelationHydrator.html +480 -0
- data/doc/Kabk/Resource.html +1986 -0
- data/doc/Kabk/ResourceBuilder.html +1002 -0
- data/doc/Kabk/RestEngine.html +879 -0
- data/doc/Kabk/SchemaRenderer.html +318 -0
- data/doc/Kabk/UnauthorizedError.html +225 -0
- data/doc/Kabk/UploadHandler.html +308 -0
- data/doc/Kabk/ValidationError.html +225 -0
- data/doc/Kabk/Validator.html +380 -0
- data/doc/Kabk.html +330 -0
- data/doc/_index.html +376 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +206 -0
- data/doc/css/style.css +1089 -0
- data/doc/file.README.html +149 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +149 -0
- data/doc/js/app.js +801 -0
- data/doc/js/full_list.js +334 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +910 -0
- data/doc/top-level-namespace.html +112 -0
- data/docs/API_REFERENCE.md +241 -0
- data/lib/kabk/adapters/base.rb +45 -0
- data/lib/kabk/adapters/sequel_adapter.rb +125 -0
- data/lib/kabk/concurrency.rb +30 -0
- data/lib/kabk/errors.rb +62 -0
- data/lib/kabk/export_handler.rb +43 -0
- data/lib/kabk/field.rb +97 -0
- data/lib/kabk/query_builder.rb +72 -0
- data/lib/kabk/registry.rb +41 -0
- data/lib/kabk/relation_hydrator.rb +107 -0
- data/lib/kabk/resource.rb +88 -0
- data/lib/kabk/resource_builder.rb +93 -0
- data/lib/kabk/rest_engine.rb +84 -0
- data/lib/kabk/schema_renderer.rb +69 -0
- data/lib/kabk/upload_handler.rb +24 -0
- data/lib/kabk/validator.rb +64 -0
- data/lib/kabk/version.rb +6 -0
- data/lib/kabk.rb +51 -0
- metadata +193 -0
|
@@ -0,0 +1,854 @@
|
|
|
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: Kabk::Adapters::Base
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.45
|
|
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 = "Kabk::Adapters::Base";
|
|
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 id="main_progress" aria-hidden="true"></div>
|
|
31
|
+
|
|
32
|
+
<div class="nav_wrap">
|
|
33
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
34
|
+
<div id="resizer"></div>
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
<div id="main" tabindex="-1">
|
|
38
|
+
<div id="header">
|
|
39
|
+
<div id="menu">
|
|
40
|
+
|
|
41
|
+
<a href="../../_index.html">Index (B)</a> »
|
|
42
|
+
<span class='title'><span class='object_link'><a href="../../Kabk.html" title="Kabk (module)">Kabk</a></span></span> » <span class='title'><span class='object_link'><a href="../Adapters.html" title="Kabk::Adapters (module)">Adapters</a></span></span>
|
|
43
|
+
»
|
|
44
|
+
<span class="title">Base</span>
|
|
45
|
+
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<div id="search">
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="class_list_link"
|
|
51
|
+
href="../../class_list.html">
|
|
52
|
+
|
|
53
|
+
<svg width="24" height="24">
|
|
54
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
56
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
57
|
+
</svg>
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Kabk::Adapters::Base
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Kabk::Adapters::Base</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/kabk/adapters/base.rb
|
|
100
|
+
</dd>
|
|
101
|
+
</dl>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
<h2>Overview</h2><div class="docstring">
|
|
106
|
+
<div class="discussion">
|
|
107
|
+
<p>Abstract base class for ORM Adapters</p>
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
<div class="tags">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div><div id="subclasses">
|
|
115
|
+
<h2>Direct Known Subclasses</h2>
|
|
116
|
+
<p class="children"><span class='object_link'><a href="SequelAdapter.html" title="Kabk::Adapters::SequelAdapter (class)">SequelAdapter</a></span></p>
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
123
|
+
<ul class="summary">
|
|
124
|
+
|
|
125
|
+
<li class="public ">
|
|
126
|
+
<span class="summary_signature">
|
|
127
|
+
|
|
128
|
+
<a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong> ⇒ Object </a>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</span>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
<span class="note title readonly">readonly</span>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute resource.</p></div></span>
|
|
148
|
+
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</ul>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<h2>
|
|
159
|
+
Instance Method Summary
|
|
160
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
161
|
+
</h2>
|
|
162
|
+
|
|
163
|
+
<ul class="summary">
|
|
164
|
+
|
|
165
|
+
<li class="public ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(attributes, context: {}) ⇒ Object </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
183
|
+
|
|
184
|
+
</li>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<li class="public ">
|
|
188
|
+
<span class="summary_signature">
|
|
189
|
+
|
|
190
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id, context: {}) ⇒ Object </a>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</span>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
205
|
+
|
|
206
|
+
</li>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<li class="public ">
|
|
210
|
+
<span class="summary_signature">
|
|
211
|
+
|
|
212
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id, context: {}) ⇒ Object </a>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
</span>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(resource) ⇒ Base </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<span class="note title constructor">constructor</span>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Base.</p></div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(params, context: {}) ⇒ Object </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id, attributes, context: {}) ⇒ Object </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
295
|
+
|
|
296
|
+
</li>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
</ul>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<div id="constructor_details" class="method_details_list">
|
|
304
|
+
<h2>Constructor Details</h2>
|
|
305
|
+
|
|
306
|
+
<div class="method_details first">
|
|
307
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
308
|
+
|
|
309
|
+
#<strong>initialize</strong>(resource) ⇒ <tt><span class='object_link'><a href="" title="Kabk::Adapters::Base (class)">Base</a></span></tt>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</h3><div class="docstring">
|
|
316
|
+
<div class="discussion">
|
|
317
|
+
<p>Returns a new instance of Base.</p>
|
|
318
|
+
|
|
319
|
+
</div>
|
|
320
|
+
</div>
|
|
321
|
+
<div class="tags">
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
</div><table class="source_code">
|
|
325
|
+
<tr>
|
|
326
|
+
<td>
|
|
327
|
+
<pre class="lines">
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
9
|
|
331
|
+
10
|
|
332
|
+
11</pre>
|
|
333
|
+
</td>
|
|
334
|
+
<td>
|
|
335
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 9</span>
|
|
336
|
+
|
|
337
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span>
|
|
338
|
+
<span class='ivar'>@resource</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span>
|
|
339
|
+
<span class='kw'>end</span></pre>
|
|
340
|
+
</td>
|
|
341
|
+
</tr>
|
|
342
|
+
</table>
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
<div id="instance_attr_details" class="attr_details">
|
|
348
|
+
<h2>Instance Attribute Details</h2>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span id=""></span>
|
|
352
|
+
<div class="method_details first">
|
|
353
|
+
<h3 class="signature first" id="resource-instance_method">
|
|
354
|
+
|
|
355
|
+
#<strong>resource</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</h3><div class="docstring">
|
|
362
|
+
<div class="discussion">
|
|
363
|
+
<p>Returns the value of attribute resource.</p>
|
|
364
|
+
|
|
365
|
+
</div>
|
|
366
|
+
</div>
|
|
367
|
+
<div class="tags">
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</div><table class="source_code">
|
|
371
|
+
<tr>
|
|
372
|
+
<td>
|
|
373
|
+
<pre class="lines">
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
7
|
|
377
|
+
8
|
|
378
|
+
9</pre>
|
|
379
|
+
</td>
|
|
380
|
+
<td>
|
|
381
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 7</span>
|
|
382
|
+
|
|
383
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource'>resource</span>
|
|
384
|
+
<span class='ivar'>@resource</span>
|
|
385
|
+
<span class='kw'>end</span></pre>
|
|
386
|
+
</td>
|
|
387
|
+
</tr>
|
|
388
|
+
</table>
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<div id="instance_method_details" class="method_details_list">
|
|
395
|
+
<h2>Instance Method Details</h2>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
<div class="method_details first">
|
|
399
|
+
<h3 class="signature first" id="create-instance_method">
|
|
400
|
+
|
|
401
|
+
#<strong>create</strong>(attributes, context: {}) ⇒ <tt>Object</tt>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</h3><div class="docstring">
|
|
408
|
+
<div class="discussion">
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
</div>
|
|
412
|
+
</div>
|
|
413
|
+
<div class="tags">
|
|
414
|
+
<p class="tag_title">Parameters:</p>
|
|
415
|
+
<ul class="param">
|
|
416
|
+
|
|
417
|
+
<li>
|
|
418
|
+
|
|
419
|
+
<span class='name'>attributes</span>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
—
|
|
427
|
+
<div class='inline'><p>Sanitized attributes</p></div>
|
|
428
|
+
|
|
429
|
+
</li>
|
|
430
|
+
|
|
431
|
+
<li>
|
|
432
|
+
|
|
433
|
+
<span class='name'>context</span>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
—
|
|
443
|
+
<div class='inline'><p>Context provided by host framework (e.g. current_user).</p></div>
|
|
444
|
+
|
|
445
|
+
</li>
|
|
446
|
+
|
|
447
|
+
</ul>
|
|
448
|
+
|
|
449
|
+
<p class="tag_title">Raises:</p>
|
|
450
|
+
<ul class="raise">
|
|
451
|
+
|
|
452
|
+
<li>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
</li>
|
|
460
|
+
|
|
461
|
+
</ul>
|
|
462
|
+
|
|
463
|
+
</div><table class="source_code">
|
|
464
|
+
<tr>
|
|
465
|
+
<td>
|
|
466
|
+
<pre class="lines">
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
27
|
|
470
|
+
28
|
|
471
|
+
29</pre>
|
|
472
|
+
</td>
|
|
473
|
+
<td>
|
|
474
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 27</span>
|
|
475
|
+
|
|
476
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='label'>context:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
477
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> must implement #create</span><span class='tstring_end'>"</span></span>
|
|
478
|
+
<span class='kw'>end</span></pre>
|
|
479
|
+
</td>
|
|
480
|
+
</tr>
|
|
481
|
+
</table>
|
|
482
|
+
</div>
|
|
483
|
+
|
|
484
|
+
<div class="method_details ">
|
|
485
|
+
<h3 class="signature " id="delete-instance_method">
|
|
486
|
+
|
|
487
|
+
#<strong>delete</strong>(id, context: {}) ⇒ <tt>Object</tt>
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</h3><div class="docstring">
|
|
494
|
+
<div class="discussion">
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div>
|
|
498
|
+
</div>
|
|
499
|
+
<div class="tags">
|
|
500
|
+
<p class="tag_title">Parameters:</p>
|
|
501
|
+
<ul class="param">
|
|
502
|
+
|
|
503
|
+
<li>
|
|
504
|
+
|
|
505
|
+
<span class='name'>id</span>
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
<span class='type'>(<tt>Integer</tt>, <tt>String</tt>)</span>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
—
|
|
513
|
+
<div class='inline'><p>Primary key</p></div>
|
|
514
|
+
|
|
515
|
+
</li>
|
|
516
|
+
|
|
517
|
+
<li>
|
|
518
|
+
|
|
519
|
+
<span class='name'>context</span>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
—
|
|
529
|
+
<div class='inline'><p>Context provided by host framework (e.g. current_user).</p></div>
|
|
530
|
+
|
|
531
|
+
</li>
|
|
532
|
+
|
|
533
|
+
</ul>
|
|
534
|
+
|
|
535
|
+
<p class="tag_title">Raises:</p>
|
|
536
|
+
<ul class="raise">
|
|
537
|
+
|
|
538
|
+
<li>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</li>
|
|
546
|
+
|
|
547
|
+
</ul>
|
|
548
|
+
|
|
549
|
+
</div><table class="source_code">
|
|
550
|
+
<tr>
|
|
551
|
+
<td>
|
|
552
|
+
<pre class="lines">
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
40
|
|
556
|
+
41
|
|
557
|
+
42</pre>
|
|
558
|
+
</td>
|
|
559
|
+
<td>
|
|
560
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 40</span>
|
|
561
|
+
|
|
562
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>context:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
563
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> must implement #delete</span><span class='tstring_end'>"</span></span>
|
|
564
|
+
<span class='kw'>end</span></pre>
|
|
565
|
+
</td>
|
|
566
|
+
</tr>
|
|
567
|
+
</table>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
<div class="method_details ">
|
|
571
|
+
<h3 class="signature " id="get-instance_method">
|
|
572
|
+
|
|
573
|
+
#<strong>get</strong>(id, context: {}) ⇒ <tt>Object</tt>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
</h3><div class="docstring">
|
|
580
|
+
<div class="discussion">
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</div>
|
|
584
|
+
</div>
|
|
585
|
+
<div class="tags">
|
|
586
|
+
<p class="tag_title">Parameters:</p>
|
|
587
|
+
<ul class="param">
|
|
588
|
+
|
|
589
|
+
<li>
|
|
590
|
+
|
|
591
|
+
<span class='name'>id</span>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
<span class='type'>(<tt>Integer</tt>, <tt>String</tt>)</span>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
—
|
|
599
|
+
<div class='inline'><p>Primary key</p></div>
|
|
600
|
+
|
|
601
|
+
</li>
|
|
602
|
+
|
|
603
|
+
<li>
|
|
604
|
+
|
|
605
|
+
<span class='name'>context</span>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
—
|
|
615
|
+
<div class='inline'><p>Context provided by host framework (e.g. current_user).</p></div>
|
|
616
|
+
|
|
617
|
+
</li>
|
|
618
|
+
|
|
619
|
+
</ul>
|
|
620
|
+
|
|
621
|
+
<p class="tag_title">Raises:</p>
|
|
622
|
+
<ul class="raise">
|
|
623
|
+
|
|
624
|
+
<li>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
</li>
|
|
632
|
+
|
|
633
|
+
</ul>
|
|
634
|
+
|
|
635
|
+
</div><table class="source_code">
|
|
636
|
+
<tr>
|
|
637
|
+
<td>
|
|
638
|
+
<pre class="lines">
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
21
|
|
642
|
+
22
|
|
643
|
+
23</pre>
|
|
644
|
+
</td>
|
|
645
|
+
<td>
|
|
646
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 21</span>
|
|
647
|
+
|
|
648
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>context:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
649
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> must implement #get</span><span class='tstring_end'>"</span></span>
|
|
650
|
+
<span class='kw'>end</span></pre>
|
|
651
|
+
</td>
|
|
652
|
+
</tr>
|
|
653
|
+
</table>
|
|
654
|
+
</div>
|
|
655
|
+
|
|
656
|
+
<div class="method_details ">
|
|
657
|
+
<h3 class="signature " id="list-instance_method">
|
|
658
|
+
|
|
659
|
+
#<strong>list</strong>(params, context: {}) ⇒ <tt>Object</tt>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</h3><div class="docstring">
|
|
666
|
+
<div class="discussion">
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
</div>
|
|
670
|
+
</div>
|
|
671
|
+
<div class="tags">
|
|
672
|
+
<p class="tag_title">Parameters:</p>
|
|
673
|
+
<ul class="param">
|
|
674
|
+
|
|
675
|
+
<li>
|
|
676
|
+
|
|
677
|
+
<span class='name'>params</span>
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
—
|
|
685
|
+
<div class='inline'><p>Request parameters (page, per_page, sort, filters).</p></div>
|
|
686
|
+
|
|
687
|
+
</li>
|
|
688
|
+
|
|
689
|
+
<li>
|
|
690
|
+
|
|
691
|
+
<span class='name'>context</span>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
—
|
|
701
|
+
<div class='inline'><p>Context provided by host framework (e.g. current_user).</p></div>
|
|
702
|
+
|
|
703
|
+
</li>
|
|
704
|
+
|
|
705
|
+
</ul>
|
|
706
|
+
|
|
707
|
+
<p class="tag_title">Raises:</p>
|
|
708
|
+
<ul class="raise">
|
|
709
|
+
|
|
710
|
+
<li>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
</li>
|
|
718
|
+
|
|
719
|
+
</ul>
|
|
720
|
+
|
|
721
|
+
</div><table class="source_code">
|
|
722
|
+
<tr>
|
|
723
|
+
<td>
|
|
724
|
+
<pre class="lines">
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
15
|
|
728
|
+
16
|
|
729
|
+
17</pre>
|
|
730
|
+
</td>
|
|
731
|
+
<td>
|
|
732
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 15</span>
|
|
733
|
+
|
|
734
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='label'>context:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
735
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> must implement #list</span><span class='tstring_end'>"</span></span>
|
|
736
|
+
<span class='kw'>end</span></pre>
|
|
737
|
+
</td>
|
|
738
|
+
</tr>
|
|
739
|
+
</table>
|
|
740
|
+
</div>
|
|
741
|
+
|
|
742
|
+
<div class="method_details ">
|
|
743
|
+
<h3 class="signature " id="update-instance_method">
|
|
744
|
+
|
|
745
|
+
#<strong>update</strong>(id, attributes, context: {}) ⇒ <tt>Object</tt>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
</h3><div class="docstring">
|
|
752
|
+
<div class="discussion">
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
</div>
|
|
756
|
+
</div>
|
|
757
|
+
<div class="tags">
|
|
758
|
+
<p class="tag_title">Parameters:</p>
|
|
759
|
+
<ul class="param">
|
|
760
|
+
|
|
761
|
+
<li>
|
|
762
|
+
|
|
763
|
+
<span class='name'>id</span>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<span class='type'>(<tt>Integer</tt>, <tt>String</tt>)</span>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
—
|
|
771
|
+
<div class='inline'><p>Primary key</p></div>
|
|
772
|
+
|
|
773
|
+
</li>
|
|
774
|
+
|
|
775
|
+
<li>
|
|
776
|
+
|
|
777
|
+
<span class='name'>attributes</span>
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
—
|
|
785
|
+
<div class='inline'><p>Sanitized attributes</p></div>
|
|
786
|
+
|
|
787
|
+
</li>
|
|
788
|
+
|
|
789
|
+
<li>
|
|
790
|
+
|
|
791
|
+
<span class='name'>context</span>
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
—
|
|
801
|
+
<div class='inline'><p>Context provided by host framework (e.g. current_user).</p></div>
|
|
802
|
+
|
|
803
|
+
</li>
|
|
804
|
+
|
|
805
|
+
</ul>
|
|
806
|
+
|
|
807
|
+
<p class="tag_title">Raises:</p>
|
|
808
|
+
<ul class="raise">
|
|
809
|
+
|
|
810
|
+
<li>
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
</li>
|
|
818
|
+
|
|
819
|
+
</ul>
|
|
820
|
+
|
|
821
|
+
</div><table class="source_code">
|
|
822
|
+
<tr>
|
|
823
|
+
<td>
|
|
824
|
+
<pre class="lines">
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
34
|
|
828
|
+
35
|
|
829
|
+
36</pre>
|
|
830
|
+
</td>
|
|
831
|
+
<td>
|
|
832
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/adapters/base.rb', line 34</span>
|
|
833
|
+
|
|
834
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='label'>context:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
835
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> must implement #update</span><span class='tstring_end'>"</span></span>
|
|
836
|
+
<span class='kw'>end</span></pre>
|
|
837
|
+
</td>
|
|
838
|
+
</tr>
|
|
839
|
+
</table>
|
|
840
|
+
</div>
|
|
841
|
+
|
|
842
|
+
</div>
|
|
843
|
+
|
|
844
|
+
</div>
|
|
845
|
+
|
|
846
|
+
<div id="footer">
|
|
847
|
+
Generated on Tue Aug 11 21:17:07 2026 by
|
|
848
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
849
|
+
0.9.45 (ruby-4.0.6).
|
|
850
|
+
</div>
|
|
851
|
+
|
|
852
|
+
</div>
|
|
853
|
+
</body>
|
|
854
|
+
</html>
|