ballast 2.2.4 → 2.2.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +6 -1
  3. data/.travis-gemfile +2 -2
  4. data/.travis.yml +5 -3
  5. data/.yardopts +1 -1
  6. data/CHANGELOG.md +9 -0
  7. data/Gemfile +1 -1
  8. data/LICENSE.md +21 -0
  9. data/README.md +22 -17
  10. data/Rakefile +1 -1
  11. data/ballast.gemspec +1 -1
  12. data/{doc → docs}/Ballast.html +19 -21
  13. data/docs/Ballast/AjaxResponse.html +1470 -0
  14. data/{doc → docs}/Ballast/Concerns.html +3 -3
  15. data/{doc → docs}/Ballast/Concerns/AjaxHandling.html +33 -38
  16. data/{doc → docs}/Ballast/Concerns/Common.html +45 -52
  17. data/{doc → docs}/Ballast/Concerns/ErrorsHandling.html +13 -14
  18. data/docs/Ballast/Concerns/JSONApi.html +127 -0
  19. data/docs/Ballast/Concerns/JSONApi/PaginationHandling.html +617 -0
  20. data/docs/Ballast/Concerns/JSONApi/RequestHandling.html +775 -0
  21. data/docs/Ballast/Concerns/JSONApi/ResponseHandling.html +917 -0
  22. data/{doc → docs}/Ballast/Concerns/View.html +35 -42
  23. data/{doc → docs}/Ballast/Configuration.html +19 -22
  24. data/{doc → docs}/Ballast/Emoji.html +1 -1
  25. data/{doc → docs}/Ballast/Emoji/Character.html +15 -18
  26. data/docs/Ballast/Emoji/Utils.html +794 -0
  27. data/{doc → docs}/Ballast/Errors.html +1 -1
  28. data/{doc → docs}/Ballast/Errors/Base.html +16 -18
  29. data/{doc → docs}/Ballast/Errors/Failure.html +1 -1
  30. data/{doc → docs}/Ballast/Errors/InvalidDomain.html +1 -1
  31. data/{doc → docs}/Ballast/Errors/ValidationFailure.html +1 -1
  32. data/{doc → docs}/Ballast/Middlewares.html +1 -1
  33. data/{doc → docs}/Ballast/Middlewares/DefaultHost.html +16 -18
  34. data/docs/Ballast/RequestDomainMatcher.html +917 -0
  35. data/docs/Ballast/Service.html +1513 -0
  36. data/docs/Ballast/Service/Response.html +1270 -0
  37. data/{doc → docs}/Ballast/Version.html +5 -9
  38. data/{doc → docs}/_index.html +45 -1
  39. data/docs/class_list.html +58 -0
  40. data/{doc → docs}/css/common.css +0 -0
  41. data/{doc → docs}/css/full_list.css +0 -0
  42. data/{doc → docs}/css/style.css +0 -0
  43. data/{doc → docs}/file.README.html +7 -5
  44. data/{doc → docs}/file_list.html +0 -0
  45. data/{doc → docs}/frames.html +0 -0
  46. data/{doc → docs}/index.html +7 -5
  47. data/{doc → docs}/js/app.js +0 -0
  48. data/{doc → docs}/js/full_list.js +0 -0
  49. data/{doc → docs}/js/jquery.js +0 -0
  50. data/{doc → docs}/method_list.html +150 -36
  51. data/docs/top-level-namespace.html +149 -0
  52. data/lib/ballast.rb +1 -1
  53. data/lib/ballast/ajax_response.rb +1 -1
  54. data/lib/ballast/concerns/ajax_handling.rb +1 -1
  55. data/lib/ballast/concerns/common.rb +1 -1
  56. data/lib/ballast/concerns/errors_handling.rb +1 -1
  57. data/lib/ballast/concerns/json_api/pagination_handling.rb +83 -0
  58. data/lib/ballast/concerns/json_api/request_handling.rb +235 -0
  59. data/lib/ballast/concerns/json_api/response_handling.rb +70 -0
  60. data/lib/ballast/concerns/view.rb +1 -1
  61. data/lib/ballast/configuration.rb +1 -1
  62. data/lib/ballast/emoji.rb +1 -1
  63. data/lib/ballast/errors.rb +1 -1
  64. data/lib/ballast/middlewares/default_host.rb +1 -1
  65. data/lib/ballast/request_domain_matcher.rb +1 -1
  66. data/lib/ballast/service.rb +1 -1
  67. data/lib/ballast/version.rb +2 -2
  68. data/spec/ballast/ajax_response_spec.rb +1 -1
  69. data/spec/ballast/concerns/ajax_handling_spec.rb +1 -1
  70. data/spec/ballast/concerns/common_spec.rb +1 -1
  71. data/spec/ballast/concerns/errors_handling_spec.rb +1 -1
  72. data/spec/ballast/concerns/view_spec.rb +1 -1
  73. data/spec/ballast/configuration_spec.rb +1 -1
  74. data/spec/ballast/errors_spec.rb +1 -1
  75. data/spec/ballast/middlewares/default_host_spec.rb +1 -1
  76. data/spec/ballast/request_domain_matcher_spec.rb +1 -1
  77. data/spec/ballast_spec.rb +1 -1
  78. data/spec/spec_helper.rb +1 -1
  79. metadata +47 -39
  80. data/doc/Ballast/AjaxResponse.html +0 -1478
  81. data/doc/Ballast/Emoji/Utils.html +0 -799
  82. data/doc/Ballast/RequestDomainMatcher.html +0 -923
  83. data/doc/Ballast/Service.html +0 -1522
  84. data/doc/Ballast/Service/Response.html +0 -1278
  85. data/doc/class_list.html +0 -58
  86. data/doc/top-level-namespace.html +0 -112
