servus 0.2.1 → 0.4.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.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/lib/generators/servus/event_handler/event_handler_generator.rb +1 -1
  3. data/lib/generators/servus/guard/guard_generator.rb +1 -1
  4. data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
  5. data/lib/generators/servus/service/service_generator.rb +1 -1
  6. data/lib/servus/base.rb +67 -9
  7. data/lib/servus/config.rb +71 -3
  8. data/lib/servus/events/bus.rb +29 -0
  9. data/lib/servus/events/emitter.rb +15 -0
  10. data/lib/servus/extensions/lazily/call.rb +82 -0
  11. data/lib/servus/extensions/lazily/errors.rb +37 -0
  12. data/lib/servus/extensions/lazily/ext.rb +23 -0
  13. data/lib/servus/extensions/lazily/resolver.rb +32 -0
  14. data/lib/servus/guard.rb +7 -6
  15. data/lib/servus/guards/falsey_guard.rb +3 -3
  16. data/lib/servus/guards/presence_guard.rb +4 -4
  17. data/lib/servus/guards/state_guard.rb +4 -5
  18. data/lib/servus/guards/truthy_guard.rb +3 -3
  19. data/lib/servus/helpers/controller_helpers.rb +40 -0
  20. data/lib/servus/railtie.rb +7 -1
  21. data/lib/servus/support/data_object.rb +80 -0
  22. data/lib/servus/support/errors.rb +16 -0
  23. data/lib/servus/support/lockdown.rb +94 -0
  24. data/lib/servus/support/logger.rb +16 -0
  25. data/lib/servus/support/response.rb +12 -1
  26. data/lib/servus/support/validator.rb +79 -34
  27. data/lib/servus/testing/example_builders.rb +74 -0
  28. data/lib/servus/testing/matchers.rb +99 -0
  29. data/lib/servus/version.rb +1 -1
  30. data/lib/servus.rb +2 -0
  31. metadata +16 -114
  32. data/.claude/commands/check-docs.md +0 -1
  33. data/.claude/commands/consistency-check.md +0 -1
  34. data/.claude/commands/fine-tooth-comb.md +0 -1
  35. data/.claude/commands/red-green-refactor.md +0 -5
  36. data/.claude/settings.json +0 -24
  37. data/.rspec +0 -3
  38. data/.rubocop.yml +0 -27
  39. data/.yardopts +0 -6
  40. data/CHANGELOG.md +0 -122
  41. data/CLAUDE.md +0 -10
  42. data/IDEAS.md +0 -5
  43. data/LICENSE.txt +0 -21
  44. data/READme.md +0 -856
  45. data/Rakefile +0 -45
  46. data/docs/core/1_overview.md +0 -77
  47. data/docs/core/2_architecture.md +0 -120
  48. data/docs/core/3_service_objects.md +0 -121
  49. data/docs/features/1_schema_validation.md +0 -119
  50. data/docs/features/2_error_handling.md +0 -121
  51. data/docs/features/3_async_execution.md +0 -81
  52. data/docs/features/4_logging.md +0 -64
  53. data/docs/features/5_event_bus.md +0 -244
  54. data/docs/features/6_guards.md +0 -356
  55. data/docs/features/guards_naming_convention.md +0 -540
  56. data/docs/guides/1_common_patterns.md +0 -90
  57. data/docs/guides/2_migration_guide.md +0 -175
  58. data/docs/integration/1_configuration.md +0 -154
  59. data/docs/integration/2_testing.md +0 -287
  60. data/docs/integration/3_rails_integration.md +0 -99
  61. data/docs/yard/Servus/Base.html +0 -1645
  62. data/docs/yard/Servus/Config.html +0 -582
  63. data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
  64. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
  65. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
  66. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
  67. data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
  68. data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
  69. data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
  70. data/docs/yard/Servus/Extensions/Async.html +0 -141
  71. data/docs/yard/Servus/Extensions.html +0 -117
  72. data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
  73. data/docs/yard/Servus/Generators.html +0 -115
  74. data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
  75. data/docs/yard/Servus/Helpers.html +0 -115
  76. data/docs/yard/Servus/Railtie.html +0 -134
  77. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
  78. data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
  79. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
  80. data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
  81. data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
  82. data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
  83. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
  84. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
  85. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
  86. data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
  87. data/docs/yard/Servus/Support/Errors.html +0 -140
  88. data/docs/yard/Servus/Support/Logger.html +0 -856
  89. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
  90. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
  91. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
  92. data/docs/yard/Servus/Support/Rescuer.html +0 -267
  93. data/docs/yard/Servus/Support/Response.html +0 -574
  94. data/docs/yard/Servus/Support/Validator.html +0 -1150
  95. data/docs/yard/Servus/Support.html +0 -119
  96. data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
  97. data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
  98. data/docs/yard/Servus/Testing.html +0 -142
  99. data/docs/yard/Servus.html +0 -343
  100. data/docs/yard/_index.html +0 -535
  101. data/docs/yard/class_list.html +0 -54
  102. data/docs/yard/css/common.css +0 -1
  103. data/docs/yard/css/full_list.css +0 -58
  104. data/docs/yard/css/style.css +0 -503
  105. data/docs/yard/file.1_common_patterns.html +0 -154
  106. data/docs/yard/file.1_configuration.html +0 -115
  107. data/docs/yard/file.1_overview.html +0 -142
  108. data/docs/yard/file.1_schema_validation.html +0 -188
  109. data/docs/yard/file.2_architecture.html +0 -157
  110. data/docs/yard/file.2_error_handling.html +0 -190
  111. data/docs/yard/file.2_migration_guide.html +0 -242
  112. data/docs/yard/file.2_testing.html +0 -227
  113. data/docs/yard/file.3_async_execution.html +0 -145
  114. data/docs/yard/file.3_rails_integration.html +0 -160
  115. data/docs/yard/file.3_service_objects.html +0 -191
  116. data/docs/yard/file.4_logging.html +0 -135
  117. data/docs/yard/file.ErrorHandling.html +0 -190
  118. data/docs/yard/file.READme.html +0 -674
  119. data/docs/yard/file.architecture.html +0 -157
  120. data/docs/yard/file.async_execution.html +0 -145
  121. data/docs/yard/file.common_patterns.html +0 -154
  122. data/docs/yard/file.configuration.html +0 -115
  123. data/docs/yard/file.error_handling.html +0 -190
  124. data/docs/yard/file.logging.html +0 -135
  125. data/docs/yard/file.migration_guide.html +0 -242
  126. data/docs/yard/file.overview.html +0 -142
  127. data/docs/yard/file.rails_integration.html +0 -160
  128. data/docs/yard/file.schema_validation.html +0 -188
  129. data/docs/yard/file.service_objects.html +0 -191
  130. data/docs/yard/file.testing.html +0 -227
  131. data/docs/yard/file_list.html +0 -119
  132. data/docs/yard/frames.html +0 -22
  133. data/docs/yard/index.html +0 -674
  134. data/docs/yard/js/app.js +0 -344
  135. data/docs/yard/js/full_list.js +0 -242
  136. data/docs/yard/js/jquery.js +0 -4
  137. data/docs/yard/method_list.html +0 -542
  138. data/docs/yard/top-level-namespace.html +0 -110
