helium-ruby 0.5.0 → 0.6.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/CONTRIBUTING.md +4 -26
- data/CONTRIBUTORS.md +4 -0
- data/README.md +12 -19
- data/docs/Helium.html +2 -2
- data/docs/Helium/Client.html +2 -2
- data/docs/Helium/Client/Elements.html +69 -1
- data/docs/Helium/Client/Http.html +1 -1
- data/docs/Helium/Client/Labels.html +1 -1
- data/docs/Helium/Client/Organizations.html +1 -1
- data/docs/Helium/Client/Sensors.html +1 -1
- data/docs/Helium/Client/Users.html +1 -1
- data/docs/Helium/ClientError.html +1 -1
- data/docs/Helium/Cursor.html +1 -1
- data/docs/Helium/DataPoint.html +2 -2
- data/docs/Helium/Element.html +60 -8
- data/docs/Helium/Error.html +7 -9
- data/docs/Helium/InvalidApiKey.html +1 -1
- data/docs/Helium/Label.html +2 -2
- data/docs/Helium/Organization.html +2 -2
- data/docs/Helium/Resource.html +113 -39
- data/docs/Helium/Sensor.html +188 -21
- data/docs/Helium/User.html +2 -2
- data/docs/Helium/Utils.html +1 -1
- data/docs/_index.html +1 -1
- data/docs/file.README.html +9 -22
- data/docs/index.html +9 -22
- data/docs/method_list.html +87 -47
- data/docs/top-level-namespace.html +1 -1
- data/lib/helium/resource.rb +3 -1
- data/lib/helium/sensor.rb +16 -5
- data/lib/helium/version.rb +1 -1
- metadata +3 -3
- data/CODE_OF_CONDUCT.md +0 -49
@@ -147,7 +147,7 @@
|
|
147
147
|
</div>
|
148
148
|
|
149
149
|
<div id="footer">
|
150
|
-
Generated on
|
150
|
+
Generated on Tue Aug 30 08:16:47 2016 by
|
151
151
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
152
152
|
0.9.3 (ruby-2.3.1).
|
153
153
|
</div>
|
data/docs/Helium/Label.html
CHANGED
@@ -145,7 +145,7 @@
|
|
145
145
|
|
146
146
|
|
147
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></p>
|
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#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
149
149
|
|
150
150
|
|
151
151
|
|
@@ -544,7 +544,7 @@ we could do something like label.sensors << new_sensor</p>
|
|
544
544
|
</div>
|
545
545
|
|
546
546
|
<div id="footer">
|
547
|
-
Generated on
|
547
|
+
Generated on Tue Aug 30 08:16:47 2016 by
|
548
548
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
549
549
|
0.9.3 (ruby-2.3.1).
|
550
550
|
</div>
|
@@ -173,7 +173,7 @@
|
|
173
173
|
|
174
174
|
|
175
175
|
<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></p>
|
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>
|
177
177
|
|
178
178
|
|
179
179
|
|
@@ -494,7 +494,7 @@
|
|
494
494
|
</div>
|
495
495
|
|
496
496
|
<div id="footer">
|
497
|
-
Generated on
|
497
|
+
Generated on Tue Aug 30 08:16:47 2016 by
|
498
498
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
499
499
|
0.9.3 (ruby-2.3.1).
|
500
500
|
</div>
|
data/docs/Helium/Resource.html
CHANGED
@@ -147,6 +147,34 @@
|
|
147
147
|
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
|
148
148
|
</div></span>
|
149
149
|
|
150
|
+
</li>
|
151
|
+
|
152
|
+
|
153
|
+
<li class="public ">
|
154
|
+
<span class="summary_signature">
|
155
|
+
|
156
|
+
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ Object </a>
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
</span>
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
<span class="note title readonly">readonly</span>
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute type.</p>
|
176
|
+
</div></span>
|
177
|
+
|
150
178
|
</li>
|
151
179
|
|
152
180
|
|
@@ -511,7 +539,8 @@
|
|
511
539
|
10
|
512
540
|
11
|
513
541
|
12
|
514
|
-
13
|
542
|
+
13
|
543
|
+
14</pre>
|
515
544
|
</td>
|
516
545
|
<td>
|
517
546
|
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 6</span>
|
@@ -521,6 +550,7 @@
|
|
521
550
|
<span class='ivar'>@params</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'>:params</span><span class='rparen'>)</span>
|
522
551
|
|
523
552
|
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>id</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
553
|
+
<span class='ivar'>@type</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'>type</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
524
554
|
<span class='ivar'>@created_at</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'>created</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
525
555
|
<span class='ivar'>@updated_at</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'>updated</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
526
556
|
<span class='kw'>end</span></pre>
|
@@ -576,6 +606,48 @@
|
|
576
606
|
</table>
|
577
607
|
</div>
|
578
608
|
|
609
|
+
|
610
|
+
<span id=""></span>
|
611
|
+
<div class="method_details ">
|
612
|
+
<h3 class="signature " id="type-instance_method">
|
613
|
+
|
614
|
+
#<strong>type</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
</h3><div class="docstring">
|
621
|
+
<div class="discussion">
|
622
|
+
<p>Returns the value of attribute type</p>
|
623
|
+
|
624
|
+
|
625
|
+
</div>
|
626
|
+
</div>
|
627
|
+
<div class="tags">
|
628
|
+
|
629
|
+
|
630
|
+
</div><table class="source_code">
|
631
|
+
<tr>
|
632
|
+
<td>
|
633
|
+
<pre class="lines">
|
634
|
+
|
635
|
+
|
636
|
+
4
|
637
|
+
5
|
638
|
+
6</pre>
|
639
|
+
</td>
|
640
|
+
<td>
|
641
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 4</span>
|
642
|
+
|
643
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
|
644
|
+
<span class='ivar'>@type</span>
|
645
|
+
<span class='kw'>end</span></pre>
|
646
|
+
</td>
|
647
|
+
</tr>
|
648
|
+
</table>
|
649
|
+
</div>
|
650
|
+
|
579
651
|
</div>
|
580
652
|
|
581
653
|
|
@@ -667,7 +739,6 @@
|
|
667
739
|
<pre class="lines">
|
668
740
|
|
669
741
|
|
670
|
-
23
|
671
742
|
24
|
672
743
|
25
|
673
744
|
26
|
@@ -678,10 +749,11 @@
|
|
678
749
|
31
|
679
750
|
32
|
680
751
|
33
|
681
|
-
34
|
752
|
+
34
|
753
|
+
35</pre>
|
682
754
|
</td>
|
683
755
|
<td>
|
684
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
756
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 24</span>
|
685
757
|
|
686
758
|
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</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>
|
687
759
|
<span class='id identifier rubyid_client'>client</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'>:client</span><span class='rparen'>)</span>
|
@@ -797,7 +869,6 @@
|
|
797
869
|
<pre class="lines">
|
798
870
|
|
799
871
|
|
800
|
-
53
|
801
872
|
54
|
802
873
|
55
|
803
874
|
56
|
@@ -813,10 +884,11 @@
|
|
813
884
|
66
|
814
885
|
67
|
815
886
|
68
|
816
|
-
69
|
887
|
+
69
|
888
|
+
70</pre>
|
817
889
|
</td>
|
818
890
|
<td>
|
819
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
891
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 54</span>
|
820
892
|
|
821
893
|
<span class='kw'>def</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='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
822
894
|
<span class='id identifier rubyid_client'>client</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'>:client</span><span class='rparen'>)</span>
|
@@ -937,17 +1009,17 @@
|
|
937
1009
|
<pre class="lines">
|
938
1010
|
|
939
1011
|
|
940
|
-
40
|
941
1012
|
41
|
942
1013
|
42
|
943
1014
|
43
|
944
1015
|
44
|
945
1016
|
45
|
946
1017
|
46
|
947
|
-
47
|
1018
|
+
47
|
1019
|
+
48</pre>
|
948
1020
|
</td>
|
949
1021
|
<td>
|
950
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1022
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 41</span>
|
951
1023
|
|
952
1024
|
<span class='kw'>def</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='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
953
1025
|
<span class='id identifier rubyid_client'>client</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'>:client</span><span class='rparen'>)</span>
|
@@ -1006,12 +1078,12 @@
|
|
1006
1078
|
<pre class="lines">
|
1007
1079
|
|
1008
1080
|
|
1009
|
-
107
|
1010
1081
|
108
|
1011
|
-
109
|
1082
|
+
109
|
1083
|
+
110</pre>
|
1012
1084
|
</td>
|
1013
1085
|
<td>
|
1014
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1086
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 108</span>
|
1015
1087
|
|
1016
1088
|
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
1017
1089
|
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
|
@@ -1063,20 +1135,22 @@
|
|
1063
1135
|
<pre class="lines">
|
1064
1136
|
|
1065
1137
|
|
1066
|
-
137
|
1067
1138
|
138
|
1068
1139
|
139
|
1069
1140
|
140
|
1070
1141
|
141
|
1071
1142
|
142
|
1072
|
-
143
|
1143
|
+
143
|
1144
|
+
144
|
1145
|
+
145</pre>
|
1073
1146
|
</td>
|
1074
1147
|
<td>
|
1075
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1148
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 138</span>
|
1076
1149
|
|
1077
1150
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
1078
1151
|
<span class='lbrace'>{</span>
|
1079
1152
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1153
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span>
|
1080
1154
|
<span class='label'>created_at:</span> <span class='id identifier rubyid_created_at'>created_at</span><span class='comma'>,</span>
|
1081
1155
|
<span class='label'>updated_at:</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
1082
1156
|
<span class='rbrace'>}</span>
|
@@ -1128,13 +1202,13 @@
|
|
1128
1202
|
<pre class="lines">
|
1129
1203
|
|
1130
1204
|
|
1131
|
-
124
|
1132
1205
|
125
|
1133
1206
|
126
|
1134
|
-
127
|
1207
|
+
127
|
1208
|
+
128</pre>
|
1135
1209
|
</td>
|
1136
1210
|
<td>
|
1137
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1211
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 125</span>
|
1138
1212
|
|
1139
1213
|
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
1140
1214
|
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@created_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
@@ -1187,13 +1261,13 @@
|
|
1187
1261
|
<pre class="lines">
|
1188
1262
|
|
1189
1263
|
|
1190
|
-
100
|
1191
1264
|
101
|
1192
1265
|
102
|
1193
|
-
103
|
1266
|
+
103
|
1267
|
+
104</pre>
|
1194
1268
|
</td>
|
1195
1269
|
<td>
|
1196
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1270
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 101</span>
|
1197
1271
|
|
1198
1272
|
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
|
1199
1273
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
@@ -1242,12 +1316,12 @@
|
|
1242
1316
|
<pre class="lines">
|
1243
1317
|
|
1244
1318
|
|
1245
|
-
113
|
1246
1319
|
114
|
1247
|
-
115
|
1320
|
+
115
|
1321
|
+
116</pre>
|
1248
1322
|
</td>
|
1249
1323
|
<td>
|
1250
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1324
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 114</span>
|
1251
1325
|
|
1252
1326
|
<span class='kw'>def</span> <span class='id identifier rubyid_eql?'>eql?</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
1253
1327
|
<span class='kw'>self</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span>
|
@@ -1295,12 +1369,12 @@
|
|
1295
1369
|
<pre class="lines">
|
1296
1370
|
|
1297
1371
|
|
1298
|
-
119
|
1299
1372
|
120
|
1300
|
-
121
|
1373
|
+
121
|
1374
|
+
122</pre>
|
1301
1375
|
</td>
|
1302
1376
|
<td>
|
1303
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1377
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 120</span>
|
1304
1378
|
|
1305
1379
|
<span class='kw'>def</span> <span class='id identifier rubyid_hash'>hash</span>
|
1306
1380
|
<span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span>
|
@@ -1352,12 +1426,12 @@
|
|
1352
1426
|
<pre class="lines">
|
1353
1427
|
|
1354
1428
|
|
1355
|
-
|
1356
|
-
|
1357
|
-
|
1429
|
+
148
|
1430
|
+
149
|
1431
|
+
150</pre>
|
1358
1432
|
</td>
|
1359
1433
|
<td>
|
1360
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1434
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 148</span>
|
1361
1435
|
|
1362
1436
|
<span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1363
1437
|
<span class='id identifier rubyid_as_json'>as_json</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
@@ -1428,7 +1502,6 @@
|
|
1428
1502
|
<pre class="lines">
|
1429
1503
|
|
1430
1504
|
|
1431
|
-
81
|
1432
1505
|
82
|
1433
1506
|
83
|
1434
1507
|
84
|
@@ -1443,10 +1516,11 @@
|
|
1443
1516
|
93
|
1444
1517
|
94
|
1445
1518
|
95
|
1446
|
-
96
|
1519
|
+
96
|
1520
|
+
97</pre>
|
1447
1521
|
</td>
|
1448
1522
|
<td>
|
1449
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1523
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 82</span>
|
1450
1524
|
|
1451
1525
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
1452
1526
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
@@ -1511,13 +1585,13 @@
|
|
1511
1585
|
<pre class="lines">
|
1512
1586
|
|
1513
1587
|
|
1514
|
-
130
|
1515
1588
|
131
|
1516
1589
|
132
|
1517
|
-
133
|
1590
|
+
133
|
1591
|
+
134</pre>
|
1518
1592
|
</td>
|
1519
1593
|
<td>
|
1520
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1594
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 131</span>
|
1521
1595
|
|
1522
1596
|
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
1523
1597
|
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@updated_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
@@ -1533,7 +1607,7 @@
|
|
1533
1607
|
</div>
|
1534
1608
|
|
1535
1609
|
<div id="footer">
|
1536
|
-
Generated on
|
1610
|
+
Generated on Tue Aug 30 08:16:47 2016 by
|
1537
1611
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1538
1612
|
0.9.3 (ruby-2.3.1).
|
1539
1613
|
</div>
|
data/docs/Helium/Sensor.html
CHANGED
@@ -110,6 +110,62 @@
|
|
110
110
|
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
111
111
|
<ul class="summary">
|
112
112
|
|
113
|
+
<li class="public ">
|
114
|
+
<span class="summary_signature">
|
115
|
+
|
116
|
+
<a href="#firmware-instance_method" title="#firmware (instance method)">#<strong>firmware</strong> ⇒ 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 firmware.</p>
|
136
|
+
</div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
<li class="public ">
|
142
|
+
<span class="summary_signature">
|
143
|
+
|
144
|
+
<a href="#last_seen-instance_method" title="#last_seen (instance method)">#<strong>last_seen</strong> ⇒ DateTime<sup>?</sup> </a>
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
</span>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
<span class="note title readonly">readonly</span>
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
<span class="summary_desc"><div class='inline'><p>When the resource was last seen.</p>
|
164
|
+
</div></span>
|
165
|
+
|
166
|
+
</li>
|
167
|
+
|
168
|
+
|
113
169
|
<li class="public ">
|
114
170
|
<span class="summary_signature">
|
115
171
|
|
@@ -201,7 +257,7 @@
|
|
201
257
|
|
202
258
|
|
203
259
|
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
204
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span></p>
|
260
|
+
<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>
|
205
261
|
|
206
262
|
|
207
263
|
|
@@ -330,7 +386,10 @@
|
|
330
386
|
8
|
331
387
|
9
|
332
388
|
10
|
333
|
-
11
|
389
|
+
11
|
390
|
+
12
|
391
|
+
13
|
392
|
+
14</pre>
|
334
393
|
</td>
|
335
394
|
<td>
|
336
395
|
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 5</span>
|
@@ -338,9 +397,12 @@
|
|
338
397
|
<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>
|
339
398
|
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
340
399
|
|
341
|
-
<span class='ivar'>@name</span>
|
342
|
-
<span class='ivar'>@mac</span>
|
343
|
-
<span class='ivar'>@ports</span>
|
400
|
+
<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>
|
401
|
+
<span class='ivar'>@mac</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'>mac</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
402
|
+
<span class='ivar'>@ports</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'>ports</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
403
|
+
<span class='ivar'>@last_seen</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'>last-seen</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
404
|
+
<span class='ivar'>@firmware</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'>versions</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sensor</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
405
|
+
|
344
406
|
<span class='kw'>end</span></pre>
|
345
407
|
</td>
|
346
408
|
</tr>
|
@@ -355,7 +417,108 @@
|
|
355
417
|
|
356
418
|
<span id=""></span>
|
357
419
|
<div class="method_details first">
|
358
|
-
<h3 class="signature first" id="
|
420
|
+
<h3 class="signature first" id="firmware-instance_method">
|
421
|
+
|
422
|
+
#<strong>firmware</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
</h3><div class="docstring">
|
429
|
+
<div class="discussion">
|
430
|
+
<p>Returns the value of attribute firmware</p>
|
431
|
+
|
432
|
+
|
433
|
+
</div>
|
434
|
+
</div>
|
435
|
+
<div class="tags">
|
436
|
+
|
437
|
+
|
438
|
+
</div><table class="source_code">
|
439
|
+
<tr>
|
440
|
+
<td>
|
441
|
+
<pre class="lines">
|
442
|
+
|
443
|
+
|
444
|
+
3
|
445
|
+
4
|
446
|
+
5</pre>
|
447
|
+
</td>
|
448
|
+
<td>
|
449
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
450
|
+
|
451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_firmware'>firmware</span>
|
452
|
+
<span class='ivar'>@firmware</span>
|
453
|
+
<span class='kw'>end</span></pre>
|
454
|
+
</td>
|
455
|
+
</tr>
|
456
|
+
</table>
|
457
|
+
</div>
|
458
|
+
|
459
|
+
|
460
|
+
<span id=""></span>
|
461
|
+
<div class="method_details ">
|
462
|
+
<h3 class="signature " id="last_seen-instance_method">
|
463
|
+
|
464
|
+
#<strong>last_seen</strong> ⇒ <tt>DateTime</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
</h3><div class="docstring">
|
471
|
+
<div class="discussion">
|
472
|
+
<p>Returns when the resource was last seen</p>
|
473
|
+
|
474
|
+
|
475
|
+
</div>
|
476
|
+
</div>
|
477
|
+
<div class="tags">
|
478
|
+
|
479
|
+
<p class="tag_title">Returns:</p>
|
480
|
+
<ul class="return">
|
481
|
+
|
482
|
+
<li>
|
483
|
+
|
484
|
+
|
485
|
+
<span class='type'>(<tt>DateTime</tt>, <tt>nil</tt>)</span>
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
—
|
490
|
+
<div class='inline'><p>when the resource was last seen</p>
|
491
|
+
</div>
|
492
|
+
|
493
|
+
</li>
|
494
|
+
|
495
|
+
</ul>
|
496
|
+
|
497
|
+
</div><table class="source_code">
|
498
|
+
<tr>
|
499
|
+
<td>
|
500
|
+
<pre class="lines">
|
501
|
+
|
502
|
+
|
503
|
+
35
|
504
|
+
36
|
505
|
+
37</pre>
|
506
|
+
</td>
|
507
|
+
<td>
|
508
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 35</span>
|
509
|
+
|
510
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_last_seen'>last_seen</span>
|
511
|
+
<span class='ivar'>@last_seen</span>
|
512
|
+
<span class='kw'>end</span></pre>
|
513
|
+
</td>
|
514
|
+
</tr>
|
515
|
+
</table>
|
516
|
+
</div>
|
517
|
+
|
518
|
+
|
519
|
+
<span id=""></span>
|
520
|
+
<div class="method_details ">
|
521
|
+
<h3 class="signature " id="mac-instance_method">
|
359
522
|
|
360
523
|
#<strong>mac</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
361
524
|
|
@@ -510,22 +673,26 @@
|
|
510
673
|
<pre class="lines">
|
511
674
|
|
512
675
|
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
676
|
+
41
|
677
|
+
42
|
678
|
+
43
|
679
|
+
44
|
680
|
+
45
|
681
|
+
46
|
682
|
+
47
|
683
|
+
48
|
684
|
+
49</pre>
|
520
685
|
</td>
|
521
686
|
<td>
|
522
|
-
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line
|
687
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 41</span>
|
523
688
|
|
524
689
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
525
690
|
<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>
|
526
691
|
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
527
692
|
<span class='label'>mac:</span> <span class='id identifier rubyid_mac'>mac</span><span class='comma'>,</span>
|
528
|
-
<span class='label'>ports:</span> <span class='id identifier rubyid_ports'>ports</span>
|
693
|
+
<span class='label'>ports:</span> <span class='id identifier rubyid_ports'>ports</span><span class='comma'>,</span>
|
694
|
+
<span class='label'>last_seen:</span> <span class='id identifier rubyid_last_seen'>last_seen</span><span class='comma'>,</span>
|
695
|
+
<span class='label'>firmware:</span> <span class='id identifier rubyid_firmware'>firmware</span>
|
529
696
|
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
530
697
|
<span class='kw'>end</span></pre>
|
531
698
|
</td>
|
@@ -548,9 +715,6 @@
|
|
548
715
|
<pre class="lines">
|
549
716
|
|
550
717
|
|
551
|
-
13
|
552
|
-
14
|
553
|
-
15
|
554
718
|
16
|
555
719
|
17
|
556
720
|
18
|
@@ -564,10 +728,13 @@
|
|
564
728
|
26
|
565
729
|
27
|
566
730
|
28
|
567
|
-
29
|
731
|
+
29
|
732
|
+
30
|
733
|
+
31
|
734
|
+
32</pre>
|
568
735
|
</td>
|
569
736
|
<td>
|
570
|
-
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line
|
737
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 16</span>
|
571
738
|
|
572
739
|
<span class='kw'>def</span> <span class='id identifier rubyid_timeseries'>timeseries</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>
|
573
740
|
<span class='id identifier rubyid_size'>size</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'>:size</span><span class='comma'>,</span> <span class='int'>1000</span><span class='rparen'>)</span>
|
@@ -596,7 +763,7 @@
|
|
596
763
|
</div>
|
597
764
|
|
598
765
|
<div id="footer">
|
599
|
-
Generated on
|
766
|
+
Generated on Tue Aug 30 08:16:47 2016 by
|
600
767
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
601
768
|
0.9.3 (ruby-2.3.1).
|
602
769
|
</div>
|