apes 1.0.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 (122) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +7 -0
  3. data/.rubocop.yml +82 -0
  4. data/.travis-gemfile +15 -0
  5. data/.travis.yml +15 -0
  6. data/.yardopts +1 -0
  7. data/CHANGELOG.md +3 -0
  8. data/Gemfile +22 -0
  9. data/README.md +177 -0
  10. data/Rakefile +44 -0
  11. data/apes.gemspec +34 -0
  12. data/doc/Apes.html +130 -0
  13. data/doc/Apes/Concerns.html +127 -0
  14. data/doc/Apes/Concerns/Errors.html +1089 -0
  15. data/doc/Apes/Concerns/Pagination.html +636 -0
  16. data/doc/Apes/Concerns/Request.html +766 -0
  17. data/doc/Apes/Concerns/Response.html +940 -0
  18. data/doc/Apes/Controller.html +1100 -0
  19. data/doc/Apes/Errors.html +125 -0
  20. data/doc/Apes/Errors/AuthenticationError.html +133 -0
  21. data/doc/Apes/Errors/BadRequestError.html +157 -0
  22. data/doc/Apes/Errors/BaseError.html +320 -0
  23. data/doc/Apes/Errors/InvalidDataError.html +157 -0
  24. data/doc/Apes/Errors/MissingDataError.html +157 -0
  25. data/doc/Apes/Model.html +378 -0
  26. data/doc/Apes/PaginationCursor.html +2138 -0
  27. data/doc/Apes/RuntimeConfiguration.html +909 -0
  28. data/doc/Apes/Serializers.html +125 -0
  29. data/doc/Apes/Serializers/JSON.html +389 -0
  30. data/doc/Apes/Serializers/JWT.html +452 -0
  31. data/doc/Apes/Serializers/List.html +347 -0
  32. data/doc/Apes/UrlsParser.html +1432 -0
  33. data/doc/Apes/Validators.html +125 -0
  34. data/doc/Apes/Validators/BaseValidator.html +278 -0
  35. data/doc/Apes/Validators/BooleanValidator.html +494 -0
  36. data/doc/Apes/Validators/EmailValidator.html +350 -0
  37. data/doc/Apes/Validators/PhoneValidator.html +375 -0
  38. data/doc/Apes/Validators/ReferenceValidator.html +372 -0
  39. data/doc/Apes/Validators/TimestampValidator.html +640 -0
  40. data/doc/Apes/Validators/UuidValidator.html +372 -0
  41. data/doc/Apes/Validators/ZipCodeValidator.html +372 -0
  42. data/doc/Apes/Version.html +189 -0
  43. data/doc/ApplicationController.html +547 -0
  44. data/doc/Concerns.html +128 -0
  45. data/doc/Concerns/ErrorHandling.html +826 -0
  46. data/doc/Concerns/PaginationHandling.html +463 -0
  47. data/doc/Concerns/RequestHandling.html +512 -0
  48. data/doc/Concerns/ResponseHandling.html +579 -0
  49. data/doc/Errors.html +126 -0
  50. data/doc/Errors/AuthenticationError.html +123 -0
  51. data/doc/Errors/BadRequestError.html +147 -0
  52. data/doc/Errors/BaseError.html +289 -0
  53. data/doc/Errors/InvalidDataError.html +147 -0
  54. data/doc/Errors/MissingDataError.html +147 -0
  55. data/doc/Model.html +315 -0
  56. data/doc/PaginationCursor.html +764 -0
  57. data/doc/Serializers.html +126 -0
  58. data/doc/Serializers/JSON.html +253 -0
  59. data/doc/Serializers/JWT.html +253 -0
  60. data/doc/Serializers/List.html +245 -0
  61. data/doc/Validators.html +126 -0
  62. data/doc/Validators/BaseValidator.html +209 -0
  63. data/doc/Validators/BooleanValidator.html +391 -0
  64. data/doc/Validators/EmailValidator.html +298 -0
  65. data/doc/Validators/PhoneValidator.html +313 -0
  66. data/doc/Validators/ReferenceValidator.html +284 -0
  67. data/doc/Validators/TimestampValidator.html +476 -0
  68. data/doc/Validators/UuidValidator.html +310 -0
  69. data/doc/Validators/ZipCodeValidator.html +310 -0
  70. data/doc/_index.html +435 -0
  71. data/doc/class_list.html +58 -0
  72. data/doc/css/common.css +1 -0
  73. data/doc/css/full_list.css +57 -0
  74. data/doc/css/style.css +339 -0
  75. data/doc/file.README.html +252 -0
  76. data/doc/file_list.html +60 -0
  77. data/doc/frames.html +26 -0
  78. data/doc/index.html +252 -0
  79. data/doc/js/app.js +219 -0
  80. data/doc/js/full_list.js +181 -0
  81. data/doc/js/jquery.js +4 -0
  82. data/doc/method_list.html +615 -0
  83. data/doc/top-level-namespace.html +112 -0
  84. data/lib/apes.rb +40 -0
  85. data/lib/apes/concerns/errors.rb +111 -0
  86. data/lib/apes/concerns/pagination.rb +81 -0
  87. data/lib/apes/concerns/request.rb +237 -0
  88. data/lib/apes/concerns/response.rb +74 -0
  89. data/lib/apes/controller.rb +77 -0
  90. data/lib/apes/errors.rb +38 -0
  91. data/lib/apes/model.rb +94 -0
  92. data/lib/apes/pagination_cursor.rb +152 -0
  93. data/lib/apes/runtime_configuration.rb +80 -0
  94. data/lib/apes/serializers.rb +88 -0
  95. data/lib/apes/urls_parser.rb +233 -0
  96. data/lib/apes/validators.rb +234 -0
  97. data/lib/apes/version.rb +24 -0
  98. data/spec/apes/concerns/errors_spec.rb +141 -0
  99. data/spec/apes/concerns/pagination_spec.rb +114 -0
  100. data/spec/apes/concerns/request_spec.rb +244 -0
  101. data/spec/apes/concerns/response_spec.rb +79 -0
  102. data/spec/apes/controller_spec.rb +54 -0
  103. data/spec/apes/errors_spec.rb +14 -0
  104. data/spec/apes/models_spec.rb +148 -0
  105. data/spec/apes/pagination_cursor_spec.rb +113 -0
  106. data/spec/apes/runtime_configuration_spec.rb +100 -0
  107. data/spec/apes/serializers_spec.rb +70 -0
  108. data/spec/apes/urls_parser_spec.rb +150 -0
  109. data/spec/apes/validators_spec.rb +237 -0
  110. data/spec/spec_helper.rb +30 -0
  111. data/views/_included.json.jbuilder +9 -0
  112. data/views/_pagination.json.jbuilder +9 -0
  113. data/views/collection.json.jbuilder +4 -0
  114. data/views/errors/400.json.jbuilder +9 -0
  115. data/views/errors/403.json.jbuilder +7 -0
  116. data/views/errors/404.json.jbuilder +6 -0
  117. data/views/errors/422.json.jbuilder +19 -0
  118. data/views/errors/500.json.jbuilder +12 -0
  119. data/views/errors/501.json.jbuilder +7 -0
  120. data/views/layouts/general.json.jbuilder +36 -0
  121. data/views/object.json.jbuilder +4 -0
  122. metadata +262 -0