data/docs/yard/Servus/Support/Errors/ServiceError.html DELETED
@@ -1,489 +0,0 @@
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: Servus::Support::Errors::ServiceError
8
-
9
- &mdash; Servus | Service Object Framework
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 = "Servus::Support::Errors::ServiceError";
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> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../../Servus.html" title="Servus (module)">Servus</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Support.html" title="Servus::Support (module)">Support</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="Servus::Support::Errors (module)">Errors</a></span></span>
41
- &raquo;
42
- <span class="title">ServiceError</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>Exception: Servus::Support::Errors::ServiceError
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">StandardError</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">StandardError</li>
78
-
79
- <li class="next">Servus::Support::Errors::ServiceError</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/servus/support/errors.rb</dd>
100
- </dl>
101
-
102
- </div>
103
-
104
- <h2>Overview</h2><div class="docstring">
105
- <div class="discussion">
106
- <p>Base error class for all Servus service errors.</p>
107
-
108
- <p>This class provides the foundation for all service-related errors, including:</p>
109
-
110
- <ul>
111
- <li>Default error messages via DEFAULT_MESSAGE constant</li>
112
- <li>API-friendly error responses via <span class='object_link'><a href="#api_error-instance_method" title="Servus::Support::Errors::ServiceError#api_error (method)">#api_error</a></span></li>
113
- <li>Automatic message fallback to default if none provided</li>
114
- </ul>
115
-
116
-
117
- </div>
118
- </div>
119
- <div class="tags">
120
-
121
- <div class="examples">
122
- <h4 class="tag_title">Examples:</h4>
123
-
124
-
125
- <h5 class="example_title"><div class='inline'><p>Creating a custom error type</p>
126
- </div></h5>
127
-
128
- <pre class="example code"><code><span class='kw'>class</span> <span class='const'>MyCustomError</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="../../../Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Support.html" title="Servus::Support (module)">Support</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="Servus::Support::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'>ServiceError</span>
129
- <span class='const'><span class='object_link'><a href="#DEFAULT_MESSAGE-constant" title="Servus::Support::Errors::ServiceError::DEFAULT_MESSAGE (constant)">DEFAULT_MESSAGE</a></span></span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Something went wrong</span><span class='tstring_end'>&#39;</span></span>
130
-
131
- <span class='kw'>def</span> <span class='id identifier rubyid_api_error'>api_error</span>
132
- <span class='lbrace'>{</span> <span class='label'>code:</span> <span class='symbol'>:custom_error</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span> <span class='rbrace'>}</span>
133
- <span class='kw'>end</span>
134
- <span class='kw'>end</span></code></pre>
135
-
136
-
137
- <h5 class="example_title"><div class='inline'><p>Using with failure method</p>
138
- </div></h5>
139
-
140
- <pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
141
- <span class='kw'>return</span> <span class='id identifier rubyid_failure'>failure</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User not found</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'><span class='object_link'><a href="../../../Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Support.html" title="Servus::Support (module)">Support</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="Servus::Support::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NotFoundError.html" title="Servus::Support::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span>
142
- <span class='comment'># ...
143
- </span><span class='kw'>end</span></code></pre>
144
-
145
- </div>
146
-
147
-
148
- </div><div id="subclasses">
149
- <h2>Direct Known Subclasses</h2>
150
- <p class="children"><span class='object_link'><a href="AuthenticationError.html" title="Servus::Support::Errors::AuthenticationError (class)">AuthenticationError</a></span>, <span class='object_link'><a href="BadRequestError.html" title="Servus::Support::Errors::BadRequestError (class)">BadRequestError</a></span>, <span class='object_link'><a href="ForbiddenError.html" title="Servus::Support::Errors::ForbiddenError (class)">ForbiddenError</a></span>, <span class='object_link'><a href="InternalServerError.html" title="Servus::Support::Errors::InternalServerError (class)">InternalServerError</a></span>, <span class='object_link'><a href="NotFoundError.html" title="Servus::Support::Errors::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="ServiceUnavailableError.html" title="Servus::Support::Errors::ServiceUnavailableError (class)">ServiceUnavailableError</a></span>, <span class='object_link'><a href="UnprocessableEntityError.html" title="Servus::Support::Errors::UnprocessableEntityError (class)">UnprocessableEntityError</a></span></p>
151
- </div>
152
-
153
-
154
- <h2>
155
- Constant Summary
156
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
157
- </h2>
158
-
159
- <dl class="constants">
160
-
161
- <dt id="DEFAULT_MESSAGE-constant" class="">DEFAULT_MESSAGE =
162
-
163
- </dt>
164
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>An error occurred</span><span class='tstring_end'>&#39;</span></span></pre></dd>
165
-
166
- </dl>
167
-
168
-
169
-
170
-
171
-
172
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
173
- <ul class="summary">
174
-
175
- <li class="public ">
176
- <span class="summary_signature">
177
-
178
- <a href="#message-instance_method" title="#message (instance method)">#<strong>message</strong> &#x21d2; Object </a>
179
-
180
-
181
-
182
- </span>
183
-
184
-
185
-
186
-
187
- <span class="note title readonly">readonly</span>
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute message.</p>
198
- </div></span>
199
-
200
- </li>
201
-
202
-
203
- </ul>
204
-
205
-
206
-
207
-
208
-
209
- <h2>
210
- Instance Method Summary
211
- <small><a href="#" class="summary_toggle">collapse</a></small>
212
- </h2>
213
-
214
- <ul class="summary">
215
-
216
- <li class="public ">
217
- <span class="summary_signature">
218
-
219
- <a href="#api_error-instance_method" title="#api_error (instance method)">#<strong>api_error</strong> &#x21d2; Hash </a>
220
-
221
-
222
-
223
- </span>
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
- <span class="summary_desc"><div class='inline'><p>Returns an API-friendly error response.</p>
234
- </div></span>
235
-
236
- </li>
237
-
238
-
239
- <li class="public ">
240
- <span class="summary_signature">
241
-
242
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(message = nil) &#x21d2; ServiceError </a>
243
-
244
-
245
-
246
- </span>
247
-
248
-
249
- <span class="note title constructor">constructor</span>
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
- <span class="summary_desc"><div class='inline'><p>Creates a new service error instance.</p>
259
- </div></span>
260
-
261
- </li>
262
-
263
-
264
- </ul>
265
-
266
-
267
-
268
- <div id="constructor_details" class="method_details_list">
269
- <h2>Constructor Details</h2>
270
-
271
- <div class="method_details first">
272
- <h3 class="signature first" id="initialize-instance_method">
273
-
274
- #<strong>initialize</strong>(message = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></tt>
275
-
276
-
277
-
278
-
279
-
280
- </h3><div class="docstring">
281
- <div class="discussion">
282
- <p>Creates a new service error instance.</p>
283
-
284
-
285
- </div>
286
- </div>
287
- <div class="tags">
288
-
289
- <div class="examples">
290
- <h4 class="tag_title">Examples:</h4>
291
-
292
-
293
- <h5 class="example_title"><div class='inline'><p>With custom message</p>
294
- </div></h5>
295
-
296
- <pre class="example code"><code><span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Something went wrong</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
297
- <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='comment'># =&gt; &quot;Something went wrong&quot;</span></code></pre>
298
-
299
-
300
- <h5 class="example_title"><div class='inline'><p>With default message</p>
301
- </div></h5>
302
-
303
- <pre class="example code"><code><span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
304
- <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='comment'># =&gt; &quot;An error occurred&quot;</span></code></pre>
305
-
306
- </div>
307
- <p class="tag_title">Parameters:</p>
308
- <ul class="param">
309
-
310
- <li>
311
-
312
- <span class='name'>message</span>
313
-
314
-
315
- <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
316
-
317
-
318
- <em class="default">(defaults to: <tt>nil</tt>)</em>
319
-
320
-
321
- &mdash;
322
- <div class='inline'><p>custom error message (uses DEFAULT_MESSAGE if nil)</p>
323
- </div>
324
-
325
- </li>
326
-
327
- </ul>
328
-
329
-
330
- </div><table class="source_code">
331
- <tr>
332
- <td>
333
- <pre class="lines">
334
-
335
-
336
- 50
337
- 51
338
- 52
339
- 53</pre>
340
- </td>
341
- <td>
342
- <pre class="code"><span class="info file"># File 'lib/servus/support/errors.rb', line 50</span>
343
-
344
- <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='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
345
- <span class='ivar'>@message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='op'>::</span><span class='const'>DEFAULT_MESSAGE</span>
346
- <span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</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'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
347
- <span class='kw'>end</span></pre>
348
- </td>
349
- </tr>
350
- </table>
351
- </div>
352
-
353
- </div>
354
-
355
- <div id="instance_attr_details" class="attr_details">
356
- <h2>Instance Attribute Details</h2>
357
-
358
-
359
- <span id=""></span>
360
- <div class="method_details first">
361
- <h3 class="signature first" id="message-instance_method">
362
-
363
- #<strong>message</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
364
-
365
-
366
-
367
-
368
-
369
- </h3><div class="docstring">
370
- <div class="discussion">
371
- <p>Returns the value of attribute message.</p>
372
-
373
-
374
- </div>
375
- </div>
376
- <div class="tags">
377
-
378
-
379
- </div><table class="source_code">
380
- <tr>
381
- <td>
382
- <pre class="lines">
383
-
384
-
385
- 34
386
- 35
387
- 36</pre>
388
- </td>
389
- <td>
390
- <pre class="code"><span class="info file"># File 'lib/servus/support/errors.rb', line 34</span>
391
-
392
- <span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
393
- <span class='ivar'>@message</span>
394
- <span class='kw'>end</span></pre>
395
- </td>
396
- </tr>
397
- </table>
398
- </div>
399
-
400
- </div>
401
-
402
-
403
- <div id="instance_method_details" class="method_details_list">
404
- <h2>Instance Method Details</h2>
405
-
406
-
407
- <div class="method_details first">
408
- <h3 class="signature first" id="api_error-instance_method">
409
-
410
- #<strong>api_error</strong> &#x21d2; <tt>Hash</tt>
411
-
412
-
413
-
414
-
415
-
416
- </h3><div class="docstring">
417
- <div class="discussion">
418
- <p>Returns an API-friendly error response.</p>
419
-
420
- <p>This method formats the error for API responses, providing both a
421
- symbolic code and the error message. Override in subclasses to customize
422
- the error code for specific HTTP status codes.</p>
423
-
424
-
425
- </div>
426
- </div>
427
- <div class="tags">
428
-
429
- <div class="examples">
430
- <h4 class="tag_title">Examples:</h4>
431
-
432
-
433
- <pre class="example code"><code><span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Servus::Support::Errors::ServiceError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Failed to process</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
434
- <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_api_error'>api_error</span> <span class='comment'># =&gt; { code: :bad_request, message: &quot;Failed to process&quot; }</span></code></pre>
435
-
436
- </div>
437
-
438
- <p class="tag_title">Returns:</p>
439
- <ul class="return">
440
-
441
- <li>
442
-
443
-
444
- <span class='type'>(<tt>Hash</tt>)</span>
445
-
446
-
447
-
448
- &mdash;
449
- <div class='inline'><p>hash with :code and :message keys</p>
450
- </div>
451
-
452
- </li>
453
-
454
- </ul>
455
-
456
- </div><table class="source_code">
457
- <tr>
458
- <td>
459
- <pre class="lines">
460
-
461
-
462
- 66
463
- 67
464
- 68</pre>
465
- </td>
466
- <td>
467
- <pre class="code"><span class="info file"># File 'lib/servus/support/errors.rb', line 66</span>
468
-
469
- <span class='kw'>def</span> <span class='id identifier rubyid_api_error'>api_error</span>
470
- <span class='lbrace'>{</span> <span class='label'>code:</span> <span class='symbol'>:bad_request</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span> <span class='rbrace'>}</span>
471
- <span class='kw'>end</span></pre>
472
- </td>
473
- </tr>
474
- </table>
475
- </div>
476
-
477
- </div>
478
-
479
- </div>
480
-
481
- <div id="footer">
482
- Generated on Fri Nov 21 00:33:24 2025 by
483
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
484
- 0.9.37 (ruby-3.4.4).
485
- </div>
486
-
487
- </div>
488
- </body>
489
- </html>