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.
- 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
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: Helium::Client::Elements
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -130,7 +130,29 @@
|
|
130
130
|
<li class="public ">
|
131
131
|
<span class="summary_signature">
|
132
132
|
|
133
|
-
<a href="#
|
133
|
+
<a href="#element_device_configuration-instance_method" title="#element_device_configuration (instance method)">#<strong>element_device_configuration</strong>(element) ⇒ Object </a>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
</span>
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
148
|
+
|
149
|
+
</li>
|
150
|
+
|
151
|
+
|
152
|
+
<li class="public ">
|
153
|
+
<span class="summary_signature">
|
154
|
+
|
155
|
+
<a href="#element_timeseries-instance_method" title="#element_timeseries (instance method)">#<strong>element_timeseries</strong>(element, opts = {}) ⇒ Object </a>
|
134
156
|
|
135
157
|
|
136
158
|
|
@@ -211,9 +233,9 @@
|
|
211
233
|
</div>
|
212
234
|
|
213
235
|
<div class="method_details ">
|
214
|
-
<h3 class="signature " id="
|
236
|
+
<h3 class="signature " id="element_device_configuration-instance_method">
|
215
237
|
|
216
|
-
#<strong>
|
238
|
+
#<strong>element_device_configuration</strong>(element) ⇒ <tt>Object</tt>
|
217
239
|
|
218
240
|
|
219
241
|
|
@@ -231,25 +253,77 @@
|
|
231
253
|
15
|
232
254
|
16
|
233
255
|
17
|
234
|
-
18
|
235
|
-
19
|
236
|
-
20
|
237
|
-
21
|
238
|
-
22</pre>
|
256
|
+
18</pre>
|
239
257
|
</td>
|
240
258
|
<td>
|
241
259
|
<pre class="code"><span class="info file"># File 'lib/helium/client/elements.rb', line 12</span>
|
242
260
|
|
243
|
-
<span class='kw'>def</span> <span class='id identifier
|
244
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/element/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'
|
261
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_element_device_configuration'>element_device_configuration</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
|
262
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/element/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/device-configuration</span><span class='tstring_end'>"</span></span>
|
245
263
|
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
246
|
-
<span class='id identifier
|
264
|
+
<span class='id identifier rubyid_dc_data'>dc_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>
|
265
|
+
<span class='comment'># dc_data is an array, but there will only be one for one
|
266
|
+
</span> <span class='kw'>return</span> <span class='const'>DeviceConfiguration</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_dc_data'>dc_data</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
267
|
+
<span class='kw'>end</span></pre>
|
268
|
+
</td>
|
269
|
+
</tr>
|
270
|
+
</table>
|
271
|
+
</div>
|
272
|
+
|
273
|
+
<div class="method_details ">
|
274
|
+
<h3 class="signature " id="element_timeseries-instance_method">
|
275
|
+
|
276
|
+
#<strong>element_timeseries</strong>(element, opts = {}) ⇒ <tt>Object</tt>
|
277
|
+
|
278
|
+
|
279
|
+
|
247
280
|
|
248
|
-
|
249
|
-
|
250
|
-
<
|
281
|
+
|
282
|
+
</h3><table class="source_code">
|
283
|
+
<tr>
|
284
|
+
<td>
|
285
|
+
<pre class="lines">
|
251
286
|
|
252
|
-
|
287
|
+
|
288
|
+
20
|
289
|
+
21
|
290
|
+
22
|
291
|
+
23
|
292
|
+
24
|
293
|
+
25
|
294
|
+
26
|
295
|
+
27
|
296
|
+
28
|
297
|
+
29
|
298
|
+
30
|
299
|
+
31
|
300
|
+
32
|
301
|
+
33
|
302
|
+
34
|
303
|
+
35
|
304
|
+
36
|
305
|
+
37</pre>
|
306
|
+
</td>
|
307
|
+
<td>
|
308
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/elements.rb', line 20</span>
|
309
|
+
|
310
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_element_timeseries'>element_timeseries</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</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>
|
311
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/element/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_element'>element</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>
|
312
|
+
|
313
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
314
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page[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'>:size</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
|
315
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter[port]</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'>:port</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
|
316
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter[start]</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'>:start_time</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span>
|
317
|
+
<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>
|
318
|
+
<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>
|
319
|
+
<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>
|
320
|
+
<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>
|
321
|
+
|
322
|
+
<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>
|
323
|
+
<span class='label'>klass:</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>DataPoint</span><span class='comma'>,</span>
|
324
|
+
<span class='label'>cursor_klass:</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>Timeseries</span><span class='comma'>,</span>
|
325
|
+
<span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span>
|
326
|
+
<span class='rparen'>)</span>
|
253
327
|
<span class='kw'>end</span></pre>
|
254
328
|
</td>
|
255
329
|
</tr>
|
@@ -291,9 +365,9 @@
|
|
291
365
|
</div>
|
292
366
|
|
293
367
|
<div id="footer">
|
294
|
-
Generated on Thu
|
368
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
295
369
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
296
|
-
0.9.
|
370
|
+
0.9.5 (ruby-2.3.1).
|
297
371
|
</div>
|
298
372
|
|
299
373
|
</div>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: Helium::Client::Http
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -246,6 +246,28 @@
|
|
246
246
|
|
247
247
|
|
248
248
|
|
249
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
250
|
+
|
251
|
+
</li>
|
252
|
+
|
253
|
+
|
254
|
+
<li class="public ">
|
255
|
+
<span class="summary_signature">
|
256
|
+
|
257
|
+
<a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, opts = {}) ⇒ Object </a>
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
</span>
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
249
271
|
<span class="summary_desc"><div class='inline'></div></span>
|
250
272
|
|
251
273
|
</li>
|
@@ -298,15 +320,19 @@
|
|
298
320
|
<pre class="lines">
|
299
321
|
|
300
322
|
|
301
|
-
|
302
|
-
|
303
|
-
|
323
|
+
39
|
324
|
+
40
|
325
|
+
41
|
326
|
+
42
|
327
|
+
43</pre>
|
304
328
|
</td>
|
305
329
|
<td>
|
306
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line
|
330
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 39</span>
|
307
331
|
|
308
332
|
<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
|
309
|
-
<span class='
|
333
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>PROTOCOL</span><span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_host</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
334
|
+
<span class='id identifier rubyid_url'>url</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='ivar'>@api_version</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@api_version</span>
|
335
|
+
<span class='id identifier rubyid_url'>url</span>
|
310
336
|
<span class='kw'>end</span></pre>
|
311
337
|
</td>
|
312
338
|
</tr>
|
@@ -328,13 +354,13 @@
|
|
328
354
|
<pre class="lines">
|
329
355
|
|
330
356
|
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
357
|
+
34
|
358
|
+
35
|
359
|
+
36
|
360
|
+
37</pre>
|
335
361
|
</td>
|
336
362
|
<td>
|
337
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line
|
363
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 34</span>
|
338
364
|
|
339
365
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
340
366
|
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:delete</span><span class='rparen'>)</span>
|
@@ -395,16 +421,18 @@
|
|
395
421
|
16
|
396
422
|
17
|
397
423
|
18
|
398
|
-
19
|
424
|
+
19
|
425
|
+
20</pre>
|
399
426
|
</td>
|
400
427
|
<td>
|
401
428
|
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 14</span>
|
402
429
|
|
403
430
|
<span class='kw'>def</span> <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='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
404
431
|
<span class='id identifier rubyid_klass'>klass</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'>:klass</span><span class='rparen'>)</span>
|
432
|
+
<span class='id identifier rubyid_cursor_klass'>cursor_klass</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'>:cursor_klass</span><span class='comma'>,</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>Cursor</span><span class='rparen'>)</span>
|
405
433
|
<span class='id identifier rubyid_params'>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='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
406
434
|
|
407
|
-
<span class='
|
435
|
+
<span class='id identifier rubyid_cursor_klass'>cursor_klass</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'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>klass:</span> <span class='id identifier rubyid_klass'>klass</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
408
436
|
<span class='kw'>end</span></pre>
|
409
437
|
</td>
|
410
438
|
</tr>
|
@@ -426,12 +454,12 @@
|
|
426
454
|
<pre class="lines">
|
427
455
|
|
428
456
|
|
429
|
-
25
|
430
457
|
26
|
431
|
-
27
|
458
|
+
27
|
459
|
+
28</pre>
|
432
460
|
</td>
|
433
461
|
<td>
|
434
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line
|
462
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 26</span>
|
435
463
|
|
436
464
|
<span class='kw'>def</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='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
437
465
|
<span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
@@ -456,12 +484,12 @@
|
|
456
484
|
<pre class="lines">
|
457
485
|
|
458
486
|
|
459
|
-
21
|
460
487
|
22
|
461
|
-
23
|
488
|
+
23
|
489
|
+
24</pre>
|
462
490
|
</td>
|
463
491
|
<td>
|
464
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line
|
492
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 22</span>
|
465
493
|
|
466
494
|
<span class='kw'>def</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='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
467
495
|
<span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
@@ -469,6 +497,36 @@
|
|
469
497
|
</td>
|
470
498
|
</tr>
|
471
499
|
</table>
|
500
|
+
</div>
|
501
|
+
|
502
|
+
<div class="method_details ">
|
503
|
+
<h3 class="signature " id="put-instance_method">
|
504
|
+
|
505
|
+
#<strong>put</strong>(path, opts = {}) ⇒ <tt>Object</tt>
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
</h3><table class="source_code">
|
512
|
+
<tr>
|
513
|
+
<td>
|
514
|
+
<pre class="lines">
|
515
|
+
|
516
|
+
|
517
|
+
30
|
518
|
+
31
|
519
|
+
32</pre>
|
520
|
+
</td>
|
521
|
+
<td>
|
522
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 30</span>
|
523
|
+
|
524
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</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>
|
525
|
+
<span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
526
|
+
<span class='kw'>end</span></pre>
|
527
|
+
</td>
|
528
|
+
</tr>
|
529
|
+
</table>
|
472
530
|
</div>
|
473
531
|
|
474
532
|
<div class="method_details ">
|
@@ -497,15 +555,15 @@ it will simply pass through</p>
|
|
497
555
|
<pre class="lines">
|
498
556
|
|
499
557
|
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
558
|
+
47
|
559
|
+
48
|
560
|
+
49
|
561
|
+
50
|
562
|
+
51
|
563
|
+
52</pre>
|
506
564
|
</td>
|
507
565
|
<td>
|
508
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line
|
566
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 47</span>
|
509
567
|
|
510
568
|
<span class='kw'>def</span> <span class='id identifier rubyid_url_for'>url_for</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
511
569
|
<span class='kw'>return</span> <span class='id identifier rubyid_path'>path</span> <span class='kw'>if</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^http</span><span class='regexp_end'>/</span></span>
|
@@ -523,9 +581,9 @@ it will simply pass through</p>
|
|
523
581
|
</div>
|
524
582
|
|
525
583
|
<div id="footer">
|
526
|
-
Generated on Thu
|
584
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
527
585
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
528
|
-
0.9.
|
586
|
+
0.9.5 (ruby-2.3.1).
|
529
587
|
</div>
|
530
588
|
|
531
589
|
</div>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: Helium::Client::Labels
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -144,28 +144,6 @@
|
|
144
144
|
|
145
145
|
|
146
146
|
|
147
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
148
|
-
|
149
|
-
</li>
|
150
|
-
|
151
|
-
|
152
|
-
<li class="public ">
|
153
|
-
<span class="summary_signature">
|
154
|
-
|
155
|
-
<a href="#label_sensors-instance_method" title="#label_sensors (instance method)">#<strong>label_sensors</strong>(label) ⇒ Object </a>
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
</span>
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
147
|
<span class="summary_desc"><div class='inline'></div></span>
|
170
148
|
|
171
149
|
</li>
|
@@ -210,7 +188,8 @@
|
|
210
188
|
|
211
189
|
|
212
190
|
|
213
|
-
<span class="summary_desc"><div class='inline'
|
191
|
+
<span class="summary_desc"><div class='inline'><p>TODO incorporate this logic into Helium::Collection.</p>
|
192
|
+
</div></span>
|
214
193
|
|
215
194
|
</li>
|
216
195
|
|
@@ -282,52 +261,6 @@
|
|
282
261
|
</td>
|
283
262
|
</tr>
|
284
263
|
</table>
|
285
|
-
</div>
|
286
|
-
|
287
|
-
<div class="method_details ">
|
288
|
-
<h3 class="signature " id="label_sensors-instance_method">
|
289
|
-
|
290
|
-
#<strong>label_sensors</strong>(label) ⇒ <tt>Object</tt>
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
</h3><table class="source_code">
|
297
|
-
<tr>
|
298
|
-
<td>
|
299
|
-
<pre class="lines">
|
300
|
-
|
301
|
-
|
302
|
-
16
|
303
|
-
17
|
304
|
-
18
|
305
|
-
19
|
306
|
-
20
|
307
|
-
21
|
308
|
-
22
|
309
|
-
23
|
310
|
-
24
|
311
|
-
25
|
312
|
-
26</pre>
|
313
|
-
</td>
|
314
|
-
<td>
|
315
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 16</span>
|
316
|
-
|
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>
|
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>
|
319
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
320
|
-
<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>
|
321
|
-
|
322
|
-
<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>
|
323
|
-
<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>
|
324
|
-
<span class='kw'>end</span>
|
325
|
-
|
326
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_sensors'>sensors</span>
|
327
|
-
<span class='kw'>end</span></pre>
|
328
|
-
</td>
|
329
|
-
</tr>
|
330
|
-
</table>
|
331
264
|
</div>
|
332
265
|
|
333
266
|
<div class="method_details ">
|
@@ -369,12 +302,33 @@
|
|
369
302
|
|
370
303
|
|
371
304
|
|
372
|
-
</h3><
|
305
|
+
</h3><div class="docstring">
|
306
|
+
<div class="discussion">
|
307
|
+
<p>TODO incorporate this logic into Helium::Collection</p>
|
308
|
+
|
309
|
+
|
310
|
+
</div>
|
311
|
+
</div>
|
312
|
+
<div class="tags">
|
313
|
+
|
314
|
+
|
315
|
+
</div><table class="source_code">
|
373
316
|
<tr>
|
374
317
|
<td>
|
375
318
|
<pre class="lines">
|
376
319
|
|
377
320
|
|
321
|
+
17
|
322
|
+
18
|
323
|
+
19
|
324
|
+
20
|
325
|
+
21
|
326
|
+
22
|
327
|
+
23
|
328
|
+
24
|
329
|
+
25
|
330
|
+
26
|
331
|
+
27
|
378
332
|
28
|
379
333
|
29
|
380
334
|
30
|
@@ -392,21 +346,10 @@
|
|
392
346
|
42
|
393
347
|
43
|
394
348
|
44
|
395
|
-
45
|
396
|
-
46
|
397
|
-
47
|
398
|
-
48
|
399
|
-
49
|
400
|
-
50
|
401
|
-
51
|
402
|
-
52
|
403
|
-
53
|
404
|
-
54
|
405
|
-
55
|
406
|
-
56</pre>
|
349
|
+
45</pre>
|
407
350
|
</td>
|
408
351
|
<td>
|
409
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line
|
352
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/labels.rb', line 17</span>
|
410
353
|
|
411
354
|
<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
355
|
<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>
|
@@ -447,9 +390,9 @@
|
|
447
390
|
</div>
|
448
391
|
|
449
392
|
<div id="footer">
|
450
|
-
Generated on Thu
|
393
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
451
394
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
452
|
-
0.9.
|
395
|
+
0.9.5 (ruby-2.3.1).
|
453
396
|
</div>
|
454
397
|
|
455
398
|
</div>
|