servus 0.3.0 → 0.5.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 (144) hide show
  1. checksums.yaml +4 -4
  2. data/lib/generators/servus/event/event_generator.rb +54 -0
  3. data/lib/generators/servus/event/templates/event.rb.erb +44 -0
  4. data/lib/generators/servus/event/templates/event_spec.rb.erb +20 -0
  5. data/lib/generators/servus/guard/guard_generator.rb +1 -1
  6. data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
  7. data/lib/generators/servus/service/service_generator.rb +1 -1
  8. data/lib/servus/base.rb +46 -3
  9. data/lib/servus/config.rb +85 -12
  10. data/lib/servus/event.rb +235 -0
  11. data/lib/servus/events/bus.rb +111 -72
  12. data/lib/servus/events/class_router.rb +40 -0
  13. data/lib/servus/events/emitter.rb +21 -6
  14. data/lib/servus/events/invocation.rb +94 -0
  15. data/lib/servus/events/router.rb +44 -0
  16. data/lib/servus/guard.rb +7 -6
  17. data/lib/servus/guards/falsey_guard.rb +3 -3
  18. data/lib/servus/guards/presence_guard.rb +4 -4
  19. data/lib/servus/guards/state_guard.rb +4 -5
  20. data/lib/servus/guards/truthy_guard.rb +3 -3
  21. data/lib/servus/helpers/controller_helpers.rb +40 -0
  22. data/lib/servus/railtie.rb +10 -8
  23. data/lib/servus/support/errors.rb +16 -0
  24. data/lib/servus/support/lockdown.rb +94 -0
  25. data/lib/servus/support/logger.rb +18 -0
  26. data/lib/servus/support/validator.rb +70 -40
  27. data/lib/servus/testing/example_builders.rb +52 -0
  28. data/lib/servus/testing/matchers.rb +103 -4
  29. data/lib/servus/version.rb +1 -1
  30. data/lib/servus.rb +7 -2
  31. metadata +14 -116
  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 -169
  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 -81
  47. data/docs/core/2_architecture.md +0 -120
  48. data/docs/core/3_service_objects.md +0 -154
  49. data/docs/features/1_schema_validation.md +0 -161
  50. data/docs/features/2_error_handling.md +0 -129
  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/7_lazy_resolvers.md +0 -238
  56. data/docs/features/guards_naming_convention.md +0 -540
  57. data/docs/guides/1_common_patterns.md +0 -90
  58. data/docs/guides/2_migration_guide.md +0 -225
  59. data/docs/integration/1_configuration.md +0 -154
  60. data/docs/integration/2_testing.md +0 -304
  61. data/docs/integration/3_rails_integration.md +0 -99
  62. data/docs/yard/Servus/Base.html +0 -1645
  63. data/docs/yard/Servus/Config.html +0 -582
  64. data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
  65. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
  66. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
  67. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
  68. data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
  69. data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
  70. data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
  71. data/docs/yard/Servus/Extensions/Async.html +0 -141
  72. data/docs/yard/Servus/Extensions.html +0 -117
  73. data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
  74. data/docs/yard/Servus/Generators.html +0 -115
  75. data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
  76. data/docs/yard/Servus/Helpers.html +0 -115
  77. data/docs/yard/Servus/Railtie.html +0 -134
  78. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
  79. data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
  80. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
  81. data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
  82. data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
  83. data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
  84. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
  85. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
  86. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
  87. data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
  88. data/docs/yard/Servus/Support/Errors.html +0 -140
  89. data/docs/yard/Servus/Support/Logger.html +0 -856
  90. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
  91. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
  92. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
  93. data/docs/yard/Servus/Support/Rescuer.html +0 -267
  94. data/docs/yard/Servus/Support/Response.html +0 -574
  95. data/docs/yard/Servus/Support/Validator.html +0 -1150
  96. data/docs/yard/Servus/Support.html +0 -119
  97. data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
  98. data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
  99. data/docs/yard/Servus/Testing.html +0 -142
  100. data/docs/yard/Servus.html +0 -343
  101. data/docs/yard/_index.html +0 -535
  102. data/docs/yard/class_list.html +0 -54
  103. data/docs/yard/css/common.css +0 -1
  104. data/docs/yard/css/full_list.css +0 -58
  105. data/docs/yard/css/style.css +0 -503
  106. data/docs/yard/file.1_common_patterns.html +0 -154
  107. data/docs/yard/file.1_configuration.html +0 -115
  108. data/docs/yard/file.1_overview.html +0 -142
  109. data/docs/yard/file.1_schema_validation.html +0 -188
  110. data/docs/yard/file.2_architecture.html +0 -157
  111. data/docs/yard/file.2_error_handling.html +0 -190
  112. data/docs/yard/file.2_migration_guide.html +0 -242
  113. data/docs/yard/file.2_testing.html +0 -227
  114. data/docs/yard/file.3_async_execution.html +0 -145
  115. data/docs/yard/file.3_rails_integration.html +0 -160
  116. data/docs/yard/file.3_service_objects.html +0 -191
  117. data/docs/yard/file.4_logging.html +0 -135
  118. data/docs/yard/file.ErrorHandling.html +0 -190
  119. data/docs/yard/file.READme.html +0 -674
  120. data/docs/yard/file.architecture.html +0 -157
  121. data/docs/yard/file.async_execution.html +0 -145
  122. data/docs/yard/file.common_patterns.html +0 -154
  123. data/docs/yard/file.configuration.html +0 -115
  124. data/docs/yard/file.error_handling.html +0 -190
  125. data/docs/yard/file.logging.html +0 -135
  126. data/docs/yard/file.migration_guide.html +0 -242
  127. data/docs/yard/file.overview.html +0 -142
  128. data/docs/yard/file.rails_integration.html +0 -160
  129. data/docs/yard/file.schema_validation.html +0 -188
  130. data/docs/yard/file.service_objects.html +0 -191
  131. data/docs/yard/file.testing.html +0 -227
  132. data/docs/yard/file_list.html +0 -119
  133. data/docs/yard/frames.html +0 -22
  134. data/docs/yard/index.html +0 -674
  135. data/docs/yard/js/app.js +0 -344
  136. data/docs/yard/js/full_list.js +0 -242
  137. data/docs/yard/js/jquery.js +0 -4
  138. data/docs/yard/method_list.html +0 -542
  139. data/docs/yard/top-level-namespace.html +0 -110
  140. data/lib/generators/servus/event_handler/event_handler_generator.rb +0 -59
  141. data/lib/generators/servus/event_handler/templates/handler.rb.erb +0 -86
  142. data/lib/generators/servus/event_handler/templates/handler_spec.rb.erb +0 -48
  143. data/lib/servus/event_handler.rb +0 -290
  144. data/lib/servus/events/errors.rb +0 -10
