<!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>
Module: Ballast::Concerns::Common
— 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/Concerns/Common.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="../../Ballast.html" title="Ballast (module)">Ballast</a></span></span> » <span class='title'><span class='object_link'><a href="../Concerns.html" title="Ballast::Concerns (module)">Concerns</a></span></span>
»
<span class="title">Common</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>Module: Ballast::Concerns::Common
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/ballast/concerns/common.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A concern to handle common tasks in an application.</p>
</div>
</div>
<div class="tags">
</div>
<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="#authenticate_user-instance_method" title="#authenticate_user (instance method)">- (Object) <strong>authenticate_user</strong>(area: nil, title: nil, message: nil, &authenticator) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Authenticates a user via HTTP, handling the error if the authentication failed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#format_long_date-instance_method" title="#format_long_date (instance method)">- (Object) <strong>format_long_date</strong>(date, separator: "•", format: "%I:%M%p %- %b %o, %Y (%:Z)") </a>
</span>
<span class="summary_desc"><div class='inline'><p>Formats a long date.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#format_short_amount-instance_method" title="#format_short_amount (instance method)">- (String) <strong>format_short_amount</strong>(amount, suffix = "") </a>
</span>
<span class="summary_desc"><div class='inline'><p>Formats a short amount of time (less than one hour).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#format_short_duration-instance_method" title="#format_short_duration (instance method)">- (String) <strong>format_short_duration</strong>(date, reference: nil, suffix: "") </a>
</span>
<span class="summary_desc"><div class='inline'><p>Formats a relative date using abbreviation or short formats.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#json%3F-instance_method" title="#json? (instance method)">- (Boolean) <strong>json?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks if the current request wants JSON or JSONP as response.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#perform_service-instance_method" title="#perform_service (instance method)">- (Service::Response) <strong>perform_service</strong>(klass, operation = :perform, **kwargs) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Executes a service.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#request_data%3F-instance_method" title="#request_data? (instance method)">- (Boolean) <strong>request_data?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks if the user is sending any data.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="authenticate_user-instance_method">
- (<tt>Object</tt>) <strong>authenticate_user</strong>(area: nil, title: nil, message: nil, &authenticator)
</h3><div class="docstring">
<div class="discussion">
<p>Authenticates a user via HTTP, handling the error if the authentication failed.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>area</span>
<span class='type'>(<tt>String|NilClass</tt>)</span>
—
<div class='inline'><p>The name of the area.</p>
</div>
</li>
<li>
<span class='name'>title</span>
<span class='type'>(<tt>String|NilClass</tt>)</span>
—
<div class='inline'><p>A title for authentication errors.</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String|NilClass</tt>)</span>
—
<div class='inline'><p>A message for authentication errors.</p>
</div>
</li>
<li>
<span class='name'>authenticator</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>A block to verify if authentication is valid.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
87
88
89
90
91
92
93
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 87</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_authenticate_user identifier id'>authenticate_user</span><span class='lparen token'>(</span><span class='label val'>area:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>title:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>message:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='rubyid_authenticator identifier id'>authenticator</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_authenticate_with_http_basic identifier id'>authenticate_with_http_basic</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_username identifier id'>username</span><span class='comma token'>,</span> <span class='rubyid_password identifier id'>password</span><span class='bitor op'>|</span> <span class='rubyid_authenticator identifier id'>authenticator</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_username identifier id'>username</span><span class='comma token'>,</span> <span class='rubyid_password identifier id'>password</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
<span class='rubyid_area identifier id'>area</span> <span class='opasgn op'>||=</span> <span class='string val'>"Private Area"</span>
<span class='rubyid_title identifier id'>title</span> <span class='opasgn op'>||=</span> <span class='string val'>"Authentication required."</span>
<span class='rubyid_message identifier id'>message</span> <span class='opasgn op'>||=</span> <span class='string val'>"To view this resource you have to authenticate."</span>
<span class='rubyid_headers identifier id'>headers</span><span class='lbrack token'>[</span><span class='string val'>"WWW-Authenticate"</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='dstring node'>"Basic realm=\"#{area}\""</span>
<span class='rubyid_handle_error identifier id'>handle_error</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='label val'>status:</span> <span class='integer val'>401</span><span class='comma token'>,</span> <span class='label val'>title:</span> <span class='rubyid_title identifier id'>title</span><span class='comma token'>,</span> <span class='label val'>message:</span> <span class='rubyid_message identifier id'>message</span><span class='rbrace token'>}</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="format_long_date-instance_method">
- (<tt>Object</tt>) <strong>format_long_date</strong>(date, separator: "•", format: "%I:%M%p %- %b %o, %Y (%:Z)")
</h3><div class="docstring">
<div class="discussion">
<p>Formats a long date.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>date</span>
<span class='type'>(<tt>DateTime</tt>)</span>
—
<div class='inline'><p>The date to format.</p>
</div>
</li>
<li>
<span class='name'>separator</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The separator between date and time.</p>
</div>
</li>
<li>
<span class='name'>format</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The format of the date, like in strftime. Use <code>%-</code> for the separator, <code>%o</code> for the ordinalized version of the day of the month
and <code>%:Z</code> for the zone name considering also DST.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 75</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_long_date identifier id'>format_long_date</span><span class='lparen token'>(</span><span class='rubyid_date identifier id'>date</span><span class='comma token'>,</span> <span class='label val'>separator:</span> <span class='string val'>"•"</span><span class='comma token'>,</span> <span class='label val'>format:</span> <span class='string val'>"%I:%M%p %- %b %o, %Y (%:Z)"</span><span class='rparen token'>)</span>
<span class='rubyid_tz identifier id'>tz</span> <span class='assign token'>=</span> <span class='rubyid_Time constant id'>Time</span><span class='dot token'>.</span><span class='rubyid_zone identifier id'>zone</span>
<span class='rubyid_replacements identifier id'>replacements</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='string val'>"%-"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_separator identifier id'>separator</span><span class='comma token'>,</span> <span class='string val'>"%o"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_date identifier id'>date</span><span class='dot token'>.</span><span class='rubyid_day identifier id'>day</span><span class='dot token'>.</span><span class='rubyid_ordinalize identifier id'>ordinalize</span><span class='comma token'>,</span> <span class='string val'>"%:Z"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_tz identifier id'>tz</span><span class='dot token'>.</span><span class='rubyid_current_name identifier id'>current_name</span><span class='lparen token'>(</span><span class='rubyid_tz identifier id'>tz</span><span class='dot token'>.</span><span class='rubyid_uses_dst? fid id'>uses_dst?</span> <span class='andop op'>&&</span> <span class='rubyid_date identifier id'>date</span><span class='dot token'>.</span><span class='rubyid_dst? fid id'>dst?</span><span class='rparen token'>)</span><span class='rbrace token'>}</span>
<span class='rubyid_date identifier id'>date</span><span class='dot token'>.</span><span class='rubyid_strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='regexp val'>/%(-|o|(:Z))/</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_r identifier id'>r</span><span class='bitor op'>|</span> <span class='rubyid_replacements identifier id'>replacements</span><span class='dot token'>.</span><span class='rubyid_fetch identifier id'>fetch</span><span class='lparen token'>(</span><span class='rubyid_r identifier id'>r</span><span class='comma token'>,</span> <span class='rubyid_r identifier id'>r</span><span class='rparen token'>)</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="format_short_amount-instance_method">
- (<tt>String</tt>) <strong>format_short_amount</strong>(amount, suffix = "")
</h3><div class="docstring">
<div class="discussion">
<p>Formats a short amount of time (less than one hour).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>amount</span>
<span class='type'>(<tt>Fixnum</tt>)</span>
—
<div class='inline'><p>The amount to format.</p>
</div>
</li>
<li>
<span class='name'>suffix</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>""</tt>)</em>
—
<div class='inline'><p>The suffix to add to the formatted amount.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The formatted amount.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61
62
63
64
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 59</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_short_amount identifier id'>format_short_amount</span><span class='lparen token'>(</span><span class='rubyid_amount identifier id'>amount</span><span class='comma token'>,</span> <span class='rubyid_suffix identifier id'>suffix</span> <span class='assign token'>=</span> <span class='string val'>""</span><span class='rparen token'>)</span>
<span class='rubyid_if if kw'>if</span> <span class='rubyid_amount identifier id'>amount</span> <span class='lt op'><</span> <span class='float val'>1</span><span class='dot token'>.</span><span class='rubyid_minute identifier id'>minute</span>
<span class='dstring node'>"#{amount.floor}s#{suffix}"</span>
<span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_amount identifier id'>amount</span> <span class='lt op'><</span> <span class='float val'>1</span><span class='dot token'>.</span><span class='rubyid_hour identifier id'>hour</span>
<span class='dstring node'>"#{(amount / 60).floor}m#{suffix}"</span>
<span class='rubyid_else else kw'>else</span>
<span class='dstring node'>"#{(amount / 3600).floor}h#{suffix}"</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="format_short_duration-instance_method">
- (<tt>String</tt>) <strong>format_short_duration</strong>(date, reference: nil, suffix: "")
</h3><div class="docstring">
<div class="discussion">
<p>Formats a relative date using abbreviation or short formats.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>date</span>
<span class='type'>(<tt>DateTime</tt>)</span>
—
<div class='inline'><p>The date to format.</p>
</div>
</li>
<li>
<span class='name'>reference</span>
<span class='type'>(<tt>DateTime|NilClass</tt>)</span>
—
<div class='inline'><p>The reference date.</p>
</div>
</li>
<li>
<span class='name'>suffix</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The suffix to add to the formatted date.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The formatted date.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42
43
44
45
46
47
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 40</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_format_short_duration identifier id'>format_short_duration</span><span class='lparen token'>(</span><span class='rubyid_date identifier id'>date</span><span class='comma token'>,</span> <span class='label val'>reference:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>suffix:</span> <span class='string val'>""</span><span class='rparen token'>)</span>
<span class='rubyid_amount identifier id'>amount</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_reference identifier id'>reference</span> <span class='orop op'>||</span> <span class='rubyid_Time constant id'>Time</span><span class='dot token'>.</span><span class='rubyid_now identifier id'>now</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> <span class='minus op'>-</span> <span class='rubyid_date identifier id'>date</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
<span class='rubyid_if if kw'>if</span> <span class='rubyid_amount identifier id'>amount</span> <span class='leq op'><=</span> <span class='integer val'>0</span>
<span class='string val'>"now"</span>
<span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_amount identifier id'>amount</span> <span class='lt op'><</span> <span class='float val'>1</span><span class='dot token'>.</span><span class='rubyid_day identifier id'>day</span>
<span class='rubyid_format_short_amount identifier id'>format_short_amount</span><span class='lparen token'>(</span><span class='rubyid_amount identifier id'>amount</span><span class='comma token'>,</span> <span class='rubyid_suffix identifier id'>suffix</span><span class='rparen token'>)</span>
<span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_amount identifier id'>amount</span> <span class='lt op'><</span> <span class='float val'>1</span><span class='dot token'>.</span><span class='rubyid_year identifier id'>year</span>
<span class='rubyid_date identifier id'>date</span><span class='dot token'>.</span><span class='rubyid_strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>"%b %d"</span><span class='rparen token'>)</span>
<span class='rubyid_else else kw'>else</span>
<span class='rubyid_date identifier id'>date</span><span class='dot token'>.</span><span class='rubyid_strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>"%b %d %Y"</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="json?-instance_method">
- (<tt>Boolean</tt>) <strong>json?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Checks if the current request wants JSON or JSONP as response.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if the request is JSON(P), <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 23</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_json? fid id'>json?</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='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen 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='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:json</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_boolean identifier id'>to_boolean</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="perform_service-instance_method">
- (<tt><span class='object_link'><a href="../Service/Response.html" title="Ballast::Service::Response (class)">Service::Response</a></span></tt>) <strong>perform_service</strong>(klass, operation = :perform, **kwargs)
</h3><div class="docstring">
<div class="discussion">
<p>Executes a service.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>klass</span>
<span class='type'>(<tt><span class='object_link'><a href="../Service.html" title="Ballast::Service (class)">Service</a></span></tt>)</span>
—
<div class='inline'><p>The service to execute.</p>
</div>
</li>
<li>
<span class='name'>operation</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>:perform</tt>)</em>
—
<div class='inline'><p>The operation to invoke.</p>
</div>
</li>
<li>
<span class='name'>kwargs</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>Parameters passed to the service.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Service/Response.html" title="Ballast::Service::Response (class)">Service::Response</a></span></tt>)</span>
—
<div class='inline'><p>The result of the invocation.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 16</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_perform_service identifier id'>perform_service</span><span class='lparen token'>(</span><span class='rubyid_klass identifier id'>klass</span><span class='comma token'>,</span> <span class='rubyid_operation identifier id'>operation</span> <span class='assign token'>=</span> <span class='symbol val'>:perform</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_kwargs identifier id'>kwargs</span><span class='rparen token'>)</span>
<span class='rubyid_@result ivar id'>@result</span> <span class='assign token'>=</span> <span class='rubyid_klass identifier id'>klass</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_self self kw'>self</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_operation identifier id'>operation</span><span class='comma token'>,</span> <span class='label val'>params:</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_kwargs identifier id'>kwargs</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="request_data?-instance_method">
- (<tt>Boolean</tt>) <strong>request_data?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Checks if the user is sending any data.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if the user is sending data, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/common.rb', line 30</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_request_data? fid id'>request_data?</span>
<span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_post? fid id'>post?</span> <span class='orop op'>||</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_put? fid id'>put?</span> <span class='orop op'>||</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_patch? fid id'>patch?</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Feb 7 19:16:43 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.0).
</div>
</body>
</html>