<!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::AjaxHandling
— 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/AjaxHandling.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'><span class='object_link'><a href="../Concerns.html" title="Ballast::Concerns (module)">Concerns</a></span></span>
»
<span class="title">AjaxHandling</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::AjaxHandling
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/ballast/concerns/ajax_handling.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A concern to handle AJAX and HTTP requests.</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="#ajax_request%3F-instance_method" title="#ajax_request? (instance method)">- (Boolean) <strong>ajax_request?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks if the current request is AJAX.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#allow_cors-instance_method" title="#allow_cors (instance method)">- (Object) <strong>allow_cors</strong>(allow_origin: "*", allow_methods: [:post, :get, :options], allow_headers: "*", max_age: 1.year, allow_credentials: false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Allows HTTP Cross-Origin Resource Sharing.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#generate_robots_txt-instance_method" title="#generate_robots_txt (instance method)">- (Object) <strong>generate_robots_txt</strong>(configuration = nil) </a>
(also: #disallow_robots)
</span>
<span class="summary_desc"><div class='inline'><p>Generates a `robots.txt file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prepare_ajax_response-instance_method" title="#prepare_ajax_response (instance method)">- (Object) <strong>prepare_ajax_response</strong>(status: :ok, data: {}, error: nil) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Prepares an AJAX response.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prevent_caching-instance_method" title="#prevent_caching (instance method)">- (Object) <strong>prevent_caching</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Prevents HTTP caching.</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="ajax_request?-instance_method">
- (<tt>Boolean</tt>) <strong>ajax_request?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Checks if the current request is AJAX.</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 AJAX, <code>false</code> otherwise.</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/ajax_handling.rb', line 16</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_ajax_request? fid id'>ajax_request?</span>
<span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_safe_send identifier id'>safe_send</span><span class='lparen token'>(</span><span class='symbol val'>:xhr?</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_boolean identifier id'>to_boolean</span> <span class='orop op'>||</span> <span class='rubyid_params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:xhr</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="allow_cors-instance_method">
- (<tt>Object</tt>) <strong>allow_cors</strong>(allow_origin: "*", allow_methods: [:post, :get, :options], allow_headers: "*", max_age: 1.year, allow_credentials: false)
</h3><div class="docstring">
<div class="discussion">
<p>Allows HTTP Cross-Origin Resource Sharing.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>allow_origin</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The value for the <code>Access-Control-Allow-Origin</code> header.</p>
</div>
</li>
<li>
<span class='name'>allow_methods</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>A list of methods for the <code>Access-Control-Allow-Methods</code> header.</p>
</div>
</li>
<li>
<span class='name'>allow_headers</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The value for the <code>Access-Control-Allow-Headers</code> header.</p>
</div>
</li>
<li>
<span class='name'>max_age</span>
<span class='type'>(<tt>Float|Fixnum</tt>)</span>
—
<div class='inline'><p>The value for the <code>Access-Control-Max-Age</code> header.</p>
</div>
</li>
<li>
<span class='name'>allow_credentials</span>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>The value for the <code>Access-Control-Allow-Credentials</code> header.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47
48
49
50
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax_handling.rb', line 45</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_allow_cors identifier id'>allow_cors</span><span class='lparen token'>(</span><span class='label val'>allow_origin:</span> <span class='string val'>"*"</span><span class='comma token'>,</span> <span class='label val'>allow_methods:</span> <span class='lbrack token'>[</span><span class='symbol val'>:post</span><span class='comma token'>,</span> <span class='symbol val'>:get</span><span class='comma token'>,</span> <span class='symbol val'>:options</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='label val'>allow_headers:</span> <span class='string val'>"*"</span><span class='comma token'>,</span> <span class='label val'>max_age:</span> <span class='float val'>1</span><span class='dot token'>.</span><span class='rubyid_year identifier id'>year</span><span class='comma token'>,</span> <span class='label val'>allow_credentials:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
<span class='rubyid_headers identifier id'>headers</span><span class='dot token'>.</span><span class='rubyid_merge! fid id'>merge!</span><span class='lparen token'>(</span><span class='lbrace token'>{</span>
<span class='string val'>"Access-Control-Allow-Origin"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_allow_origin identifier id'>allow_origin</span><span class='comma token'>,</span>
<span class='string val'>"Access-Control-Allow-Methods"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_allow_methods identifier id'>allow_methods</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_m identifier id'>m</span><span class='bitor op'>|</span> <span class='rubyid_m identifier id'>m</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='rubyid_upcase identifier id'>upcase</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>", "</span><span class='rparen token'>)</span><span class='comma token'>,</span>
<span class='string val'>"Access-Control-Allow-Headers"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_allow_headers identifier id'>allow_headers</span><span class='comma token'>,</span>
<span class='string val'>"Access-Control-Max-Age"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='rubyid_max_age identifier id'>max_age</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span>
<span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='rubyid_headers identifier id'>headers</span><span class='lbrack token'>[</span><span class='string val'>"Access-Control-Allow-Credentials"</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>"true"</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_allow_credentials identifier id'>allow_credentials</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="generate_robots_txt-instance_method">
- (<tt>Object</tt>) <strong>generate_robots_txt</strong>(configuration = nil)
<span class="aliases">Also known as:
<span class="names"><span id='disallow_robots-instance_method'>disallow_robots</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Generates a `robots.txt file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>configuration</span>
<span class='type'>(<tt>Hash|NilClass</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>An hash of agent and list of paths to include.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61
62
63
64
65
66
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax_handling.rb', line 59</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_generate_robots_txt identifier id'>generate_robots_txt</span><span class='lparen token'>(</span><span class='rubyid_configuration identifier id'>configuration</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
<span class='rubyid_configuration identifier id'>configuration</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='string val'>"*"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"/"</span><span class='rbrace token'>}</span>
<span class='rubyid_rv identifier id'>rv</span> <span class='assign token'>=</span> <span class='rubyid_configuration identifier id'>configuration</span><span class='dot token'>.</span><span class='rubyid_reduce identifier id'>reduce</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_accu identifier id'>accu</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='rubyid_agent identifier id'>agent</span><span class='comma token'>,</span> <span class='rubyid_paths identifier id'>paths</span><span class='rparen token'>)</span><span class='bitor op'>|</span>
<span class='rubyid_paths identifier id'>paths</span> <span class='assign token'>=</span> <span class='rubyid_paths identifier id'>paths</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_e identifier id'>e</span><span class='bitor op'>|</span> <span class='dstring node'>"Disallow: #{e}"</span> <span class='rbrace token'>}</span>
<span class='rubyid_accu identifier id'>accu</span> <span class='lshft op'><<</span> <span class='dstring node'>"User-agent: #{agent}\n#{paths.join("\n")}"</span>
<span class='rubyid_accu identifier id'>accu</span>
<span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>"\n\n"</span><span class='rparen token'>)</span>
<span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='label val'>text:</span> <span class='rubyid_rv identifier id'>rv</span><span class='comma token'>,</span> <span class='label val'>content_type:</span> <span class='string val'>"text/plain"</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="prepare_ajax_response-instance_method">
- (<tt>Object</tt>) <strong>prepare_ajax_response</strong>(status: :ok, data: {}, error: nil)
</h3><div class="docstring">
<div class="discussion">
<p>Prepares 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</tt>)</span>
—
<div class='inline'><p>The data of the response.</p>
</div>
</li>
<li>
<span class='name'>error</span>
<span class='type'>(<tt>Object|NilClass</tt>)</span>
—
<div class='inline'><p>The error of the response.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax_handling.rb', line 25</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_prepare_ajax_response identifier id'>prepare_ajax_response</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='rparen token'>)</span>
<span class='rubyid_Ballast constant id'>Ballast</span><span class='colon2 op'>::</span><span class='rubyid_AjaxResponse constant id'>AjaxResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='rubyid_status identifier id'>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='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_self self kw'>self</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="prevent_caching-instance_method">
- (<tt>Object</tt>) <strong>prevent_caching</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Prevents HTTP caching.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax_handling.rb', line 30</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_prevent_caching identifier id'>prevent_caching</span>
<span class='rubyid_response identifier id'>response</span><span class='dot token'>.</span><span class='rubyid_headers identifier id'>headers</span><span class='dot token'>.</span><span class='rubyid_merge! fid id'>merge!</span><span class='lparen token'>(</span><span class='lbrace token'>{</span>
<span class='string val'>"Cache-Control"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"no-cache, no-store, max-age=0, must-revalidate"</span><span class='comma token'>,</span>
<span class='string val'>"Pragma"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"no-cache"</span><span class='comma token'>,</span>
<span class='string val'>"Expires"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"Fri, 01 Jan 1990 00:00:00 GMT"</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>
</div>
<div id="footer">
Generated on Sat Feb 7 19:34:06 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>