jsonapi_compliable 0.11.4 → 0.11.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/docs/Jsonapi.html +1 -1
  3. data/docs/Jsonapi/ResourceGenerator.html +32 -22
  4. data/docs/JsonapiCompliable.html +174 -19
  5. data/docs/JsonapiCompliable/Adapters.html +1 -1
  6. data/docs/JsonapiCompliable/Adapters/Abstract.html +1 -1
  7. data/docs/JsonapiCompliable/Adapters/ActiveRecord.html +41 -31
  8. data/docs/JsonapiCompliable/Adapters/ActiveRecordSideloading.html +47 -39
  9. data/docs/JsonapiCompliable/Adapters/Null.html +1 -1
  10. data/docs/JsonapiCompliable/Base.html +70 -14
  11. data/docs/JsonapiCompliable/Configuration.html +308 -0
  12. data/docs/JsonapiCompliable/Deserializer.html +1 -1
  13. data/docs/JsonapiCompliable/Errors.html +2 -2
  14. data/docs/JsonapiCompliable/Errors/BadFilter.html +1 -1
  15. data/docs/JsonapiCompliable/Errors/InvalidInclude.html +266 -0
  16. data/docs/JsonapiCompliable/Errors/RecordNotFound.html +124 -0
  17. data/docs/JsonapiCompliable/Errors/StatNotFound.html +10 -10
  18. data/docs/JsonapiCompliable/Errors/UnsupportedPageSize.html +1 -1
  19. data/docs/JsonapiCompliable/Errors/ValidationError.html +1 -1
  20. data/docs/JsonapiCompliable/Extensions.html +1 -1
  21. data/docs/JsonapiCompliable/Extensions/BooleanAttribute.html +1 -1
  22. data/docs/JsonapiCompliable/Extensions/BooleanAttribute/ClassMethods.html +1 -1
  23. data/docs/JsonapiCompliable/Extensions/ExtraAttribute.html +1 -1
  24. data/docs/JsonapiCompliable/Extensions/ExtraAttribute/ClassMethods.html +1 -1
  25. data/docs/JsonapiCompliable/Query.html +1 -1
  26. data/docs/JsonapiCompliable/Rails.html +1 -1
  27. data/docs/JsonapiCompliable/Resource.html +3 -3
  28. data/docs/JsonapiCompliable/Scope.html +171 -17
  29. data/docs/JsonapiCompliable/Scoping.html +1 -1
  30. data/docs/JsonapiCompliable/Scoping/Base.html +1 -1
  31. data/docs/JsonapiCompliable/Scoping/DefaultFilter.html +2 -2
  32. data/docs/JsonapiCompliable/Scoping/ExtraFields.html +2 -2
  33. data/docs/JsonapiCompliable/Scoping/Filter.html +1 -1
  34. data/docs/JsonapiCompliable/Scoping/Filterable.html +1 -1
  35. data/docs/JsonapiCompliable/Scoping/Paginate.html +2 -2
  36. data/docs/JsonapiCompliable/Scoping/Sort.html +5 -3
  37. data/docs/JsonapiCompliable/SerializableTempId.html +1 -1
  38. data/docs/JsonapiCompliable/Sideload.html +1 -1
  39. data/docs/JsonapiCompliable/Stats.html +1 -1
  40. data/docs/JsonapiCompliable/Stats/DSL.html +1 -1
  41. data/docs/JsonapiCompliable/Stats/Payload.html +1 -1
  42. data/docs/JsonapiCompliable/Util.html +1 -1
  43. data/docs/JsonapiCompliable/Util/FieldParams.html +1 -1
  44. data/docs/JsonapiCompliable/Util/Hash.html +1 -1
  45. data/docs/JsonapiCompliable/Util/IncludeParams.html +1 -1
  46. data/docs/JsonapiCompliable/Util/Persistence.html +1 -1
  47. data/docs/JsonapiCompliable/Util/RelationshipPayload.html +1 -1
  48. data/docs/JsonapiCompliable/Util/RenderOptions.html +16 -2
  49. data/docs/JsonapiCompliable/Util/Sideload.html +1 -1
  50. data/docs/JsonapiCompliable/Util/ValidationResponse.html +1 -1
  51. data/docs/_index.html +28 -7
  52. data/docs/class_list.html +1 -1
  53. data/docs/file.README.html +41 -1
  54. data/docs/index.html +41 -1
  55. data/docs/method_list.html +281 -209
  56. data/docs/top-level-namespace.html +1 -1
  57. data/lib/jsonapi_compliable/scope.rb +2 -0
  58. data/lib/jsonapi_compliable/version.rb +1 -1
  59. metadata +5 -2
data/docs/JsonapiCompliable/Deserializer.html CHANGED
@@ -892,7 +892,7 @@ create/update/destroy/disassociate. Based on the request env or the
892
892
  </div>
