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.html ADDED
@@ -0,0 +1,330 @@
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
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";
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 (K)</a> &raquo;
42
+
43
+
44
+ <span class="title">Kabk</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
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.rb<span class="defines">,<br>
84
+ lib/kabk/field.rb,<br> lib/kabk/errors.rb,<br> lib/kabk/version.rb,<br> lib/kabk/registry.rb,<br> lib/kabk/resource.rb,<br> lib/kabk/validator.rb,<br> lib/kabk/concurrency.rb,<br> lib/kabk/rest_engine.rb,<br> lib/kabk/adapters/base.rb,<br> lib/kabk/query_builder.rb,<br> lib/kabk/export_handler.rb,<br> lib/kabk/upload_handler.rb,<br> lib/kabk/schema_renderer.rb,<br> lib/kabk/resource_builder.rb,<br> lib/kabk/relation_hydrator.rb,<br> lib/kabk/adapters/sequel_adapter.rb</span>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+ <p>Kabk module namespace</p>
94
+
95
+ </div>
96
+ </div>
97
+ <div class="tags">
98
+
99
+
100
+ </div><h2>Defined Under Namespace</h2>
101
+ <p class="children">
102
+
103
+
104
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Kabk/Adapters.html" title="Kabk::Adapters (module)">Adapters</a></span>
105
+
106
+
107
+
108
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Kabk/ApiError.html" title="Kabk::ApiError (class)">ApiError</a></span>, <span class='object_link'><a href="Kabk/Concurrency.html" title="Kabk::Concurrency (class)">Concurrency</a></span>, <span class='object_link'><a href="Kabk/ConcurrencyConflictError.html" title="Kabk::ConcurrencyConflictError (class)">ConcurrencyConflictError</a></span>, <span class='object_link'><a href="Kabk/Error.html" title="Kabk::Error (class)">Error</a></span>, <span class='object_link'><a href="Kabk/ExportHandler.html" title="Kabk::ExportHandler (class)">ExportHandler</a></span>, <span class='object_link'><a href="Kabk/Field.html" title="Kabk::Field (class)">Field</a></span>, <span class='object_link'><a href="Kabk/ForbiddenError.html" title="Kabk::ForbiddenError (class)">ForbiddenError</a></span>, <span class='object_link'><a href="Kabk/InvalidFieldError.html" title="Kabk::InvalidFieldError (class)">InvalidFieldError</a></span>, <span class='object_link'><a href="Kabk/InvalidOldPasswordError.html" title="Kabk::InvalidOldPasswordError (class)">InvalidOldPasswordError</a></span>, <span class='object_link'><a href="Kabk/NotFoundError.html" title="Kabk::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="Kabk/QueryBuilder.html" title="Kabk::QueryBuilder (class)">QueryBuilder</a></span>, <span class='object_link'><a href="Kabk/Registry.html" title="Kabk::Registry (class)">Registry</a></span>, <span class='object_link'><a href="Kabk/RelationHydrator.html" title="Kabk::RelationHydrator (class)">RelationHydrator</a></span>, <span class='object_link'><a href="Kabk/Resource.html" title="Kabk::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Kabk/ResourceBuilder.html" title="Kabk::ResourceBuilder (class)">ResourceBuilder</a></span>, <span class='object_link'><a href="Kabk/RestEngine.html" title="Kabk::RestEngine (class)">RestEngine</a></span>, <span class='object_link'><a href="Kabk/SchemaRenderer.html" title="Kabk::SchemaRenderer (class)">SchemaRenderer</a></span>, <span class='object_link'><a href="Kabk/UnauthorizedError.html" title="Kabk::UnauthorizedError (class)">UnauthorizedError</a></span>, <span class='object_link'><a href="Kabk/UploadHandler.html" title="Kabk::UploadHandler (class)">UploadHandler</a></span>, <span class='object_link'><a href="Kabk/ValidationError.html" title="Kabk::ValidationError (class)">ValidationError</a></span>, <span class='object_link'><a href="Kabk/Validator.html" title="Kabk::Validator (class)">Validator</a></span>
109
+
110
+
111
+ </p>
112
+
113
+
114
+ <h2>
115
+ Constant Summary
116
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
117
+ </h2>
118
+
119
+ <dl class="constants">
120
+
121
+ <dt id="VERSION-constant" class="">VERSION =
122
+
123
+ </dt>
124
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.2</span><span class='tstring_end'>&quot;</span></span></pre></dd>
125
+
126
+ </dl>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <h2>
137
+ Class Method Summary
138
+ <small><a href="#" class="summary_toggle">collapse</a></small>
139
+ </h2>
140
+
141
+ <ul class="summary">
142
+
143
+ <li class="public ">
144
+ <span class="summary_signature">
145
+
146
+ <a href="#register-class_method" title="register (class method)">.<strong>register</strong>(name:, table:, adapter: nil) { ... } &#x21d2; Object </a>
147
+
148
+
149
+
150
+ </span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'><p>Register a new model as a resource.</p></div></span>
161
+
162
+ </li>
163
+
164
+
165
+ </ul>
166
+
167
+
168
+
169
+
170
+
171
+ <div id="class_method_details" class="method_details_list">
172
+ <h2>Class Method Details</h2>
173
+
174
+
175
+ <div class="method_details first">
176
+ <h3 class="signature first" id="register-class_method">
177
+
178
+ .<strong>register</strong>(name:, table:, adapter: nil) { ... } &#x21d2; <tt>Object</tt>
179
+
180
+
181
+
182
+
183
+
184
+ </h3><div class="docstring">
185
+ <div class="discussion">
186
+ <p>Register a new model as a resource</p>
187
+
188
+ </div>
189
+ </div>
190
+ <div class="tags">
191
+ <p class="tag_title">Parameters:</p>
192
+ <ul class="param">
193
+
194
+ <li>
195
+
196
+ <span class='name'>name</span>
197
+
198
+
199
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
200
+
201
+
202
+
203
+ &mdash;
204
+ <div class='inline'><p>The unique identifier for the resource</p></div>
205
+
206
+ </li>
207
+
208
+ <li>
209
+
210
+ <span class='name'>table</span>
211
+
212
+
213
+ <span class='type'>(<tt>Class</tt>)</span>
214
+
215
+
216
+
217
+ &mdash;
218
+ <div class='inline'><p>The Model class (e.g. Sequel::Model)</p></div>
219
+
220
+ </li>
221
+
222
+ <li>
223
+
224
+ <span class='name'>adapter</span>
225
+
226
+
227
+ <span class='type'>(<tt><span class='object_link'><a href="Kabk/Adapters/Base.html" title="Kabk::Adapters::Base (class)">Kabk::Adapters::Base</a></span></tt>)</span>
228
+
229
+
230
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
231
+
232
+
233
+ &mdash;
234
+ <div class='inline'><p>Optional explicit adapter instance</p></div>
235
+
236
+ </li>
237
+
238
+ </ul>
239
+
240
+ <p class="tag_title">Yields:</p>
241
+ <ul class="yield">
242
+
243
+ <li>
244
+
245
+
246
+ <span class='type'></span>
247
+
248
+
249
+
250
+
251
+ <div class='inline'><p>Block evaluated in the context of a ResourceBuilder</p></div>
252
+
253
+ </li>
254
+
255
+ </ul>
256
+
257
+ </div><table class="source_code">
258
+ <tr>
259
+ <td>
260
+ <pre class="lines">
261
+
262
+
263
+ 28
264
+ 29
265
+ 30
266
+ 31
267
+ 32
268
+ 33
269
+ 34
270
+ 35
271
+ 36
272
+ 37
273
+ 38
274
+ 39
275
+ 40
276
+ 41
277
+ 42
278
+ 43
279
+ 44
280
+ 45
281
+ 46
282
+ 47
283
+ 48
284
+ 49
285
+ 50</pre>
286
+ </td>
287
+ <td>
288
+ <pre class="code"><span class="info file"># File 'lib/kabk.rb', line 28</span>
289
+
290
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>table:</span><span class='comma'>,</span> <span class='label'>adapter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
291
+ <span class='id identifier rubyid_resource'>resource</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Kabk/Resource.html" title="Kabk::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Kabk/Resource.html#initialize-instance_method" title="Kabk::Resource#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>model_class:</span> <span class='id identifier rubyid_table'>table</span><span class='rparen'>)</span>
292
+ <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Kabk/ResourceBuilder.html" title="Kabk::ResourceBuilder (class)">ResourceBuilder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Kabk/ResourceBuilder.html#initialize-instance_method" title="Kabk::ResourceBuilder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span>
293
+ <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
294
+
295
+ <span class='comment'># Fallbacks per protocol
296
+ </span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_plural_name'>plural_name</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>s</span><span class='tstring_end'>&quot;</span></span>
297
+ <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_title'>title</span> <span class='op'>||=</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_plural_name'>plural_name</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span>
298
+ <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_icon'>icon</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Database</span><span class='tstring_end'>&quot;</span></span>
299
+ <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/admin/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_plural_name'>plural_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
300
+
301
+ <span class='comment'># Determine and assign adapter
302
+ </span> <span class='kw'>if</span> <span class='id identifier rubyid_adapter'>adapter</span>
303
+ <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter'>adapter</span>
304
+ <span class='kw'>elsif</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>Sequel</span><span class='op'>::</span><span class='const'>Model</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_table'>table</span> <span class='op'>&lt;</span> <span class='const'>Sequel</span><span class='op'>::</span><span class='const'>Model</span>
305
+ <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Kabk/Adapters.html" title="Kabk::Adapters (module)">Adapters</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Kabk/Adapters/SequelAdapter.html" title="Kabk::Adapters::SequelAdapter (class)">SequelAdapter</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Kabk/Adapters/Base.html#initialize-instance_method" title="Kabk::Adapters::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span>
306
+ <span class='kw'>else</span>
307
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Could not determine appropriate adapter for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_table'>table</span><span class='embexpr_end'>}</span><span class='tstring_content'>. Please provide an explicit adapter.</span><span class='tstring_end'>&quot;</span></span>
308
+ <span class='kw'>end</span>
309
+
310
+ <span class='const'><span class='object_link'><a href="Kabk/Registry.html" title="Kabk::Registry (class)">Registry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'><span class='object_link'><a href="Kabk/Registry.html#instance-class_method" title="Kabk::Registry.instance (method)">instance</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="Kabk/Registry.html#register-instance_method" title="Kabk::Registry#register (method)">register</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span>
311
+ <span class='id identifier rubyid_resource'>resource</span>
312
+ <span class='kw'>end</span></pre>
313
+ </td>
314
+ </tr>
315
+ </table>
316
+ </div>
317
+
318
+ </div>
319
+
320
+ </div>
321
+
322
+ <div id="footer">
323
+ Generated on Tue Aug 11 21:17:06 2026 by
324
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
325
+ 0.9.45 (ruby-4.0.6).
326
+ </div>
327
+
328
+ </div>
329
+ </body>
330
+ </html>