helium-ruby 0.20.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +47 -0
- data/docs/Helium.html +6 -6
- data/docs/Helium/Client.html +62 -34
- data/docs/Helium/Client/Configurations.html +296 -0
- data/docs/Helium/Client/DeviceConfigurations.html +465 -0
- data/docs/Helium/Client/Elements.html +92 -18
- data/docs/Helium/Client/Http.html +86 -28
- data/docs/Helium/Client/Labels.html +29 -86
- data/docs/Helium/Client/Organizations.html +5 -75
- data/docs/Helium/Client/Sensors.html +147 -17
- data/docs/Helium/Client/Users.html +5 -9
- data/docs/Helium/ClientError.html +3 -3
- data/docs/Helium/Collection.html +1053 -0
- data/docs/Helium/Configuration.html +380 -0
- data/docs/Helium/Cursor.html +7 -3
- data/docs/Helium/DataPoint.html +16 -5
- data/docs/Helium/DeviceConfiguration.html +476 -0
- data/docs/Helium/Element.html +203 -43
- data/docs/Helium/Error.html +15 -5
- data/docs/Helium/InvalidApiKey.html +3 -3
- data/docs/Helium/Label.html +35 -36
- data/docs/Helium/Metadata.html +589 -0
- data/docs/Helium/Organization.html +236 -17
- data/docs/Helium/Resource.html +655 -161
- data/docs/Helium/Sensor.html +345 -111
- data/docs/Helium/Timeseries.html +354 -0
- data/docs/Helium/User.html +161 -18
- data/docs/Helium/Utils.html +56 -4
- data/docs/_index.html +72 -7
- data/docs/class_list.html +1 -1
- data/docs/css/style.css +8 -1
- data/docs/file.README.html +66 -6
- data/docs/frames.html +1 -1
- data/docs/index.html +66 -6
- data/docs/method_list.html +619 -139
- data/docs/top-level-namespace.html +3 -3
- data/lib/helium.rb +2 -0
- data/lib/helium/client/configurations.rb +0 -12
- data/lib/helium/client/elements.rb +0 -12
- data/lib/helium/client/labels.rb +1 -12
- data/lib/helium/client/organizations.rb +1 -47
- data/lib/helium/client/sensors.rb +0 -12
- data/lib/helium/client/users.rb +1 -3
- data/lib/helium/collection.rb +129 -0
- data/lib/helium/configuration.rb +5 -1
- data/lib/helium/element.rb +1 -1
- data/lib/helium/label.rb +1 -3
- data/lib/helium/metadata.rb +58 -0
- data/lib/helium/organization.rb +4 -4
- data/lib/helium/resource.rb +28 -29
- data/lib/helium/sensor.rb +1 -1
- data/lib/helium/version.rb +1 -1
- metadata +11 -2
|
@@ -0,0 +1,354 @@
|
|
|
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
|
+
Class: Helium::Timeseries
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.5
|
|
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 = "Helium::Timeseries";
|
|
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"></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 (T)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Helium.html" title="Helium (module)">Helium</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Timeseries</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
|
+
<iframe id="search_frame" src="../class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Helium::Timeseries
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName"><span class='object_link'><a href="Cursor.html" title="Helium::Cursor (class)">Cursor</a></span></span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next"><span class='object_link'><a href="Cursor.html" title="Helium::Cursor (class)">Cursor</a></span></li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Helium::Timeseries</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<dl>
|
|
95
|
+
<dt>Includes:</dt>
|
|
96
|
+
<dd><span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></dd>
|
|
97
|
+
</dl>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<dl>
|
|
105
|
+
<dt>Defined in:</dt>
|
|
106
|
+
<dd>lib/helium/timeseries.rb</dd>
|
|
107
|
+
</dl>
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>
|
|
120
|
+
Instance Method Summary
|
|
121
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
122
|
+
</h2>
|
|
123
|
+
|
|
124
|
+
<ul class="summary">
|
|
125
|
+
|
|
126
|
+
<li class="public ">
|
|
127
|
+
<span class="summary_signature">
|
|
128
|
+
|
|
129
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(opts = {}) ⇒ DataPoint </a>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<span class="summary_desc"><div class='inline'><p>Creates a new data point on this timeseries.</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
</ul>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
|
|
162
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span>, <span class='object_link'><a href="Utils.html#kebab_case-instance_method" title="Helium::Utils#kebab_case (method)">#kebab_case</a></span></p>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Cursor.html" title="Helium::Cursor (class)">Cursor</a></span></h3>
|
|
173
|
+
<p class="inherited"><span class='object_link'><a href="Cursor.html#each-instance_method" title="Helium::Cursor#each (method)">#each</a></span>, <span class='object_link'><a href="Cursor.html#initialize-instance_method" title="Helium::Cursor#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Cursor.html#to_json-instance_method" title="Helium::Cursor#to_json (method)">#to_json</a></span></p>
|
|
174
|
+
|
|
175
|
+
<div id="constructor_details" class="method_details_list">
|
|
176
|
+
<h2>Constructor Details</h2>
|
|
177
|
+
|
|
178
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Cursor.html#initialize-instance_method" title="Helium::Cursor#initialize (method)">Helium::Cursor</a></span></p>
|
|
179
|
+
|
|
180
|
+
</div>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<div id="instance_method_details" class="method_details_list">
|
|
184
|
+
<h2>Instance Method Details</h2>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<div class="method_details first">
|
|
188
|
+
<h3 class="signature first" id="create-instance_method">
|
|
189
|
+
|
|
190
|
+
#<strong>create</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span></tt>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</h3><div class="docstring">
|
|
197
|
+
<div class="discussion">
|
|
198
|
+
<p>Creates a new data point on this timeseries</p>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
<div class="tags">
|
|
204
|
+
<p class="tag_title">Parameters:</p>
|
|
205
|
+
<ul class="param">
|
|
206
|
+
|
|
207
|
+
<li>
|
|
208
|
+
|
|
209
|
+
<span class='name'>opts</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
—
|
|
219
|
+
<div class='inline'><p>a customizable set of options</p>
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
</li>
|
|
223
|
+
|
|
224
|
+
</ul>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
230
|
+
<ul class="option">
|
|
231
|
+
|
|
232
|
+
<li>
|
|
233
|
+
<span class="name">:port</span>
|
|
234
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
235
|
+
<span class="default">
|
|
236
|
+
|
|
237
|
+
</span>
|
|
238
|
+
|
|
239
|
+
— <div class='inline'><p>A port for the data point</p>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
</li>
|
|
243
|
+
|
|
244
|
+
<li>
|
|
245
|
+
<span class="name">:value</span>
|
|
246
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
247
|
+
<span class="default">
|
|
248
|
+
|
|
249
|
+
</span>
|
|
250
|
+
|
|
251
|
+
— <div class='inline'><p>A value for the data point</p>
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
</li>
|
|
255
|
+
|
|
256
|
+
<li>
|
|
257
|
+
<span class="name">:timestamp</span>
|
|
258
|
+
<span class="type">(<tt>DateTime</tt>)</span>
|
|
259
|
+
<span class="default">
|
|
260
|
+
|
|
261
|
+
</span>
|
|
262
|
+
|
|
263
|
+
— <div class='inline'><p>A timestamp for the data point. If not provided, it will default to the current time.</p>
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
</li>
|
|
267
|
+
|
|
268
|
+
</ul>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<p class="tag_title">Returns:</p>
|
|
272
|
+
<ul class="return">
|
|
273
|
+
|
|
274
|
+
<li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class='type'>(<tt><span class='object_link'><a href="DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span></tt>)</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</li>
|
|
282
|
+
|
|
283
|
+
</ul>
|
|
284
|
+
|
|
285
|
+
</div><table class="source_code">
|
|
286
|
+
<tr>
|
|
287
|
+
<td>
|
|
288
|
+
<pre class="lines">
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
10
|
|
292
|
+
11
|
|
293
|
+
12
|
|
294
|
+
13
|
|
295
|
+
14
|
|
296
|
+
15
|
|
297
|
+
16
|
|
298
|
+
17
|
|
299
|
+
18
|
|
300
|
+
19
|
|
301
|
+
20
|
|
302
|
+
21
|
|
303
|
+
22
|
|
304
|
+
23
|
|
305
|
+
24
|
|
306
|
+
25
|
|
307
|
+
26
|
|
308
|
+
27
|
|
309
|
+
28
|
|
310
|
+
29
|
|
311
|
+
30</pre>
|
|
312
|
+
</td>
|
|
313
|
+
<td>
|
|
314
|
+
<pre class="code"><span class="info file"># File 'lib/helium/timeseries.rb', line 10</span>
|
|
315
|
+
|
|
316
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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>
|
|
317
|
+
<span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:port</span><span class='rparen'>)</span>
|
|
318
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:value</span><span class='rparen'>)</span>
|
|
319
|
+
<span class='id identifier rubyid_timestamp'>timestamp</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:timestamp</span><span class='comma'>,</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
|
|
320
|
+
|
|
321
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
322
|
+
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
|
323
|
+
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
|
324
|
+
<span class='label'>port:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
|
|
325
|
+
<span class='label'>value:</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span>
|
|
326
|
+
<span class='label'>timestamp:</span> <span class='id identifier rubyid_datetime_to_iso'>datetime_to_iso</span><span class='lparen'>(</span><span class='id identifier rubyid_timestamp'>timestamp</span><span class='rparen'>)</span>
|
|
327
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
328
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>data-point</span><span class='tstring_end'>'</span></span>
|
|
329
|
+
<span class='rbrace'>}</span>
|
|
330
|
+
<span class='rbrace'>}</span>
|
|
331
|
+
|
|
332
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
333
|
+
<span class='id identifier rubyid_resource_data'>resource_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
334
|
+
|
|
335
|
+
<span class='kw'>return</span> <span class='const'>DataPoint</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_resource_data'>resource_data</span><span class='rparen'>)</span>
|
|
336
|
+
<span class='kw'>end</span></pre>
|
|
337
|
+
</td>
|
|
338
|
+
</tr>
|
|
339
|
+
</table>
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
</div>
|
|
343
|
+
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
<div id="footer">
|
|
347
|
+
Generated on Thu Jan 12 15:58:35 2017 by
|
|
348
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
349
|
+
0.9.5 (ruby-2.3.1).
|
|
350
|
+
</div>
|
|
351
|
+
|
|
352
|
+
</div>
|
|
353
|
+
</body>
|
|
354
|
+
</html>
|
data/docs/Helium/User.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: Helium::User
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.5
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -163,6 +163,36 @@
|
|
|
163
163
|
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
|
|
164
164
|
</div></span>
|
|
165
165
|
|
|
166
|
+
</li>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<li class="public ">
|
|
170
|
+
<span class="summary_signature">
|
|
171
|
+
|
|
172
|
+
<a href="#pending_invite-instance_method" title="#pending_invite (instance method)">#<strong>pending_invite</strong> ⇒ Object </a>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
(also: #pending_invite?)
|
|
177
|
+
|
|
178
|
+
</span>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class="note title readonly">readonly</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute pending_invite.</p>
|
|
194
|
+
</div></span>
|
|
195
|
+
|
|
166
196
|
</li>
|
|
167
197
|
|
|
168
198
|
|
|
@@ -173,7 +203,7 @@
|
|
|
173
203
|
|
|
174
204
|
|
|
175
205
|
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
|
176
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
|
206
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#params-instance_method" title="Helium::Resource#params (method)">#params</a></span>, <span class='object_link'><a href="Resource.html#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
|
177
207
|
|
|
178
208
|
|
|
179
209
|
|
|
@@ -229,6 +259,28 @@
|
|
|
229
259
|
<span class="summary_desc"><div class='inline'><p>A new instance of User.</p>
|
|
230
260
|
</div></span>
|
|
231
261
|
|
|
262
|
+
</li>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<li class="public ">
|
|
266
|
+
<span class="summary_signature">
|
|
267
|
+
|
|
268
|
+
<a href="#resource_path-instance_method" title="#resource_path (instance method)">#<strong>resource_path</strong> ⇒ Object </a>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</span>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
283
|
+
|
|
232
284
|
</li>
|
|
233
285
|
|
|
234
286
|
|
|
@@ -245,7 +297,18 @@
|
|
|
245
297
|
|
|
246
298
|
|
|
247
299
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
|
248
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>, <span class='object_link'><a href="Resource.html#all-class_method" title="Helium::Resource.all (method)">all</a></span>, <span class='object_link'><a href="Resource.html#create-class_method" title="Helium::Resource.create (method)">create</a></span>, <span class='object_link'><a href="Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Resource.html#destroy-instance_method" title="Helium::Resource#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Resource.html#find-class_method" title="Helium::Resource.find (method)">find</a></span>, <span class='object_link'><a href="Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>, <span class='object_link'><a href="Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>, <span class='object_link'><a href="Resource.html#update-instance_method" title="Helium::Resource#update (method)">#update</a></span>, <span class='object_link'><a href="Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
|
|
300
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>, <span class='object_link'><a href="Resource.html#all-class_method" title="Helium::Resource.all (method)">all</a></span>, <span class='object_link'><a href="Resource.html#all_path-class_method" title="Helium::Resource.all_path (method)">all_path</a></span>, <span class='object_link'><a href="Resource.html#create-class_method" title="Helium::Resource.create (method)">create</a></span>, <span class='object_link'><a href="Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Resource.html#destroy-instance_method" title="Helium::Resource#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Resource.html#find-class_method" title="Helium::Resource.find (method)">find</a></span>, <span class='object_link'><a href="Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>, <span class='object_link'><a href="Resource.html#initialize_from_path-class_method" title="Helium::Resource.initialize_from_path (method)">initialize_from_path</a></span>, <span class='object_link'><a href="Resource.html#metadata-instance_method" title="Helium::Resource#metadata (method)">#metadata</a></span>, <span class='object_link'><a href="Resource.html#resource_name-class_method" title="Helium::Resource.resource_name (method)">resource_name</a></span>, <span class='object_link'><a href="Resource.html#resource_name-instance_method" title="Helium::Resource#resource_name (method)">#resource_name</a></span>, <span class='object_link'><a href="Resource.html#singleton-class_method" title="Helium::Resource.singleton (method)">singleton</a></span>, <span class='object_link'><a href="Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>, <span class='object_link'><a href="Resource.html#update-instance_method" title="Helium::Resource#update (method)">#update</a></span>, <span class='object_link'><a href="Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
|
|
311
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span>, <span class='object_link'><a href="Utils.html#kebab_case-instance_method" title="Helium::Utils#kebab_case (method)">#kebab_case</a></span></p>
|
|
249
312
|
<div id="constructor_details" class="method_details_list">
|
|
250
313
|
<h2>Constructor Details</h2>
|
|
251
314
|
|
|
@@ -274,21 +337,23 @@
|
|
|
274
337
|
<pre class="lines">
|
|
275
338
|
|
|
276
339
|
|
|
277
|
-
5
|
|
278
340
|
6
|
|
279
341
|
7
|
|
280
342
|
8
|
|
281
343
|
9
|
|
282
|
-
10
|
|
344
|
+
10
|
|
345
|
+
11
|
|
346
|
+
12</pre>
|
|
283
347
|
</td>
|
|
284
348
|
<td>
|
|
285
|
-
<pre class="code"><span class="info file"># File 'lib/helium/user.rb', line
|
|
349
|
+
<pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 6</span>
|
|
286
350
|
|
|
287
351
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</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>
|
|
288
352
|
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
|
289
353
|
|
|
290
|
-
<span class='ivar'>@name</span>
|
|
291
|
-
<span class='ivar'>@email</span>
|
|
354
|
+
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attributes</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
355
|
+
<span class='ivar'>@email</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>email</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
356
|
+
<span class='ivar'>@pending_invite</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pending_invite</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
292
357
|
<span class='kw'>end</span></pre>
|
|
293
358
|
</td>
|
|
294
359
|
</tr>
|
|
@@ -384,6 +449,52 @@
|
|
|
384
449
|
</table>
|
|
385
450
|
</div>
|
|
386
451
|
|
|
452
|
+
|
|
453
|
+
<span id=""></span>
|
|
454
|
+
<div class="method_details ">
|
|
455
|
+
<h3 class="signature " id="pending_invite-instance_method">
|
|
456
|
+
|
|
457
|
+
#<strong>pending_invite</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
<span class="aliases">Also known as:
|
|
462
|
+
<span class="names"><span id='pending_invite?-instance_method'>pending_invite?</span></span>
|
|
463
|
+
</span>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
</h3><div class="docstring">
|
|
468
|
+
<div class="discussion">
|
|
469
|
+
<p>Returns the value of attribute pending_invite</p>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
</div>
|
|
474
|
+
<div class="tags">
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
</div><table class="source_code">
|
|
478
|
+
<tr>
|
|
479
|
+
<td>
|
|
480
|
+
<pre class="lines">
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
3
|
|
484
|
+
4
|
|
485
|
+
5</pre>
|
|
486
|
+
</td>
|
|
487
|
+
<td>
|
|
488
|
+
<pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 3</span>
|
|
489
|
+
|
|
490
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_pending_invite'>pending_invite</span>
|
|
491
|
+
<span class='ivar'>@pending_invite</span>
|
|
492
|
+
<span class='kw'>end</span></pre>
|
|
493
|
+
</td>
|
|
494
|
+
</tr>
|
|
495
|
+
</table>
|
|
496
|
+
</div>
|
|
497
|
+
|
|
387
498
|
</div>
|
|
388
499
|
|
|
389
500
|
|
|
@@ -416,25 +527,57 @@
|
|
|
416
527
|
<pre class="lines">
|
|
417
528
|
|
|
418
529
|
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
530
|
+
19
|
|
531
|
+
20
|
|
532
|
+
21
|
|
533
|
+
22
|
|
534
|
+
23
|
|
535
|
+
24
|
|
536
|
+
25</pre>
|
|
425
537
|
</td>
|
|
426
538
|
<td>
|
|
427
|
-
<pre class="code"><span class="info file"># File 'lib/helium/user.rb', line
|
|
539
|
+
<pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 19</span>
|
|
428
540
|
|
|
429
541
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
|
430
542
|
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
431
543
|
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
|
432
|
-
<span class='label'>email:</span> <span class='id identifier rubyid_email'>email</span>
|
|
544
|
+
<span class='label'>email:</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span>
|
|
545
|
+
<span class='label'>pending_invite:</span> <span class='id identifier rubyid_pending_invite'>pending_invite</span>
|
|
433
546
|
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
434
547
|
<span class='kw'>end</span></pre>
|
|
435
548
|
</td>
|
|
436
549
|
</tr>
|
|
437
550
|
</table>
|
|
551
|
+
</div>
|
|
552
|
+
|
|
553
|
+
<div class="method_details ">
|
|
554
|
+
<h3 class="signature " id="resource_path-instance_method">
|
|
555
|
+
|
|
556
|
+
#<strong>resource_path</strong> ⇒ <tt>Object</tt>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
</h3><table class="source_code">
|
|
563
|
+
<tr>
|
|
564
|
+
<td>
|
|
565
|
+
<pre class="lines">
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
14
|
|
569
|
+
15
|
|
570
|
+
16</pre>
|
|
571
|
+
</td>
|
|
572
|
+
<td>
|
|
573
|
+
<pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 14</span>
|
|
574
|
+
|
|
575
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_path'>resource_path</span>
|
|
576
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/user</span><span class='tstring_end'>"</span></span>
|
|
577
|
+
<span class='kw'>end</span></pre>
|
|
578
|
+
</td>
|
|
579
|
+
</tr>
|
|
580
|
+
</table>
|
|
438
581
|
</div>
|
|
439
582
|
|
|
440
583
|
</div>
|
|
@@ -442,9 +585,9 @@
|
|
|
442
585
|
</div>
|
|
443
586
|
|
|
444
587
|
<div id="footer">
|
|
445
|
-
Generated on Thu
|
|
588
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
|
446
589
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
447
|
-
0.9.
|
|
590
|
+
0.9.5 (ruby-2.3.1).
|
|
448
591
|
</div>
|
|
449
592
|
|
|
450
593
|
</div>
|