<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: JsonapiCompliable::Base
— 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::Base";
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 (B)</a> »
<span class='title'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span>
»
<span class="title">Base</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>Module: JsonapiCompliable::Base
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/jsonapi_compliable/base.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Provides main interface to jsonapi_compliable</p>
<p>This gets mixed in to a “context” class, such as a Rails controller.</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="#jsonapi-class_method" title="jsonapi (class method)">.<strong>jsonapi</strong>(foo = 'bar', resource: nil, &blk) ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Define your JSONAPI configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sideload_whitelist-class_method" title="sideload_whitelist (class method)">.<strong>sideload_whitelist</strong>(hash) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set the sideload whitelist.</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="#default_jsonapi_render_options-instance_method" title="#default_jsonapi_render_options (instance method)">#<strong>default_jsonapi_render_options</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Define a hash that will be automatically merged into your render_jsonapi
call.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#deserialized_params-instance_method" title="#deserialized_params (instance method)">#<strong>deserialized_params</strong> ⇒ Deserializer </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#jsonapi_create-instance_method" title="#jsonapi_create (instance method)">#<strong>jsonapi_create</strong> ⇒ Util::ValidationResponse </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create the resource model and process all nested relationships via the
serialized parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#jsonapi_destroy-instance_method" title="#jsonapi_destroy (instance method)">#<strong>jsonapi_destroy</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#jsonapi_resource-instance_method" title="#jsonapi_resource (instance method)">#<strong>jsonapi_resource</strong> ⇒ Resource </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns an instance of the associated Resource.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#jsonapi_scope-instance_method" title="#jsonapi_scope (instance method)">#<strong>jsonapi_scope</strong>(scope, opts = {}) ⇒ Scope </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Use when direct, low-level access to the scope is required.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#jsonapi_update-instance_method" title="#jsonapi_update (instance method)">#<strong>jsonapi_update</strong> ⇒ Util::ValidationResponse </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Update the resource model and process all nested relationships via the
serialized parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#query-instance_method" title="#query (instance method)">#<strong>query</strong> ⇒ Query </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Instantiates the relevant Query object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#query_hash-instance_method" title="#query_hash (instance method)">#<strong>query_hash</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The normalized query hash for only the <strong>current</strong> resource.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#render_jsonapi-instance_method" title="#render_jsonapi (instance method)">#<strong>render_jsonapi</strong>(scope, opts = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Similar to <tt>render :json</tt> or <tt>render :jsonapi</tt>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sideload_whitelist-instance_method" title="#sideload_whitelist (instance method)">#<strong>sideload_whitelist</strong> ⇒ Object </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wrap_context-instance_method" title="#wrap_context (instance method)">#<strong>wrap_context</strong> ⇒ Object </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>Tracks the current context so we can refer to it within any random object.</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="jsonapi-class_method">
.<strong>jsonapi</strong>(foo = 'bar', resource: nil, &blk) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Define your JSONAPI configuration</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Inline Resource</p>
</div></p>
<pre class="example code"><code><span class='comment'># 'Quick and Dirty' solution that does not require a separate
</span><span class='comment'># Resource object
</span><span class='kw'>class</span> <span class='const'>PostsController</span> <span class='op'><</span> <span class='const'>ApplicationController</span>
<span class='id identifier rubyid_jsonapi'>jsonapi</span> <span class='kw'>do</span>
<span class='id identifier rubyid_type'>type</span> <span class='symbol'>:posts</span>
<span class='id identifier rubyid_use_adapter'>use_adapter</span> <span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Adapters.html" title="JsonapiCompliable::Adapters (module)">Adapters</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Adapters/ActiveRecord.html" title="JsonapiCompliable::Adapters::ActiveRecord (class)">ActiveRecord</a></span></span>
<span class='id identifier rubyid_allow_filter'>allow_filter</span> <span class='symbol'>:title</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
<p class="example_title"><div class='inline'>
<p>Resource Class (preferred)</p>
</div></p>
<pre class="example code"><code><span class='comment'># Make code reusable by encapsulating it in a Resource class
</span><span class='kw'>class</span> <span class='const'>PostsController</span> <span class='op'><</span> <span class='const'>ApplicationController</span>
<span class='id identifier rubyid_jsonapi'>jsonapi</span> <span class='label'>resource:</span> <span class='const'>PostResource</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>resource</span>
<span class='type'>(<tt><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></tt>)</span>
—
<div class='inline'>
<p>the Resource class associated to this endpoint</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47
48
49
50
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi'>jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_foo'>foo</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bar</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_resource'>resource</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span>
<span class='kw'>else</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span> <span class='op'>=</span> <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="sideload_whitelist-class_method">
.<strong>sideload_whitelist</strong>(hash) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set the sideload whitelist. You may want to omit sideloads for security or
performance reasons.</p>
<p>Uses JSONAPI::IncludeDirective from <a href="{http://jsonapi-rb.org" target="_parent" title="jsonapi-rb">jsonapi-rb</a>}</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Whitelisting Relationships</p>
</div></p>
<pre class="example code"><code><span class='comment'># Given the following whitelist
</span><span class='kw'>class</span> <span class='const'>PostsController</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='id identifier rubyid_jsonapi'>jsonapi</span> <span class='label'>resource:</span> <span class='const'>MyResource</span>
<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'>:blog</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>show:</span> <span class='lbracket'>[</span><span class='symbol'>:blog</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>
<span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='comment'># ... code ...
</span><span class='kw'>end</span>
<span class='comment'># A request to sideload 'tags'
</span><span class='comment'>#
</span><span class='comment'># GET /posts/1?include=tags
</span><span class='comment'>#
</span><span class='comment'># ...will silently fail.
</span><span class='comment'>#
</span><span class='comment'># A request for comments and tags:
</span><span class='comment'>#
</span><span class='comment'># GET /posts/1?include=tags,comments
</span><span class='comment'>#
</span><span class='comment'># ...will only sideload comments</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>whitelist</span>
<span class='type'>(<tt>Hash</tt>, <tt>Array</tt>, <tt>Symbol</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Query.html#include_hash-instance_method" title="JsonapiCompliable::Query#include_hash (method)">Query#include_hash</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_sideload_whitelist'>sideload_whitelist</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__sideload_whitelist'>_sideload_whitelist</span> <span class='op'>=</span> <span class='const'>JSONAPI</span><span class='op'>::</span><span class='const'>IncludeDirective</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
<span class='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="default_jsonapi_render_options-instance_method">
#<strong>default_jsonapi_render_options</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Define a hash that will be automatically merged into your render_jsonapi
call</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code># this
render_jsonapi(foo)
# is equivalent to this
render jsonapi: foo, default_jsonapi_render_options</code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>the options hash you define</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#render_jsonapi-instance_method" title="JsonapiCompliable::Base#render_jsonapi (method)">#render_jsonapi</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
286
287
288
289</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 286</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_jsonapi_render_options'>default_jsonapi_render_options</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_options'>options</span><span class='op'>|</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="deserialized_params-instance_method">
#<strong>deserialized_params</strong> ⇒ <tt><span class='object_link'><a href="Deserializer.html" title="JsonapiCompliable::Deserializer (class)">Deserializer</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Deserializer.html" title="JsonapiCompliable::Deserializer (class)">Deserializer</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Deserializer.html#initialize-instance_method" title="JsonapiCompliable::Deserializer#initialize (method)">Deserializer#initialize</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
161
162
163</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 161</span>
<span class='kw'>def</span> <span class='id identifier rubyid_deserialized_params'>deserialized_params</span>
<span class='ivar'>@deserialized_params</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Deserializer.html" title="JsonapiCompliable::Deserializer (class)">Deserializer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Deserializer.html#initialize-instance_method" title="JsonapiCompliable::Deserializer#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="jsonapi_create-instance_method">
#<strong>jsonapi_create</strong> ⇒ <tt><span class='object_link'><a href="Util/ValidationResponse.html" title="JsonapiCompliable::Util::ValidationResponse (class)">Util::ValidationResponse</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create the resource model and process all nested relationships via the
serialized parameters. Any error, including validation errors, will roll
back the transaction.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Basic Rails</p>
</div></p>
<pre class="example code"><code><span class='comment'># Example Resource must have 'model'
</span><span class='comment'>#
</span><span class='comment'># class PostResource < ApplicationResource
</span><span class='comment'># model Post
</span><span class='comment'># end
</span><span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
<span class='id identifier rubyid_post'>post</span><span class='comma'>,</span> <span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_create'>jsonapi_create</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span>
<span class='kw'>if</span> <span class='id identifier rubyid_success'>success</span>
<span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_post'>post</span><span class='comma'>,</span> <span class='label'>scope:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_render_errors_for'>render_errors_for</span><span class='lparen'>(</span><span class='id identifier rubyid_post'>post</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Util/ValidationResponse.html" title="JsonapiCompliable::Util::ValidationResponse (class)">Util::ValidationResponse</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Resource.html#model-class_method" title="JsonapiCompliable::Resource.model (method)">Resource.model</a></span></li>
<li>#resource</li>
<li><span class='object_link'><a href="#deserialized_params-instance_method" title="JsonapiCompliable::Base#deserialized_params (method)">#deserialized_params</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
189
190
191
192
193
194
195
196</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 189</span>
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_create'>jsonapi_create</span>
<span class='id identifier rubyid__persist'>_persist</span> <span class='kw'>do</span>
<span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_persist_with_relationships'>persist_with_relationships</span> \
<span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_meta'>meta</span><span class='comma'>,</span>
<span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span>
<span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_relationships'>relationships</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="jsonapi_destroy-instance_method">
#<strong>jsonapi_destroy</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
229
230
231
232
233</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 229</span>
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_destroy'>jsonapi_destroy</span>
<span class='id identifier rubyid__persist'>_persist</span> <span class='kw'>do</span>
<span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</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="jsonapi_resource-instance_method">
#<strong>jsonapi_resource</strong> ⇒ <tt><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an instance of the associated Resource</p>
<p>In other words, if you configured your controller as:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_jsonapi'>jsonapi</span> <span class='label'>resource:</span> <span class='const'>MyResource</span>
</code></pre>
<p>This returns MyResource.new</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></tt>)</span>
—
<div class='inline'>
<p>the configured Resource for this controller</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
108
109
110</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 108</span>
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span>
<span class='ivar'>@jsonapi_resource</span> <span class='op'>||=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="jsonapi_scope-instance_method">
#<strong>jsonapi_scope</strong>(scope, opts = {}) ⇒ <tt><span class='object_link'><a href="Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Use when direct, low-level access to the scope is required.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Show Action</p>
</div></p>
<pre class="example code"><code><span class='comment'># Scope#resolve returns an array, but we only want to render
</span><span class='comment'># one object, not an array
</span><span class='id identifier rubyid_scope'>scope</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_scope'>jsonapi_scope</span><span class='lparen'>(</span><span class='const'>Employee</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='label'>scope:</span> <span class='kw'>false</span><span class='rparen'>)</span></code></pre>
<p class="example_title"><div class='inline'>
<p>Scope Chaining</p>
</div></p>
<pre class="example code"><code><span class='comment'># Chain onto scope after running through typical DSL
</span><span class='comment'># Here, we'll add active: true to our hash if the user
</span><span class='comment'># is filtering on something
</span><span class='id identifier rubyid_scope'>scope</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_scope'>jsonapi_scope</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>active:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span><span class='lbracket'>[</span><span class='symbol'>:filter</span><span class='rbracket'>]</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span></tt>)</span>
—
<div class='inline'>
<p>the configured scope</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Resource.html#build_scope-instance_method" title="JsonapiCompliable::Resource#build_scope (method)">Resource#build_scope</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
155
156
157</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 155</span>
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_scope'>jsonapi_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_build_scope'>build_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="jsonapi_update-instance_method">
#<strong>jsonapi_update</strong> ⇒ <tt><span class='object_link'><a href="Util/ValidationResponse.html" title="JsonapiCompliable::Util::ValidationResponse (class)">Util::ValidationResponse</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Update the resource model and process all nested relationships via the
serialized parameters. Any error, including validation errors, will roll
back the transaction.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Basic Rails</p>
</div></p>
<pre class="example code"><code><span class='comment'># Example Resource must have 'model'
</span><span class='comment'>#
</span><span class='comment'># class PostResource < ApplicationResource
</span><span class='comment'># model Post
</span><span class='comment'># end
</span><span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span>
<span class='id identifier rubyid_post'>post</span><span class='comma'>,</span> <span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_update'>jsonapi_update</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span>
<span class='kw'>if</span> <span class='id identifier rubyid_success'>success</span>
<span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_post'>post</span><span class='comma'>,</span> <span class='label'>scope:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_render_errors_for'>render_errors_for</span><span class='lparen'>(</span><span class='id identifier rubyid_post'>post</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Util/ValidationResponse.html" title="JsonapiCompliable::Util::ValidationResponse (class)">Util::ValidationResponse</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#jsonapi_create-instance_method" title="JsonapiCompliable::Base#jsonapi_create (method)">#jsonapi_create</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
220
221
222
223
224
225
226
227</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 220</span>
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_update'>jsonapi_update</span>
<span class='id identifier rubyid__persist'>_persist</span> <span class='kw'>do</span>
<span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_persist_with_relationships'>persist_with_relationships</span> \
<span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_meta'>meta</span><span class='comma'>,</span>
<span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span>
<span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_relationships'>relationships</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="query-instance_method">
#<strong>query</strong> ⇒ <tt><span class='object_link'><a href="Query.html" title="JsonapiCompliable::Query (class)">Query</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Instantiates the relevant Query object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Query.html" title="JsonapiCompliable::Query (class)">Query</a></span></tt>)</span>
—
<div class='inline'>
<p>the Query object for this resource/params</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Query.html" title="JsonapiCompliable::Query (class)">Query</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
116
117
118</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 116</span>
<span class='kw'>def</span> <span class='id identifier rubyid_query'>query</span>
<span class='ivar'>@query</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Query.html" title="JsonapiCompliable::Query (class)">Query</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Query.html#initialize-instance_method" title="JsonapiCompliable::Query#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="query_hash-instance_method">
#<strong>query_hash</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the normalized query hash for only the <strong>current</strong>
resource</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>the normalized query hash for only the <strong>current</strong> resource</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Query.html#to_hash-instance_method" title="JsonapiCompliable::Query#to_hash (method)">Query#to_hash</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
122
123
124</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 122</span>
<span class='kw'>def</span> <span class='id identifier rubyid_query_hash'>query_hash</span>
<span class='ivar'>@query_hash</span> <span class='op'>||=</span> <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="render_jsonapi-instance_method">
#<strong>render_jsonapi</strong>(scope, opts = {}) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Similar to <tt>render :json</tt> or <tt>render :jsonapi</tt></p>
<p>By default, this will “build” the scope via <code>#jsonapi_scope</code>. To
avoid this, pass <tt>scope: false</tt></p>
<p>This builds relevant options and sends them to
<tt>JSONAPI::Serializable::SuccessRenderer#render</tt>from <a href="http://jsonapi-rb.org" target="_parent" title="jsonapi-rb">jsonapi-rb</a></p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Build Scope by Default</p>
</div></p>
<pre class="example code"><code><span class='comment'># Employee.all returns an ActiveRecord::Relation. No SQL is fired at this point.
</span><span class='comment'># We further 'chain' onto this scope, applying pagination, sorting,
</span><span class='comment'># filters, etc that the user has requested.
</span><span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span>
<span class='id identifier rubyid_employees'>employees</span> <span class='op'>=</span> <span class='const'>Employee</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
<span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_employees'>employees</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
<p class="example_title"><div class='inline'>
<p>Avoid Building Scope by Default</p>
</div></p>
<pre class="example code"><code><span class='comment'># Maybe we already manually scoped, and don't want to fire the logic twice
</span><span class='comment'># This code is equivalent to the above example
</span><span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span>
<span class='id identifier rubyid_scope'>scope</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_scope'>jsonapi_scope</span><span class='lparen'>(</span><span class='const'>Employee</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='rparen'>)</span>
<span class='comment'># ... do other things with the scope ...
</span> <span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span><span class='comma'>,</span> <span class='label'>scope:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'>(<tt><span class='object_link'><a href="Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span></tt>, <tt>Object</tt>)</span>
—
<div class='inline'>
<p>the scope to build or render.</p>
</div>
</li>
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>the render options passed to <a href="http://jsonapi-rb.org" target="_parent" title="jsonapi-rb">jsonapi-rb</a></p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
<ul class="option">
<li>
<span class="name">:scope</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>Default: true. Should we call #jsonapi_scope on this object?</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#jsonapi_scope-instance_method" title="JsonapiCompliable::Base#jsonapi_scope (method)">#jsonapi_scope</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
266
267
268
269
270
271
272
273</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 266</span>
<span class='kw'>def</span> <span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_scope'>jsonapi_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:scope</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>false</span> <span class='op'>||</span> <span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='id identifier rubyid_default_jsonapi_render_options'>default_jsonapi_render_options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Util.html" title="JsonapiCompliable::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/RenderOptions.html" title="JsonapiCompliable::Util::RenderOptions (class)">RenderOptions</a></span></span><span class='period'>.</span><span class='id identifier rubyid_generate'><span class='object_link'><a href="Util/RenderOptions.html#generate-class_method" title="JsonapiCompliable::Util::RenderOptions.generate (method)">generate</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_query_hash'>query_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:expose</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_deserialized_params'>deserialized_params</span><span class='period'>.</span><span class='id identifier rubyid_include_directive'>include_directive</span> <span class='kw'>if</span> <span class='id identifier rubyid_force_includes?'>force_includes?</span>
<span class='id identifier rubyid_perform_render_jsonapi'>perform_render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="sideload_whitelist-instance_method">
#<strong>sideload_whitelist</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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
87
88
89
90
91
92</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 21</span>
<span class='kw'>module</span> <span class='const'>ClassMethods</span>
<span class='comment'># Define your JSONAPI configuration
</span> <span class='comment'>#
</span> <span class='comment'># @example Inline Resource
</span> <span class='comment'># # 'Quick and Dirty' solution that does not require a separate
</span> <span class='comment'># # Resource object
</span> <span class='comment'># class PostsController < ApplicationController
</span> <span class='comment'># jsonapi do
</span> <span class='comment'># type :posts
</span> <span class='comment'># use_adapter JsonapiCompliable::Adapters::ActiveRecord
</span> <span class='comment'>#
</span> <span class='comment'># allow_filter :title
</span> <span class='comment'># end
</span> <span class='comment'># end
</span> <span class='comment'>#
</span> <span class='comment'># @example Resource Class (preferred)
</span> <span class='comment'># # Make code reusable by encapsulating it in a Resource class
</span> <span class='comment'># class PostsController < ApplicationController
</span> <span class='comment'># jsonapi resource: PostResource
</span> <span class='comment'># end
</span> <span class='comment'>#
</span> <span class='comment'># @see Resource
</span> <span class='comment'># @param resource [Resource] the Resource class associated to this endpoint
</span> <span class='comment'># @return [void]
</span> <span class='kw'>def</span> <span class='id identifier rubyid_jsonapi'>jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_foo'>foo</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bar</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_resource'>resource</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span>
<span class='kw'>else</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span> <span class='op'>=</span> <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__jsonapi_compliable'>_jsonapi_compliable</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>end</span>
<span class='comment'># Set the sideload whitelist. You may want to omit sideloads for
</span> <span class='comment'># security or performance reasons.
</span> <span class='comment'>#
</span> <span class='comment'># Uses JSONAPI::IncludeDirective from {{http://jsonapi-rb.org jsonapi-rb}}
</span> <span class='comment'>#
</span> <span class='comment'># @example Whitelisting Relationships
</span> <span class='comment'># # Given the following whitelist
</span> <span class='comment'># class PostsController < ApplicationResource
</span> <span class='comment'># jsonapi resource: MyResource
</span> <span class='comment'>#
</span> <span class='comment'># sideload_whitelist({
</span> <span class='comment'># index: [:blog],
</span> <span class='comment'># show: [:blog, { comments: :author }]
</span> <span class='comment'># })
</span> <span class='comment'>#
</span> <span class='comment'># # ... code ...
</span> <span class='comment'># end
</span> <span class='comment'>#
</span> <span class='comment'># # A request to sideload 'tags'
</span> <span class='comment'># #
</span> <span class='comment'># # GET /posts/1?include=tags
</span> <span class='comment'># #
</span> <span class='comment'># # ...will silently fail.
</span> <span class='comment'># #
</span> <span class='comment'># # A request for comments and tags:
</span> <span class='comment'># #
</span> <span class='comment'># # GET /posts/1?include=tags,comments
</span> <span class='comment'># #
</span> <span class='comment'># # ...will only sideload comments
</span> <span class='comment'>#
</span> <span class='comment'># @param [Hash, Array, Symbol] whitelist
</span> <span class='comment'># @see Query#include_hash
</span> <span class='kw'>def</span> <span class='id identifier rubyid_sideload_whitelist'>sideload_whitelist</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__sideload_whitelist'>_sideload_whitelist</span> <span class='op'>=</span> <span class='const'>JSONAPI</span><span class='op'>::</span><span class='const'>IncludeDirective</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="wrap_context-instance_method">
#<strong>wrap_context</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Tracks the current context so we can refer to it within any random object.
Helpful for easy-access to things like the current user.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
<li>
<span class='type'></span>
<div class='inline'>
<p>Code to run within the current context</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
132
133
134
135
136</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 132</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wrap_context'>wrap_context</span>
<span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_with_context'>with_context</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_action_name'>action_name</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='kw'>yield</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon May 7 09:24:11 2018 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>