helium-ruby 0.20.0 → 0.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +47 -0
  3. data/docs/Helium.html +6 -6
  4. data/docs/Helium/Client.html +62 -34
  5. data/docs/Helium/Client/Configurations.html +296 -0
  6. data/docs/Helium/Client/DeviceConfigurations.html +465 -0
  7. data/docs/Helium/Client/Elements.html +92 -18
  8. data/docs/Helium/Client/Http.html +86 -28
  9. data/docs/Helium/Client/Labels.html +29 -86
  10. data/docs/Helium/Client/Organizations.html +5 -75
  11. data/docs/Helium/Client/Sensors.html +147 -17
  12. data/docs/Helium/Client/Users.html +5 -9
  13. data/docs/Helium/ClientError.html +3 -3
  14. data/docs/Helium/Collection.html +1053 -0
  15. data/docs/Helium/Configuration.html +380 -0
  16. data/docs/Helium/Cursor.html +7 -3
  17. data/docs/Helium/DataPoint.html +16 -5
  18. data/docs/Helium/DeviceConfiguration.html +476 -0
  19. data/docs/Helium/Element.html +203 -43
  20. data/docs/Helium/Error.html +15 -5
  21. data/docs/Helium/InvalidApiKey.html +3 -3
  22. data/docs/Helium/Label.html +35 -36
  23. data/docs/Helium/Metadata.html +589 -0
  24. data/docs/Helium/Organization.html +236 -17
  25. data/docs/Helium/Resource.html +655 -161
  26. data/docs/Helium/Sensor.html +345 -111
  27. data/docs/Helium/Timeseries.html +354 -0
  28. data/docs/Helium/User.html +161 -18
  29. data/docs/Helium/Utils.html +56 -4
  30. data/docs/_index.html +72 -7
  31. data/docs/class_list.html +1 -1
  32. data/docs/css/style.css +8 -1
  33. data/docs/file.README.html +66 -6
  34. data/docs/frames.html +1 -1
  35. data/docs/index.html +66 -6
  36. data/docs/method_list.html +619 -139
  37. data/docs/top-level-namespace.html +3 -3
  38. data/lib/helium.rb +2 -0
  39. data/lib/helium/client/configurations.rb +0 -12
  40. data/lib/helium/client/elements.rb +0 -12
  41. data/lib/helium/client/labels.rb +1 -12
  42. data/lib/helium/client/organizations.rb +1 -47
  43. data/lib/helium/client/sensors.rb +0 -12
  44. data/lib/helium/client/users.rb +1 -3
  45. data/lib/helium/collection.rb +129 -0
  46. data/lib/helium/configuration.rb +5 -1
  47. data/lib/helium/element.rb +1 -1
  48. data/lib/helium/label.rb +1 -3
  49. data/lib/helium/metadata.rb +58 -0
  50. data/lib/helium/organization.rb +4 -4
  51. data/lib/helium/resource.rb +28 -29
  52. data/lib/helium/sensor.rb +1 -1
  53. data/lib/helium/version.rb +1 -1
  54. metadata +11 -2
