helium-ruby 0.4.0 → 0.5.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/.rubocop.yml +1 -0
- data/README.md +3 -3
- data/docs/Helium.html +4 -4
- data/docs/Helium/Client.html +9 -9
- data/docs/Helium/Client/Elements.html +8 -110
- data/docs/Helium/Client/Http.html +31 -33
- data/docs/Helium/Client/Labels.html +38 -218
- data/docs/Helium/Client/Organizations.html +1 -1
- data/docs/Helium/Client/Sensors.html +30 -214
- data/docs/Helium/Client/Users.html +1 -1
- data/docs/Helium/ClientError.html +153 -0
- data/docs/Helium/Cursor.html +8 -8
- data/docs/Helium/DataPoint.html +9 -9
- data/docs/Helium/Element.html +16 -79
- data/docs/Helium/Error.html +267 -0
- data/docs/Helium/InvalidApiKey.html +157 -0
- data/docs/Helium/Label.html +29 -133
- data/docs/Helium/Organization.html +8 -8
- data/docs/Helium/Resource.html +717 -43
- data/docs/Helium/Sensor.html +31 -132
- data/docs/Helium/User.html +8 -8
- data/docs/Helium/Utils.html +1 -1
- data/docs/_index.html +33 -4
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +4 -4
- data/docs/index.html +4 -4
- data/docs/method_list.html +112 -144
- data/docs/top-level-namespace.html +1 -1
- data/lib/helium.rb +1 -0
- data/lib/helium/client.rb +3 -3
- data/lib/helium/client/elements.rb +10 -27
- data/lib/helium/client/http.rb +38 -19
- data/lib/helium/client/labels.rb +7 -53
- data/lib/helium/client/sensors.rb +5 -54
- data/lib/helium/cursor.rb +6 -6
- data/lib/helium/data_point.rb +5 -5
- data/lib/helium/element.rb +7 -8
- data/lib/helium/error.rb +28 -0
- data/lib/helium/label.rb +3 -11
- data/lib/helium/organization.rb +4 -4
- data/lib/helium/resource.rb +103 -5
- data/lib/helium/sensor.rb +13 -15
- data/lib/helium/user.rb +4 -4
- data/lib/helium/version.rb +1 -1
- metadata +6 -2
@@ -108,7 +108,7 @@
|
|
108
108
|
<li class="public ">
|
109
109
|
<span class="summary_signature">
|
110
110
|
|
111
|
-
<a href="#
|
111
|
+
<a href="#create_label-instance_method" title="#create_label (instance method)">#<strong>create_label</strong>(attributes) ⇒ Object </a>
|
112
112
|
|
113
113
|
|
114
114
|
|
@@ -196,51 +196,7 @@
|
|
196
196
|
<li class="public ">
|
197
197
|
<span class="summary_signature">
|
198
198
|
|
199
|
-
<a href="#
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
</span>
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
214
|
-
|
215
|
-
</li>
|
216
|
-
|
217
|
-
|
218
|
-
<li class="public ">
|
219
|
-
<span class="summary_signature">
|
220
|
-
|
221
|
-
<a href="#update_label-instance_method" title="#update_label (instance method)">#<strong>update_label</strong>(label, name:) ⇒ Object </a>
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
</span>
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
236
|
-
|
237
|
-
</li>
|
238
|
-
|
239
|
-
|
240
|
-
<li class="public ">
|
241
|
-
<span class="summary_signature">
|
242
|
-
|
243
|
-
<a href="#update_label_sensors-instance_method" title="#update_label_sensors (instance method)">#<strong>update_label_sensors</strong>(label, sensors: []) ⇒ Object </a>
|
199
|
+
<a href="#update_label_sensors-instance_method" title="#update_label_sensors (instance method)">#<strong>update_label_sensors</strong>(label, opts = {}) ⇒ Object </a>
|
244
200
|
|
245
201
|
|
246
202
|
|
@@ -269,9 +225,9 @@
|
|
269
225
|
|
270
226
|
|
271
227
|
<div class="method_details first">
|
272
|
-
<h3 class="signature first" id="
|
228
|
+
<h3 class="signature first" id="create_label-instance_method">
|
273
229
|
|
274
|
-
#<strong>
|
230
|
+
#<strong>create_label</strong>(attributes) ⇒ <tt>Object</tt>
|
275
231
|
|
276
232
|
|
277
233
|
|
@@ -283,17 +239,15 @@
|
|
283
239
|
<pre class="lines">
|
284
240
|
|
285
241
|
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
62</pre>
|
242
|
+
12
|
243
|
+
13
|
244
|
+
14</pre>
|
290
245
|
</td>
|
291
246
|
<td>
|
292
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line
|
247
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 12</span>
|
293
248
|
|
294
|
-
<span class='kw'>def</span> <span class='id identifier
|
295
|
-
<span class='
|
296
|
-
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
249
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_label'>create_label</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
250
|
+
<span class='const'>Label</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
297
251
|
<span class='kw'>end</span></pre>
|
298
252
|
</td>
|
299
253
|
</tr>
|
@@ -315,21 +269,15 @@
|
|
315
269
|
<pre class="lines">
|
316
270
|
|
317
271
|
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
18
|
322
|
-
19
|
323
|
-
20</pre>
|
272
|
+
8
|
273
|
+
9
|
274
|
+
10</pre>
|
324
275
|
</td>
|
325
276
|
<td>
|
326
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line
|
277
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 8</span>
|
327
278
|
|
328
279
|
<span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
329
|
-
<span class='
|
330
|
-
<span class='id identifier rubyid_label_data'>label_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>
|
331
|
-
|
332
|
-
<span class='kw'>return</span> <span class='const'>Label</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_label_data'>label_data</span><span class='rparen'>)</span>
|
280
|
+
<span class='const'>Label</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
333
281
|
<span class='kw'>end</span></pre>
|
334
282
|
</td>
|
335
283
|
</tr>
|
@@ -351,20 +299,20 @@
|
|
351
299
|
<pre class="lines">
|
352
300
|
|
353
301
|
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
302
|
+
16
|
303
|
+
17
|
304
|
+
18
|
305
|
+
19
|
306
|
+
20
|
307
|
+
21
|
308
|
+
22
|
309
|
+
23
|
310
|
+
24
|
311
|
+
25
|
312
|
+
26</pre>
|
365
313
|
</td>
|
366
314
|
<td>
|
367
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line
|
315
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 16</span>
|
368
316
|
|
369
317
|
<span class='kw'>def</span> <span class='id identifier rubyid_label_sensors'>label_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span>
|
370
318
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/label/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/sensor</span><span class='tstring_end'>"</span></span>
|
@@ -399,27 +347,13 @@
|
|
399
347
|
|
400
348
|
4
|
401
349
|
5
|
402
|
-
6
|
403
|
-
7
|
404
|
-
8
|
405
|
-
9
|
406
|
-
10
|
407
|
-
11
|
408
|
-
12
|
409
|
-
13</pre>
|
350
|
+
6</pre>
|
410
351
|
</td>
|
411
352
|
<td>
|
412
353
|
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 4</span>
|
413
354
|
|
414
355
|
<span class='kw'>def</span> <span class='id identifier rubyid_labels'>labels</span>
|
415
|
-
<span class='
|
416
|
-
<span class='id identifier rubyid_labels_data'>labels_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>
|
417
|
-
|
418
|
-
<span class='id identifier rubyid_labels'>labels</span> <span class='op'>=</span> <span class='id identifier rubyid_labels_data'>labels_data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_label_data'>label_data</span><span class='op'>|</span>
|
419
|
-
<span class='const'>Label</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_label_data'>label_data</span><span class='rparen'>)</span>
|
420
|
-
<span class='kw'>end</span>
|
421
|
-
|
422
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_labels'>labels</span>
|
356
|
+
<span class='const'>Label</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
423
357
|
<span class='kw'>end</span></pre>
|
424
358
|
</td>
|
425
359
|
</tr>
|
@@ -427,9 +361,9 @@
|
|
427
361
|
</div>
|
428
362
|
|
429
363
|
<div class="method_details ">
|
430
|
-
<h3 class="signature " id="
|
364
|
+
<h3 class="signature " id="update_label_sensors-instance_method">
|
431
365
|
|
432
|
-
#<strong>
|
366
|
+
#<strong>update_label_sensors</strong>(label, opts = {}) ⇒ <tt>Object</tt>
|
433
367
|
|
434
368
|
|
435
369
|
|
@@ -441,12 +375,6 @@
|
|
441
375
|
<pre class="lines">
|
442
376
|
|
443
377
|
|
444
|
-
22
|
445
|
-
23
|
446
|
-
24
|
447
|
-
25
|
448
|
-
26
|
449
|
-
27
|
450
378
|
28
|
451
379
|
29
|
452
380
|
30
|
@@ -457,48 +385,8 @@
|
|
457
385
|
35
|
458
386
|
36
|
459
387
|
37
|
460
|
-
38
|
461
|
-
|
462
|
-
<td>
|
463
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 22</span>
|
464
|
-
|
465
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_new_label'>new_label</span><span class='lparen'>(</span><span class='label'>name:</span><span class='rparen'>)</span>
|
466
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/label</span><span class='tstring_end'>"</span></span>
|
467
|
-
|
468
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
469
|
-
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
470
|
-
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
471
|
-
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span>
|
472
|
-
<span class='rbrace'>}</span><span class='comma'>,</span>
|
473
|
-
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>label</span><span class='tstring_end'>"</span></span>
|
474
|
-
<span class='rbrace'>}</span>
|
475
|
-
<span class='rbrace'>}</span>
|
476
|
-
|
477
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
478
|
-
<span class='id identifier rubyid_label_data'>label_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>
|
479
|
-
|
480
|
-
<span class='kw'>return</span> <span class='const'>Label</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_label_data'>label_data</span><span class='rparen'>)</span>
|
481
|
-
<span class='kw'>end</span></pre>
|
482
|
-
</td>
|
483
|
-
</tr>
|
484
|
-
</table>
|
485
|
-
</div>
|
486
|
-
|
487
|
-
<div class="method_details ">
|
488
|
-
<h3 class="signature " id="update_label-instance_method">
|
489
|
-
|
490
|
-
#<strong>update_label</strong>(label, name:) ⇒ <tt>Object</tt>
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
</h3><table class="source_code">
|
497
|
-
<tr>
|
498
|
-
<td>
|
499
|
-
<pre class="lines">
|
500
|
-
|
501
|
-
|
388
|
+
38
|
389
|
+
39
|
502
390
|
40
|
503
391
|
41
|
504
392
|
42
|
@@ -515,82 +403,14 @@
|
|
515
403
|
53
|
516
404
|
54
|
517
405
|
55
|
518
|
-
56
|
519
|
-
57</pre>
|
406
|
+
56</pre>
|
520
407
|
</td>
|
521
408
|
<td>
|
522
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line
|
523
|
-
|
524
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_label'>update_label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='label'>name:</span><span class='rparen'>)</span>
|
525
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/label/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
526
|
-
|
527
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
528
|
-
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
529
|
-
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
530
|
-
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span>
|
531
|
-
<span class='rbrace'>}</span><span class='comma'>,</span>
|
532
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
533
|
-
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>label</span><span class='tstring_end'>"</span></span>
|
534
|
-
<span class='rbrace'>}</span>
|
535
|
-
<span class='rbrace'>}</span>
|
536
|
-
|
537
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
538
|
-
<span class='id identifier rubyid_label_data'>label_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>
|
409
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 28</span>
|
539
410
|
|
540
|
-
|
541
|
-
<span class='
|
542
|
-
</td>
|
543
|
-
</tr>
|
544
|
-
</table>
|
545
|
-
</div>
|
546
|
-
|
547
|
-
<div class="method_details ">
|
548
|
-
<h3 class="signature " id="update_label_sensors-instance_method">
|
549
|
-
|
550
|
-
#<strong>update_label_sensors</strong>(label, sensors: []) ⇒ <tt>Object</tt>
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
</h3><table class="source_code">
|
557
|
-
<tr>
|
558
|
-
<td>
|
559
|
-
<pre class="lines">
|
560
|
-
|
561
|
-
|
562
|
-
76
|
563
|
-
77
|
564
|
-
78
|
565
|
-
79
|
566
|
-
80
|
567
|
-
81
|
568
|
-
82
|
569
|
-
83
|
570
|
-
84
|
571
|
-
85
|
572
|
-
86
|
573
|
-
87
|
574
|
-
88
|
575
|
-
89
|
576
|
-
90
|
577
|
-
91
|
578
|
-
92
|
579
|
-
93
|
580
|
-
94
|
581
|
-
95
|
582
|
-
96
|
583
|
-
97
|
584
|
-
98
|
585
|
-
99
|
586
|
-
100
|
587
|
-
101
|
588
|
-
102</pre>
|
589
|
-
</td>
|
590
|
-
<td>
|
591
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 76</span>
|
411
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_label_sensors'>update_label_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</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>
|
412
|
+
<span class='id identifier rubyid_sensors'>sensors</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'>:sensors</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
592
413
|
|
593
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_label_sensors'>update_label_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='label'>sensors:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
594
414
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/label/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/relationships/sensor</span><span class='tstring_end'>"</span></span>
|
595
415
|
|
596
416
|
<span class='id identifier rubyid_sensors'>sensors</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_sensors'>sensors</span><span class='rparen'>)</span>
|
@@ -627,7 +447,7 @@
|
|
627
447
|
</div>
|
628
448
|
|
629
449
|
<div id="footer">
|
630
|
-
Generated on
|
450
|
+
Generated on Wed Aug 24 13:22:51 2016 by
|
631
451
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
632
452
|
0.9.3 (ruby-2.3.1).
|
633
453
|
</div>
|
@@ -241,7 +241,7 @@
|
|
241
241
|
</div>
|
242
242
|
|
243
243
|
<div id="footer">
|
244
|
-
Generated on
|
244
|
+
Generated on Wed Aug 24 13:22:51 2016 by
|
245
245
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
246
246
|
0.9.3 (ruby-2.3.1).
|
247
247
|
</div>
|
@@ -108,29 +108,7 @@
|
|
108
108
|
<li class="public ">
|
109
109
|
<span class="summary_signature">
|
110
110
|
|
111
|
-
<a href="#
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
</span>
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
126
|
-
|
127
|
-
</li>
|
128
|
-
|
129
|
-
|
130
|
-
<li class="public ">
|
131
|
-
<span class="summary_signature">
|
132
|
-
|
133
|
-
<a href="#new_sensor-instance_method" title="#new_sensor (instance method)">#<strong>new_sensor</strong>(name:) ⇒ Object </a>
|
111
|
+
<a href="#create_sensor-instance_method" title="#create_sensor (instance method)">#<strong>create_sensor</strong>(attributes) ⇒ Object </a>
|
134
112
|
|
135
113
|
|
136
114
|
|
@@ -210,28 +188,6 @@
|
|
210
188
|
|
211
189
|
|
212
190
|
|
213
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
214
|
-
|
215
|
-
</li>
|
216
|
-
|
217
|
-
|
218
|
-
<li class="public ">
|
219
|
-
<span class="summary_signature">
|
220
|
-
|
221
|
-
<a href="#update_sensor-instance_method" title="#update_sensor (instance method)">#<strong>update_sensor</strong>(sensor, name:) ⇒ Object </a>
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
</span>
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
191
|
<span class="summary_desc"><div class='inline'></div></span>
|
236
192
|
|
237
193
|
</li>
|
@@ -247,9 +203,9 @@
|
|
247
203
|
|
248
204
|
|
249
205
|
<div class="method_details first">
|
250
|
-
<h3 class="signature first" id="
|
206
|
+
<h3 class="signature first" id="create_sensor-instance_method">
|
251
207
|
|
252
|
-
#<strong>
|
208
|
+
#<strong>create_sensor</strong>(attributes) ⇒ <tt>Object</tt>
|
253
209
|
|
254
210
|
|
255
211
|
|
@@ -261,75 +217,15 @@
|
|
261
217
|
<pre class="lines">
|
262
218
|
|
263
219
|
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
77</pre>
|
268
|
-
</td>
|
269
|
-
<td>
|
270
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 74</span>
|
271
|
-
|
272
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_sensor'>delete_sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor'>sensor</span><span class='rparen'>)</span>
|
273
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
274
|
-
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
275
|
-
<span class='kw'>end</span></pre>
|
276
|
-
</td>
|
277
|
-
</tr>
|
278
|
-
</table>
|
279
|
-
</div>
|
280
|
-
|
281
|
-
<div class="method_details ">
|
282
|
-
<h3 class="signature " id="new_sensor-instance_method">
|
283
|
-
|
284
|
-
#<strong>new_sensor</strong>(name:) ⇒ <tt>Object</tt>
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
</h3><table class="source_code">
|
291
|
-
<tr>
|
292
|
-
<td>
|
293
|
-
<pre class="lines">
|
294
|
-
|
295
|
-
|
296
|
-
37
|
297
|
-
38
|
298
|
-
39
|
299
|
-
40
|
300
|
-
41
|
301
|
-
42
|
302
|
-
43
|
303
|
-
44
|
304
|
-
45
|
305
|
-
46
|
306
|
-
47
|
307
|
-
48
|
308
|
-
49
|
309
|
-
50
|
310
|
-
51
|
311
|
-
52
|
312
|
-
53</pre>
|
220
|
+
27
|
221
|
+
28
|
222
|
+
29</pre>
|
313
223
|
</td>
|
314
224
|
<td>
|
315
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line
|
225
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 27</span>
|
316
226
|
|
317
|
-
<span class='kw'>def</span> <span class='id identifier
|
318
|
-
<span class='id identifier
|
319
|
-
|
320
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
321
|
-
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
322
|
-
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
323
|
-
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span>
|
324
|
-
<span class='rbrace'>}</span><span class='comma'>,</span>
|
325
|
-
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor</span><span class='tstring_end'>"</span></span>
|
326
|
-
<span class='rbrace'>}</span>
|
327
|
-
<span class='rbrace'>}</span>
|
328
|
-
|
329
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
330
|
-
<span class='id identifier rubyid_sensor_data'>sensor_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>
|
331
|
-
|
332
|
-
<span class='kw'>return</span> <span class='const'>Sensor</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_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
227
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_sensor'>create_sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
228
|
+
<span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
333
229
|
<span class='kw'>end</span></pre>
|
334
230
|
</td>
|
335
231
|
</tr>
|
@@ -351,21 +247,15 @@
|
|
351
247
|
<pre class="lines">
|
352
248
|
|
353
249
|
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
18
|
358
|
-
19
|
359
|
-
20</pre>
|
250
|
+
8
|
251
|
+
9
|
252
|
+
10</pre>
|
360
253
|
</td>
|
361
254
|
<td>
|
362
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line
|
255
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 8</span>
|
363
256
|
|
364
257
|
<span class='kw'>def</span> <span class='id identifier rubyid_sensor'>sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
365
|
-
<span class='
|
366
|
-
<span class='id identifier rubyid_sensor_data'>sensor_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>
|
367
|
-
|
368
|
-
<span class='kw'>return</span> <span class='const'>Sensor</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_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
258
|
+
<span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
369
259
|
<span class='kw'>end</span></pre>
|
370
260
|
</td>
|
371
261
|
</tr>
|
@@ -387,23 +277,23 @@
|
|
387
277
|
<pre class="lines">
|
388
278
|
|
389
279
|
|
280
|
+
12
|
281
|
+
13
|
282
|
+
14
|
283
|
+
15
|
284
|
+
16
|
285
|
+
17
|
286
|
+
18
|
287
|
+
19
|
288
|
+
20
|
289
|
+
21
|
390
290
|
22
|
391
291
|
23
|
392
292
|
24
|
393
|
-
25
|
394
|
-
26
|
395
|
-
27
|
396
|
-
28
|
397
|
-
29
|
398
|
-
30
|
399
|
-
31
|
400
|
-
32
|
401
|
-
33
|
402
|
-
34
|
403
|
-
35</pre>
|
293
|
+
25</pre>
|
404
294
|
</td>
|
405
295
|
<td>
|
406
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line
|
296
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 12</span>
|
407
297
|
|
408
298
|
<span class='kw'>def</span> <span class='id identifier rubyid_sensor_timeseries'>sensor_timeseries</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor'>sensor</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>
|
409
299
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/timeseries</span><span class='tstring_end'>"</span></span>
|
@@ -415,7 +305,7 @@
|
|
415
305
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter[end]</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_datetime_to_iso'>datetime_to_iso</span><span class='lparen'>(</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'>:end_time</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span>
|
416
306
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>agg[type]</span><span class='tstring_end'>"</span></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'>:aggtype</span><span class='rparen'>)</span><span class='comma'>,</span>
|
417
307
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>agg[size]</span><span class='tstring_end'>"</span></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'>:aggsize</span><span class='rparen'>)</span>
|
418
|
-
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier
|
308
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid__key'>_key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='rbrace'>}</span>
|
419
309
|
|
420
310
|
<span class='id identifier rubyid_paginated_get'>paginated_get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>klass:</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>DataPoint</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
421
311
|
<span class='kw'>end</span></pre>
|
@@ -441,87 +331,13 @@
|
|
441
331
|
|
442
332
|
4
|
443
333
|
5
|
444
|
-
6
|
445
|
-
7
|
446
|
-
8
|
447
|
-
9
|
448
|
-
10
|
449
|
-
11
|
450
|
-
12
|
451
|
-
13</pre>
|
334
|
+
6</pre>
|
452
335
|
</td>
|
453
336
|
<td>
|
454
337
|
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 4</span>
|
455
338
|
|
456
339
|
<span class='kw'>def</span> <span class='id identifier rubyid_sensors'>sensors</span>
|
457
|
-
<span class='
|
458
|
-
<span class='id identifier rubyid_sensors_data'>sensors_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>
|
459
|
-
|
460
|
-
<span class='id identifier rubyid_sensors'>sensors</span> <span class='op'>=</span> <span class='id identifier rubyid_sensors_data'>sensors_data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sensor_data'>sensor_data</span><span class='op'>|</span>
|
461
|
-
<span class='const'>Sensor</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_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
462
|
-
<span class='kw'>end</span>
|
463
|
-
|
464
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_sensors'>sensors</span>
|
465
|
-
<span class='kw'>end</span></pre>
|
466
|
-
</td>
|
467
|
-
</tr>
|
468
|
-
</table>
|
469
|
-
</div>
|
470
|
-
|
471
|
-
<div class="method_details ">
|
472
|
-
<h3 class="signature " id="update_sensor-instance_method">
|
473
|
-
|
474
|
-
#<strong>update_sensor</strong>(sensor, name:) ⇒ <tt>Object</tt>
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
</h3><table class="source_code">
|
481
|
-
<tr>
|
482
|
-
<td>
|
483
|
-
<pre class="lines">
|
484
|
-
|
485
|
-
|
486
|
-
55
|
487
|
-
56
|
488
|
-
57
|
489
|
-
58
|
490
|
-
59
|
491
|
-
60
|
492
|
-
61
|
493
|
-
62
|
494
|
-
63
|
495
|
-
64
|
496
|
-
65
|
497
|
-
66
|
498
|
-
67
|
499
|
-
68
|
500
|
-
69
|
501
|
-
70
|
502
|
-
71
|
503
|
-
72</pre>
|
504
|
-
</td>
|
505
|
-
<td>
|
506
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 55</span>
|
507
|
-
|
508
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_sensor'>update_sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor'>sensor</span><span class='comma'>,</span> <span class='label'>name:</span><span class='rparen'>)</span>
|
509
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
510
|
-
|
511
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
512
|
-
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
513
|
-
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
514
|
-
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span>
|
515
|
-
<span class='rbrace'>}</span><span class='comma'>,</span>
|
516
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
517
|
-
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor</span><span class='tstring_end'>"</span></span>
|
518
|
-
<span class='rbrace'>}</span>
|
519
|
-
<span class='rbrace'>}</span>
|
520
|
-
|
521
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
522
|
-
<span class='id identifier rubyid_sensor_data'>sensor_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>
|
523
|
-
|
524
|
-
<span class='kw'>return</span> <span class='const'>Sensor</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_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
340
|
+
<span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
525
341
|
<span class='kw'>end</span></pre>
|
526
342
|
</td>
|
527
343
|
</tr>
|
@@ -533,7 +349,7 @@
|
|
533
349
|
</div>
|
534
350
|
|
535
351
|
<div id="footer">
|
536
|
-
Generated on
|
352
|
+
Generated on Wed Aug 24 13:22:51 2016 by
|
537
353
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
538
354
|
0.9.3 (ruby-2.3.1).
|
539
355
|
</div>
|