<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: JsonapiCompliable::Deserializer
— 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::Deserializer";
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 (D)</a> »
<span class='title'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span>
»
<span class="title">Deserializer</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::Deserializer
</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::Deserializer</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/jsonapi_compliable/deserializer.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Responsible for parsing incoming write payloads</p>
<p>Given a PUT payload like:</p>
<pre class="code ruby"><code class="ruby">{
data: {
id: '1',
type: 'posts',
attributes: { title: 'My Title' },
relationships: {
author: {
data: {
id: '1',
type: 'authors'
}
}
}
},
included: [
{
id: '1'
type: 'authors',
attributes: { name: 'Joe Author' }
}
]
}</code></pre>
<p>You can now easily deal with this payload:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_deserializer'>deserializer</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span>
<span class='comment'># => { id: '1', title: 'My Title' }
</span><span class='id identifier rubyid_deserializer'>deserializer</span><span class='period'>.</span><span class='id identifier rubyid_meta'>meta</span>
<span class='comment'># => { type: 'posts', method: :update }
</span><span class='id identifier rubyid_deserializer'>deserializer</span><span class='period'>.</span><span class='id identifier rubyid_relationships'>relationships</span>
<span class='comment'># {
</span><span class='comment'># author: {
</span><span class='comment'># meta: { ... },
</span><span class='comment'># attributes: { ... },
</span><span class='comment'># relationships: { ... }
</span><span class='comment'># }
</span><span class='comment'># }
</span></code></pre>
<p>When creating objects, we accept a <code>temp-id</code> so that the client
can track the object it just created. Expect this in <code>meta</code>:</p>
<pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>authors</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>method:</span> <span class='symbol'>:create</span><span class='comma'>,</span> <span class='label'>temp_id:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>abc123</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
</code></pre>
</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="#attributes-instance_method" title="#attributes (instance method)">#<strong>attributes</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The raw :attributes hash + <code>id</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#attributes=-instance_method" title="#attributes= (instance method)">#<strong>attributes=</strong>(attrs) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Override the attributes # @see #attributes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The raw :data value of the payload.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The raw :id value of the payload.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#include_directive-instance_method" title="#include_directive (instance method)">#<strong>include_directive</strong>(memo = {}, relationship_node = nil) ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Parses the <code>relationships</code> recursively and builds an all-hash
include directive like.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(payload, env) ⇒ Deserializer </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Deserializer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#meta-instance_method" title="#meta (instance method)">#<strong>meta</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>'meta' information about this resource.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#relationships-instance_method" title="#relationships (instance method)">#<strong>relationships</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The relationships hash.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(payload, env) ⇒ <tt><span class='object_link'><a href="" title="JsonapiCompliable::Deserializer (class)">Deserializer</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Deserializer</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>payload</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>The incoming payload with symbolized keys</p>
</div>
</li>
<li>
<span class='name'>env</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>the Rack env (e.g. <code>request.env</code>).</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
<span class='ivar'>@payload</span> <span class='op'>=</span> <span class='id identifier rubyid_payload'>payload</span>
<span class='ivar'>@env</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</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="attributes-instance_method">
#<strong>attributes</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the raw :attributes hash + <code>id</code></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 raw :attributes hash + <code>id</code></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attributes'>attributes</span>
<span class='ivar'>@attributes</span> <span class='op'>||=</span> <span class='id identifier rubyid_raw_attributes'>raw_attributes</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_hash'>hash</span><span class='op'>|</span>
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="attributes=-instance_method">
#<strong>attributes=</strong>(attrs) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Override the attributes # @see #attributes</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 74</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attributes='>attributes=</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span>
<span class='ivar'>@attributes</span> <span class='op'>=</span> <span class='id identifier rubyid_attrs'>attrs</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="data-instance_method">
#<strong>data</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the raw :data value of the payload</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 raw :data value of the payload</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
<span class='ivar'>@payload</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the raw :id value of the payload</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>the raw :id value of the payload</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="include_directive-instance_method">
#<strong>include_directive</strong>(memo = {}, relationship_node = nil) ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Parses the <code>relationships</code> recursively and builds an all-hash
include directive like</p>
<pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span> <span class='label'>posts:</span> <span class='lbrace'>{</span> <span class='label'>comments:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
</code></pre>
<p>Relationships that have been marked for destruction will NOT be part of the
include directive.</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 include directive</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
107
108
109
110
111
112
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 107</span>
<span class='kw'>def</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='lparen'>(</span><span class='id identifier rubyid_memo'>memo</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_relationship_node'>relationship_node</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_relationship_node'>relationship_node</span> <span class='op'>||=</span> <span class='id identifier rubyid_relationships'>relationships</span>
<span class='id identifier rubyid_relationship_node'>relationship_node</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_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_relationship_payload'>relationship_payload</span><span class='op'>|</span>
<span class='id identifier rubyid_merge_include_directive'>merge_include_directive</span><span class='lparen'>(</span><span class='id identifier rubyid_memo'>memo</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_relationship_payload'>relationship_payload</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_memo'>memo</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="meta-instance_method">
#<strong>meta</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>'meta' information about this resource. Includes:</p>
<p><code>type</code>: the jsonapi type <code>method</code>:
create/update/destroy/disassociate. Based on the request env or the
<code>method</code> within the <code>relationships</code> hash
<code>temp_id</code>: the <code>temp-id</code>, if specified</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
85
86
87
88
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 85</span>
<span class='kw'>def</span> <span class='id identifier rubyid_meta'>meta</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>temp_id:</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:temp-id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>method:</span> <span class='id identifier rubyid_method'>method</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="relationships-instance_method">
#<strong>relationships</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the relationships hash</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 relationships hash</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/deserializer.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_relationships'>relationships</span>
<span class='ivar'>@relationships</span> <span class='op'>||=</span> <span class='id identifier rubyid_process_relationships'>process_relationships</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_relationships'>raw_relationships</span><span class='rparen'>)</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>