@@ -0,0 +1,476 @@
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::DeviceConfiguration
8
+
9
+ &mdash; 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::DeviceConfiguration";
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 (D)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Helium.html" title="Helium (module)">Helium</a></span></span>
41
+ &raquo;
42
+ <span class="title">DeviceConfiguration</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::DeviceConfiguration
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="Resource.html" title="Helium::Resource (class)">Resource</a></span></span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></li>
80
+
81
+ <li class="next">Helium::DeviceConfiguration</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/helium/device_configuration.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
111
+ <ul class="summary">
112
+
113
+ <li class="public ">
114
+ <span class="summary_signature">
115
+
116
+ <a href="#loaded-instance_method" title="#loaded (instance method)">#<strong>loaded</strong> &#x21d2; Object </a>
117
+
118
+
119
+
120
+ </span>
121
+
122
+
123
+
124
+
125
+ <span class="note title readonly">readonly</span>
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute loaded.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+
144
+
145
+
146
+
147
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
148
+ <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>
149
+
150
+
151
+
152
+ <h2>
153
+ Instance Method Summary
154
+ <small><a href="#" class="summary_toggle">collapse</a></small>
155
+ </h2>
156
+
157
+ <ul class="summary">
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#as_json-instance_method" title="#as_json (instance method)">#<strong>as_json</strong> &#x21d2; Object </a>
163
+
164
+
165
+
166
+ </span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'></div></span>
177
+
178
+ </li>
179
+
180
+
181
+ <li class="public ">
182
+ <span class="summary_signature">
183
+
184
+ <a href="#configuration-instance_method" title="#configuration (instance method)">#<strong>configuration</strong> &#x21d2; Object </a>
185
+
186
+
187
+
188
+ </span>
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'></div></span>
199
+
200
+ </li>
201
+
202
+
203
+ <li class="public ">
204
+ <span class="summary_signature">
205
+
206
+ <a href="#device-instance_method" title="#device (instance method)">#<strong>device</strong> &#x21d2; Object </a>
207
+
208
+
209
+
210
+ </span>
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'></div></span>
221
+
222
+ </li>
223
+
224
+
225
+ <li class="public ">
226
+ <span class="summary_signature">
227
+
228
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; DeviceConfiguration </a>
229
+
230
+
231
+
232
+ </span>
233
+
234
+
235
+ <span class="note title constructor">constructor</span>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+ <span class="summary_desc"><div class='inline'><p>A new instance of DeviceConfiguration.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ </ul>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
263
+ <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#resource_path-instance_method" title="Helium::Resource#resource_path (method)">#resource_path</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>
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
274
+ <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>
275
+ <div id="constructor_details" class="method_details_list">
276
+ <h2>Constructor Details</h2>
277
+
278
+ <div class="method_details first">
279
+ <h3 class="signature first" id="initialize-instance_method">
280
+
281
+ #<strong>initialize</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Helium::DeviceConfiguration (class)">DeviceConfiguration</a></span></tt>
282
+
283
+
284
+
285
+
286
+
287
+ </h3><div class="docstring">
288
+ <div class="discussion">
289
+ <p>Returns a new instance of DeviceConfiguration</p>
290
+
291
+
292
+ </div>
293
+ </div>
294
+ <div class="tags">
295
+
296
+
297
+ </div><table class="source_code">
298
+ <tr>
299
+ <td>
300
+ <pre class="lines">
301
+
302
+
303
+ 5
304
+ 6
305
+ 7
306
+ 8</pre>
307
+ </td>
308
+ <td>
309
+ <pre class="code"><span class="info file"># File 'lib/helium/device_configuration.rb', line 5</span>
310
+
311
+ <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>
312
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
313
+ <span class='ivar'>@loaded</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'>&#39;</span><span class='tstring_content'>meta</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>loaded</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
314
+ <span class='kw'>end</span></pre>
315
+ </td>
316
+ </tr>
317
+ </table>
318
+ </div>
319
+
320
+ </div>
321
+
322
+ <div id="instance_attr_details" class="attr_details">
323
+ <h2>Instance Attribute Details</h2>
324
+
325
+
326
+ <span id=""></span>
327
+ <div class="method_details first">
328
+ <h3 class="signature first" id="loaded-instance_method">
329
+
330
+ #<strong>loaded</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
331
+
332
+
333
+
334
+
335
+
336
+ </h3><div class="docstring">
337
+ <div class="discussion">
338
+ <p>Returns the value of attribute loaded</p>
339
+
340
+
341
+ </div>
342
+ </div>
343
+ <div class="tags">
344
+
345
+
346
+ </div><table class="source_code">
347
+ <tr>
348
+ <td>
349
+ <pre class="lines">
350
+
351
+
352
+ 3
353
+ 4
354
+ 5</pre>
355
+ </td>
356
+ <td>
357
+ <pre class="code"><span class="info file"># File 'lib/helium/device_configuration.rb', line 3</span>
358
+
359
+ <span class='kw'>def</span> <span class='id identifier rubyid_loaded'>loaded</span>
360
+ <span class='ivar'>@loaded</span>
361
+ <span class='kw'>end</span></pre>
362
+ </td>
363
+ </tr>
364
+ </table>
365
+ </div>
366
+
367
+ </div>
368
+
369
+
370
+ <div id="instance_method_details" class="method_details_list">
371
+ <h2>Instance Method Details</h2>
372
+
373
+
374
+ <div class="method_details first">
375
+ <h3 class="signature first" id="as_json-instance_method">
376
+
377
+ #<strong>as_json</strong> &#x21d2; <tt>Object</tt>
378
+
379
+
380
+
381
+
382
+
383
+ </h3><table class="source_code">
384
+ <tr>
385
+ <td>
386
+ <pre class="lines">
387
+
388
+
389
+ 18
390
+ 19
391
+ 20</pre>
392
+ </td>
393
+ <td>
394
+ <pre class="code"><span class="info file"># File 'lib/helium/device_configuration.rb', line 18</span>
395
+
396
+ <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
397
+ <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> <span class='label'>loaded:</span> <span class='id identifier rubyid_loaded'>loaded</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+ <div class="method_details ">
405
+ <h3 class="signature " id="configuration-instance_method">
406
+
407
+ #<strong>configuration</strong> &#x21d2; <tt>Object</tt>
408
+
409
+
410
+
411
+
412
+
413
+ </h3><table class="source_code">
414
+ <tr>
415
+ <td>
416
+ <pre class="lines">
417
+
418
+
419
+ 14
420
+ 15
421
+ 16</pre>
422
+ </td>
423
+ <td>
424
+ <pre class="code"><span class="info file"># File 'lib/helium/device_configuration.rb', line 14</span>
425
+
426
+ <span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span>
427
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_device_configuration_configuration'>device_configuration_configuration</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
428
+ <span class='kw'>end</span></pre>
429
+ </td>
430
+ </tr>
431
+ </table>
432
+ </div>
433
+
434
+ <div class="method_details ">
435
+ <h3 class="signature " id="device-instance_method">
436
+
437
+ #<strong>device</strong> &#x21d2; <tt>Object</tt>
438
+
439
+
440
+
441
+
442
+
443
+ </h3><table class="source_code">
444
+ <tr>
445
+ <td>
446
+ <pre class="lines">
447
+
448
+
449
+ 10
450
+ 11
451
+ 12</pre>
452
+ </td>
453
+ <td>
454
+ <pre class="code"><span class="info file"># File 'lib/helium/device_configuration.rb', line 10</span>
455
+
456
+ <span class='kw'>def</span> <span class='id identifier rubyid_device'>device</span>
457
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_device_configuration_device'>device_configuration_device</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
458
+ <span class='kw'>end</span></pre>
459
+ </td>
460
+ </tr>
461
+ </table>
462
+ </div>
463
+
464
+ </div>
465
+
466
+ </div>
467
+
468
+ <div id="footer">
469
+ Generated on Thu Jan 12 15:58:35 2017 by
470
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
471
+ 0.9.5 (ruby-2.3.1).
472
+ </div>
473
+
474
+ </div>
475
+ </body>
476
+ </html>