893
893
 
894
894
  <div id="footer">
895
- Generated on Tue Oct 3 14:55:07 2017 by
895
+ Generated on Thu May 3 15:52:18 2018 by
896
896
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
897
897
  0.9.9 (ruby-2.3.0).
898
898
  </div>
data/docs/JsonapiCompliable/Errors.html CHANGED
@@ -89,7 +89,7 @@
89
89
 
90
90
 
91
91
 
92
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="Errors/BadFilter.html" title="JsonapiCompliable::Errors::BadFilter (class)">BadFilter</a></span>, <span class='object_link'><a href="Errors/StatNotFound.html" title="JsonapiCompliable::Errors::StatNotFound (class)">StatNotFound</a></span>, <span class='object_link'><a href="Errors/UnsupportedPageSize.html" title="JsonapiCompliable::Errors::UnsupportedPageSize (class)">UnsupportedPageSize</a></span>, <span class='object_link'><a href="Errors/ValidationError.html" title="JsonapiCompliable::Errors::ValidationError (class)">ValidationError</a></span>
92
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Errors/BadFilter.html" title="JsonapiCompliable::Errors::BadFilter (class)">BadFilter</a></span>, <span class='object_link'><a href="Errors/InvalidInclude.html" title="JsonapiCompliable::Errors::InvalidInclude (class)">InvalidInclude</a></span>, <span class='object_link'><a href="Errors/RecordNotFound.html" title="JsonapiCompliable::Errors::RecordNotFound (class)">RecordNotFound</a></span>, <span class='object_link'><a href="Errors/StatNotFound.html" title="JsonapiCompliable::Errors::StatNotFound (class)">StatNotFound</a></span>, <span class='object_link'><a href="Errors/UnsupportedPageSize.html" title="JsonapiCompliable::Errors::UnsupportedPageSize (class)">UnsupportedPageSize</a></span>, <span class='object_link'><a href="Errors/ValidationError.html" title="JsonapiCompliable::Errors::ValidationError (class)">ValidationError</a></span>
93
93
 
94
94
 
95
95
  </p>
@@ -105,7 +105,7 @@
105
105
  </div>
106
106
 
107
107
  <div id="footer">
108
- Generated on Tue Oct 3 14:55:06 2017 by
108
+ Generated on Thu May 3 15:52:17 2018 by
109
109
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
110
110
  0.9.9 (ruby-2.3.0).
111
111
  </div>
data/docs/JsonapiCompliable/Errors/BadFilter.html CHANGED
@@ -114,7 +114,7 @@
114
114
  </div>
115
115
 
116
116
  <div id="footer">
117
- Generated on Tue Oct 3 14:55:07 2017 by
117
+ Generated on Thu May 3 15:52:17 2018 by
118
118
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
119
  0.9.9 (ruby-2.3.0).
120
120
  </div>
