docs/Ballast/Concerns/Common.html
<!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='kw'>def</span> <span class='id identifier rubyid_authenticate_user'>authenticate_user</span><span class='lparen'>(</span><span class='label'>area:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>title:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_authenticator'>authenticator</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_authenticate_with_http_basic'>authenticate_with_http_basic</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_authenticator'>authenticator</span><span class='rparen'>)</span>
<span class='id identifier rubyid_area'>area</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Private Area</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_title'>title</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Authentication required.</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_message'>message</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>To view this resource you have to authenticate.</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>WWW-Authenticate</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Basic realm=\"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_area'>area</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_handle_error'>handle_error</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>status:</span> <span class='int'>401</span><span class='comma'>,</span> <span class='label'>title:</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='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='kw'>def</span> <span class='id identifier rubyid_format_long_date'>format_long_date</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='comma'>,</span> <span class='label'>separator:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>•</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%I:%M%p %- %b %o, %Y (%:Z)</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_tz'>tz</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_zone'>zone</span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%-</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_separator'>separator</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%o</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_day'>day</span><span class='period'>.</span><span class='id identifier rubyid_ordinalize'>ordinalize</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%:Z</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tz'>tz</span><span class='period'>.</span><span class='id identifier rubyid_current_name'>current_name</span><span class='lparen'>(</span><span class='id identifier rubyid_tz'>tz</span><span class='period'>.</span><span class='id identifier rubyid_uses_dst?'>uses_dst?</span> <span class='op'>&&</span> <span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_dst?'>dst?</span><span class='rparen'>)</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>%(-|o|(:Z))</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='comma'>,</span> <span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='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='kw'>def</span> <span class='id identifier rubyid_format_short_amount'>format_short_amount</span><span class='lparen'>(</span><span class='id identifier rubyid_amount'>amount</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_amount'>amount</span> <span class='op'><</span> <span class='int'>1</span><span class='period'>.</span><span class='id identifier rubyid_minute'>minute</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_amount'>amount</span><span class='period'>.</span><span class='id identifier rubyid_floor'>floor</span><span class='embexpr_end'>}</span><span class='tstring_content'>s</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_amount'>amount</span> <span class='op'><</span> <span class='int'>1</span><span class='period'>.</span><span class='id identifier rubyid_hour'>hour</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='lparen'>(</span><span class='id identifier rubyid_amount'>amount</span> <span class='op'>/</span> <span class='int'>60</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_floor'>floor</span><span class='embexpr_end'>}</span><span class='tstring_content'>m</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='lparen'>(</span><span class='id identifier rubyid_amount'>amount</span> <span class='op'>/</span> <span class='int'>3600</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_floor'>floor</span><span class='embexpr_end'>}</span><span class='tstring_content'>h</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='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='kw'>def</span> <span class='id identifier rubyid_format_short_duration'>format_short_duration</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='comma'>,</span> <span class='label'>reference:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>suffix:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_amount'>amount</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_reference'>reference</span> <span class='op'>||</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>-</span> <span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>if</span> <span class='id identifier rubyid_amount'>amount</span> <span class='op'><=</span> <span class='int'>0</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>now</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_amount'>amount</span> <span class='op'><</span> <span class='int'>1</span><span class='period'>.</span><span class='id identifier rubyid_day'>day</span>
<span class='id identifier rubyid_format_short_amount'>format_short_amount</span><span class='lparen'>(</span><span class='id identifier rubyid_amount'>amount</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_amount'>amount</span> <span class='op'><</span> <span class='int'>1</span><span class='period'>.</span><span class='id identifier rubyid_year'>year</span>
<span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%b %d</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%b %d %Y</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='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='kw'>def</span> <span class='id identifier rubyid_json?'>json?</span>
<span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:json</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
<span class='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='kw'>def</span> <span class='id identifier rubyid_perform_service'>perform_service</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='comma'>,</span> <span class='id identifier rubyid_operation'>operation</span> <span class='op'>=</span> <span class='symbol'>:perform</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
<span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_operation'>operation</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
<span class='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='kw'>def</span> <span class='id identifier rubyid_request_data?'>request_data?</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_post?'>post?</span> <span class='op'>||</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_put?'>put?</span> <span class='op'>||</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_patch?'>patch?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Aug 18 15:49:48 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>