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.

Files changed (67) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +27 -0
  3. data/Gemfile +6 -0
  4. data/Gemfile.lock +108 -0
  5. data/Kabk_logo.svg +33 -0
  6. data/LICENSE +21 -0
  7. data/README.md +101 -0
  8. data/doc/Kabk/Adapters/Base.html +854 -0
  9. data/doc/Kabk/Adapters/SequelAdapter.html +948 -0
  10. data/doc/Kabk/Adapters.html +120 -0
  11. data/doc/Kabk/ApiError.html +511 -0
  12. data/doc/Kabk/Auth/JwtStrategy.html +551 -0
  13. data/doc/Kabk/Auth.html +118 -0
  14. data/doc/Kabk/Concurrency.html +297 -0
  15. data/doc/Kabk/ConcurrencyConflictError.html +225 -0
  16. data/doc/Kabk/Error.html +140 -0
  17. data/doc/Kabk/ExportHandler.html +381 -0
  18. data/doc/Kabk/Field.html +2160 -0
  19. data/doc/Kabk/ForbiddenError.html +225 -0
  20. data/doc/Kabk/InvalidFieldError.html +136 -0
  21. data/doc/Kabk/InvalidOldPasswordError.html +225 -0
  22. data/doc/Kabk/NotFoundError.html +225 -0
  23. data/doc/Kabk/QueryBuilder.html +551 -0
  24. data/doc/Kabk/Registry.html +608 -0
  25. data/doc/Kabk/RelationHydrator.html +480 -0
  26. data/doc/Kabk/Resource.html +1986 -0
  27. data/doc/Kabk/ResourceBuilder.html +1002 -0
  28. data/doc/Kabk/RestEngine.html +879 -0
  29. data/doc/Kabk/SchemaRenderer.html +318 -0
  30. data/doc/Kabk/UnauthorizedError.html +225 -0
  31. data/doc/Kabk/UploadHandler.html +308 -0
  32. data/doc/Kabk/ValidationError.html +225 -0
  33. data/doc/Kabk/Validator.html +380 -0
  34. data/doc/Kabk.html +330 -0
  35. data/doc/_index.html +376 -0
  36. data/doc/class_list.html +54 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +206 -0
  39. data/doc/css/style.css +1089 -0
  40. data/doc/file.README.html +149 -0
  41. data/doc/file_list.html +59 -0
  42. data/doc/frames.html +22 -0
  43. data/doc/index.html +149 -0
  44. data/doc/js/app.js +801 -0
  45. data/doc/js/full_list.js +334 -0
  46. data/doc/js/jquery.js +4 -0
  47. data/doc/method_list.html +910 -0
  48. data/doc/top-level-namespace.html +112 -0
  49. data/docs/API_REFERENCE.md +241 -0
  50. data/lib/kabk/adapters/base.rb +45 -0
  51. data/lib/kabk/adapters/sequel_adapter.rb +125 -0
  52. data/lib/kabk/concurrency.rb +30 -0
  53. data/lib/kabk/errors.rb +62 -0
  54. data/lib/kabk/export_handler.rb +43 -0
  55. data/lib/kabk/field.rb +97 -0
  56. data/lib/kabk/query_builder.rb +72 -0
  57. data/lib/kabk/registry.rb +41 -0
  58. data/lib/kabk/relation_hydrator.rb +107 -0
  59. data/lib/kabk/resource.rb +88 -0
  60. data/lib/kabk/resource_builder.rb +93 -0
  61. data/lib/kabk/rest_engine.rb +84 -0
  62. data/lib/kabk/schema_renderer.rb +69 -0
  63. data/lib/kabk/upload_handler.rb +24 -0
  64. data/lib/kabk/validator.rb +64 -0
  65. data/lib/kabk/version.rb +6 -0
  66. data/lib/kabk.rb +51 -0
  67. metadata +193 -0
