<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: JsonapiCompliable::Util::IncludeParams
— Documentation by YARD 0.9.9
</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">
pathId = "JsonapiCompliable::Util::IncludeParams";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (I)</a> »
<span class='title'><span class='object_link'><a href="../../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span> » <span class='title'><span class='object_link'><a href="../Util.html" title="JsonapiCompliable::Util (module)">Util</a></span></span>
»
<span class="title">IncludeParams</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: JsonapiCompliable::Util::IncludeParams
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">JsonapiCompliable::Util::IncludeParams</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/jsonapi_compliable/util/include_params.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Utility class for dealing with Include Directives</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#scrub-class_method" title="scrub (class method)">.<strong>scrub</strong>(requested_includes, allowed_includes) ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Let's say the user requested these sideloads:.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="scrub-class_method">
.<strong>scrub</strong>(requested_includes, allowed_includes) ⇒ <tt><span class='object_link'><a href="Hash.html" title="JsonapiCompliable::Util::Hash (class)">Hash</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Let's say the user requested these sideloads:</p>
<pre class="code ruby"><code class="ruby">GET /posts?include=comments.author</code></pre>
<p>But our resource had this code:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sideload_whitelist'>sideload_whitelist</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>index:</span> <span class='lbracket'>[</span><span class='symbol'>:comments</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
</code></pre>
<p>We should drop the 'author' sideload from the request.</p>
<p>Hashes become 'include directive hashes' within the library. ie</p>
<pre class="code ruby"><code class="ruby"><span class='lbracket'>[</span><span class='symbol'>:tags</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>comments:</span> <span class='symbol'>:author</span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
</code></pre>
<p>Becomes</p>
<pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span> <span class='label'>tags:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>comments:</span> <span class='lbrace'>{</span> <span class='label'>author:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>requested_includes</span>
<span class='type'>(<tt><span class='object_link'><a href="Hash.html" title="JsonapiCompliable::Util::Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'>
<p>the nested hash the user requested</p>
</div>
</li>
<li>
<span class='name'>allowed_includes</span>
<span class='type'>(<tt><span class='object_link'><a href="Hash.html" title="JsonapiCompliable::Util::Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'>
<p>the nested hash configured via DSL</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Hash.html" title="JsonapiCompliable::Util::Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'>
<p>the scrubbed hash</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/util/include_params.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_scrub'>scrub</span><span class='lparen'>(</span><span class='id identifier rubyid_requested_includes'>requested_includes</span><span class='comma'>,</span> <span class='id identifier rubyid_allowed_includes'>allowed_includes</span><span class='rparen'>)</span>
<span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_valid'>valid</span><span class='op'>|</span>
<span class='id identifier rubyid_requested_includes'>requested_includes</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_sub_hash'>sub_hash</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_allowed_includes'>allowed_includes</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_valid'>valid</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_scrub'>scrub</span><span class='lparen'>(</span><span class='id identifier rubyid_sub_hash'>sub_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_allowed_includes'>allowed_includes</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Jun 7 10:15:10 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.3.0).
</div>
</div>
</body>
</html>