data/docs/JsonapiCompliable/Errors/InvalidInclude.html ADDED
@@ -0,0 +1,266 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: JsonapiCompliable::Errors::InvalidInclude
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "JsonapiCompliable::Errors::InvalidInclude";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (I)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="JsonapiCompliable::Errors (module)">Errors</a></span></span>
41
+ &raquo;
42
+ <span class="title">InvalidInclude</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Exception: JsonapiCompliable::Errors::InvalidInclude
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">StandardError</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next">JsonapiCompliable::Errors::InvalidInclude</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/jsonapi_compliable/errors.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h2>
113
+ Instance Method Summary
114
+ <small><a href="#" class="summary_toggle">collapse</a></small>
115
+ </h2>
116
+
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(relationship, parent_resource) &#x21d2; InvalidInclude </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+ <span class="note title constructor">constructor</span>
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <span class="summary_desc"><div class='inline'>
139
+ <p>A new instance of InvalidInclude.</p>
140
+ </div></span>
141
+
142
+ </li>
143
+
144
+
145
+ <li class="public ">
146
+ <span class="summary_signature">
147
+
148
+ <a href="#message-instance_method" title="#message (instance method)">#<strong>message</strong> &#x21d2; Object </a>
149
+
150
+
151
+
152
+ </span>
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <span class="summary_desc"><div class='inline'></div></span>
163
+
164
+ </li>
165
+
166
+
167
+ </ul>
168
+
169
+
170
+
171
+ <div id="constructor_details" class="method_details_list">
172
+ <h2>Constructor Details</h2>
173
+
174
+ <div class="method_details first">
175
+ <h3 class="signature first" id="initialize-instance_method">
176
+
177
+ #<strong>initialize</strong>(relationship, parent_resource) &#x21d2; <tt><span class='object_link'><a href="" title="JsonapiCompliable::Errors::InvalidInclude (class)">InvalidInclude</a></span></tt>
178
+
179
+
180
+
181
+
182
+
183
+ </h3><div class="docstring">
184
+ <div class="discussion">
185
+
186
+ <p>Returns a new instance of InvalidInclude</p>
187
+
188
+
189
+ </div>
190
+ </div>
191
+ <div class="tags">
192
+
193
+
194
+ </div><table class="source_code">
195
+ <tr>
196
+ <td>
197
+ <pre class="lines">
198
+
199
+
200
+ 17
201
+ 18
202
+ 19
203
+ 20</pre>
204
+ </td>
205
+ <td>
206
+ <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/errors.rb', line 17</span>
207
+
208
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_relationship'>relationship</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_resource'>parent_resource</span><span class='rparen'>)</span>
209
+ <span class='ivar'>@relationship</span> <span class='op'>=</span> <span class='id identifier rubyid_relationship'>relationship</span>
210
+ <span class='ivar'>@parent_resource</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_resource'>parent_resource</span>
211
+ <span class='kw'>end</span></pre>
212
+ </td>
213
+ </tr>
214
+ </table>
215
+ </div>
216
+
217
+ </div>
218
+
219
+
220
+ <div id="instance_method_details" class="method_details_list">
221
+ <h2>Instance Method Details</h2>
222
+
223
+
224
+ <div class="method_details first">
225
+ <h3 class="signature first" id="message-instance_method">
226
+
227
+ #<strong>message</strong> &#x21d2; <tt>Object</tt>
228
+
229
+
230
+
231
+
232
+
233
+ </h3><table class="source_code">
234
+ <tr>
235
+ <td>
236
+ <pre class="lines">
237
+
238
+
239
+ 22
240
+ 23
241
+ 24</pre>
242
+ </td>
243
+ <td>
244
+ <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/errors.rb', line 22</span>
245
+
246
+ <span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
247
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The requested included relationship \&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@relationship</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; is not supported on resource \&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@parent_resource</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>
248
+ <span class='kw'>end</span></pre>
249
+ </td>
250
+ </tr>
251
+ </table>
252
+ </div>
253
+
254
+ </div>
255
+
256
+ </div>
257
+
258
+ <div id="footer">
259
+ Generated on Thu May 3 15:52:17 2018 by
260
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
261
+ 0.9.9 (ruby-2.3.0).
262
+ </div>
263
+
264
+ </div>
265
+ </body>
266
+ </html>
data/docs/JsonapiCompliable/Errors/RecordNotFound.html ADDED
@@ -0,0 +1,124 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: JsonapiCompliable::Errors::RecordNotFound
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "JsonapiCompliable::Errors::RecordNotFound";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="JsonapiCompliable::Errors (module)">Errors</a></span></span>
41
+ &raquo;
42
+ <span class="title">RecordNotFound</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Exception: JsonapiCompliable::Errors::RecordNotFound
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">StandardError</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next">JsonapiCompliable::Errors::RecordNotFound</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/jsonapi_compliable/errors.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ </div>
115
+
116
+ <div id="footer">
117
+ Generated on Thu May 3 15:52:18 2018 by
118
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
+ 0.9.9 (ruby-2.3.0).
120
+ </div>
121
+
122
+ </div>
123
+ </body>
124
+ </html>
data/docs/JsonapiCompliable/Errors/StatNotFound.html CHANGED
@@ -197,13 +197,13 @@
197
197
  <pre class="lines">
198
198
 
199
199
 
200
- 17
201
- 18
202
- 19
203
- 20</pre>
200
+ 28
201
+ 29
202
+ 30
203
+ 31</pre>
204
204
  </td>
205
205
  <td>
206
- <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/errors.rb', line 17</span>
206
+ <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/errors.rb', line 28</span>
207
207
 
208
208
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_calculation'>calculation</span><span class='rparen'>)</span>
209
209
  <span class='ivar'>@attribute</span> <span class='op'>=</span> <span class='id identifier rubyid_attribute'>attribute</span>
@@ -236,12 +236,12 @@
236
236
  <pre class="lines">
237
237
 
238
238
 
239
- 22
240
- 23
241
- 24</pre>
239
+ 33
240
+ 34
241
+ 35</pre>
242
242
  </td>
243
243
  <td>
244
- <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/errors.rb', line 22</span>
244
+ <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/errors.rb', line 33</span>
245
245
 
246
246
  <span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
247
247
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>No stat configured for calculation </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_pretty'>pretty</span><span class='lparen'>(</span><span class='ivar'>@calculation</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> on attribute </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_pretty'>pretty</span><span class='lparen'>(</span><span class='ivar'>@attribute</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -256,7 +256,7 @@
256
256
  </div>
257
257
 
258
258
  <div id="footer">
259
- Generated on Tue Oct 3 14:55:07 2017 by
259
+ Generated on Thu May 3 15:52:18 2018 by
260
260
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
261
261
  0.9.9 (ruby-2.3.0).
262
262
  </div>