data/doc/Kabk/Adapters.html ADDED
@@ -0,0 +1,120 @@
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
+ Module: Kabk::Adapters
8
+
9
+ &mdash; 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";
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 (A)</a> &raquo;
42
+ <span class='title'><span class='object_link'><a href="../Kabk.html" title="Kabk (module)">Kabk</a></span></span>
43
+ &raquo;
44
+ <span class="title">Adapters</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>Module: Kabk::Adapters
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dl>
82
+ <dt>Defined in:</dt>
83
+ <dd>lib/kabk/adapters/base.rb<span class="defines">,<br>
84
+ lib/kabk/adapters/sequel_adapter.rb</span>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Defined Under Namespace</h2>
92
+ <p class="children">
93
+
94
+
95
+
96
+
97
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Adapters/Base.html" title="Kabk::Adapters::Base (class)">Base</a></span>, <span class='object_link'><a href="Adapters/SequelAdapter.html" title="Kabk::Adapters::SequelAdapter (class)">SequelAdapter</a></span>
98
+
99
+
100
+ </p>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ </div>
111
+
112
+ <div id="footer">
113
+ Generated on Tue Aug 11 21:17:06 2026 by
114
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
115
+ 0.9.45 (ruby-4.0.6).
116
+ </div>
117
+
118
+ </div>
119
+ </body>
120
+ </html>
data/doc/Kabk/ApiError.html ADDED
@@ -0,0 +1,511 @@
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
+ Exception: Kabk::ApiError
8
+
9
+ &mdash; 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::ApiError";
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 (A)</a> &raquo;
42
+ <span class='title'><span class='object_link'><a href="../Kabk.html" title="Kabk (module)">Kabk</a></span></span>
43
+ &raquo;
44
+ <span class="title">ApiError</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>Exception: Kabk::ApiError
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">StandardError</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">StandardError</li>
80
+
81
+ <li class="next">Kabk::ApiError</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/kabk/errors.rb
102
+ </dd>
103
+ </dl>
104
+
105
+ </div>
106
+
107
+ <h2>Overview</h2><div class="docstring">
108
+ <div class="discussion">
109
+ <p>Defines standardized API errors that map to protocol error codes</p>
110
+
111
+ </div>
112
+ </div>
113
+ <div class="tags">
114
+
115
+
116
+ </div><div id="subclasses">
117
+ <h2>Direct Known Subclasses</h2>
118
+ <p class="children"><span class='object_link'><a href="ConcurrencyConflictError.html" title="Kabk::ConcurrencyConflictError (class)">ConcurrencyConflictError</a></span>, <span class='object_link'><a href="ForbiddenError.html" title="Kabk::ForbiddenError (class)">ForbiddenError</a></span>, <span class='object_link'><a href="InvalidOldPasswordError.html" title="Kabk::InvalidOldPasswordError (class)">InvalidOldPasswordError</a></span>, <span class='object_link'><a href="NotFoundError.html" title="Kabk::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="UnauthorizedError.html" title="Kabk::UnauthorizedError (class)">UnauthorizedError</a></span>, <span class='object_link'><a href="ValidationError.html" title="Kabk::ValidationError (class)">ValidationError</a></span></p>
119
+ </div>
120
+
121
+
122
+
123
+
124
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
125
+ <ul class="summary">
126
+
127
+ <li class="public ">
128
+ <span class="summary_signature">
129
+
130
+ <a href="#code-instance_method" title="#code (instance method)">#<strong>code</strong> &#x21d2; Object </a>
131
+
132
+
133
+
134
+ </span>
135
+
136
+
137
+
138
+
139
+ <span class="note title readonly">readonly</span>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute code.</p></div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#fields-instance_method" title="#fields (instance method)">#<strong>fields</strong> &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+ <span class="note title readonly">readonly</span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute fields.</p></div></span>
177
+
178
+ </li>
179
+
180
+
181
+ <li class="public ">
182
+ <span class="summary_signature">
183
+
184
+ <a href="#http_status-instance_method" title="#http_status (instance method)">#<strong>http_status</strong> &#x21d2; Object </a>
185
+
186
+
187
+
188
+ </span>
189
+
190
+
191
+
192
+
193
+ <span class="note title readonly">readonly</span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute http_status.</p></div></span>
204
+
205
+ </li>
206
+
207
+
208
+ </ul>
209
+
210
+
211
+
212
+
213
+
214
+ <h2>
215
+ Instance Method Summary
216
+ <small><a href="#" class="summary_toggle">collapse</a></small>
217
+ </h2>
218
+
219
+ <ul class="summary">
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(message, code: &quot;SERVER_ERROR&quot;, http_status: 500, fields: {}) &#x21d2; ApiError </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+ <span class="note title constructor">constructor</span>
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+ <span class="summary_desc"><div class='inline'><p>A new instance of ApiError.</p></div></span>
241
+
242
+ </li>
243
+
244
+
245
+ <li class="public ">
246
+ <span class="summary_signature">
247
+
248
+ <a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> &#x21d2; Object </a>
249
+
250
+
251
+
252
+ </span>
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'></div></span>
263
+
264
+ </li>
265
+
266
+
267
+ </ul>
268
+
269
+
270
+
271
+
272
+ <div id="constructor_details" class="method_details_list">
273
+ <h2>Constructor Details</h2>
274
+
275
+ <div class="method_details first">
276
+ <h3 class="signature first" id="initialize-instance_method">
277
+
278
+ #<strong>initialize</strong>(message, code: &quot;SERVER_ERROR&quot;, http_status: 500, fields: {}) &#x21d2; <tt><span class='object_link'><a href="" title="Kabk::ApiError (class)">ApiError</a></span></tt>
279
+
280
+
281
+
282
+
283
+
284
+ </h3><div class="docstring">
285
+ <div class="discussion">
286
+ <p>Returns a new instance of ApiError.</p>
287
+
288
+ </div>
289
+ </div>
290
+ <div class="tags">
291
+
292
+
293
+ </div><table class="source_code">
294
+ <tr>
295
+ <td>
296
+ <pre class="lines">
297
+
298
+
299
+ 8
300
+ 9
301
+ 10
302
+ 11
303
+ 12
304
+ 13</pre>
305
+ </td>
306
+ <td>
307
+ <pre class="code"><span class="info file"># File 'lib/kabk/errors.rb', line 8</span>
308
+
309
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='label'>code:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>SERVER_ERROR</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>http_status:</span> <span class='int'>500</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
310
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
311
+ <span class='ivar'>@code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
312
+ <span class='ivar'>@http_status</span> <span class='op'>=</span> <span class='id identifier rubyid_http_status'>http_status</span>
313
+ <span class='ivar'>@fields</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span>
314
+ <span class='kw'>end</span></pre>
315
+ </td>
316
+ </tr>
317
+ </table>
318
+ </div>
319
+
320
+ </div>
321
+
322
+ <div id="instance_attr_details" class="attr_details">
323
+ <h2>Instance Attribute Details</h2>
324
+
325
+
326
+ <span id=""></span>
327
+ <div class="method_details first">
328
+ <h3 class="signature first" id="code-instance_method">
329
+
330
+ #<strong>code</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
331
+
332
+
333
+
334
+
335
+
336
+ </h3><div class="docstring">
337
+ <div class="discussion">
338
+ <p>Returns the value of attribute code.</p>
339
+
340
+ </div>
341
+ </div>
342
+ <div class="tags">
343
+
344
+
345
+ </div><table class="source_code">
346
+ <tr>
347
+ <td>
348
+ <pre class="lines">
349
+
350
+
351
+ 6
352
+ 7
353
+ 8</pre>
354
+ </td>
355
+ <td>
356
+ <pre class="code"><span class="info file"># File 'lib/kabk/errors.rb', line 6</span>
357
+
358
+ <span class='kw'>def</span> <span class='id identifier rubyid_code'>code</span>
359
+ <span class='ivar'>@code</span>
360
+ <span class='kw'>end</span></pre>
361
+ </td>
362
+ </tr>
363
+ </table>
364
+ </div>
365
+
366
+
367
+ <span id=""></span>
368
+ <div class="method_details ">
369
+ <h3 class="signature " id="fields-instance_method">
370
+
371
+ #<strong>fields</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
372
+
373
+
374
+
375
+
376
+
377
+ </h3><div class="docstring">
378
+ <div class="discussion">
379
+ <p>Returns the value of attribute fields.</p>
380
+
381
+ </div>
382
+ </div>
383
+ <div class="tags">
384
+
385
+
386
+ </div><table class="source_code">
387
+ <tr>
388
+ <td>
389
+ <pre class="lines">
390
+
391
+
392
+ 6
393
+ 7
394
+ 8</pre>
395
+ </td>
396
+ <td>
397
+ <pre class="code"><span class="info file"># File 'lib/kabk/errors.rb', line 6</span>
398
+
399
+ <span class='kw'>def</span> <span class='id identifier rubyid_fields'>fields</span>
400
+ <span class='ivar'>@fields</span>
401
+ <span class='kw'>end</span></pre>
402
+ </td>
403
+ </tr>
404
+ </table>
405
+ </div>
406
+
407
+
408
+ <span id=""></span>
409
+ <div class="method_details ">
410
+ <h3 class="signature " id="http_status-instance_method">
411
+
412
+ #<strong>http_status</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
413
+
414
+
415
+
416
+
417
+
418
+ </h3><div class="docstring">
419
+ <div class="discussion">
420
+ <p>Returns the value of attribute http_status.</p>
421
+
422
+ </div>
423
+ </div>
424
+ <div class="tags">
425
+
426
+
427
+ </div><table class="source_code">
428
+ <tr>
429
+ <td>
430
+ <pre class="lines">
431
+
432
+
433
+ 6
434
+ 7
435
+ 8</pre>
436
+ </td>
437
+ <td>
438
+ <pre class="code"><span class="info file"># File 'lib/kabk/errors.rb', line 6</span>
439
+
440
+ <span class='kw'>def</span> <span class='id identifier rubyid_http_status'>http_status</span>
441
+ <span class='ivar'>@http_status</span>
442
+ <span class='kw'>end</span></pre>
443
+ </td>
444
+ </tr>
445
+ </table>
446
+ </div>
447
+
448
+ </div>
449
+
450
+
451
+ <div id="instance_method_details" class="method_details_list">
452
+ <h2>Instance Method Details</h2>
453
+
454
+
455
+ <div class="method_details first">
456
+ <h3 class="signature first" id="to_h-instance_method">
457
+
458
+ #<strong>to_h</strong> &#x21d2; <tt>Object</tt>
459
+
460
+
461
+
462
+
463
+
464
+ </h3><table class="source_code">
465
+ <tr>
466
+ <td>
467
+ <pre class="lines">
468
+
469
+
470
+ 15
471
+ 16
472
+ 17
473
+ 18
474
+ 19
475
+ 20
476
+ 21
477
+ 22
478
+ 23
479
+ 24</pre>
480
+ </td>
481
+ <td>
482
+ <pre class="code"><span class="info file"># File 'lib/kabk/errors.rb', line 15</span>
483
+
484
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
485
+ <span class='lbrace'>{</span>
486
+ <span class='label'>success:</span> <span class='kw'>false</span><span class='comma'>,</span>
487
+ <span class='label'>error:</span> <span class='lbrace'>{</span>
488
+ <span class='label'>code:</span> <span class='ivar'>@code</span><span class='comma'>,</span>
489
+ <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
490
+ <span class='label'>fields:</span> <span class='ivar'>@fields</span>
491
+ <span class='rbrace'>}</span>
492
+ <span class='rbrace'>}</span>
493
+ <span class='kw'>end</span></pre>
494
+ </td>
495
+ </tr>
496
+ </table>
497
+ </div>
498
+
499
+ </div>
500
+
501
+ </div>
502
+
503
+ <div id="footer">
504
+ Generated on Tue Aug 11 21:17:06 2026 by
505
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
506
+ 0.9.45 (ruby-4.0.6).
507
+ </div>
508
+
509
+ </div>
510
+ </body>
511
+ </html>