servus 0.3.0 → 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 (132) 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 +46 -3
  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/guard.rb +7 -6
  11. data/lib/servus/guards/falsey_guard.rb +3 -3
  12. data/lib/servus/guards/presence_guard.rb +4 -4
  13. data/lib/servus/guards/state_guard.rb +4 -5
  14. data/lib/servus/guards/truthy_guard.rb +3 -3
  15. data/lib/servus/helpers/controller_helpers.rb +40 -0
  16. data/lib/servus/support/errors.rb +16 -0
  17. data/lib/servus/support/lockdown.rb +94 -0
  18. data/lib/servus/support/logger.rb +16 -0
  19. data/lib/servus/support/validator.rb +65 -34
  20. data/lib/servus/testing/example_builders.rb +52 -0
  21. data/lib/servus/testing/matchers.rb +99 -0
  22. data/lib/servus/version.rb +1 -1
  23. data/lib/servus.rb +1 -0
  24. metadata +7 -111
  25. data/.claude/commands/check-docs.md +0 -1
  26. data/.claude/commands/consistency-check.md +0 -1
  27. data/.claude/commands/fine-tooth-comb.md +0 -1
  28. data/.claude/commands/red-green-refactor.md +0 -5
  29. data/.claude/settings.json +0 -24
  30. data/.rspec +0 -3
  31. data/.rubocop.yml +0 -27
  32. data/.yardopts +0 -6
  33. data/CHANGELOG.md +0 -169
  34. data/CLAUDE.md +0 -10
  35. data/IDEAS.md +0 -5
  36. data/LICENSE.txt +0 -21
  37. data/READme.md +0 -856
  38. data/Rakefile +0 -45
  39. data/docs/core/1_overview.md +0 -81
  40. data/docs/core/2_architecture.md +0 -120
  41. data/docs/core/3_service_objects.md +0 -154
  42. data/docs/features/1_schema_validation.md +0 -161
  43. data/docs/features/2_error_handling.md +0 -129
  44. data/docs/features/3_async_execution.md +0 -81
  45. data/docs/features/4_logging.md +0 -64
  46. data/docs/features/5_event_bus.md +0 -244
  47. data/docs/features/6_guards.md +0 -356
  48. data/docs/features/7_lazy_resolvers.md +0 -238
  49. data/docs/features/guards_naming_convention.md +0 -540
  50. data/docs/guides/1_common_patterns.md +0 -90
  51. data/docs/guides/2_migration_guide.md +0 -225
  52. data/docs/integration/1_configuration.md +0 -154
  53. data/docs/integration/2_testing.md +0 -304
  54. data/docs/integration/3_rails_integration.md +0 -99
  55. data/docs/yard/Servus/Base.html +0 -1645
  56. data/docs/yard/Servus/Config.html +0 -582
  57. data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
  58. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
  59. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
  60. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
  61. data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
  62. data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
  63. data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
  64. data/docs/yard/Servus/Extensions/Async.html +0 -141
  65. data/docs/yard/Servus/Extensions.html +0 -117
  66. data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
  67. data/docs/yard/Servus/Generators.html +0 -115
  68. data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
  69. data/docs/yard/Servus/Helpers.html +0 -115
  70. data/docs/yard/Servus/Railtie.html +0 -134
  71. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
  72. data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
  73. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
  74. data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
  75. data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
  76. data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
  77. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
  78. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
  79. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
  80. data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
  81. data/docs/yard/Servus/Support/Errors.html +0 -140
  82. data/docs/yard/Servus/Support/Logger.html +0 -856
  83. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
  84. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
  85. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
  86. data/docs/yard/Servus/Support/Rescuer.html +0 -267
  87. data/docs/yard/Servus/Support/Response.html +0 -574
  88. data/docs/yard/Servus/Support/Validator.html +0 -1150
  89. data/docs/yard/Servus/Support.html +0 -119
  90. data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
  91. data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
  92. data/docs/yard/Servus/Testing.html +0 -142
  93. data/docs/yard/Servus.html +0 -343
  94. data/docs/yard/_index.html +0 -535
  95. data/docs/yard/class_list.html +0 -54
  96. data/docs/yard/css/common.css +0 -1
  97. data/docs/yard/css/full_list.css +0 -58
  98. data/docs/yard/css/style.css +0 -503
  99. data/docs/yard/file.1_common_patterns.html +0 -154
  100. data/docs/yard/file.1_configuration.html +0 -115
  101. data/docs/yard/file.1_overview.html +0 -142
  102. data/docs/yard/file.1_schema_validation.html +0 -188
  103. data/docs/yard/file.2_architecture.html +0 -157
  104. data/docs/yard/file.2_error_handling.html +0 -190
  105. data/docs/yard/file.2_migration_guide.html +0 -242
  106. data/docs/yard/file.2_testing.html +0 -227
  107. data/docs/yard/file.3_async_execution.html +0 -145
  108. data/docs/yard/file.3_rails_integration.html +0 -160
  109. data/docs/yard/file.3_service_objects.html +0 -191
  110. data/docs/yard/file.4_logging.html +0 -135
  111. data/docs/yard/file.ErrorHandling.html +0 -190
  112. data/docs/yard/file.READme.html +0 -674
  113. data/docs/yard/file.architecture.html +0 -157
  114. data/docs/yard/file.async_execution.html +0 -145
  115. data/docs/yard/file.common_patterns.html +0 -154
  116. data/docs/yard/file.configuration.html +0 -115
  117. data/docs/yard/file.error_handling.html +0 -190
  118. data/docs/yard/file.logging.html +0 -135
  119. data/docs/yard/file.migration_guide.html +0 -242
  120. data/docs/yard/file.overview.html +0 -142
  121. data/docs/yard/file.rails_integration.html +0 -160
  122. data/docs/yard/file.schema_validation.html +0 -188
  123. data/docs/yard/file.service_objects.html +0 -191
  124. data/docs/yard/file.testing.html +0 -227
  125. data/docs/yard/file_list.html +0 -119
  126. data/docs/yard/frames.html +0 -22
  127. data/docs/yard/index.html +0 -674
  128. data/docs/yard/js/app.js +0 -344
  129. data/docs/yard/js/full_list.js +0 -242
  130. data/docs/yard/js/jquery.js +0 -4
  131. data/docs/yard/method_list.html +0 -542
  132. data/docs/yard/top-level-namespace.html +0 -110
