helium-ruby 0.20.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +47 -0
- data/docs/Helium.html +6 -6
- data/docs/Helium/Client.html +62 -34
- data/docs/Helium/Client/Configurations.html +296 -0
- data/docs/Helium/Client/DeviceConfigurations.html +465 -0
- data/docs/Helium/Client/Elements.html +92 -18
- data/docs/Helium/Client/Http.html +86 -28
- data/docs/Helium/Client/Labels.html +29 -86
- data/docs/Helium/Client/Organizations.html +5 -75
- data/docs/Helium/Client/Sensors.html +147 -17
- data/docs/Helium/Client/Users.html +5 -9
- data/docs/Helium/ClientError.html +3 -3
- data/docs/Helium/Collection.html +1053 -0
- data/docs/Helium/Configuration.html +380 -0
- data/docs/Helium/Cursor.html +7 -3
- data/docs/Helium/DataPoint.html +16 -5
- data/docs/Helium/DeviceConfiguration.html +476 -0
- data/docs/Helium/Element.html +203 -43
- data/docs/Helium/Error.html +15 -5
- data/docs/Helium/InvalidApiKey.html +3 -3
- data/docs/Helium/Label.html +35 -36
- data/docs/Helium/Metadata.html +589 -0
- data/docs/Helium/Organization.html +236 -17
- data/docs/Helium/Resource.html +655 -161
- data/docs/Helium/Sensor.html +345 -111
- data/docs/Helium/Timeseries.html +354 -0
- data/docs/Helium/User.html +161 -18
- data/docs/Helium/Utils.html +56 -4
- data/docs/_index.html +72 -7
- data/docs/class_list.html +1 -1
- data/docs/css/style.css +8 -1
- data/docs/file.README.html +66 -6
- data/docs/frames.html +1 -1
- data/docs/index.html +66 -6
- data/docs/method_list.html +619 -139
- data/docs/top-level-namespace.html +3 -3
- data/lib/helium.rb +2 -0
- data/lib/helium/client/configurations.rb +0 -12
- data/lib/helium/client/elements.rb +0 -12
- data/lib/helium/client/labels.rb +1 -12
- data/lib/helium/client/organizations.rb +1 -47
- data/lib/helium/client/sensors.rb +0 -12
- data/lib/helium/client/users.rb +1 -3
- data/lib/helium/collection.rb +129 -0
- data/lib/helium/configuration.rb +5 -1
- data/lib/helium/element.rb +1 -1
- data/lib/helium/label.rb +1 -3
- data/lib/helium/metadata.rb +58 -0
- data/lib/helium/organization.rb +4 -4
- data/lib/helium/resource.rb +28 -29
- data/lib/helium/sensor.rb +1 -1
- data/lib/helium/version.rb +1 -1
- metadata +11 -2
data/docs/Helium/Utils.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Module: Helium::Utils
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.5
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
|
|
79
79
|
<dl>
|
|
80
80
|
<dt>Included in:</dt>
|
|
81
|
-
<dd><span class='object_link'><a href="Client.html" title="Helium::Client (class)">Client</a></span></dd>
|
|
81
|
+
<dd><span class='object_link'><a href="Client.html" title="Helium::Client (class)">Client</a></span>, <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Timeseries.html" title="Helium::Timeseries (class)">Timeseries</a></span></dd>
|
|
82
82
|
</dl>
|
|
83
83
|
|
|
84
84
|
|
|
@@ -122,6 +122,28 @@
|
|
|
122
122
|
|
|
123
123
|
|
|
124
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="#kebab_case-instance_method" title="#kebab_case (instance method)">#<strong>kebab_case</strong>(string) ⇒ Object </a>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</span>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
125
147
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
126
148
|
|
|
127
149
|
</li>
|
|
@@ -166,6 +188,36 @@
|
|
|
166
188
|
</td>
|
|
167
189
|
</tr>
|
|
168
190
|
</table>
|
|
191
|
+
</div>
|
|
192
|
+
|
|
193
|
+
<div class="method_details ">
|
|
194
|
+
<h3 class="signature " id="kebab_case-instance_method">
|
|
195
|
+
|
|
196
|
+
#<strong>kebab_case</strong>(string) ⇒ <tt>Object</tt>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
</h3><table class="source_code">
|
|
203
|
+
<tr>
|
|
204
|
+
<td>
|
|
205
|
+
<pre class="lines">
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
8
|
|
209
|
+
9
|
|
210
|
+
10</pre>
|
|
211
|
+
</td>
|
|
212
|
+
<td>
|
|
213
|
+
<pre class="code"><span class="info file"># File 'lib/helium/utils.rb', line 8</span>
|
|
214
|
+
|
|
215
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_kebab_case'>kebab_case</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
|
|
216
|
+
<span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(.)([A-Z])</span><span class='regexp_end'>/</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\1-\2</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
|
217
|
+
<span class='kw'>end</span></pre>
|
|
218
|
+
</td>
|
|
219
|
+
</tr>
|
|
220
|
+
</table>
|
|
169
221
|
</div>
|
|
170
222
|
|
|
171
223
|
</div>
|
|
@@ -173,9 +225,9 @@
|
|
|
173
225
|
</div>
|
|
174
226
|
|
|
175
227
|
<div id="footer">
|
|
176
|
-
Generated on Thu
|
|
228
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
|
177
229
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
178
|
-
0.9.
|
|
230
|
+
0.9.5 (ruby-2.3.1).
|
|
179
231
|
</div>
|
|
180
232
|
|
|
181
233
|
</div>
|
data/docs/_index.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<title>
|
|
7
|
-
Documentation by YARD 0.9.
|
|
7
|
+
Documentation by YARD 0.9.5
|
|
8
8
|
|
|
9
9
|
</title>
|
|
10
10
|
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
|
|
55
55
|
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
56
56
|
|
|
57
|
-
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.
|
|
57
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.5</h1>
|
|
58
58
|
<div id="listing">
|
|
59
59
|
<h1 class="alphaindex">Alphabetic Index</h1>
|
|
60
60
|
|
|
@@ -96,6 +96,27 @@
|
|
|
96
96
|
|
|
97
97
|
</li>
|
|
98
98
|
|
|
99
|
+
<li>
|
|
100
|
+
<span class='object_link'><a href="Helium/Collection.html" title="Helium::Collection (class)">Collection</a></span>
|
|
101
|
+
|
|
102
|
+
<small>(Helium)</small>
|
|
103
|
+
|
|
104
|
+
</li>
|
|
105
|
+
|
|
106
|
+
<li>
|
|
107
|
+
<span class='object_link'><a href="Helium/Configuration.html" title="Helium::Configuration (class)">Configuration</a></span>
|
|
108
|
+
|
|
109
|
+
<small>(Helium)</small>
|
|
110
|
+
|
|
111
|
+
</li>
|
|
112
|
+
|
|
113
|
+
<li>
|
|
114
|
+
<span class='object_link'><a href="Helium/Client/Configurations.html" title="Helium::Client::Configurations (module)">Configurations</a></span>
|
|
115
|
+
|
|
116
|
+
<small>(Helium::Client)</small>
|
|
117
|
+
|
|
118
|
+
</li>
|
|
119
|
+
|
|
99
120
|
<li>
|
|
100
121
|
<span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span>
|
|
101
122
|
|
|
@@ -118,6 +139,20 @@
|
|
|
118
139
|
|
|
119
140
|
</li>
|
|
120
141
|
|
|
142
|
+
<li>
|
|
143
|
+
<span class='object_link'><a href="Helium/DeviceConfiguration.html" title="Helium::DeviceConfiguration (class)">DeviceConfiguration</a></span>
|
|
144
|
+
|
|
145
|
+
<small>(Helium)</small>
|
|
146
|
+
|
|
147
|
+
</li>
|
|
148
|
+
|
|
149
|
+
<li>
|
|
150
|
+
<span class='object_link'><a href="Helium/Client/DeviceConfigurations.html" title="Helium::Client::DeviceConfigurations (module)">DeviceConfigurations</a></span>
|
|
151
|
+
|
|
152
|
+
<small>(Helium::Client)</small>
|
|
153
|
+
|
|
154
|
+
</li>
|
|
155
|
+
|
|
121
156
|
</ul>
|
|
122
157
|
</ul>
|
|
123
158
|
|
|
@@ -208,6 +243,24 @@
|
|
|
208
243
|
</ul>
|
|
209
244
|
|
|
210
245
|
|
|
246
|
+
<ul id="alpha_M" class="alpha">
|
|
247
|
+
<li class="letter">M</li>
|
|
248
|
+
<ul>
|
|
249
|
+
|
|
250
|
+
<li>
|
|
251
|
+
<span class='object_link'><a href="Helium/Metadata.html" title="Helium::Metadata (class)">Metadata</a></span>
|
|
252
|
+
|
|
253
|
+
<small>(Helium)</small>
|
|
254
|
+
|
|
255
|
+
</li>
|
|
256
|
+
|
|
257
|
+
</ul>
|
|
258
|
+
</ul>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
</td><td valign='top' width="33%">
|
|
262
|
+
|
|
263
|
+
|
|
211
264
|
<ul id="alpha_O" class="alpha">
|
|
212
265
|
<li class="letter">O</li>
|
|
213
266
|
<ul>
|
|
@@ -230,9 +283,6 @@
|
|
|
230
283
|
</ul>
|
|
231
284
|
|
|
232
285
|
|
|
233
|
-
</td><td valign='top' width="33%">
|
|
234
|
-
|
|
235
|
-
|
|
236
286
|
<ul id="alpha_R" class="alpha">
|
|
237
287
|
<li class="letter">R</li>
|
|
238
288
|
<ul>
|
|
@@ -270,6 +320,21 @@
|
|
|
270
320
|
</ul>
|
|
271
321
|
|
|
272
322
|
|
|
323
|
+
<ul id="alpha_T" class="alpha">
|
|
324
|
+
<li class="letter">T</li>
|
|
325
|
+
<ul>
|
|
326
|
+
|
|
327
|
+
<li>
|
|
328
|
+
<span class='object_link'><a href="Helium/Timeseries.html" title="Helium::Timeseries (class)">Timeseries</a></span>
|
|
329
|
+
|
|
330
|
+
<small>(Helium)</small>
|
|
331
|
+
|
|
332
|
+
</li>
|
|
333
|
+
|
|
334
|
+
</ul>
|
|
335
|
+
</ul>
|
|
336
|
+
|
|
337
|
+
|
|
273
338
|
<ul id="alpha_U" class="alpha">
|
|
274
339
|
<li class="letter">U</li>
|
|
275
340
|
<ul>
|
|
@@ -307,9 +372,9 @@
|
|
|
307
372
|
</div>
|
|
308
373
|
|
|
309
374
|
<div id="footer">
|
|
310
|
-
Generated on Thu
|
|
375
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
|
311
376
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
312
|
-
0.9.
|
|
377
|
+
0.9.5 (ruby-2.3.1).
|
|
313
378
|
</div>
|
|
314
379
|
|
|
315
380
|
</div>
|
data/docs/class_list.html
CHANGED
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
|
|
44
44
|
<ul id="full_list" class="class">
|
|
45
45
|
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
|
|
46
|
-
<li id='object_Helium' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Helium.html" title="Helium (module)">Helium</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Helium::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Helium/Client.html" title="Helium::Client (class)">Client</a></span> < Object<small class='search_info'>Helium</small></div><ul><li id='object_Helium::Client::Elements' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Http' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Http.html" title="Helium::Client::Http (module)">Http</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Labels' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Organizations' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Sensors' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Users' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Users.html" title="Helium::Client::Users (module)">Users</a></span><small class='search_info'>Helium::Client</small></div></li></ul></li><li id='object_Helium::ClientError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/ClientError.html" title="Helium::ClientError (class)">ClientError</a></span> < Error<small class='search_info'>Helium</small></div></li><li id='object_Helium::Cursor' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::DataPoint' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::
|
|
46
|
+
<li id='object_Helium' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Helium.html" title="Helium (module)">Helium</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Helium::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Helium/Client.html" title="Helium::Client (class)">Client</a></span> < Object<small class='search_info'>Helium</small></div><ul><li id='object_Helium::Client::Configurations' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Configurations.html" title="Helium::Client::Configurations (module)">Configurations</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::DeviceConfigurations' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/DeviceConfigurations.html" title="Helium::Client::DeviceConfigurations (module)">DeviceConfigurations</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Elements' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Http' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Http.html" title="Helium::Client::Http (module)">Http</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Labels' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Organizations' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Sensors' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Users' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Users.html" title="Helium::Client::Users (module)">Users</a></span><small class='search_info'>Helium::Client</small></div></li></ul></li><li id='object_Helium::ClientError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/ClientError.html" title="Helium::ClientError (class)">ClientError</a></span> < Error<small class='search_info'>Helium</small></div></li><li id='object_Helium::Collection' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Collection.html" title="Helium::Collection (class)">Collection</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::Configuration' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Configuration.html" title="Helium::Configuration (class)">Configuration</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Cursor' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::DataPoint' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::DeviceConfiguration' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/DeviceConfiguration.html" title="Helium::DeviceConfiguration (class)">DeviceConfiguration</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Element' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Element.html" title="Helium::Element (class)">Element</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Error' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Error.html" title="Helium::Error (class)">Error</a></span> < StandardError<small class='search_info'>Helium</small></div></li><li id='object_Helium::InvalidApiKey' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/InvalidApiKey.html" title="Helium::InvalidApiKey (class)">InvalidApiKey</a></span> < ClientError<small class='search_info'>Helium</small></div></li><li id='object_Helium::Label' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Label.html" title="Helium::Label (class)">Label</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Metadata' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Metadata.html" title="Helium::Metadata (class)">Metadata</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::Organization' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Organization.html" title="Helium::Organization (class)">Organization</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Resource' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Resource.html" title="Helium::Resource (class)">Resource</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::Sensor' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Sensor.html" title="Helium::Sensor (class)">Sensor</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Timeseries' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Timeseries.html" title="Helium::Timeseries (class)">Timeseries</a></span> < Cursor<small class='search_info'>Helium</small></div></li><li id='object_Helium::User' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/User.html" title="Helium::User (class)">User</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Utils' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Utils.html" title="Helium::Utils (module)">Utils</a></span><small class='search_info'>Helium</small></div></li></ul></li>
|
|
47
47
|
|
|
48
48
|
</ul>
|
|
49
49
|
</div>
|
data/docs/css/style.css
CHANGED
|
@@ -215,7 +215,14 @@ p.inherited {
|
|
|
215
215
|
|
|
216
216
|
ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
|
|
217
217
|
.index_inline_list { padding-left: 0; font-size: 1.1em; }
|
|
218
|
-
|
|
218
|
+
|
|
219
|
+
.index_inline_list li {
|
|
220
|
+
list-style: none;
|
|
221
|
+
display: inline-block;
|
|
222
|
+
padding: 0 12px;
|
|
223
|
+
line-height: 30px;
|
|
224
|
+
margin-bottom: 5px;
|
|
225
|
+
}
|
|
219
226
|
|
|
220
227
|
dl.constants { margin-left: 10px; }
|
|
221
228
|
dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
|
data/docs/file.README.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
File: README
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.5
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -71,9 +71,9 @@
|
|
|
71
71
|
<h2>Helium Documentation and Community Support</h2>
|
|
72
72
|
|
|
73
73
|
<ul>
|
|
74
|
-
<li><p><strong>helium-ruby docs</strong> - Documentation for the gem's source can be found <a href="https://helium.github.io/helium-ruby/">here</a
|
|
75
|
-
<li><p><strong>Helium Docs</strong> Complete documenation for all parts of Helium can be found at <a href="https://docs/helium.com">docs.helium.com</a
|
|
76
|
-
<li><p><strong>chat.helium.com</strong> - If you have questions or ideas about how to use this code - or any part of Helium - head over the <a href="
|
|
74
|
+
<li><p><strong>helium-ruby docs</strong> - Documentation for the gem's source can be found <a href="https://helium.github.io/helium-ruby/">here</a>:</p></li>
|
|
75
|
+
<li><p><strong>Helium Docs</strong> Complete documenation for all parts of Helium can be found at <a href="https://docs/helium.com">docs.helium.com</a>.</p></li>
|
|
76
|
+
<li><p><strong>chat.helium.com</strong> - If you have questions or ideas about how to use this code - or any part of Helium - head over the <a href="http://chat.helium.com">chat.helium.com</a>. We're standing by to help.</p></li>
|
|
77
77
|
</ul>
|
|
78
78
|
|
|
79
79
|
<h2>Installation</h2>
|
|
@@ -237,6 +237,14 @@
|
|
|
237
237
|
|
|
238
238
|
<p>A full list of aggregation types and sizes can be found here: <a href="https://docs.helium.com/docs/timeseries#aggregations">https://docs.helium.com/docs/timeseries#aggregations</a>.</p>
|
|
239
239
|
|
|
240
|
+
<h4>Creating Timeseries data</h4>
|
|
241
|
+
|
|
242
|
+
<p>Data points can be written to a sensor's timeseries data.</p>
|
|
243
|
+
|
|
244
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_timeseries'>timeseries</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>port:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>power level</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>value:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>over 9000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>timestamp:</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
|
|
245
|
+
<span class='comment'># => #<Helium::DataPoint:0x007f88634b9e50 @params={"attributes"=>{"value"=>"over 9000", "timestamp"=>"2016-09-26T23:19:01Z", "port"=>"power level"}, "relationships"=>{"sensor"=>{"data"=>{"id"=>"071488bb-3050-4849-8984-ca9e683cfc91", "type"=>"sensor"}}}, "id"=>"fd557521-8f59-457f-a75e-d0ce2c58dc1a", "meta"=>{"created"=>"2016-09-26T23:19:06.695036Z"}, "type"=>"data-point"}, @id="fd557521-8f59-457f-a75e-d0ce2c58dc1a", @type="data-point", @created_at="2016-09-26T23:19:06.695036Z", @updated_at=nil, @timestamp="2016-09-26T23:19:01Z", @value="over 9000", @port="power level">
|
|
246
|
+
</span></code></pre>
|
|
247
|
+
|
|
240
248
|
<h3>Elements</h3>
|
|
241
249
|
|
|
242
250
|
<h4>Get all Elements</h4>
|
|
@@ -257,6 +265,14 @@
|
|
|
257
265
|
<span class='comment'># => #<Helium::Element:0x007faf732c2548 @id="1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de", @name="A New Name", @mac="6081f9fffe00033f", @created_at="2015-08-12T23:19:34.175932Z", @updated_at="2015-08-12T23:19:34.174828Z", @versions=nil>
|
|
258
266
|
</span></code></pre>
|
|
259
267
|
|
|
268
|
+
<h4>Creating Timeseries data</h4>
|
|
269
|
+
|
|
270
|
+
<p>Data points can be written to an element's timeseries data.</p>
|
|
271
|
+
|
|
272
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_timeseries'>timeseries</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>port:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>power level</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>value:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>over 9000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>timestamp:</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
|
|
273
|
+
<span class='comment'># => #<Helium::DataPoint:0x007f88634b9e50 @params={"attributes"=>{"value"=>"over 9000", "timestamp"=>"2016-09-26T23:19:01Z", "port"=>"power level"}, "relationships"=>{"sensor"=>{"data"=>{"id"=>"071488bb-3050-4849-8984-ca9e683cfc91", "type"=>"sensor"}}}, "id"=>"fd557521-8f59-457f-a75e-d0ce2c58dc1a", "meta"=>{"created"=>"2016-09-26T23:19:06.695036Z"}, "type"=>"data-point"}, @id="fd557521-8f59-457f-a75e-d0ce2c58dc1a", @type="data-point", @created_at="2016-09-26T23:19:06.695036Z", @updated_at=nil, @timestamp="2016-09-26T23:19:01Z", @value="over 9000", @port="power level">
|
|
274
|
+
</span></code></pre>
|
|
275
|
+
|
|
260
276
|
<h3>Labels</h3>
|
|
261
277
|
|
|
262
278
|
<p>Sensors can be grouped together under a named label.</p>
|
|
@@ -321,6 +337,50 @@
|
|
|
321
337
|
<span class='comment'># => "{\"id\":\"08bab58b-d095-4c7c-912c-1f8024d91d95\",\"created_at\":\"2015-08-06T17:28:11+00:00\",\"updated_at\":\"2016-05-30T22:36:50+00:00\",\"name\":\"Marc's Isotope\",\"mac\":\"6081f9fffe00019b\",\"ports\":[\"b\",\"t\"]}"
|
|
322
338
|
</span></code></pre>
|
|
323
339
|
|
|
340
|
+
<h3>Metadata</h3>
|
|
341
|
+
|
|
342
|
+
<p>Metadata is a set of user-definable properties associated with a particular resource. These properties are declared as keys and values in the JSONAPI attributes object.</p>
|
|
343
|
+
|
|
344
|
+
<p>Metadata is always represented as a JSON object (hash) that maps string properties to any valid JSON type (strings, numbers, or further nested objects). Metadata can be used to store application preferences, user-defined properties, or additional details associated with a resource.</p>
|
|
345
|
+
|
|
346
|
+
<h4>Accessing Metadata</h4>
|
|
347
|
+
|
|
348
|
+
<p>A resource's metadata object can be accessed by calling <code>.metadata</code> on it. For example:</p>
|
|
349
|
+
|
|
350
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span>
|
|
351
|
+
<span class='comment'># => <Helium::Metadata properties={"location"=>"Building B"}>
|
|
352
|
+
</span>
|
|
353
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_properties'>properties</span>
|
|
354
|
+
<span class='comment'># => {
|
|
355
|
+
</span><span class='comment'># "location" => "Building B"
|
|
356
|
+
</span><span class='comment'># }
|
|
357
|
+
</span>
|
|
358
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_location'>location</span>
|
|
359
|
+
<span class='comment'># => "Building B"
|
|
360
|
+
</span></code></pre>
|
|
361
|
+
|
|
362
|
+
<h4>Updating Metadata</h4>
|
|
363
|
+
|
|
364
|
+
<p>A resource's metadata can be updating by using the <code>.update</code> method:</p>
|
|
365
|
+
|
|
366
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>location:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Building A</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
367
|
+
<span class='comment'># => <Helium::Metadata properties={"location"=>"Building A"}>
|
|
368
|
+
</span></code></pre>
|
|
369
|
+
|
|
370
|
+
<h4>Filtering by Metadata</h4>
|
|
371
|
+
|
|
372
|
+
<p>Resources can be filtered based on their metadata properties. The following would perform a search and return only the sensors that have a <code>location</code> metadata property equal to 'Building A':</p>
|
|
373
|
+
|
|
374
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>location:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Building A</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
375
|
+
<span class='comment'># => [#<Helium::Sensor ...>]
|
|
376
|
+
</span></code></pre>
|
|
377
|
+
|
|
378
|
+
<p>The <code>where</code> filter also accepts arrays and will match metadata properties when the array in the filter forms a subset of the corresponding array value in the metadata object.</p>
|
|
379
|
+
|
|
380
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>departments:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>facilities</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>it</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
381
|
+
<span class='comment'># => [#<Helium::Sensor ...>]
|
|
382
|
+
</span></code></pre>
|
|
383
|
+
|
|
324
384
|
<h2>Development</h2>
|
|
325
385
|
|
|
326
386
|
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
|
@@ -349,9 +409,9 @@
|
|
|
349
409
|
</div></div>
|
|
350
410
|
|
|
351
411
|
<div id="footer">
|
|
352
|
-
Generated on Thu
|
|
412
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
|
353
413
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
354
|
-
0.9.
|
|
414
|
+
0.9.5 (ruby-2.3.1).
|
|
355
415
|
</div>
|
|
356
416
|
|
|
357
417
|
</div>
|
data/docs/frames.html
CHANGED
data/docs/index.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
File: README
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.5
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -71,9 +71,9 @@
|
|
|
71
71
|
<h2>Helium Documentation and Community Support</h2>
|
|
72
72
|
|
|
73
73
|
<ul>
|
|
74
|
-
<li><p><strong>helium-ruby docs</strong> - Documentation for the gem's source can be found <a href="https://helium.github.io/helium-ruby/">here</a
|
|
75
|
-
<li><p><strong>Helium Docs</strong> Complete documenation for all parts of Helium can be found at <a href="https://docs/helium.com">docs.helium.com</a
|
|
76
|
-
<li><p><strong>chat.helium.com</strong> - If you have questions or ideas about how to use this code - or any part of Helium - head over the <a href="
|
|
74
|
+
<li><p><strong>helium-ruby docs</strong> - Documentation for the gem's source can be found <a href="https://helium.github.io/helium-ruby/">here</a>:</p></li>
|
|
75
|
+
<li><p><strong>Helium Docs</strong> Complete documenation for all parts of Helium can be found at <a href="https://docs/helium.com">docs.helium.com</a>.</p></li>
|
|
76
|
+
<li><p><strong>chat.helium.com</strong> - If you have questions or ideas about how to use this code - or any part of Helium - head over the <a href="http://chat.helium.com">chat.helium.com</a>. We're standing by to help.</p></li>
|
|
77
77
|
</ul>
|
|
78
78
|
|
|
79
79
|
<h2>Installation</h2>
|
|
@@ -237,6 +237,14 @@
|
|
|
237
237
|
|
|
238
238
|
<p>A full list of aggregation types and sizes can be found here: <a href="https://docs.helium.com/docs/timeseries#aggregations">https://docs.helium.com/docs/timeseries#aggregations</a>.</p>
|
|
239
239
|
|
|
240
|
+
<h4>Creating Timeseries data</h4>
|
|
241
|
+
|
|
242
|
+
<p>Data points can be written to a sensor's timeseries data.</p>
|
|
243
|
+
|
|
244
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_timeseries'>timeseries</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>port:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>power level</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>value:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>over 9000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>timestamp:</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
|
|
245
|
+
<span class='comment'># => #<Helium::DataPoint:0x007f88634b9e50 @params={"attributes"=>{"value"=>"over 9000", "timestamp"=>"2016-09-26T23:19:01Z", "port"=>"power level"}, "relationships"=>{"sensor"=>{"data"=>{"id"=>"071488bb-3050-4849-8984-ca9e683cfc91", "type"=>"sensor"}}}, "id"=>"fd557521-8f59-457f-a75e-d0ce2c58dc1a", "meta"=>{"created"=>"2016-09-26T23:19:06.695036Z"}, "type"=>"data-point"}, @id="fd557521-8f59-457f-a75e-d0ce2c58dc1a", @type="data-point", @created_at="2016-09-26T23:19:06.695036Z", @updated_at=nil, @timestamp="2016-09-26T23:19:01Z", @value="over 9000", @port="power level">
|
|
246
|
+
</span></code></pre>
|
|
247
|
+
|
|
240
248
|
<h3>Elements</h3>
|
|
241
249
|
|
|
242
250
|
<h4>Get all Elements</h4>
|
|
@@ -257,6 +265,14 @@
|
|
|
257
265
|
<span class='comment'># => #<Helium::Element:0x007faf732c2548 @id="1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de", @name="A New Name", @mac="6081f9fffe00033f", @created_at="2015-08-12T23:19:34.175932Z", @updated_at="2015-08-12T23:19:34.174828Z", @versions=nil>
|
|
258
266
|
</span></code></pre>
|
|
259
267
|
|
|
268
|
+
<h4>Creating Timeseries data</h4>
|
|
269
|
+
|
|
270
|
+
<p>Data points can be written to an element's timeseries data.</p>
|
|
271
|
+
|
|
272
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_timeseries'>timeseries</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>port:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>power level</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>value:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>over 9000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>timestamp:</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
|
|
273
|
+
<span class='comment'># => #<Helium::DataPoint:0x007f88634b9e50 @params={"attributes"=>{"value"=>"over 9000", "timestamp"=>"2016-09-26T23:19:01Z", "port"=>"power level"}, "relationships"=>{"sensor"=>{"data"=>{"id"=>"071488bb-3050-4849-8984-ca9e683cfc91", "type"=>"sensor"}}}, "id"=>"fd557521-8f59-457f-a75e-d0ce2c58dc1a", "meta"=>{"created"=>"2016-09-26T23:19:06.695036Z"}, "type"=>"data-point"}, @id="fd557521-8f59-457f-a75e-d0ce2c58dc1a", @type="data-point", @created_at="2016-09-26T23:19:06.695036Z", @updated_at=nil, @timestamp="2016-09-26T23:19:01Z", @value="over 9000", @port="power level">
|
|
274
|
+
</span></code></pre>
|
|
275
|
+
|
|
260
276
|
<h3>Labels</h3>
|
|
261
277
|
|
|
262
278
|
<p>Sensors can be grouped together under a named label.</p>
|
|
@@ -321,6 +337,50 @@
|
|
|
321
337
|
<span class='comment'># => "{\"id\":\"08bab58b-d095-4c7c-912c-1f8024d91d95\",\"created_at\":\"2015-08-06T17:28:11+00:00\",\"updated_at\":\"2016-05-30T22:36:50+00:00\",\"name\":\"Marc's Isotope\",\"mac\":\"6081f9fffe00019b\",\"ports\":[\"b\",\"t\"]}"
|
|
322
338
|
</span></code></pre>
|
|
323
339
|
|
|
340
|
+
<h3>Metadata</h3>
|
|
341
|
+
|
|
342
|
+
<p>Metadata is a set of user-definable properties associated with a particular resource. These properties are declared as keys and values in the JSONAPI attributes object.</p>
|
|
343
|
+
|
|
344
|
+
<p>Metadata is always represented as a JSON object (hash) that maps string properties to any valid JSON type (strings, numbers, or further nested objects). Metadata can be used to store application preferences, user-defined properties, or additional details associated with a resource.</p>
|
|
345
|
+
|
|
346
|
+
<h4>Accessing Metadata</h4>
|
|
347
|
+
|
|
348
|
+
<p>A resource's metadata object can be accessed by calling <code>.metadata</code> on it. For example:</p>
|
|
349
|
+
|
|
350
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span>
|
|
351
|
+
<span class='comment'># => <Helium::Metadata properties={"location"=>"Building B"}>
|
|
352
|
+
</span>
|
|
353
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_properties'>properties</span>
|
|
354
|
+
<span class='comment'># => {
|
|
355
|
+
</span><span class='comment'># "location" => "Building B"
|
|
356
|
+
</span><span class='comment'># }
|
|
357
|
+
</span>
|
|
358
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_location'>location</span>
|
|
359
|
+
<span class='comment'># => "Building B"
|
|
360
|
+
</span></code></pre>
|
|
361
|
+
|
|
362
|
+
<h4>Updating Metadata</h4>
|
|
363
|
+
|
|
364
|
+
<p>A resource's metadata can be updating by using the <code>.update</code> method:</p>
|
|
365
|
+
|
|
366
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>location:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Building A</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
367
|
+
<span class='comment'># => <Helium::Metadata properties={"location"=>"Building A"}>
|
|
368
|
+
</span></code></pre>
|
|
369
|
+
|
|
370
|
+
<h4>Filtering by Metadata</h4>
|
|
371
|
+
|
|
372
|
+
<p>Resources can be filtered based on their metadata properties. The following would perform a search and return only the sensors that have a <code>location</code> metadata property equal to 'Building A':</p>
|
|
373
|
+
|
|
374
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>location:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Building A</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
375
|
+
<span class='comment'># => [#<Helium::Sensor ...>]
|
|
376
|
+
</span></code></pre>
|
|
377
|
+
|
|
378
|
+
<p>The <code>where</code> filter also accepts arrays and will match metadata properties when the array in the filter forms a subset of the corresponding array value in the metadata object.</p>
|
|
379
|
+
|
|
380
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>departments:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>facilities</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>it</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
381
|
+
<span class='comment'># => [#<Helium::Sensor ...>]
|
|
382
|
+
</span></code></pre>
|
|
383
|
+
|
|
324
384
|
<h2>Development</h2>
|
|
325
385
|
|
|
326
386
|
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
|
@@ -349,9 +409,9 @@
|
|
|
349
409
|
</div></div>
|
|
350
410
|
|
|
351
411
|
<div id="footer">
|
|
352
|
-
Generated on Thu
|
|
412
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
|
353
413
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
354
|
-
0.9.
|
|
414
|
+
0.9.5 (ruby-2.3.1).
|
|
355
415
|
</div>
|
|
356
416
|
|
|
357
417
|
</div>
|