<!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: Ballast::AjaxResponse
— 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#!Ballast/AjaxResponse.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 (A)</a> »
<span class='title'><span class='object_link'><a href="../Ballast.html" title="Ballast (module)">Ballast</a></span></span>
»
<span class="title">AjaxResponse</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: Ballast::AjaxResponse
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Ballast::AjaxResponse</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/ballast/ajax_response.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>An AJAX response.</p>
</div>
</div>
<div class="tags">
</div>
<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="#data-instance_method" title="#data (instance method)">- (Object|Hash|NilClass) <strong>data</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The data to send to the client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error-instance_method" title="#error (instance method)">- (Object|NilClass) <strong>error</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A error message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#status-instance_method" title="#status (instance method)">- (Symbol|Fixnum) <strong>status</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The HTTP status of the response.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#transport-instance_method" title="#transport (instance method)">- (Object|NilClass) <strong>transport</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The transport to use for sending.</p>
</div></span>
</li>
</ul>
<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="#as_json-instance_method" title="#as_json (instance method)">- (Hash) <strong>as_json</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a JSON representation of the response.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AjaxResponse) <strong>initialize</strong>(status: :ok, data: {}, error: nil, transport: nil) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Creates an AJAX response.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#numeric_status-instance_method" title="#numeric_status (instance method)">- (Fixnum) <strong>numeric_status</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the status as a number.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reply-instance_method" title="#reply (instance method)">- (Object) <strong>reply</strong>(format: :json, pretty_json: false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Sends the response using the transport.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Ballast::AjaxResponse (class)">AjaxResponse</a></span></tt>) <strong>initialize</strong>(status: :ok, data: {}, error: nil, transport: nil)
</h3><div class="docstring">
<div class="discussion">
<p>Creates an AJAX response.</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 status of the response.</p>
</div>
</li>
<li>
<span class='name'>data</span>
<span class='type'>(<tt>Object|Hash|NilClass</tt>)</span>
—
<div class='inline'><p>Additional data to append to the response.</p>
</div>
</li>
<li>
<span class='name'>error</span>
<span class='type'>(<tt>Object|NilClass</tt>)</span>
—
<div class='inline'><p>A error to append to the response.</p>
</div>
</li>
<li>
<span class='name'>transport</span>
<span class='type'>(<tt>Object|NilClass</tt>)</span>
—
<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>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 26</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
<span class='rubyid_@status ivar id'>@status</span> <span class='assign token'>=</span> <span class='rubyid_status identifier id'>status</span>
<span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
<span class='rubyid_@error ivar id'>@error</span> <span class='assign token'>=</span> <span class='rubyid_error identifier id'>error</span>
<span class='rubyid_@transport ivar id'>@transport</span> <span class='assign token'>=</span> <span class='rubyid_transport identifier id'>transport</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="data=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="data-instance_method">
- (<tt>Object|Hash|NilClass</tt>) <strong>data</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The data to send to the client.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object|Hash|NilClass</tt>)</span>
—
<div class='inline'><p>The data to send to the client.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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
77
78
79
80
81
82
83
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
<span class='rubyid_class class kw'>class</span> <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span>
<span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:status</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:error</span><span class='comma token'>,</span> <span class='symbol val'>:transport</span>
<span class='comment val'># Creates an AJAX response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param status [Symbol|Fixnum] The HTTP status of the response.</span>
<span class='comment val'># @param data [Object|Hash|NilClass] Additional data to append to the response.</span>
<span class='comment val'># @param error [Object|NilClass] A error to append to the response.</span>
<span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
<span class='rubyid_@status ivar id'>@status</span> <span class='assign token'>=</span> <span class='rubyid_status identifier id'>status</span>
<span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
<span class='rubyid_@error ivar id'>@error</span> <span class='assign token'>=</span> <span class='rubyid_error identifier id'>error</span>
<span class='rubyid_@transport ivar id'>@transport</span> <span class='assign token'>=</span> <span class='rubyid_transport identifier id'>transport</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns the status as a number.</span>
<span class='comment val'>#</span>
<span class='comment val'># @return [Fixnum] The status as a number.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span>
<span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns a JSON representation of the response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.</span>
<span class='comment val'># @return [Hash] A JSON representation of the response.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_as_json identifier id'>as_json</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='lbrace token'>{</span>
<span class='label val'>status:</span> <span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:original_status</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span>
<span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span>
<span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span>
<span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Sends the response using the transport.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param format [Symbol] The content type of the response.</span>
<span class='comment val'># @param pretty_json [Boolean] If JSON response must be pretty formatted.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span><span class='lparen token'>(</span><span class='label val'>format:</span> <span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='label val'>pretty_json:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
<span class='rubyid_return return kw'>return</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_performed? fid id'>performed?</span>
<span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_pretty_json identifier id'>pretty_json</span> <span class='integer val'>? </span><span class='rubyid_Oj constant id'>Oj</span><span class='dot token'>.</span><span class='rubyid_dump identifier id'>dump</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_ActiveSupport constant id'>ActiveSupport</span><span class='colon2 op'>::</span><span class='rubyid_JSON constant id'>JSON</span><span class='dot token'>.</span><span class='rubyid_encode identifier id'>encode</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:text</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_content identifier id'>content</span><span class='comma token'>,</span> <span class='label val'>status:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span> <span class='label val'>callback:</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='label val'>content_type:</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_private identifier id'>private</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_callback identifier id'>callback</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:pretty_jsonp</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='dstring node'>"jsonp#{Time.now.to_i}"</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='eq op'>==</span> <span class='symbol val'>:text</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='string val'>"text/plain"</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='lbrack token'>[</span><span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rbrack token'>]</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:format</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='string val'>"json"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> <span class='orop op'>||</span> <span class='symbol val'>:html</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='lbrace token'>{</span><span class='label val'>status:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span><span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id="error=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="error-instance_method">
- (<tt>Object|NilClass</tt>) <strong>error</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A error message.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object|NilClass</tt>)</span>
—
<div class='inline'><p>A error message.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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
77
78
79
80
81
82
83
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
<span class='rubyid_class class kw'>class</span> <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span>
<span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:status</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:error</span><span class='comma token'>,</span> <span class='symbol val'>:transport</span>
<span class='comment val'># Creates an AJAX response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param status [Symbol|Fixnum] The HTTP status of the response.</span>
<span class='comment val'># @param data [Object|Hash|NilClass] Additional data to append to the response.</span>
<span class='comment val'># @param error [Object|NilClass] A error to append to the response.</span>
<span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
<span class='rubyid_@status ivar id'>@status</span> <span class='assign token'>=</span> <span class='rubyid_status identifier id'>status</span>
<span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
<span class='rubyid_@error ivar id'>@error</span> <span class='assign token'>=</span> <span class='rubyid_error identifier id'>error</span>
<span class='rubyid_@transport ivar id'>@transport</span> <span class='assign token'>=</span> <span class='rubyid_transport identifier id'>transport</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns the status as a number.</span>
<span class='comment val'>#</span>
<span class='comment val'># @return [Fixnum] The status as a number.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span>
<span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns a JSON representation of the response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.</span>
<span class='comment val'># @return [Hash] A JSON representation of the response.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_as_json identifier id'>as_json</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='lbrace token'>{</span>
<span class='label val'>status:</span> <span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:original_status</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span>
<span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span>
<span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span>
<span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Sends the response using the transport.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param format [Symbol] The content type of the response.</span>
<span class='comment val'># @param pretty_json [Boolean] If JSON response must be pretty formatted.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span><span class='lparen token'>(</span><span class='label val'>format:</span> <span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='label val'>pretty_json:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
<span class='rubyid_return return kw'>return</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_performed? fid id'>performed?</span>
<span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_pretty_json identifier id'>pretty_json</span> <span class='integer val'>? </span><span class='rubyid_Oj constant id'>Oj</span><span class='dot token'>.</span><span class='rubyid_dump identifier id'>dump</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_ActiveSupport constant id'>ActiveSupport</span><span class='colon2 op'>::</span><span class='rubyid_JSON constant id'>JSON</span><span class='dot token'>.</span><span class='rubyid_encode identifier id'>encode</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:text</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_content identifier id'>content</span><span class='comma token'>,</span> <span class='label val'>status:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span> <span class='label val'>callback:</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='label val'>content_type:</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_private identifier id'>private</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_callback identifier id'>callback</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:pretty_jsonp</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='dstring node'>"jsonp#{Time.now.to_i}"</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='eq op'>==</span> <span class='symbol val'>:text</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='string val'>"text/plain"</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='lbrack token'>[</span><span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rbrack token'>]</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:format</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='string val'>"json"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> <span class='orop op'>||</span> <span class='symbol val'>:html</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='lbrace token'>{</span><span class='label val'>status:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span><span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id="status=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="status-instance_method">
- (<tt>Symbol|Fixnum</tt>) <strong>status</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The HTTP status of the response.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol|Fixnum</tt>)</span>
—
<div class='inline'><p>The HTTP status of the response.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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
77
78
79
80
81
82
83
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
<span class='rubyid_class class kw'>class</span> <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span>
<span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:status</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:error</span><span class='comma token'>,</span> <span class='symbol val'>:transport</span>
<span class='comment val'># Creates an AJAX response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param status [Symbol|Fixnum] The HTTP status of the response.</span>
<span class='comment val'># @param data [Object|Hash|NilClass] Additional data to append to the response.</span>
<span class='comment val'># @param error [Object|NilClass] A error to append to the response.</span>
<span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
<span class='rubyid_@status ivar id'>@status</span> <span class='assign token'>=</span> <span class='rubyid_status identifier id'>status</span>
<span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
<span class='rubyid_@error ivar id'>@error</span> <span class='assign token'>=</span> <span class='rubyid_error identifier id'>error</span>
<span class='rubyid_@transport ivar id'>@transport</span> <span class='assign token'>=</span> <span class='rubyid_transport identifier id'>transport</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns the status as a number.</span>
<span class='comment val'>#</span>
<span class='comment val'># @return [Fixnum] The status as a number.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span>
<span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns a JSON representation of the response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.</span>
<span class='comment val'># @return [Hash] A JSON representation of the response.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_as_json identifier id'>as_json</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='lbrace token'>{</span>
<span class='label val'>status:</span> <span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:original_status</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span>
<span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span>
<span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span>
<span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Sends the response using the transport.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param format [Symbol] The content type of the response.</span>
<span class='comment val'># @param pretty_json [Boolean] If JSON response must be pretty formatted.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span><span class='lparen token'>(</span><span class='label val'>format:</span> <span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='label val'>pretty_json:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
<span class='rubyid_return return kw'>return</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_performed? fid id'>performed?</span>
<span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_pretty_json identifier id'>pretty_json</span> <span class='integer val'>? </span><span class='rubyid_Oj constant id'>Oj</span><span class='dot token'>.</span><span class='rubyid_dump identifier id'>dump</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_ActiveSupport constant id'>ActiveSupport</span><span class='colon2 op'>::</span><span class='rubyid_JSON constant id'>JSON</span><span class='dot token'>.</span><span class='rubyid_encode identifier id'>encode</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:text</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_content identifier id'>content</span><span class='comma token'>,</span> <span class='label val'>status:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span> <span class='label val'>callback:</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='label val'>content_type:</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_private identifier id'>private</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_callback identifier id'>callback</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:pretty_jsonp</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='dstring node'>"jsonp#{Time.now.to_i}"</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='eq op'>==</span> <span class='symbol val'>:text</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='string val'>"text/plain"</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='lbrack token'>[</span><span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rbrack token'>]</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:format</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='string val'>"json"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> <span class='orop op'>||</span> <span class='symbol val'>:html</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='lbrace token'>{</span><span class='label val'>status:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span><span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id="transport=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="transport-instance_method">
- (<tt>Object|NilClass</tt>) <strong>transport</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The transport to use for sending. Must respond to <code>render</code>, <code>params</code>, <code>request.format</code> and <code>performed?</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object|NilClass</tt>)</span>
—
<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>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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
77
78
79
80
81
82
83
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
<span class='rubyid_class class kw'>class</span> <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span>
<span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:status</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:error</span><span class='comma token'>,</span> <span class='symbol val'>:transport</span>
<span class='comment val'># Creates an AJAX response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param status [Symbol|Fixnum] The HTTP status of the response.</span>
<span class='comment val'># @param data [Object|Hash|NilClass] Additional data to append to the response.</span>
<span class='comment val'># @param error [Object|NilClass] A error to append to the response.</span>
<span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
<span class='rubyid_@status ivar id'>@status</span> <span class='assign token'>=</span> <span class='rubyid_status identifier id'>status</span>
<span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
<span class='rubyid_@error ivar id'>@error</span> <span class='assign token'>=</span> <span class='rubyid_error identifier id'>error</span>
<span class='rubyid_@transport ivar id'>@transport</span> <span class='assign token'>=</span> <span class='rubyid_transport identifier id'>transport</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns the status as a number.</span>
<span class='comment val'>#</span>
<span class='comment val'># @return [Fixnum] The status as a number.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span>
<span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Returns a JSON representation of the response.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.</span>
<span class='comment val'># @return [Hash] A JSON representation of the response.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_as_json identifier id'>as_json</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='lbrace token'>{</span>
<span class='label val'>status:</span> <span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:original_status</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span>
<span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span>
<span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span>
<span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># Sends the response using the transport.</span>
<span class='comment val'>#</span>
<span class='comment val'># @param format [Symbol] The content type of the response.</span>
<span class='comment val'># @param pretty_json [Boolean] If JSON response must be pretty formatted.</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span><span class='lparen token'>(</span><span class='label val'>format:</span> <span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='label val'>pretty_json:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
<span class='rubyid_return return kw'>return</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_performed? fid id'>performed?</span>
<span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_pretty_json identifier id'>pretty_json</span> <span class='integer val'>? </span><span class='rubyid_Oj constant id'>Oj</span><span class='dot token'>.</span><span class='rubyid_dump identifier id'>dump</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_ActiveSupport constant id'>ActiveSupport</span><span class='colon2 op'>::</span><span class='rubyid_JSON constant id'>JSON</span><span class='dot token'>.</span><span class='rubyid_encode identifier id'>encode</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:text</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_content identifier id'>content</span><span class='comma token'>,</span> <span class='label val'>status:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span> <span class='label val'>callback:</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='label val'>content_type:</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_private identifier id'>private</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_callback identifier id'>callback</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:pretty_jsonp</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='dstring node'>"jsonp#{Time.now.to_i}"</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='eq op'>==</span> <span class='symbol val'>:text</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='string val'>"text/plain"</span> <span class='colon op'>:</span> <span class='rubyid_nil nil kw'>nil</span>
<span class='lbrack token'>[</span><span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rbrack token'>]</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_choose_format identifier id'>choose_format</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:format</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_format identifier id'>format</span> <span class='orop op'>||</span> <span class='string val'>"json"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> <span class='orop op'>||</span> <span class='symbol val'>:html</span>
<span class='rubyid_end end kw'>end</span>
<span class='comment val'># :nodoc:</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='lbrace token'>{</span><span class='label val'>status:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span><span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end 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="as_json-instance_method">
- (<tt>Hash</tt>) <strong>as_json</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns a JSON representation of the response.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>The options to use for serializing. Currently only <code>original_status</code> is supported.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>A JSON representation of the response.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 44</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_as_json identifier id'>as_json</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='lbrace token'>{</span>
<span class='label val'>status:</span> <span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:original_status</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span>
<span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span>
<span class='label val'>error:</span> <span class='rubyid_error identifier id'>error</span>
<span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="numeric_status-instance_method">
- (<tt>Fixnum</tt>) <strong>numeric_status</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the status as a number.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Fixnum</tt>)</span>
—
<div class='inline'><p>The status as a number.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 36</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span>
<span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_status identifier id'>status</span> <span class='colon op'>:</span> <span class='rubyid_Rack constant id'>Rack</span><span class='colon2 op'>::</span><span class='rubyid_Utils constant id'>Utils</span><span class='dot token'>.</span><span class='rubyid_status_code identifier id'>status_code</span><span class='lparen token'>(</span><span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reply-instance_method">
- (<tt>Object</tt>) <strong>reply</strong>(format: :json, pretty_json: false)
</h3><div class="docstring">
<div class="discussion">
<p>Sends the response using the transport.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>format</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>The content type of the response.</p>
</div>
</li>
<li>
<span class='name'>pretty_json</span>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>If JSON response must be pretty formatted.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58
59
60
61
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 56</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span><span class='lparen token'>(</span><span class='label val'>format:</span> <span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='label val'>pretty_json:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
<span class='rubyid_return return kw'>return</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_performed? fid id'>performed?</span>
<span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='rubyid_format_reply identifier id'>format_reply</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='rubyid_prepare_content identifier id'>prepare_content</span>
<span class='rubyid_content identifier id'>content</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_pretty_json identifier id'>pretty_json</span> <span class='integer val'>? </span><span class='rubyid_Oj constant id'>Oj</span><span class='dot token'>.</span><span class='rubyid_dump identifier id'>dump</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_ActiveSupport constant id'>ActiveSupport</span><span class='colon2 op'>::</span><span class='rubyid_JSON constant id'>JSON</span><span class='dot token'>.</span><span class='rubyid_encode identifier id'>encode</span><span class='lparen token'>(</span><span class='rubyid_content identifier id'>content</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='symbol val'>:jsonp</span><span class='comma token'>,</span> <span class='symbol val'>:text</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span>
<span class='rubyid_transport identifier id'>transport</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_content identifier id'>content</span><span class='comma token'>,</span> <span class='label val'>status:</span> <span class='rubyid_numeric_status identifier id'>numeric_status</span><span class='comma token'>,</span> <span class='label val'>callback:</span> <span class='rubyid_callback identifier id'>callback</span><span class='comma token'>,</span> <span class='label val'>content_type:</span> <span class='rubyid_content_type identifier id'>content_type</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Mar 9 10:37:57 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>