data/docs/Ballast/Service/Response.html ADDED
@@ -0,0 +1,1270 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Ballast::Service::Response
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!Ballast/Service/Response.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (R)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Ballast.html" title="Ballast (module)">Ballast</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Service.html" title="Ballast::Service (class)">Service</a></span></span>
36
+ &raquo;
37
+ <span class="title">Response</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Ballast::Service::Response
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Ballast::Service::Response</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/ballast/service.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <p>A response to a service invocation.</p>
105
+
106
+
107
+ </div>
108
+ </div>
109
+ <div class="tags">
110
+
111
+
112
+ </div>
113
+
114
+
115
+
116
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#data-instance_method" title="#data (instance method)">- (Object) <strong>data</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+ <span class="note title readonly">readonly</span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'><p>The data returned by the operation.</p>
142
+ </div></span>
143
+
144
+ </li>
145
+
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+ <span class="note title readonly">readonly</span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'><p>The errors returned by the operation.</p>
170
+ </div></span>
171
+
172
+ </li>
173
+
174
+
175
+ <li class="public ">
176
+ <span class="summary_signature">
177
+
178
+ <a href="#success-instance_method" title="#success (instance method)">- (Boolean) <strong>success</strong> </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>Whether the invocation was successful or not.</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="#as_ajax_response-instance_method" title="#as_ajax_response (instance method)">- (AjaxResponse) <strong>as_ajax_response</strong>(transport = nil) </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'><p>Converts this response to a AJAX response.</p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+ <span class="summary_desc"><div class='inline'><p>Returns the first error returned by the operation.</p>
257
+ </div></span>
258
+
259
+ </li>
260
+
261
+
262
+ <li class="public ">
263
+ <span class="summary_signature">
264
+
265
+ <a href="#fail%3F-instance_method" title="#fail? (instance method)">- (Boolean) <strong>fail?</strong> </a>
266
+
267
+
268
+
269
+ (also: #failed?)
270
+
271
+ </span>
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <span class="summary_desc"><div class='inline'><p>Returns whether the invocation failed or not.</p>
282
+ </div></span>
283
+
284
+ </li>
285
+
286
+
287
+ <li class="public ">
288
+ <span class="summary_signature">
289
+
290
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Response) <strong>initialize</strong>(success = true, data: nil, errors: nil, error: nil) </a>
291
+
292
+
293
+
294
+ </span>
295
+
296
+
297
+ <span class="note title constructor">constructor</span>
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+ <span class="summary_desc"><div class='inline'><p>Creates a new service response.</p>
307
+ </div></span>
308
+
309
+ </li>
310
+
311
+
312
+ <li class="public ">
313
+ <span class="summary_signature">
314
+
315
+ <a href="#success%3F-instance_method" title="#success? (instance method)">- (Boolean) <strong>success?</strong> </a>
316
+
317
+
318
+
319
+ (also: #successful?, #succeeded?)
320
+
321
+ </span>
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+ <span class="summary_desc"><div class='inline'><p>Returns whether the invocation was successful or not.</p>
332
+ </div></span>
333
+
334
+ </li>
335
+
336
+
337
+ </ul>
338
+
339
+
340
+ <div id="constructor_details" class="method_details_list">
341
+ <h2>Constructor Details</h2>
342
+
343
+ <div class="method_details first">
344
+ <h3 class="signature first" id="initialize-instance_method">
345
+
346
+ - (<tt><span class='object_link'><a href="" title="Ballast::Service::Response (class)">Response</a></span></tt>) <strong>initialize</strong>(success = true, data: nil, errors: nil, error: nil)
347
+
348
+
349
+
350
+
351
+
352
+ </h3><div class="docstring">
353
+ <div class="discussion">
354
+ <p>Creates a new service response.</p>
355
+
356
+
357
+ </div>
358
+ </div>
359
+ <div class="tags">
360
+ <p class="tag_title">Parameters:</p>
361
+ <ul class="param">
362
+
363
+ <li>
364
+
365
+ <span class='name'>success</span>
366
+
367
+
368
+ <span class='type'>(<tt>Boolean</tt>)</span>
369
+
370
+
371
+ <em class="default">(defaults to: <tt>true</tt>)</em>
372
+
373
+
374
+ &mdash;
375
+ <div class='inline'><p>Whether the invocation was successful or not.</p>
376
+ </div>
377
+
378
+ </li>
379
+
380
+ <li>
381
+
382
+ <span class='name'>data</span>
383
+
384
+
385
+ <span class='type'>(<tt>Object|NilClass</tt>)</span>
386
+
387
+
388
+
389
+ &mdash;
390
+ <div class='inline'><p>The data returned by the operation.</p>
391
+ </div>
392
+
393
+ </li>
394
+
395
+ <li>
396
+
397
+ <span class='name'>errors</span>
398
+
399
+
400
+ <span class='type'>(<tt>Array|NilClass</tt>)</span>
401
+
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'><p>The errors returned by the operation.</p>
406
+ </div>
407
+
408
+ </li>
409
+
410
+ <li>
411
+
412
+ <span class='name'>error</span>
413
+
414
+
415
+ <span class='type'>(<tt>Object|NilClass</tt>)</span>
416
+
417
+
418
+
419
+ &mdash;
420
+ <div class='inline'><p>Alias for errors. <em>Ignored if <code>errors</code> is present.</em></p>
421
+ </div>
422
+
423
+ </li>
424
+
425
+ </ul>
426
+
427
+
428
+ </div><table class="source_code">
429
+ <tr>
430
+ <td>
431
+ <pre class="lines">
432
+
433
+
434
+ 29
435
+ 30
436
+ 31
437
+ 32
438
+ 33
439
+ 34
440
+ 35</pre>
441
+ </td>
442
+ <td>
443
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 29</span>
444
+
445
+ <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='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
446
+ <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
447
+
448
+ <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
449
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
450
+ <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
451
+ <span class='kw'>end</span></pre>
452
+ </td>
453
+ </tr>
454
+ </table>
455
+ </div>
456
+
457
+ </div>
458
+
459
+ <div id="instance_attr_details" class="attr_details">
460
+ <h2>Instance Attribute Details</h2>
461
+
462
+
463
+ <span id=""></span>
464
+ <div class="method_details first">
465
+ <h3 class="signature first" id="data-instance_method">
466
+
467
+ - (<tt>Object</tt>) <strong>data</strong> <span class="extras">(readonly)</span>
468
+
469
+
470
+
471
+
472
+
473
+ </h3><div class="docstring">
474
+ <div class="discussion">
475
+ <p>Returns The data returned by the operation.</p>
476
+
477
+
478
+ </div>
479
+ </div>
480
+ <div class="tags">
481
+
482
+ <p class="tag_title">Returns:</p>
483
+ <ul class="return">
484
+
485
+ <li>
486
+
487
+
488
+ <span class='type'>(<tt>Object</tt>)</span>
489
+
490
+
491
+
492
+ &mdash;
493
+ <div class='inline'><p>The data returned by the operation.</p>
494
+ </div>
495
+
496
+ </li>
497
+
498
+ </ul>
499
+
500
+ </div><table class="source_code">
501
+ <tr>
502
+ <td>
503
+ <pre class="lines">
504
+
505
+
506
+ 20
507
+ 21
508
+ 22
509
+ 23
510
+ 24
511
+ 25
512
+ 26
513
+ 27
514
+ 28
515
+ 29
516
+ 30
517
+ 31
518
+ 32
519
+ 33
520
+ 34
521
+ 35
522
+ 36
523
+ 37
524
+ 38
525
+ 39
526
+ 40
527
+ 41
528
+ 42
529
+ 43
530
+ 44
531
+ 45
532
+ 46
533
+ 47
534
+ 48
535
+ 49
536
+ 50
537
+ 51
538
+ 52
539
+ 53
540
+ 54
541
+ 55
542
+ 56
543
+ 57
544
+ 58
545
+ 59
546
+ 60
547
+ 61
548
+ 62
549
+ 63
550
+ 64
551
+ 65
552
+ 66
553
+ 67
554
+ 68
555
+ 69
556
+ 70
557
+ 71
558
+ 72
559
+ 73
560
+ 74
561
+ 75
562
+ 76
563
+ 77
564
+ 78</pre>
565
+ </td>
566
+ <td>
567
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 20</span>
568
+
569
+ <span class='kw'>class</span> <span class='const'>Response</span>
570
+ <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:success</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
571
+
572
+ <span class='comment'># Creates a new service response.
573
+ </span> <span class='comment'>#
574
+ </span> <span class='comment'># @param success [Boolean] Whether the invocation was successful or not.
575
+ </span> <span class='comment'># @param data [Object|NilClass] The data returned by the operation.
576
+ </span> <span class='comment'># @param errors [Array|NilClass] The errors returned by the operation.
577
+ </span> <span class='comment'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*
578
+ </span> <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='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
579
+ <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
580
+
581
+ <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
582
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
583
+ <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
584
+ <span class='kw'>end</span>
585
+
586
+ <span class='comment'># Returns whether the invocation was successful or not.
587
+ </span> <span class='comment'>#
588
+ </span> <span class='comment'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.
589
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
590
+ <span class='comment'># TODO@PI: Ignore rubocop on this
591
+ </span> <span class='ivar'>@success</span>
592
+ <span class='kw'>end</span>
593
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:successful?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
594
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:succeeded?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
595
+
596
+ <span class='comment'># Returns whether the invocation failed or not.
597
+ </span> <span class='comment'>#
598
+ </span> <span class='comment'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.
599
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
600
+ <span class='op'>!</span><span class='ivar'>@success</span>
601
+ <span class='kw'>end</span>
602
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:failed?</span><span class='comma'>,</span> <span class='symbol'>:fail?</span>
603
+
604
+ <span class='comment'># Returns the first error returned by the operation.
605
+ </span> <span class='comment'>#
606
+ </span> <span class='comment'># @return [Object] The first error returned by the service.
607
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
608
+ <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
609
+ <span class='kw'>end</span>
610
+
611
+ <span class='comment'># Converts this response to a AJAX response.
612
+ </span> <span class='comment'>#
613
+ </span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
614
+ </span> <span class='comment'># @return [AjaxResponse] The AJAX response, which will include only the first error.
615
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
616
+ <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
617
+ <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
618
+ <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
619
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
620
+ <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
621
+ <span class='kw'>else</span>
622
+ <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
623
+ <span class='kw'>end</span>
624
+
625
+ <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
626
+ <span class='kw'>end</span>
627
+ <span class='kw'>end</span></pre>
628
+ </td>
629
+ </tr>
630
+ </table>
631
+ </div>
632
+
633
+
634
+ <span id=""></span>
635
+ <div class="method_details ">
636
+ <h3 class="signature " id="errors-instance_method">
637
+
638
+ - (<tt>Array</tt>) <strong>errors</strong> <span class="extras">(readonly)</span>
639
+
640
+
641
+
642
+
643
+
644
+ </h3><div class="docstring">
645
+ <div class="discussion">
646
+ <p>Returns The errors returned by the operation.</p>
647
+
648
+
649
+ </div>
650
+ </div>
651
+ <div class="tags">
652
+
653
+ <p class="tag_title">Returns:</p>
654
+ <ul class="return">
655
+
656
+ <li>
657
+
658
+
659
+ <span class='type'>(<tt>Array</tt>)</span>
660
+
661
+
662
+
663
+ &mdash;
664
+ <div class='inline'><p>The errors returned by the operation.</p>
665
+ </div>
666
+
667
+ </li>
668
+
669
+ </ul>
670
+
671
+ </div><table class="source_code">
672
+ <tr>
673
+ <td>
674
+ <pre class="lines">
675
+
676
+
677
+ 20
678
+ 21
679
+ 22
680
+ 23
681
+ 24
682
+ 25
683
+ 26
684
+ 27
685
+ 28
686
+ 29
687
+ 30
688
+ 31
689
+ 32
690
+ 33
691
+ 34
692
+ 35
693
+ 36
694
+ 37
695
+ 38
696
+ 39
697
+ 40
698
+ 41
699
+ 42
700
+ 43
701
+ 44
702
+ 45
703
+ 46
704
+ 47
705
+ 48
706
+ 49
707
+ 50
708
+ 51
709
+ 52
710
+ 53
711
+ 54
712
+ 55
713
+ 56
714
+ 57
715
+ 58
716
+ 59
717
+ 60
718
+ 61
719
+ 62
720
+ 63
721
+ 64
722
+ 65
723
+ 66
724
+ 67
725
+ 68
726
+ 69
727
+ 70
728
+ 71
729
+ 72
730
+ 73
731
+ 74
732
+ 75
733
+ 76
734
+ 77
735
+ 78</pre>
736
+ </td>
737
+ <td>
738
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 20</span>
739
+
740
+ <span class='kw'>class</span> <span class='const'>Response</span>
741
+ <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:success</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
742
+
743
+ <span class='comment'># Creates a new service response.
744
+ </span> <span class='comment'>#
745
+ </span> <span class='comment'># @param success [Boolean] Whether the invocation was successful or not.
746
+ </span> <span class='comment'># @param data [Object|NilClass] The data returned by the operation.
747
+ </span> <span class='comment'># @param errors [Array|NilClass] The errors returned by the operation.
748
+ </span> <span class='comment'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*
749
+ </span> <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='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
750
+ <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
751
+
752
+ <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
753
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
754
+ <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
755
+ <span class='kw'>end</span>
756
+
757
+ <span class='comment'># Returns whether the invocation was successful or not.
758
+ </span> <span class='comment'>#
759
+ </span> <span class='comment'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.
760
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
761
+ <span class='comment'># TODO@PI: Ignore rubocop on this
762
+ </span> <span class='ivar'>@success</span>
763
+ <span class='kw'>end</span>
764
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:successful?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
765
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:succeeded?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
766
+
767
+ <span class='comment'># Returns whether the invocation failed or not.
768
+ </span> <span class='comment'>#
769
+ </span> <span class='comment'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.
770
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
771
+ <span class='op'>!</span><span class='ivar'>@success</span>
772
+ <span class='kw'>end</span>
773
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:failed?</span><span class='comma'>,</span> <span class='symbol'>:fail?</span>
774
+
775
+ <span class='comment'># Returns the first error returned by the operation.
776
+ </span> <span class='comment'>#
777
+ </span> <span class='comment'># @return [Object] The first error returned by the service.
778
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
779
+ <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
780
+ <span class='kw'>end</span>
781
+
782
+ <span class='comment'># Converts this response to a AJAX response.
783
+ </span> <span class='comment'>#
784
+ </span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
785
+ </span> <span class='comment'># @return [AjaxResponse] The AJAX response, which will include only the first error.
786
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
787
+ <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
788
+ <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
789
+ <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
790
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
791
+ <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
792
+ <span class='kw'>else</span>
793
+ <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
794
+ <span class='kw'>end</span>
795
+
796
+ <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
797
+ <span class='kw'>end</span>
798
+ <span class='kw'>end</span></pre>
799
+ </td>
800
+ </tr>
801
+ </table>
802
+ </div>
803
+
804
+
805
+ <span id=""></span>
806
+ <div class="method_details ">
807
+ <h3 class="signature " id="success-instance_method">
808
+
809
+ - (<tt>Boolean</tt>) <strong>success</strong> <span class="extras">(readonly)</span>
810
+
811
+
812
+
813
+
814
+
815
+ </h3><div class="docstring">
816
+ <div class="discussion">
817
+ <p>Returns Whether the invocation was successful or not.</p>
818
+
819
+
820
+ </div>
821
+ </div>
822
+ <div class="tags">
823
+
824
+ <p class="tag_title">Returns:</p>
825
+ <ul class="return">
826
+
827
+ <li>
828
+
829
+
830
+ <span class='type'>(<tt>Boolean</tt>)</span>
831
+
832
+
833
+
834
+ &mdash;
835
+ <div class='inline'><p>Whether the invocation was successful or not.</p>
836
+ </div>
837
+
838
+ </li>
839
+
840
+ </ul>
841
+
842
+ </div><table class="source_code">
843
+ <tr>
844
+ <td>
845
+ <pre class="lines">
846
+
847
+
848
+ 20
849
+ 21
850
+ 22
851
+ 23
852
+ 24
853
+ 25
854
+ 26
855
+ 27
856
+ 28
857
+ 29
858
+ 30
859
+ 31
860
+ 32
861
+ 33
862
+ 34
863
+ 35
864
+ 36
865
+ 37
866
+ 38
867
+ 39
868
+ 40
869
+ 41
870
+ 42
871
+ 43
872
+ 44
873
+ 45
874
+ 46
875
+ 47
876
+ 48
877
+ 49
878
+ 50
879
+ 51
880
+ 52
881
+ 53
882
+ 54
883
+ 55
884
+ 56
885
+ 57
886
+ 58
887
+ 59
888
+ 60
889
+ 61
890
+ 62
891
+ 63
892
+ 64
893
+ 65
894
+ 66
895
+ 67
896
+ 68
897
+ 69
898
+ 70
899
+ 71
900
+ 72
901
+ 73
902
+ 74
903
+ 75
904
+ 76
905
+ 77
906
+ 78</pre>
907
+ </td>
908
+ <td>
909
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 20</span>
910
+
911
+ <span class='kw'>class</span> <span class='const'>Response</span>
912
+ <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:success</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
913
+
914
+ <span class='comment'># Creates a new service response.
915
+ </span> <span class='comment'>#
916
+ </span> <span class='comment'># @param success [Boolean] Whether the invocation was successful or not.
917
+ </span> <span class='comment'># @param data [Object|NilClass] The data returned by the operation.
918
+ </span> <span class='comment'># @param errors [Array|NilClass] The errors returned by the operation.
919
+ </span> <span class='comment'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*
920
+ </span> <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='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
921
+ <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
922
+
923
+ <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
924
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
925
+ <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
926
+ <span class='kw'>end</span>
927
+
928
+ <span class='comment'># Returns whether the invocation was successful or not.
929
+ </span> <span class='comment'>#
930
+ </span> <span class='comment'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.
931
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
932
+ <span class='comment'># TODO@PI: Ignore rubocop on this
933
+ </span> <span class='ivar'>@success</span>
934
+ <span class='kw'>end</span>
935
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:successful?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
936
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:succeeded?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
937
+
938
+ <span class='comment'># Returns whether the invocation failed or not.
939
+ </span> <span class='comment'>#
940
+ </span> <span class='comment'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.
941
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
942
+ <span class='op'>!</span><span class='ivar'>@success</span>
943
+ <span class='kw'>end</span>
944
+ <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:failed?</span><span class='comma'>,</span> <span class='symbol'>:fail?</span>
945
+
946
+ <span class='comment'># Returns the first error returned by the operation.
947
+ </span> <span class='comment'>#
948
+ </span> <span class='comment'># @return [Object] The first error returned by the service.
949
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
950
+ <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
951
+ <span class='kw'>end</span>
952
+
953
+ <span class='comment'># Converts this response to a AJAX response.
954
+ </span> <span class='comment'>#
955
+ </span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
956
+ </span> <span class='comment'># @return [AjaxResponse] The AJAX response, which will include only the first error.
957
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
958
+ <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
959
+ <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
960
+ <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
961
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
962
+ <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
963
+ <span class='kw'>else</span>
964
+ <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
965
+ <span class='kw'>end</span>
966
+
967
+ <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
968
+ <span class='kw'>end</span>
969
+ <span class='kw'>end</span></pre>
970
+ </td>
971
+ </tr>
972
+ </table>
973
+ </div>
974
+
975
+ </div>
976
+
977
+
978
+ <div id="instance_method_details" class="method_details_list">
979
+ <h2>Instance Method Details</h2>
980
+
981
+
982
+ <div class="method_details first">
983
+ <h3 class="signature first" id="as_ajax_response-instance_method">
984
+
985
+ - (<tt><span class='object_link'><a href="../AjaxResponse.html" title="Ballast::AjaxResponse (class)">AjaxResponse</a></span></tt>) <strong>as_ajax_response</strong>(transport = nil)
986
+
987
+
988
+
989
+
990
+
991
+ </h3><div class="docstring">
992
+ <div class="discussion">
993
+ <p>Converts this response to a AJAX response.</p>
994
+
995
+
996
+ </div>
997
+ </div>
998
+ <div class="tags">
999
+ <p class="tag_title">Parameters:</p>
1000
+ <ul class="param">
1001
+
1002
+ <li>
1003
+
1004
+ <span class='name'>transport</span>
1005
+
1006
+
1007
+ <span class='type'>(<tt>Object|NilClass</tt>)</span>
1008
+
1009
+
1010
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1011
+
1012
+
1013
+ &mdash;
1014
+ <div class='inline'><p>The transport to use for sending. Must respond to <code>render</code>, <code>params</code>, <code>request.format</code> and <code>performed?</code>.</p>
1015
+ </div>
1016
+
1017
+ </li>
1018
+
1019
+ </ul>
1020
+
1021
+ <p class="tag_title">Returns:</p>
1022
+ <ul class="return">
1023
+
1024
+ <li>
1025
+
1026
+
1027
+ <span class='type'>(<tt><span class='object_link'><a href="../AjaxResponse.html" title="Ballast::AjaxResponse (class)">AjaxResponse</a></span></tt>)</span>
1028
+
1029
+
1030
+
1031
+ &mdash;
1032
+ <div class='inline'><p>The AJAX response, which will include only the first error.</p>
1033
+ </div>
1034
+
1035
+ </li>
1036
+
1037
+ </ul>
1038
+
1039
+ </div><table class="source_code">
1040
+ <tr>
1041
+ <td>
1042
+ <pre class="lines">
1043
+
1044
+
1045
+ 66
1046
+ 67
1047
+ 68
1048
+ 69
1049
+ 70
1050
+ 71
1051
+ 72
1052
+ 73
1053
+ 74
1054
+ 75
1055
+ 76
1056
+ 77</pre>
1057
+ </td>
1058
+ <td>
1059
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 66</span>
1060
+
1061
+ <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1062
+ <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
1063
+ <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
1064
+ <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
1065
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
1066
+ <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
1067
+ <span class='kw'>else</span>
1068
+ <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
1069
+ <span class='kw'>end</span>
1070
+
1071
+ <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
1072
+ <span class='kw'>end</span></pre>
1073
+ </td>
1074
+ </tr>
1075
+ </table>
1076
+ </div>
1077
+
1078
+ <div class="method_details ">
1079
+ <h3 class="signature " id="error-instance_method">
1080
+
1081
+ - (<tt>Object</tt>) <strong>error</strong>
1082
+
1083
+
1084
+
1085
+
1086
+
1087
+ </h3><div class="docstring">
1088
+ <div class="discussion">
1089
+ <p>Returns the first error returned by the operation.</p>
1090
+
1091
+
1092
+ </div>
1093
+ </div>
1094
+ <div class="tags">
1095
+
1096
+ <p class="tag_title">Returns:</p>
1097
+ <ul class="return">
1098
+
1099
+ <li>
1100
+
1101
+
1102
+ <span class='type'>(<tt>Object</tt>)</span>
1103
+
1104
+
1105
+
1106
+ &mdash;
1107
+ <div class='inline'><p>The first error returned by the service.</p>
1108
+ </div>
1109
+
1110
+ </li>
1111
+
1112
+ </ul>
1113
+
1114
+ </div><table class="source_code">
1115
+ <tr>
1116
+ <td>
1117
+ <pre class="lines">
1118
+
1119
+
1120
+ 58
1121
+ 59
1122
+ 60</pre>
1123
+ </td>
1124
+ <td>
1125
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 58</span>
1126
+
1127
+ <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
1128
+ <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
1129
+ <span class='kw'>end</span></pre>
1130
+ </td>
1131
+ </tr>
1132
+ </table>
1133
+ </div>
1134
+
1135
+ <div class="method_details ">
1136
+ <h3 class="signature " id="fail?-instance_method">
1137
+
1138
+ - (<tt>Boolean</tt>) <strong>fail?</strong>
1139
+
1140
+
1141
+
1142
+ <span class="aliases">Also known as:
1143
+ <span class="names"><span id='failed?-instance_method'>failed?</span></span>
1144
+ </span>
1145
+
1146
+
1147
+
1148
+ </h3><div class="docstring">
1149
+ <div class="discussion">
1150
+ <p>Returns whether the invocation failed or not.</p>
1151
+
1152
+
1153
+ </div>
1154
+ </div>
1155
+ <div class="tags">
1156
+
1157
+ <p class="tag_title">Returns:</p>
1158
+ <ul class="return">
1159
+
1160
+ <li>
1161
+
1162
+
1163
+ <span class='type'>(<tt>Boolean</tt>)</span>
1164
+
1165
+
1166
+
1167
+ &mdash;
1168
+ <div class='inline'><p><code>true</code> if the service invocation failed, <code>false</code> otherwise.</p>
1169
+ </div>
1170
+
1171
+ </li>
1172
+
1173
+ </ul>
1174
+
1175
+ </div><table class="source_code">
1176
+ <tr>
1177
+ <td>
1178
+ <pre class="lines">
1179
+
1180
+
1181
+ 50
1182
+ 51
1183
+ 52</pre>
1184
+ </td>
1185
+ <td>
1186
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 50</span>
1187
+
1188
+ <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
1189
+ <span class='op'>!</span><span class='ivar'>@success</span>
1190
+ <span class='kw'>end</span></pre>
1191
+ </td>
1192
+ </tr>
1193
+ </table>
1194
+ </div>
1195
+
1196
+ <div class="method_details ">
1197
+ <h3 class="signature " id="success?-instance_method">
1198
+
1199
+ - (<tt>Boolean</tt>) <strong>success?</strong>
1200
+
1201
+
1202
+
1203
+ <span class="aliases">Also known as:
1204
+ <span class="names"><span id='successful?-instance_method'>successful?</span>, <span id='succeeded?-instance_method'>succeeded?</span></span>
1205
+ </span>
1206
+
1207
+
1208
+
1209
+ </h3><div class="docstring">
1210
+ <div class="discussion">
1211
+ <p>Returns whether the invocation was successful or not.</p>
1212
+
1213
+
1214
+ </div>
1215
+ </div>
1216
+ <div class="tags">
1217
+
1218
+ <p class="tag_title">Returns:</p>
1219
+ <ul class="return">
1220
+
1221
+ <li>
1222
+
1223
+
1224
+ <span class='type'>(<tt>Boolean</tt>)</span>
1225
+
1226
+
1227
+
1228
+ &mdash;
1229
+ <div class='inline'><p><code>true</code> if the service invocation was successful, <code>false</code> otherwise.</p>
1230
+ </div>
1231
+
1232
+ </li>
1233
+
1234
+ </ul>
1235
+
1236
+ </div><table class="source_code">
1237
+ <tr>
1238
+ <td>
1239
+ <pre class="lines">
1240
+
1241
+
1242
+ 40
1243
+ 41
1244
+ 42
1245
+ 43</pre>
1246
+ </td>
1247
+ <td>
1248
+ <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 40</span>
1249
+
1250
+ <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
1251
+ <span class='comment'># TODO@PI: Ignore rubocop on this
1252
+ </span> <span class='ivar'>@success</span>
1253
+ <span class='kw'>end</span></pre>
1254
+ </td>
1255
+ </tr>
1256
+ </table>
1257
+ </div>
1258
+
1259
+ </div>
1260
+
1261
+ </div>
1262
+
1263
+ <div id="footer">
1264
+ Generated on Thu Aug 18 15:49:49 2016 by
1265
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1266
+ 0.8.7.6 (ruby-2.3.0).
1267
+ </div>
1268
+
1269
+ </body>
1270
+ </html>