data/docs/yard/Servus/Support/Errors/InternalServerError.html DELETED
@@ -1,283 +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::InternalServerError
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::InternalServerError";
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 (I)</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">InternalServerError</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::InternalServerError
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName"><span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">StandardError</li>
78
-
79
- <li class="next"><span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></li>
80
-
81
- <li class="next">Servus::Support::Errors::InternalServerError</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/servus/support/errors.rb</dd>
102
- </dl>
103
-
104
- </div>
105
-
106
- <h2>Overview</h2><div class="docstring">
107
- <div class="discussion">
108
- <p>Represents a 500 Internal Server Error.</p>
109
-
110
- <p>Use this error for unexpected server-side failures.</p>
111
-
112
-
113
- </div>
114
- </div>
115
- <div class="tags">
116
-
117
- <div class="examples">
118
- <h4 class="tag_title">Examples:</h4>
119
-
120
-
121
- <pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
122
- <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'>Database connection lost</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>InternalServerError</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_db_down?'>db_down?</span>
123
- <span class='kw'>end</span></code></pre>
124
-
125
- </div>
126
-
127
-
128
- </div>
129
-
130
- <h2>
131
- Constant Summary
132
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
133
- </h2>
134
-
135
- <dl class="constants">
136
-
137
- <dt id="DEFAULT_MESSAGE-constant" class="">DEFAULT_MESSAGE =
138
-
139
- </dt>
140
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Internal server error</span><span class='tstring_end'>&#39;</span></span></pre></dd>
141
-
142
- </dl>
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
- <h2>Instance Attribute Summary</h2>
151
-
152
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></h3>
153
- <p class="inherited"><span class='object_link'><a href="ServiceError.html#message-instance_method" title="Servus::Support::Errors::ServiceError#message (method)">#message</a></span></p>
154
-
155
-
156
-
157
- <h2>
158
- Instance Method Summary
159
- <small><a href="#" class="summary_toggle">collapse</a></small>
160
- </h2>
161
-
162
- <ul class="summary">
163
-
164
- <li class="public ">
165
- <span class="summary_signature">
166
-
167
- <a href="#api_error-instance_method" title="#api_error (instance method)">#<strong>api_error</strong> &#x21d2; Hash </a>
168
-
169
-
170
-
171
- </span>
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
- <span class="summary_desc"><div class='inline'><p>API error response with :internal_server_error code.</p>
182
- </div></span>
183
-
184
- </li>
185
-
186
-
187
- </ul>
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></h3>
200
- <p class="inherited"><span class='object_link'><a href="ServiceError.html#initialize-instance_method" title="Servus::Support::Errors::ServiceError#initialize (method)">#initialize</a></span></p>
201
-
202
- <div id="constructor_details" class="method_details_list">
203
- <h2>Constructor Details</h2>
204
-
205
- <p class="notice">This class inherits a constructor from <span class='object_link'><a href="ServiceError.html#initialize-instance_method" title="Servus::Support::Errors::ServiceError#initialize (method)">Servus::Support::Errors::ServiceError</a></span></p>
206
-
207
- </div>
208
-
209
-
210
- <div id="instance_method_details" class="method_details_list">
211
- <h2>Instance Method Details</h2>
212
-
213
-
214
- <div class="method_details first">
215
- <h3 class="signature first" id="api_error-instance_method">
216
-
217
- #<strong>api_error</strong> &#x21d2; <tt>Hash</tt>
218
-
219
-
220
-
221
-
222
-
223
- </h3><div class="docstring">
224
- <div class="discussion">
225
- <p>Returns API error response with :internal_server_error code.</p>
226
-
227
-
228
- </div>
229
- </div>
230
- <div class="tags">
231
-
232
- <p class="tag_title">Returns:</p>
233
- <ul class="return">
234
-
235
- <li>
236
-
237
-
238
- <span class='type'>(<tt>Hash</tt>)</span>
239
-
240
-
241
-
242
- &mdash;
243
- <div class='inline'><p>API error response with :internal_server_error code</p>
244
- </div>
245
-
246
- </li>
247
-
248
- </ul>
249
-
250
- </div><table class="source_code">
251
- <tr>
252
- <td>
253
- <pre class="lines">
254
-
255
-
256
- 199
257
- 200
258
- 201</pre>
259
- </td>
260
- <td>
261
- <pre class="code"><span class="info file"># File 'lib/servus/support/errors.rb', line 199</span>
262
-
263
- <span class='kw'>def</span> <span class='id identifier rubyid_api_error'>api_error</span>
264
- <span class='lbrace'>{</span> <span class='label'>code:</span> <span class='symbol'>:internal_server_error</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span> <span class='rbrace'>}</span>
265
- <span class='kw'>end</span></pre>
266
- </td>
267
- </tr>
268
- </table>
269
- </div>
270
-
271
- </div>
272
-
273
- </div>
274
-
275
- <div id="footer">
276
- Generated on Fri Nov 21 00:33:24 2025 by
277
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
278
- 0.9.37 (ruby-3.4.4).
279
- </div>
280
-
281
- </div>
282
- </body>
283
- </html>
data/docs/yard/Servus/Support/Errors/NotFoundError.html DELETED
@@ -1,284 +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::NotFoundError
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::NotFoundError";
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 (N)</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">NotFoundError</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::NotFoundError
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName"><span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">StandardError</li>
78
-
79
- <li class="next"><span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></li>
80
-
81
- <li class="next">Servus::Support::Errors::NotFoundError</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/servus/support/errors.rb</dd>
102
- </dl>
103
-
104
- </div>
105
-
106
- <h2>Overview</h2><div class="docstring">
107
- <div class="discussion">
108
- <p>Represents a 404 Not Found error.</p>
109
-
110
- <p>Use this error when a requested resource cannot be found.</p>
111
-
112
-
113
- </div>
114
- </div>
115
- <div class="tags">
116
-
117
- <div class="examples">
118
- <h4 class="tag_title">Examples:</h4>
119
-
120
-
121
- <pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
122
- <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find_by'>find_by</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@user_id</span><span class='rparen'>)</span>
123
- <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'>NotFoundError</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_user'>user</span>
124
- <span class='kw'>end</span></code></pre>
125
-
126
- </div>
127
-
128
-
129
- </div>
130
-
131
- <h2>
132
- Constant Summary
133
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
134
- </h2>
135
-
136
- <dl class="constants">
137
-
138
- <dt id="DEFAULT_MESSAGE-constant" class="">DEFAULT_MESSAGE =
139
-
140
- </dt>
141
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Not found</span><span class='tstring_end'>&#39;</span></span></pre></dd>
142
-
143
- </dl>
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- <h2>Instance Attribute Summary</h2>
152
-
153
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></h3>
154
- <p class="inherited"><span class='object_link'><a href="ServiceError.html#message-instance_method" title="Servus::Support::Errors::ServiceError#message (method)">#message</a></span></p>
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="#api_error-instance_method" title="#api_error (instance method)">#<strong>api_error</strong> &#x21d2; Hash </a>
169
-
170
-
171
-
172
- </span>
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
- <span class="summary_desc"><div class='inline'><p>API error response with :not_found code.</p>
183
- </div></span>
184
-
185
- </li>
186
-
187
-
188
- </ul>
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></h3>
201
- <p class="inherited"><span class='object_link'><a href="ServiceError.html#initialize-instance_method" title="Servus::Support::Errors::ServiceError#initialize (method)">#initialize</a></span></p>
202
-
203
- <div id="constructor_details" class="method_details_list">
204
- <h2>Constructor Details</h2>
205
-
206
- <p class="notice">This class inherits a constructor from <span class='object_link'><a href="ServiceError.html#initialize-instance_method" title="Servus::Support::Errors::ServiceError#initialize (method)">Servus::Support::Errors::ServiceError</a></span></p>
207
-
208
- </div>
209
-
210
-
211
- <div id="instance_method_details" class="method_details_list">
212
- <h2>Instance Method Details</h2>
213
-
214
-
215
- <div class="method_details first">
216
- <h3 class="signature first" id="api_error-instance_method">
217
-
218
- #<strong>api_error</strong> &#x21d2; <tt>Hash</tt>
219
-
220
-
221
-
222
-
223
-
224
- </h3><div class="docstring">
225
- <div class="discussion">
226
- <p>Returns API error response with :not_found code.</p>
227
-
228
-
229
- </div>
230
- </div>
231
- <div class="tags">
232
-
233
- <p class="tag_title">Returns:</p>
234
- <ul class="return">
235
-
236
- <li>
237
-
238
-
239
- <span class='type'>(<tt>Hash</tt>)</span>
240
-
241
-
242
-
243
- &mdash;
244
- <div class='inline'><p>API error response with :not_found code</p>
245
- </div>
246
-
247
- </li>
248
-
249
- </ul>
250
-
251
- </div><table class="source_code">
252
- <tr>
253
- <td>
254
- <pre class="lines">
255
-
256
-
257
- 151
258
- 152
259
- 153</pre>
260
- </td>
261
- <td>
262
- <pre class="code"><span class="info file"># File 'lib/servus/support/errors.rb', line 151</span>
263
-
264
- <span class='kw'>def</span> <span class='id identifier rubyid_api_error'>api_error</span>
265
- <span class='lbrace'>{</span> <span class='label'>code:</span> <span class='symbol'>:not_found</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span> <span class='rbrace'>}</span>
266
- <span class='kw'>end</span></pre>
267
- </td>
268
- </tr>
269
- </table>
270
- </div>
271
-
272
- </div>
273
-
274
- </div>
275
-
276
- <div id="footer">
277
- Generated on Fri Nov 21 00:33:24 2025 by
278
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
279
- 0.9.37 (ruby-3.4.4).
280
- </div>
281
-
282
- </div>
283
- </body>
284
- </html>