data/doc/Apes/Concerns/Response.html ADDED
@@ -0,0 +1,940 @@
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
+ Module: Apes::Concerns::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#!Apes/Concerns/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="../../Apes.html" title="Apes (module)">Apes</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Concerns.html" title="Apes::Concerns (module)">Concerns</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>Module: Apes::Concerns::Response
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1">Included in:</dt>
81
+ <dd class="r1"><span class='object_link'><a href="../Controller.html" title="Apes::Controller (class)">Apes::Controller</a></span></dd>
82
+
83
+
84
+
85
+ <dt class="r2 last">Defined in:</dt>
86
+ <dd class="r2 last">lib/apes/concerns/response.rb</dd>
87
+
88
+ </dl>
89
+ <div class="clear"></div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+ <p>JSON API response handling module.</p>
94
+
95
+
96
+ </div>
97
+ </div>
98
+ <div class="tags">
99
+
100
+
101
+ </div>
102
+
103
+
104
+
105
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
106
+ <ul class="summary">
107
+
108
+ <li class="public ">
109
+ <span class="summary_signature">
110
+
111
+ <a href="#included-instance_method" title="#included (instance method)">- (Object) <strong>included</strong> </a>
112
+
113
+
114
+
115
+ </span>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute included.</p>
129
+ </div></span>
130
+
131
+ </li>
132
+
133
+
134
+ </ul>
135
+
136
+
137
+
138
+
139
+
140
+ <h2>
141
+ Instance Method Summary
142
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
143
+ </h2>
144
+
145
+ <ul class="summary">
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#response_data-instance_method" title="#response_data (instance method)">- (HashWithIndifferentAccess|Object|Nil) <strong>response_data</strong>(default = nil) </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <span class="summary_desc"><div class='inline'><p>Returns the data for the current response.</p>
165
+ </div></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#response_include-instance_method" title="#response_include (instance method)">- (HashWithIndifferentAccess) <strong>response_include</strong>(object, template = nil) </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'><p>Adds an object to the included (side-load) set.</p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#response_included-instance_method" title="#response_included (instance method)">- (HashWithIndifferentAccess|Object|Nil) <strong>response_included</strong>(default = nil) </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'><p>Returns the included (side-loaded) objects for the current response.</p>
211
+ </div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#response_links-instance_method" title="#response_links (instance method)">- (HashWithIndifferentAccess|Object|Nil) <strong>response_links</strong>(default = 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>Returns the linked objects for the current response.</p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#response_meta-instance_method" title="#response_meta (instance method)">- (HashWithIndifferentAccess|Object|Nil) <strong>response_meta</strong>(default = nil) </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 metadata for the current response.</p>
257
+ </div></span>
258
+
259
+ </li>
260
+
261
+
262
+ <li class="public ">
263
+ <span class="summary_signature">
264
+
265
+ <a href="#response_template_for-instance_method" title="#response_template_for (instance method)">- (String) <strong>response_template_for</strong>(object) </a>
266
+
267
+
268
+
269
+ </span>
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+ <span class="summary_desc"><div class='inline'><p>Returns the template to use to render a object.</p>
280
+ </div></span>
281
+
282
+ </li>
283
+
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#response_timestamp-instance_method" title="#response_timestamp (instance method)">- (String) <strong>response_timestamp</strong>(timestamp) </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <span class="summary_desc"><div class='inline'><p>Serializes a timestamp.</p>
303
+ </div></span>
304
+
305
+ </li>
306
+
307
+
308
+ </ul>
309
+
310
+
311
+
312
+ <div id="instance_attr_details" class="attr_details">
313
+ <h2>Instance Attribute Details</h2>
314
+
315
+
316
+ <span id="included=-instance_method"></span>
317
+ <div class="method_details first">
318
+ <h3 class="signature first" id="included-instance_method">
319
+
320
+ - (<tt>Object</tt>) <strong>included</strong>
321
+
322
+
323
+
324
+
325
+
326
+ </h3><div class="docstring">
327
+ <div class="discussion">
328
+ <p>Returns the value of attribute included</p>
329
+
330
+
331
+ </div>
332
+ </div>
333
+ <div class="tags">
334
+
335
+
336
+ </div><table class="source_code">
337
+ <tr>
338
+ <td>
339
+ <pre class="lines">
340
+
341
+
342
+ 10
343
+ 11
344
+ 12</pre>
345
+ </td>
346
+ <td>
347
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 10</span>
348
+
349
+ <span class='kw'>def</span> <span class='id identifier rubyid_included'>included</span>
350
+ <span class='ivar'>@included</span>
351
+ <span class='kw'>end</span></pre>
352
+ </td>
353
+ </tr>
354
+ </table>
355
+ </div>
356
+
357
+ </div>
358
+
359
+
360
+ <div id="instance_method_details" class="method_details_list">
361
+ <h2>Instance Method Details</h2>
362
+
363
+
364
+ <div class="method_details first">
365
+ <h3 class="signature first" id="response_data-instance_method">
366
+
367
+ - (<tt>HashWithIndifferentAccess|Object|Nil</tt>) <strong>response_data</strong>(default = nil)
368
+
369
+
370
+
371
+
372
+
373
+ </h3><div class="docstring">
374
+ <div class="discussion">
375
+ <p>Returns the data for the current response.</p>
376
+
377
+
378
+ </div>
379
+ </div>
380
+ <div class="tags">
381
+ <p class="tag_title">Parameters:</p>
382
+ <ul class="param">
383
+
384
+ <li>
385
+
386
+ <span class='name'>default</span>
387
+
388
+
389
+ <span class='type'>(<tt>Object</tt>)</span>
390
+
391
+
392
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
393
+
394
+
395
+ &mdash;
396
+ <div class='inline'><p>Fallback data if nothing is found.</p>
397
+ </div>
398
+
399
+ </li>
400
+
401
+ </ul>
402
+
403
+ <p class="tag_title">Returns:</p>
404
+ <ul class="return">
405
+
406
+ <li>
407
+
408
+
409
+ <span class='type'>(<tt>HashWithIndifferentAccess|Object|Nil</tt>)</span>
410
+
411
+
412
+
413
+ &mdash;
414
+ <div class='inline'><p>The data for the current response.</p>
415
+ </div>
416
+
417
+ </li>
418
+
419
+ </ul>
420
+
421
+ </div><table class="source_code">
422
+ <tr>
423
+ <td>
424
+ <pre class="lines">
425
+
426
+
427
+ 34
428
+ 35
429
+ 36</pre>
430
+ </td>
431
+ <td>
432
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 34</span>
433
+
434
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_data'>response_data</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
435
+ <span class='ivar'>@data</span> <span class='op'>||</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>||</span> <span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
436
+ <span class='kw'>end</span></pre>
437
+ </td>
438
+ </tr>
439
+ </table>
440
+ </div>
441
+
442
+ <div class="method_details ">
443
+ <h3 class="signature " id="response_include-instance_method">
444
+
445
+ - (<tt>HashWithIndifferentAccess</tt>) <strong>response_include</strong>(object, template = nil)
446
+
447
+
448
+
449
+
450
+
451
+ </h3><div class="docstring">
452
+ <div class="discussion">
453
+ <p>Adds an object to the included (side-load) set.</p>
454
+
455
+
456
+ </div>
457
+ </div>
458
+ <div class="tags">
459
+ <p class="tag_title">Parameters:</p>
460
+ <ul class="param">
461
+
462
+ <li>
463
+
464
+ <span class='name'>object</span>
465
+
466
+
467
+ <span class='type'>(<tt>Object</tt>)</span>
468
+
469
+
470
+
471
+ &mdash;
472
+ <div class='inline'><p>The object to include.</p>
473
+ </div>
474
+
475
+ </li>
476
+
477
+ <li>
478
+
479
+ <span class='name'>template</span>
480
+
481
+
482
+ <span class='type'>(<tt>String</tt>)</span>
483
+
484
+
485
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
486
+
487
+
488
+ &mdash;
489
+ <div class='inline'><p>The template to use for rendering.</p>
490
+ </div>
491
+
492
+ </li>
493
+
494
+ </ul>
495
+
496
+ <p class="tag_title">Returns:</p>
497
+ <ul class="return">
498
+
499
+ <li>
500
+
501
+
502
+ <span class='type'>(<tt>HashWithIndifferentAccess</tt>)</span>
503
+
504
+
505
+
506
+ &mdash;
507
+ <div class='inline'><p>A hash of objects to include. Keys are a template:id formatted strings, values are <code>[object, template]</code> pairs.</p>
508
+ </div>
509
+
510
+ </li>
511
+
512
+ </ul>
513
+
514
+ </div><table class="source_code">
515
+ <tr>
516
+ <td>
517
+ <pre class="lines">
518
+
519
+
520
+ 59
521
+ 60
522
+ 61
523
+ 62
524
+ 63</pre>
525
+ </td>
526
+ <td>
527
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 59</span>
528
+
529
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_include'>response_include</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
530
+ <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span> <span class='op'>||=</span> <span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
531
+ <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lbracket'>[</span><span class='id identifier rubyid_sprintf'>sprintf</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%s:%s</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_response_template_for'>response_template_for</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_to_param'>to_param</span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span><span class='rbracket'>]</span>
532
+ <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span>
533
+ <span class='kw'>end</span></pre>
534
+ </td>
535
+ </tr>
536
+ </table>
537
+ </div>
538
+
539
+ <div class="method_details ">
540
+ <h3 class="signature " id="response_included-instance_method">
541
+
542
+ - (<tt>HashWithIndifferentAccess|Object|Nil</tt>) <strong>response_included</strong>(default = nil)
543
+
544
+
545
+
546
+
547
+
548
+ </h3><div class="docstring">
549
+ <div class="discussion">
550
+ <p>Returns the included (side-loaded) objects for the current response.</p>
551
+
552
+
553
+ </div>
554
+ </div>
555
+ <div class="tags">
556
+ <p class="tag_title">Parameters:</p>
557
+ <ul class="param">
558
+
559
+ <li>
560
+
561
+ <span class='name'>default</span>
562
+
563
+
564
+ <span class='type'>(<tt>Object</tt>)</span>
565
+
566
+
567
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
568
+
569
+
570
+ &mdash;
571
+ <div class='inline'><p>Fallback data if nothing is found.</p>
572
+ </div>
573
+
574
+ </li>
575
+
576
+ </ul>
577
+
578
+ <p class="tag_title">Returns:</p>
579
+ <ul class="return">
580
+
581
+ <li>
582
+
583
+
584
+ <span class='type'>(<tt>HashWithIndifferentAccess|Object|Nil</tt>)</span>
585
+
586
+
587
+
588
+ &mdash;
589
+ <div class='inline'><p>The included objects for the current response.</p>
590
+ </div>
591
+
592
+ </li>
593
+
594
+ </ul>
595
+
596
+ </div><table class="source_code">
597
+ <tr>
598
+ <td>
599
+ <pre class="lines">
600
+
601
+
602
+ 50
603
+ 51
604
+ 52</pre>
605
+ </td>
606
+ <td>
607
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 50</span>
608
+
609
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_included'>response_included</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
610
+ <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span> <span class='op'>||</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>||</span> <span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
611
+ <span class='kw'>end</span></pre>
612
+ </td>
613
+ </tr>
614
+ </table>
615
+ </div>
616
+
617
+ <div class="method_details ">
618
+ <h3 class="signature " id="response_links-instance_method">
619
+
620
+ - (<tt>HashWithIndifferentAccess|Object|Nil</tt>) <strong>response_links</strong>(default = nil)
621
+
622
+
623
+
624
+
625
+
626
+ </h3><div class="docstring">
627
+ <div class="discussion">
628
+ <p>Returns the linked objects for the current response.</p>
629
+
630
+
631
+ </div>
632
+ </div>
633
+ <div class="tags">
634
+ <p class="tag_title">Parameters:</p>
635
+ <ul class="param">
636
+
637
+ <li>
638
+
639
+ <span class='name'>default</span>
640
+
641
+
642
+ <span class='type'>(<tt>Object</tt>)</span>
643
+
644
+
645
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
646
+
647
+
648
+ &mdash;
649
+ <div class='inline'><p>Fallback data if nothing is found.</p>
650
+ </div>
651
+
652
+ </li>
653
+
654
+ </ul>
655
+
656
+ <p class="tag_title">Returns:</p>
657
+ <ul class="return">
658
+
659
+ <li>
660
+
661
+
662
+ <span class='type'>(<tt>HashWithIndifferentAccess|Object|Nil</tt>)</span>
663
+
664
+
665
+
666
+ &mdash;
667
+ <div class='inline'><p>The linked objects for the current response.</p>
668
+ </div>
669
+
670
+ </li>
671
+
672
+ </ul>
673
+
674
+ </div><table class="source_code">
675
+ <tr>
676
+ <td>
677
+ <pre class="lines">
678
+
679
+
680
+ 42
681
+ 43
682
+ 44</pre>
683
+ </td>
684
+ <td>
685
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 42</span>
686
+
687
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_links'>response_links</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
688
+ <span class='ivar'>@links</span> <span class='op'>||</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>||</span> <span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
689
+ <span class='kw'>end</span></pre>
690
+ </td>
691
+ </tr>
692
+ </table>
693
+ </div>
694
+
695
+ <div class="method_details ">
696
+ <h3 class="signature " id="response_meta-instance_method">
697
+
698
+ - (<tt>HashWithIndifferentAccess|Object|Nil</tt>) <strong>response_meta</strong>(default = nil)
699
+
700
+
701
+
702
+
703
+
704
+ </h3><div class="docstring">
705
+ <div class="discussion">
706
+ <p>Returns the metadata for the current response.</p>
707
+
708
+
709
+ </div>
710
+ </div>
711
+ <div class="tags">
712
+ <p class="tag_title">Parameters:</p>
713
+ <ul class="param">
714
+
715
+ <li>
716
+
717
+ <span class='name'>default</span>
718
+
719
+
720
+ <span class='type'>(<tt>Object</tt>)</span>
721
+
722
+
723
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
724
+
725
+
726
+ &mdash;
727
+ <div class='inline'><p>Fallback data if nothing is found.</p>
728
+ </div>
729
+
730
+ </li>
731
+
732
+ </ul>
733
+
734
+ <p class="tag_title">Returns:</p>
735
+ <ul class="return">
736
+
737
+ <li>
738
+
739
+
740
+ <span class='type'>(<tt>HashWithIndifferentAccess|Object|Nil</tt>)</span>
741
+
742
+
743
+
744
+ &mdash;
745
+ <div class='inline'><p>The metadata for the current response.</p>
746
+ </div>
747
+
748
+ </li>
749
+
750
+ </ul>
751
+
752
+ </div><table class="source_code">
753
+ <tr>
754
+ <td>
755
+ <pre class="lines">
756
+
757
+
758
+ 26
759
+ 27
760
+ 28</pre>
761
+ </td>
762
+ <td>
763
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 26</span>
764
+
765
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_meta'>response_meta</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
766
+ <span class='ivar'>@meta</span> <span class='op'>||</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>||</span> <span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
767
+ <span class='kw'>end</span></pre>
768
+ </td>
769
+ </tr>
770
+ </table>
771
+ </div>
772
+
773
+ <div class="method_details ">
774
+ <h3 class="signature " id="response_template_for-instance_method">
775
+
776
+ - (<tt>String</tt>) <strong>response_template_for</strong>(object)
777
+
778
+
779
+
780
+
781
+
782
+ </h3><div class="docstring">
783
+ <div class="discussion">
784
+ <p>Returns the template to use to render a object.</p>
785
+
786
+
787
+ </div>
788
+ </div>
789
+ <div class="tags">
790
+ <p class="tag_title">Parameters:</p>
791
+ <ul class="param">
792
+
793
+ <li>
794
+
795
+ <span class='name'>object</span>
796
+
797
+
798
+ <span class='type'>(<tt>Object</tt>)</span>
799
+
800
+
801
+
802
+ &mdash;
803
+ <div class='inline'><p>The object to render.</p>
804
+ </div>
805
+
806
+ </li>
807
+
808
+ </ul>
809
+
810
+ <p class="tag_title">Returns:</p>
811
+ <ul class="return">
812
+
813
+ <li>
814
+
815
+
816
+ <span class='type'>(<tt>String</tt>)</span>
817
+
818
+
819
+
820
+ &mdash;
821
+ <div class='inline'><p>The template to use.</p>
822
+ </div>
823
+
824
+ </li>
825
+
826
+ </ul>
827
+
828
+ </div><table class="source_code">
829
+ <tr>
830
+ <td>
831
+ <pre class="lines">
832
+
833
+
834
+ 16
835
+ 17
836
+ 18
837
+ 19
838
+ 20</pre>
839
+ </td>
840
+ <td>
841
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 16</span>
842
+
843
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_template_for'>response_template_for</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
844
+ <span class='kw'>return</span> <span class='ivar'>@object_template</span> <span class='kw'>if</span> <span class='ivar'>@object_template</span>
845
+ <span class='id identifier rubyid_object'>object</span> <span class='op'>=</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='kw'>if</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:first</span><span class='rparen'>)</span>
846
+ <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
847
+ <span class='kw'>end</span></pre>
848
+ </td>
849
+ </tr>
850
+ </table>
851
+ </div>
852
+
853
+ <div class="method_details ">
854
+ <h3 class="signature " id="response_timestamp-instance_method">
855
+
856
+ - (<tt>String</tt>) <strong>response_timestamp</strong>(timestamp)
857
+
858
+
859
+
860
+
861
+
862
+ </h3><div class="docstring">
863
+ <div class="discussion">
864
+ <p>Serializes a timestamp.</p>
865
+
866
+
867
+ </div>
868
+ </div>
869
+ <div class="tags">
870
+ <p class="tag_title">Parameters:</p>
871
+ <ul class="param">
872
+
873
+ <li>
874
+
875
+ <span class='name'>timestamp</span>
876
+
877
+
878
+ <span class='type'>(<tt>DateTime</tt>)</span>
879
+
880
+
881
+
882
+ &mdash;
883
+ <div class='inline'><p>The timestamp to serialize.</p>
884
+ </div>
885
+
886
+ </li>
887
+
888
+ </ul>
889
+
890
+ <p class="tag_title">Returns:</p>
891
+ <ul class="return">
892
+
893
+ <li>
894
+
895
+
896
+ <span class='type'>(<tt>String</tt>)</span>
897
+
898
+
899
+
900
+ &mdash;
901
+ <div class='inline'><p>The serialized timestamp.</p>
902
+ </div>
903
+
904
+ </li>
905
+
906
+ </ul>
907
+
908
+ </div><table class="source_code">
909
+ <tr>
910
+ <td>
911
+ <pre class="lines">
912
+
913
+
914
+ 69
915
+ 70
916
+ 71</pre>
917
+ </td>
918
+ <td>
919
+ <pre class="code"><span class="info file"># File 'lib/apes/concerns/response.rb', line 69</span>
920
+
921
+ <span class='kw'>def</span> <span class='id identifier rubyid_response_timestamp'>response_timestamp</span><span class='lparen'>(</span><span class='id identifier rubyid_timestamp'>timestamp</span><span class='rparen'>)</span>
922
+ <span class='id identifier rubyid_timestamp'>timestamp</span><span class='period'>.</span><span class='id identifier rubyid_safe_send'>safe_send</span><span class='lparen'>(</span><span class='symbol'>:strftime</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%FT%T.%L%z</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
923
+ <span class='kw'>end</span></pre>
924
+ </td>
925
+ </tr>
926
+ </table>
927
+ </div>
928
+
929
+ </div>
930
+
931
+ </div>
932
+
933
+ <div id="footer">
934
+ Generated on Sat Jun 4 12:41:53 2016 by
935
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
936
+ 0.8.7.6 (ruby-2.3.0).
937
+ </div>
938
+
939
+ </body>
940
+ </html>