<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Apes::Controller
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!Apes/Controller.html";
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../Apes.html" title="Apes (module)">Apes</a></span></span>
»
<span class="title">Controller</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Apes::Controller
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">ActionController::API</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">ActionController::API</li>
<li class="next">Apes::Controller</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Includes:</dt>
<dd class="r2">ActionController::ImplicitRender, ActionView::Layouts, <span class='object_link'><a href="Concerns/Errors.html" title="Apes::Concerns::Errors (module)">Apes::Concerns::Errors</a></span>, <span class='object_link'><a href="Concerns/Pagination.html" title="Apes::Concerns::Pagination (module)">Apes::Concerns::Pagination</a></span>, <span class='object_link'><a href="Concerns/Request.html" title="Apes::Concerns::Request (module)">Apes::Concerns::Request</a></span>, <span class='object_link'><a href="Concerns/Response.html" title="Apes::Concerns::Response (module)">Apes::Concerns::Response</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/apes/controller.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A ready to use controller for JSON API applications.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="Concerns/Errors.html" title="Apes::Concerns::Errors (module)">Apes::Concerns::Errors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Errors.html#ERROR_HANDLERS-constant" title="Apes::Concerns::Errors::ERROR_HANDLERS (constant)">Apes::Concerns::Errors::ERROR_HANDLERS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="Concerns/Request.html" title="Apes::Concerns::Request (module)">Apes::Concerns::Request</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Request.html#CONTENT_TYPE-constant" title="Apes::Concerns::Request::CONTENT_TYPE (constant)">Apes::Concerns::Request::CONTENT_TYPE</a></span></p>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#current_account-instance_method" title="#current_account (instance method)">- (Object) <strong>current_account</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The current account making the request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cursor-instance_method" title="#cursor (instance method)">- (Apes::PaginationCursor) <strong>cursor</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The pagination cursor for this request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#request_cursor-instance_method" title="#request_cursor (instance method)">- (Apes::PaginationCursor) <strong>request_cursor</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The original pagination cursor sent from the client.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="Concerns/Response.html" title="Apes::Concerns::Response (module)">Apes::Concerns::Response</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Response.html#included-instance_method" title="Apes::Concerns::Response#included (method)">#included</a></span></p>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#default_url_options-instance_method" title="#default_url_options (instance method)">- (Hash) <strong>default_url_options</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the default URL options for this request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#handle_cors-instance_method" title="#handle_cors (instance method)">- (Object) <strong>handle_cors</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Tiny handle to handle CORS OPTIONS requests.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#render_error-instance_method" title="#render_error (instance method)">- (Object) <strong>render_error</strong>(status, errors) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Default handler to render errors.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Errors.html" title="Apes::Concerns::Errors (module)">Apes::Concerns::Errors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Errors.html#error_handle_bad_request-instance_method" title="Apes::Concerns::Errors#error_handle_bad_request (method)">#error_handle_bad_request</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_debug-instance_method" title="Apes::Concerns::Errors#error_handle_debug (method)">#error_handle_debug</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_exception-instance_method" title="Apes::Concerns::Errors#error_handle_exception (method)">#error_handle_exception</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_fordidden-instance_method" title="Apes::Concerns::Errors#error_handle_fordidden (method)">#error_handle_fordidden</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_general-instance_method" title="Apes::Concerns::Errors#error_handle_general (method)">#error_handle_general</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_invalid_data-instance_method" title="Apes::Concerns::Errors#error_handle_invalid_data (method)">#error_handle_invalid_data</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_missing_data-instance_method" title="Apes::Concerns::Errors#error_handle_missing_data (method)">#error_handle_missing_data</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_not_found-instance_method" title="Apes::Concerns::Errors#error_handle_not_found (method)">#error_handle_not_found</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_others-instance_method" title="Apes::Concerns::Errors#error_handle_others (method)">#error_handle_others</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_unknown_attribute-instance_method" title="Apes::Concerns::Errors#error_handle_unknown_attribute (method)">#error_handle_unknown_attribute</a></span>, <span class='object_link'><a href="Concerns/Errors.html#error_handle_validation-instance_method" title="Apes::Concerns::Errors#error_handle_validation (method)">#error_handle_validation</a></span>, <span class='object_link'><a href="Concerns/Errors.html#fail_request%21-instance_method" title="Apes::Concerns::Errors#fail_request! (method)">#fail_request!</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Pagination.html" title="Apes::Concerns::Pagination (module)">Apes::Concerns::Pagination</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Pagination.html#paginate-instance_method" title="Apes::Concerns::Pagination#paginate (method)">#paginate</a></span>, <span class='object_link'><a href="Concerns/Pagination.html#pagination_field-instance_method" title="Apes::Concerns::Pagination#pagination_field (method)">#pagination_field</a></span>, <span class='object_link'><a href="Concerns/Pagination.html#pagination_skip%3F-instance_method" title="Apes::Concerns::Pagination#pagination_skip? (method)">#pagination_skip?</a></span>, <span class='object_link'><a href="Concerns/Pagination.html#pagination_supported%3F-instance_method" title="Apes::Concerns::Pagination#pagination_supported? (method)">#pagination_supported?</a></span>, <span class='object_link'><a href="Concerns/Pagination.html#pagination_url-instance_method" title="Apes::Concerns::Pagination#pagination_url (method)">#pagination_url</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Response.html" title="Apes::Concerns::Response (module)">Apes::Concerns::Response</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Response.html#response_data-instance_method" title="Apes::Concerns::Response#response_data (method)">#response_data</a></span>, <span class='object_link'><a href="Concerns/Response.html#response_include-instance_method" title="Apes::Concerns::Response#response_include (method)">#response_include</a></span>, <span class='object_link'><a href="Concerns/Response.html#response_included-instance_method" title="Apes::Concerns::Response#response_included (method)">#response_included</a></span>, <span class='object_link'><a href="Concerns/Response.html#response_links-instance_method" title="Apes::Concerns::Response#response_links (method)">#response_links</a></span>, <span class='object_link'><a href="Concerns/Response.html#response_meta-instance_method" title="Apes::Concerns::Response#response_meta (method)">#response_meta</a></span>, <span class='object_link'><a href="Concerns/Response.html#response_template_for-instance_method" title="Apes::Concerns::Response#response_template_for (method)">#response_template_for</a></span>, <span class='object_link'><a href="Concerns/Response.html#response_timestamp-instance_method" title="Apes::Concerns::Response#response_timestamp (method)">#response_timestamp</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Request.html" title="Apes::Concerns::Request (module)">Apes::Concerns::Request</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Concerns/Request.html#request_cast_attributes-instance_method" title="Apes::Concerns::Request#request_cast_attributes (method)">#request_cast_attributes</a></span>, <span class='object_link'><a href="Concerns/Request.html#request_extract_model-instance_method" title="Apes::Concerns::Request#request_extract_model (method)">#request_extract_model</a></span>, <span class='object_link'><a href="Concerns/Request.html#request_handle_cors-instance_method" title="Apes::Concerns::Request#request_handle_cors (method)">#request_handle_cors</a></span>, <span class='object_link'><a href="Concerns/Request.html#request_source_host-instance_method" title="Apes::Concerns::Request#request_source_host (method)">#request_source_host</a></span>, <span class='object_link'><a href="Concerns/Request.html#request_valid_content_type-instance_method" title="Apes::Concerns::Request#request_valid_content_type (method)">#request_valid_content_type</a></span>, <span class='object_link'><a href="Concerns/Request.html#request_validate-instance_method" title="Apes::Concerns::Request#request_validate (method)">#request_validate</a></span></p>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="current_account-instance_method">
- (<tt>Object</tt>) <strong>current_account</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The current account making the request</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>The current account making the request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/apes/controller.rb', line 15</span>
<span class='kw'>class</span> <span class='const'>Controller</span> <span class='op'><</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>API</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>ImplicitRender</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActionView</span><span class='op'>::</span><span class='const'>Layouts</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Request</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Response</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Pagination</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Errors</span>
<span class='id identifier rubyid_layout'>layout</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>general</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_before_filter'>before_filter</span> <span class='symbol'>:request_handle_cors</span>
<span class='id identifier rubyid_before_filter'>before_filter</span> <span class='symbol'>:request_validate</span>
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:current_account</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:request_cursor</span>
<span class='comment'># Exception handling
</span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>Exception</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='symbol'>:error_handle_exception</span>
<span class='comment'># This allows to avoid to declare all the views
</span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>ActionView</span><span class='op'>::</span><span class='const'>MissingTemplate</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='symbol'>:render_default_views</span>
<span class='comment'># Returns the default URL options for this request.
</span> <span class='comment'># It ensures that the host is always included and that is set properly in development mode.
</span> <span class='comment'>#
</span> <span class='comment'># @return [Hash] Default URL options for the request.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_default_url_options'>default_url_options</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>only_path:</span> <span class='kw'>false</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>host:</span> <span class='id identifier rubyid_request_source_host'>request_source_host</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>RuntimeConfiguration</span><span class='period'>.</span><span class='id identifier rubyid_development?'>development?</span>
<span class='id identifier rubyid_rv'>rv</span>
<span class='kw'>end</span>
<span class='comment'># Tiny handle to handle CORS OPTIONS requests. It just renders nothing as headers are handle in Apes::Concerns::Response module.
</span> <span class='comment'>#
</span> <span class='comment'># To enable this route, add the following to the routes.rb:
</span> <span class='comment'>#
</span> <span class='comment'># # This is to enable AJAX cross domain
</span> <span class='comment'># match '*path', to: 'application#handle_cors', via: :options
</span> <span class='kw'>def</span> <span class='id identifier rubyid_handle_cors'>handle_cors</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>nothing:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:no_content</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Default handler to render errors.
</span> <span class='comment'>#
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP error code to return.
</span> <span class='comment'># @param errors [Array] The list of occurred errors.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_render_error'>render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
<span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span>
<span class='id identifier rubyid_status_code'>status_code</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='op'>::</span><span class='const'>SYMBOL_TO_STATUS_CODE</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='int'>500</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>errors/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_private'>private</span>
<span class='comment'># :nodoc:
</span> <span class='kw'>def</span> <span class='id identifier rubyid_render_default_views'>render_default_views</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@objects</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/collection</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@object</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/object</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_error_handle_exception'>error_handle_exception</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="cursor-instance_method">
- (<tt><span class='object_link'><a href="PaginationCursor.html" title="Apes::PaginationCursor (class)">Apes::PaginationCursor</a></span></tt>) <strong>cursor</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The pagination cursor for this request.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="PaginationCursor.html" title="Apes::PaginationCursor (class)">Apes::PaginationCursor</a></span></tt>)</span>
—
<div class='inline'><p>The pagination cursor for this request.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/apes/controller.rb', line 15</span>
<span class='kw'>class</span> <span class='const'>Controller</span> <span class='op'><</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>API</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>ImplicitRender</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActionView</span><span class='op'>::</span><span class='const'>Layouts</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Request</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Response</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Pagination</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Errors</span>
<span class='id identifier rubyid_layout'>layout</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>general</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_before_filter'>before_filter</span> <span class='symbol'>:request_handle_cors</span>
<span class='id identifier rubyid_before_filter'>before_filter</span> <span class='symbol'>:request_validate</span>
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:current_account</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:request_cursor</span>
<span class='comment'># Exception handling
</span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>Exception</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='symbol'>:error_handle_exception</span>
<span class='comment'># This allows to avoid to declare all the views
</span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>ActionView</span><span class='op'>::</span><span class='const'>MissingTemplate</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='symbol'>:render_default_views</span>
<span class='comment'># Returns the default URL options for this request.
</span> <span class='comment'># It ensures that the host is always included and that is set properly in development mode.
</span> <span class='comment'>#
</span> <span class='comment'># @return [Hash] Default URL options for the request.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_default_url_options'>default_url_options</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>only_path:</span> <span class='kw'>false</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>host:</span> <span class='id identifier rubyid_request_source_host'>request_source_host</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>RuntimeConfiguration</span><span class='period'>.</span><span class='id identifier rubyid_development?'>development?</span>
<span class='id identifier rubyid_rv'>rv</span>
<span class='kw'>end</span>
<span class='comment'># Tiny handle to handle CORS OPTIONS requests. It just renders nothing as headers are handle in Apes::Concerns::Response module.
</span> <span class='comment'>#
</span> <span class='comment'># To enable this route, add the following to the routes.rb:
</span> <span class='comment'>#
</span> <span class='comment'># # This is to enable AJAX cross domain
</span> <span class='comment'># match '*path', to: 'application#handle_cors', via: :options
</span> <span class='kw'>def</span> <span class='id identifier rubyid_handle_cors'>handle_cors</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>nothing:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:no_content</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Default handler to render errors.
</span> <span class='comment'>#
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP error code to return.
</span> <span class='comment'># @param errors [Array] The list of occurred errors.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_render_error'>render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
<span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span>
<span class='id identifier rubyid_status_code'>status_code</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='op'>::</span><span class='const'>SYMBOL_TO_STATUS_CODE</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='int'>500</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>errors/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_private'>private</span>
<span class='comment'># :nodoc:
</span> <span class='kw'>def</span> <span class='id identifier rubyid_render_default_views'>render_default_views</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@objects</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/collection</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@object</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/object</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_error_handle_exception'>error_handle_exception</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="request_cursor-instance_method">
- (<tt><span class='object_link'><a href="PaginationCursor.html" title="Apes::PaginationCursor (class)">Apes::PaginationCursor</a></span></tt>) <strong>request_cursor</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The original pagination cursor sent from the client.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="PaginationCursor.html" title="Apes::PaginationCursor (class)">Apes::PaginationCursor</a></span></tt>)</span>
—
<div class='inline'><p>The original pagination cursor sent from the client.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/apes/controller.rb', line 15</span>
<span class='kw'>class</span> <span class='const'>Controller</span> <span class='op'><</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>API</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>ImplicitRender</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActionView</span><span class='op'>::</span><span class='const'>Layouts</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Request</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Response</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Pagination</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>Concerns</span><span class='op'>::</span><span class='const'>Errors</span>
<span class='id identifier rubyid_layout'>layout</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>general</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_before_filter'>before_filter</span> <span class='symbol'>:request_handle_cors</span>
<span class='id identifier rubyid_before_filter'>before_filter</span> <span class='symbol'>:request_validate</span>
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:current_account</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:request_cursor</span>
<span class='comment'># Exception handling
</span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>Exception</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='symbol'>:error_handle_exception</span>
<span class='comment'># This allows to avoid to declare all the views
</span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>ActionView</span><span class='op'>::</span><span class='const'>MissingTemplate</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='symbol'>:render_default_views</span>
<span class='comment'># Returns the default URL options for this request.
</span> <span class='comment'># It ensures that the host is always included and that is set properly in development mode.
</span> <span class='comment'>#
</span> <span class='comment'># @return [Hash] Default URL options for the request.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_default_url_options'>default_url_options</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>only_path:</span> <span class='kw'>false</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>host:</span> <span class='id identifier rubyid_request_source_host'>request_source_host</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>RuntimeConfiguration</span><span class='period'>.</span><span class='id identifier rubyid_development?'>development?</span>
<span class='id identifier rubyid_rv'>rv</span>
<span class='kw'>end</span>
<span class='comment'># Tiny handle to handle CORS OPTIONS requests. It just renders nothing as headers are handle in Apes::Concerns::Response module.
</span> <span class='comment'>#
</span> <span class='comment'># To enable this route, add the following to the routes.rb:
</span> <span class='comment'>#
</span> <span class='comment'># # This is to enable AJAX cross domain
</span> <span class='comment'># match '*path', to: 'application#handle_cors', via: :options
</span> <span class='kw'>def</span> <span class='id identifier rubyid_handle_cors'>handle_cors</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>nothing:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:no_content</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Default handler to render errors.
</span> <span class='comment'>#
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP error code to return.
</span> <span class='comment'># @param errors [Array] The list of occurred errors.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_render_error'>render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
<span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span>
<span class='id identifier rubyid_status_code'>status_code</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='op'>::</span><span class='const'>SYMBOL_TO_STATUS_CODE</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='int'>500</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>errors/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_private'>private</span>
<span class='comment'># :nodoc:
</span> <span class='kw'>def</span> <span class='id identifier rubyid_render_default_views'>render_default_views</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@objects</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/collection</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@object</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/object</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_error_handle_exception'>error_handle_exception</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="default_url_options-instance_method">
- (<tt>Hash</tt>) <strong>default_url_options</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the default URL options for this request.
It ensures that the host is always included and that is set properly in development mode.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>Default URL options for the request.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/apes/controller.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_url_options'>default_url_options</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>only_path:</span> <span class='kw'>false</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>host:</span> <span class='id identifier rubyid_request_source_host'>request_source_host</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='const'>Apes</span><span class='op'>::</span><span class='const'>RuntimeConfiguration</span><span class='period'>.</span><span class='id identifier rubyid_development?'>development?</span>
<span class='id identifier rubyid_rv'>rv</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="handle_cors-instance_method">
- (<tt>Object</tt>) <strong>handle_cors</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Tiny handle to handle CORS OPTIONS requests. It just renders nothing as headers are handle in Apes::Concerns::Response module.</p>
<p>To enable this route, add the following to the routes.rb:</p>
<pre class="code ruby"><code class="ruby"><span class='comment'># This is to enable AJAX cross domain
</span><span class='id identifier rubyid_match'>match</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*path</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>to:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application#handle_cors</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>via:</span> <span class='symbol'>:options</span>
</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/apes/controller.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_handle_cors'>handle_cors</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>nothing:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:no_content</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="render_error-instance_method">
- (<tt>Object</tt>) <strong>render_error</strong>(status, errors)
</h3><div class="docstring">
<div class="discussion">
<p>Default handler to render errors.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>status</span>
<span class='type'>(<tt>Symbol|Fixnum</tt>)</span>
—
<div class='inline'><p>The HTTP error code to return.</p>
</div>
</li>
<li>
<span class='name'>errors</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>The list of occurred errors.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/apes/controller.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_render_error'>render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
<span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span>
<span class='id identifier rubyid_status_code'>status_code</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='op'>::</span><span class='const'>SYMBOL_TO_STATUS_CODE</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='int'>500</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>errors/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Aug 18 15:49:46 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
</body>
</html>