@@ -1,574 +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
- Class: Servus::Support::Response
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::Response";
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 (R)</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>
41
- &raquo;
42
- <span class="title">Response</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>Class: Servus::Support::Response
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">Servus::Support::Response</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/servus/support/response.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
- <p>Encapsulates the result of a service execution.</p>
105
-
106
- <p>Response objects are returned by all service calls and contain either
107
- successful data or an error, never both. Use <span class='object_link'><a href="#success%3F-instance_method" title="Servus::Support::Response#success? (method)">#success?</a></span> to determine
108
- which path to take when handling results.</p>
109
-
110
-
111
- </div>
112
- </div>
113
- <div class="tags">
114
-
115
- <div class="examples">
116
- <h4 class="tag_title">Examples:</h4>
117
-
118
-
119
- <h5 class="example_title"><div class='inline'><p>Handling a successful response</p>
120
- </div></h5>
121
-
122
- <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>user_id:</span> <span class='int'>123</span><span class='rparen'>)</span>
123
- <span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
124
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Data: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
125
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='comment'># =&gt; nil
126
- </span><span class='kw'>end</span></code></pre>
127
-
128
-
129
- <h5 class="example_title"><div class='inline'><p>Handling a failed response</p>
130
- </div></h5>
131
-
132
- <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>user_id:</span> <span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span>
133
- <span class='kw'>unless</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
134
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
135
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Data: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='comment'># =&gt; nil
136
- </span><span class='kw'>end</span></code></pre>
137
-
138
-
139
- <h5 class="example_title"><div class='inline'><p>Pattern matching in controllers</p>
140
- </div></h5>
141
-
142
- <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
143
- <span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
144
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:ok</span>
145
- <span class='kw'>else</span>
146
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:unprocessable_entity</span>
147
- <span class='kw'>end</span></code></pre>
148
-
149
- </div>
150
-
151
-
152
- <p class="tag_title">See Also:</p>
153
- <ul class="see">
154
-
155
- <li><span class='object_link'><a href="../Base.html#success-instance_method" title="Servus::Base#success (method)">Base#success</a></span></li>
156
-
157
- <li><span class='object_link'><a href="../Base.html#failure-instance_method" title="Servus::Base#failure (method)">Base#failure</a></span></li>
158
-
159
- </ul>
160
-
161
- </div>
162
-
163
-
164
-
165
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
166
- <ul class="summary">
167
-
168
- <li class="public ">
169
- <span class="summary_signature">
170
-
171
- <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong> &#x21d2; Object </a>
172
-
173
-
174
-
175
- </span>
176
-
177
-
178
-
179
-
180
- <span class="note title readonly">readonly</span>
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
- <span class="summary_desc"><div class='inline'><p>[Object] The data returned by the service.</p>
191
- </div></span>
192
-
193
- </li>
194
-
195
-
196
- <li class="public ">
197
- <span class="summary_signature">
198
-
199
- <a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong> &#x21d2; Object </a>
200
-
201
-
202
-
203
- </span>
204
-
205
-
206
-
207
-
208
- <span class="note title readonly">readonly</span>
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
- <span class="summary_desc"><div class='inline'><p>[Servus::Support::Errors::ServiceError] The error returned by the service.</p>
219
- </div></span>
220
-
221
- </li>
222
-
223
-
224
- </ul>
225
-
226
-
227
-
228
-
229
-
230
- <h2>
231
- Instance Method Summary
232
- <small><a href="#" class="summary_toggle">collapse</a></small>
233
- </h2>
234
-
235
- <ul class="summary">
236
-
237
- <li class="public ">
238
- <span class="summary_signature">
239
-
240
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(success, data, error) &#x21d2; Response </a>
241
-
242
-
243
-
244
- </span>
245
-
246
-
247
- <span class="note title constructor">constructor</span>
248
-
249
-
250
-
251
-
252
-
253
- <span class="private note title">private</span>
254
-
255
-
256
- <span class="summary_desc"><div class='inline'><p>Creates a new response object.</p>
257
- </div></span>
258
-
259
- </li>
260
-
261
-
262
- <li class="public ">
263
- <span class="summary_signature">
264
-
265
- <a href="#success%3F-instance_method" title="#success? (instance method)">#<strong>success?</strong> &#x21d2; Boolean </a>
266
-
267
-
268
-
269
- </span>
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
- <span class="summary_desc"><div class='inline'><p>Checks if the service execution was successful.</p>
280
- </div></span>
281
-
282
- </li>
283
-
284
-
285
- </ul>
286
-
287
-
288
- <div id="constructor_details" class="method_details_list">
289
- <h2>Constructor Details</h2>
290
-
291
- <div class="method_details first">
292
- <h3 class="signature first" id="initialize-instance_method">
293
-
294
- #<strong>initialize</strong>(success, data, error) &#x21d2; <tt><span class='object_link'><a href="" title="Servus::Support::Response (class)">Response</a></span></tt>
295
-
296
-
297
-
298
-
299
-
300
- </h3><div class="docstring">
301
- <div class="discussion">
302
- <p class="note private">
303
- <strong>This method is part of a private API.</strong>
304
- You should avoid using this method if possible, as it may be removed or be changed in the future.
305
- </p>
306
-
307
- <div class="note notetag">
308
- <strong>Note:</strong>
309
- <div class='inline'><p>This is typically called by <span class='object_link'><a href="../Base.html#success-instance_method" title="Servus::Base#success (method)">Base#success</a></span> or <span class='object_link'><a href="../Base.html#failure-instance_method" title="Servus::Base#failure (method)">Base#failure</a></span>
310
- rather than being instantiated directly.</p>
311
- </div>
312
- </div>
313
-
314
- <p>Creates a new response object.</p>
315
-
316
-
317
- </div>
318
- </div>
319
- <div class="tags">
320
- <p class="tag_title">Parameters:</p>
321
- <ul class="param">
322
-
323
- <li>
324
-
325
- <span class='name'>success</span>
326
-
327
-
328
- <span class='type'>(<tt>Boolean</tt>)</span>
329
-
330
-
331
-
332
- &mdash;
333
- <div class='inline'><p>true for successful responses, false for failures</p>
334
- </div>
335
-
336
- </li>
337
-
338
- <li>
339
-
340
- <span class='name'>data</span>
341
-
342
-
343
- <span class='type'>(<tt>Object</tt>, <tt>nil</tt>)</span>
344
-
345
-
346
-
347
- &mdash;
348
- <div class='inline'><p>the result data (nil for failures)</p>
349
- </div>
350
-
351
- </li>
352
-
353
- <li>
354
-
355
- <span class='name'>error</span>
356
-
357
-
358
- <span class='type'>(<tt><span class='object_link'><a href="Errors/ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">Servus::Support::Errors::ServiceError</a></span></tt>, <tt>nil</tt>)</span>
359
-
360
-
361
-
362
- &mdash;
363
- <div class='inline'><p>the error (nil for successes)</p>
364
- </div>
365
-
366
- </li>
367
-
368
- </ul>
369
-
370
-
371
- </div><table class="source_code">
372
- <tr>
373
- <td>
374
- <pre class="lines">
375
-
376
-
377
- 52
378
- 53
379
- 54
380
- 55
381
- 56</pre>
382
- </td>
383
- <td>
384
- <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 52</span>
385
-
386
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
387
- <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span>
388
- <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
389
- <span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
390
- <span class='kw'>end</span></pre>
391
- </td>
392
- </tr>
393
- </table>
394
- </div>
395
-
396
- </div>
397
-
398
- <div id="instance_attr_details" class="attr_details">
399
- <h2>Instance Attribute Details</h2>
400
-
401
-
402
- <span id=""></span>
403
- <div class="method_details first">
404
- <h3 class="signature first" id="data-instance_method">
405
-
406
- #<strong>data</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
407
-
408
-
409
-
410
-
411
-
412
- </h3><div class="docstring">
413
- <div class="discussion">
414
- <p>[Object] The data returned by the service</p>
415
-
416
-
417
- </div>
418
- </div>
419
- <div class="tags">
420
-
421
-
422
- </div><table class="source_code">
423
- <tr>
424
- <td>
425
- <pre class="lines">
426
-
427
-
428
- 37
429
- 38
430
- 39</pre>
431
- </td>
432
- <td>
433
- <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 37</span>
434
-
435
- <span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
436
- <span class='ivar'>@data</span>
437
- <span class='kw'>end</span></pre>
438
- </td>
439
- </tr>
440
- </table>
441
- </div>
442
-
443
-
444
- <span id=""></span>
445
- <div class="method_details ">
446
- <h3 class="signature " id="error-instance_method">
447
-
448
- #<strong>error</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
449
-
450
-
451
-
452
-
453
-
454
- </h3><div class="docstring">
455
- <div class="discussion">
456
- <p>[Servus::Support::Errors::ServiceError] The error returned by the service</p>
457
-
458
-
459
- </div>
460
- </div>
461
- <div class="tags">
462
-
463
-
464
- </div><table class="source_code">
465
- <tr>
466
- <td>
467
- <pre class="lines">
468
-
469
-
470
- 40
471
- 41
472
- 42</pre>
473
- </td>
474
- <td>
475
- <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 40</span>
476
-
477
- <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
478
- <span class='ivar'>@error</span>
479
- <span class='kw'>end</span></pre>
480
- </td>
481
- </tr>
482
- </table>
483
- </div>
484
-
485
- </div>
486
-
487
-
488
- <div id="instance_method_details" class="method_details_list">
489
- <h2>Instance Method Details</h2>
490
-
491
-
492
- <div class="method_details first">
493
- <h3 class="signature first" id="success?-instance_method">
494
-
495
- #<strong>success?</strong> &#x21d2; <tt>Boolean</tt>
496
-
497
-
498
-
499
-
500
-
501
- </h3><div class="docstring">
502
- <div class="discussion">
503
- <p>Checks if the service execution was successful.</p>
504
-
505
-
506
- </div>
507
- </div>
508
- <div class="tags">
509
-
510
- <div class="examples">
511
- <h4 class="tag_title">Examples:</h4>
512
-
513
-
514
- <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
515
- <span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
516
- <span class='comment'># Handle success - result.data is available
517
- </span><span class='kw'>else</span>
518
- <span class='comment'># Handle failure - result.error is available
519
- </span><span class='kw'>end</span></code></pre>
520
-
521
- </div>
522
-
523
- <p class="tag_title">Returns:</p>
524
- <ul class="return">
525
-
526
- <li>
527
-
528
-
529
- <span class='type'>(<tt>Boolean</tt>)</span>
530
-
531
-
532
-
533
- &mdash;
534
- <div class='inline'><p>true if the service succeeded, false if it failed</p>
535
- </div>
536
-
537
- </li>
538
-
539
- </ul>
540
-
541
- </div><table class="source_code">
542
- <tr>
543
- <td>
544
- <pre class="lines">
545
-
546
-
547
- 69
548
- 70
549
- 71</pre>
550
- </td>
551
- <td>
552
- <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 69</span>
553
-
554
- <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
555
- <span class='ivar'>@success</span>
556
- <span class='kw'>end</span></pre>
557
- </td>
558
- </tr>
559
- </table>
560
- </div>
561
-
562
- </div>
563
-
564
- </div>
565
-
566
- <div id="footer">
567
- Generated on Fri Nov 21 00:33:24 2025 by
568
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
569
- 0.9.37 (ruby-3.4.4).
570
- </div>
571
-
572
- </div>
573
- </body>
574
- </html>