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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c67d0f22efa262651fe436bdc015bbbfe576c0a3
|
4
|
+
data.tar.gz: f8413a6d0e3e128b1d591f57827f3b020e39f465
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 52dd2b52f35eaebd5bec0f17ec69f63acf9890c799bfd3b1786bbb188289181a404dc48bcca397ae9ccb242ae5e6d9ebb496cd4a01a13fe3f7756a2f6c230831
|
7
|
+
data.tar.gz: 3a13c38c722f6816392d48502a8c7fae27bfadc8a1a7f8dbfbc228fe3f6c63cb420f8d177d3cff92d24671cce74d27acccaa32c8b38959e63477652c45e59d73
|
data/README.md
CHANGED
@@ -288,6 +288,53 @@ client.sensors.first.to_json
|
|
288
288
|
# => "{\"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\"]}"
|
289
289
|
```
|
290
290
|
|
291
|
+
### Metadata
|
292
|
+
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.
|
293
|
+
|
294
|
+
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.
|
295
|
+
|
296
|
+
#### Accessing Metadata
|
297
|
+
|
298
|
+
A resource's metadata object can be accessed by calling `.metadata` on it. For example:
|
299
|
+
|
300
|
+
|
301
|
+
``` ruby
|
302
|
+
client.sensors.first.metadata
|
303
|
+
# => <Helium::Metadata properties={"location"=>"Building B"}>
|
304
|
+
|
305
|
+
client.sensors.first.metadata.properties
|
306
|
+
# => {
|
307
|
+
# "location" => "Building B"
|
308
|
+
# }
|
309
|
+
|
310
|
+
client.sensors.first.metadata.location
|
311
|
+
# => "Building B"
|
312
|
+
```
|
313
|
+
|
314
|
+
#### Updating Metadata
|
315
|
+
|
316
|
+
A resource's metadata can be updating by using the `.update` method:
|
317
|
+
|
318
|
+
```ruby
|
319
|
+
client.sensors.first.metadata.update(location: 'Building A')
|
320
|
+
# => <Helium::Metadata properties={"location"=>"Building A"}>
|
321
|
+
```
|
322
|
+
|
323
|
+
#### Filtering by Metadata
|
324
|
+
|
325
|
+
Resources can be filtered based on their metadata properties. The following would perform a search and return only the sensors that have a `location` metadata property equal to 'Building A':
|
326
|
+
|
327
|
+
```ruby
|
328
|
+
client.sensors.where(location: 'Building A')
|
329
|
+
# => [#<Helium::Sensor ...>]
|
330
|
+
```
|
331
|
+
|
332
|
+
The `where` 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.
|
333
|
+
|
334
|
+
```ruby
|
335
|
+
client.sensors.where(departments: ['facilities', 'it'])
|
336
|
+
# => [#<Helium::Sensor ...>]
|
337
|
+
```
|
291
338
|
|
292
339
|
## Development
|
293
340
|
|
data/docs/Helium.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: Helium
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -81,7 +81,7 @@
|
|
81
81
|
<dl>
|
82
82
|
<dt>Defined in:</dt>
|
83
83
|
<dd>lib/helium.rb<span class="defines">,<br />
|
84
|
-
lib/helium/user.rb,<br /> lib/helium/
|
84
|
+
lib/helium/user.rb,<br /> lib/helium/utils.rb,<br /> lib/helium/label.rb,<br /> lib/helium/error.rb,<br /> lib/helium/cursor.rb,<br /> lib/helium/client.rb,<br /> lib/helium/sensor.rb,<br /> lib/helium/element.rb,<br /> lib/helium/version.rb,<br /> lib/helium/metadata.rb,<br /> lib/helium/resource.rb,<br /> lib/helium/data_point.rb,<br /> lib/helium/timeseries.rb,<br /> lib/helium/collection.rb,<br /> lib/helium/client/http.rb,<br /> lib/helium/organization.rb,<br /> lib/helium/client/users.rb,<br /> lib/helium/client/labels.rb,<br /> lib/helium/configuration.rb,<br /> lib/helium/client/sensors.rb,<br /> lib/helium/client/elements.rb,<br /> lib/helium/device_configuration.rb,<br /> lib/helium/client/organizations.rb,<br /> lib/helium/client/configurations.rb,<br /> lib/helium/client/device_configurations.rb</span>
|
85
85
|
</dd>
|
86
86
|
</dl>
|
87
87
|
|
@@ -95,7 +95,7 @@
|
|
95
95
|
|
96
96
|
|
97
97
|
|
98
|
-
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Helium/Client.html" title="Helium::Client (class)">Client</a></span>, <span class='object_link'><a href="Helium/ClientError.html" title="Helium::ClientError (class)">ClientError</a></span>, <span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span>, <span class='object_link'><a href="Helium/DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span>, <span class='object_link'><a href="Helium/Element.html" title="Helium::Element (class)">Element</a></span>, <span class='object_link'><a href="Helium/Error.html" title="Helium::Error (class)">Error</a></span>, <span class='object_link'><a href="Helium/InvalidApiKey.html" title="Helium::InvalidApiKey (class)">InvalidApiKey</a></span>, <span class='object_link'><a href="Helium/Label.html" title="Helium::Label (class)">Label</a></span>, <span class='object_link'><a href="Helium/Organization.html" title="Helium::Organization (class)">Organization</a></span>, <span class='object_link'><a href="Helium/Resource.html" title="Helium::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Helium/Sensor.html" title="Helium::Sensor (class)">Sensor</a></span>, <span class='object_link'><a href="Helium/User.html" title="Helium::User (class)">User</a></span>
|
98
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Helium/Client.html" title="Helium::Client (class)">Client</a></span>, <span class='object_link'><a href="Helium/ClientError.html" title="Helium::ClientError (class)">ClientError</a></span>, <span class='object_link'><a href="Helium/Collection.html" title="Helium::Collection (class)">Collection</a></span>, <span class='object_link'><a href="Helium/Configuration.html" title="Helium::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span>, <span class='object_link'><a href="Helium/DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span>, <span class='object_link'><a href="Helium/DeviceConfiguration.html" title="Helium::DeviceConfiguration (class)">DeviceConfiguration</a></span>, <span class='object_link'><a href="Helium/Element.html" title="Helium::Element (class)">Element</a></span>, <span class='object_link'><a href="Helium/Error.html" title="Helium::Error (class)">Error</a></span>, <span class='object_link'><a href="Helium/InvalidApiKey.html" title="Helium::InvalidApiKey (class)">InvalidApiKey</a></span>, <span class='object_link'><a href="Helium/Label.html" title="Helium::Label (class)">Label</a></span>, <span class='object_link'><a href="Helium/Metadata.html" title="Helium::Metadata (class)">Metadata</a></span>, <span class='object_link'><a href="Helium/Organization.html" title="Helium::Organization (class)">Organization</a></span>, <span class='object_link'><a href="Helium/Resource.html" title="Helium::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Helium/Sensor.html" title="Helium::Sensor (class)">Sensor</a></span>, <span class='object_link'><a href="Helium/Timeseries.html" title="Helium::Timeseries (class)">Timeseries</a></span>, <span class='object_link'><a href="Helium/User.html" title="Helium::User (class)">User</a></span>
|
99
99
|
|
100
100
|
|
101
101
|
</p>
|
@@ -106,7 +106,7 @@
|
|
106
106
|
<dt id="VERSION-constant" class="">VERSION =
|
107
107
|
|
108
108
|
</dt>
|
109
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.
|
109
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.20.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
110
110
|
|
111
111
|
</dl>
|
112
112
|
|
@@ -121,9 +121,9 @@
|
|
121
121
|
</div>
|
122
122
|
|
123
123
|
<div id="footer">
|
124
|
-
Generated on Thu
|
124
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
125
125
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
126
|
-
0.9.
|
126
|
+
0.9.5 (ruby-2.3.1).
|
127
127
|
</div>
|
128
128
|
|
129
129
|
</div>
|
data/docs/Helium/Client.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Helium::Client
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -91,7 +91,7 @@
|
|
91
91
|
|
92
92
|
<dl>
|
93
93
|
<dt>Includes:</dt>
|
94
|
-
<dd><span class='object_link'><a href="Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span>, <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span>, <span class='object_link'><a href="Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span>, <span class='object_link'><a href="Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span>, <span class='object_link'><a href="Client/Users.html" title="Helium::Client::Users (module)">Users</a></span>, <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></dd>
|
94
|
+
<dd><span class='object_link'><a href="Client/Configurations.html" title="Helium::Client::Configurations (module)">Configurations</a></span>, <span class='object_link'><a href="Client/DeviceConfigurations.html" title="Helium::Client::DeviceConfigurations (module)">DeviceConfigurations</a></span>, <span class='object_link'><a href="Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span>, <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span>, <span class='object_link'><a href="Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span>, <span class='object_link'><a href="Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span>, <span class='object_link'><a href="Client/Users.html" title="Helium::Client::Users (module)">Users</a></span>, <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></dd>
|
95
95
|
</dl>
|
96
96
|
|
97
97
|
|
@@ -102,7 +102,7 @@
|
|
102
102
|
<dl>
|
103
103
|
<dt>Defined in:</dt>
|
104
104
|
<dd>lib/helium/client.rb<span class="defines">,<br />
|
105
|
-
lib/helium/client/http.rb,<br /> lib/helium/client/users.rb,<br /> lib/helium/client/labels.rb,<br /> lib/helium/client/sensors.rb,<br /> lib/helium/client/elements.rb,<br /> lib/helium/client/organizations.rb</span>
|
105
|
+
lib/helium/client/http.rb,<br /> lib/helium/client/users.rb,<br /> lib/helium/client/labels.rb,<br /> lib/helium/client/sensors.rb,<br /> lib/helium/client/elements.rb,<br /> lib/helium/client/organizations.rb,<br /> lib/helium/client/configurations.rb,<br /> lib/helium/client/device_configurations.rb</span>
|
106
106
|
</dd>
|
107
107
|
</dl>
|
108
108
|
|
@@ -112,7 +112,7 @@
|
|
112
112
|
<p class="children">
|
113
113
|
|
114
114
|
|
115
|
-
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span>, <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span>, <span class='object_link'><a href="Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span>, <span class='object_link'><a href="Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span>, <span class='object_link'><a href="Client/Users.html" title="Helium::Client::Users (module)">Users</a></span>
|
115
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Client/Configurations.html" title="Helium::Client::Configurations (module)">Configurations</a></span>, <span class='object_link'><a href="Client/DeviceConfigurations.html" title="Helium::Client::DeviceConfigurations (module)">DeviceConfigurations</a></span>, <span class='object_link'><a href="Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span>, <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span>, <span class='object_link'><a href="Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span>, <span class='object_link'><a href="Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span>, <span class='object_link'><a href="Client/Users.html" title="Helium::Client::Users (module)">Users</a></span>
|
116
116
|
|
117
117
|
|
118
118
|
|
@@ -125,7 +125,7 @@
|
|
125
125
|
<dt id="API_VERSION-constant" class="">API_VERSION =
|
126
126
|
|
127
127
|
</dt>
|
128
|
-
<dd><pre class="code"><span class='
|
128
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>v1</span><span class='tstring_end'>'</span></span></pre></dd>
|
129
129
|
|
130
130
|
<dt id="HOST-constant" class="">HOST =
|
131
131
|
|
@@ -271,8 +271,30 @@
|
|
271
271
|
|
272
272
|
|
273
273
|
|
274
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/DeviceConfigurations.html" title="Helium::Client::DeviceConfigurations (module)">DeviceConfigurations</a></span></h3>
|
275
|
+
<p class="inherited"><span class='object_link'><a href="Client/DeviceConfigurations.html#create_device_configuration-instance_method" title="Helium::Client::DeviceConfigurations#create_device_configuration (method)">#create_device_configuration</a></span>, <span class='object_link'><a href="Client/DeviceConfigurations.html#device_configuration-instance_method" title="Helium::Client::DeviceConfigurations#device_configuration (method)">#device_configuration</a></span>, <span class='object_link'><a href="Client/DeviceConfigurations.html#device_configuration_configuration-instance_method" title="Helium::Client::DeviceConfigurations#device_configuration_configuration (method)">#device_configuration_configuration</a></span>, <span class='object_link'><a href="Client/DeviceConfigurations.html#device_configuration_device-instance_method" title="Helium::Client::DeviceConfigurations#device_configuration_device (method)">#device_configuration_device</a></span>, <span class='object_link'><a href="Client/DeviceConfigurations.html#device_configurations-instance_method" title="Helium::Client::DeviceConfigurations#device_configurations (method)">#device_configurations</a></span></p>
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Configurations.html" title="Helium::Client::Configurations (module)">Configurations</a></span></h3>
|
286
|
+
<p class="inherited"><span class='object_link'><a href="Client/Configurations.html#configuration-instance_method" title="Helium::Client::Configurations#configuration (method)">#configuration</a></span>, <span class='object_link'><a href="Client/Configurations.html#configurations-instance_method" title="Helium::Client::Configurations#configurations (method)">#configurations</a></span>, <span class='object_link'><a href="Client/Configurations.html#create_configuration-instance_method" title="Helium::Client::Configurations#create_configuration (method)">#create_configuration</a></span></p>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
274
296
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span></h3>
|
275
|
-
<p class="inherited"><span class='object_link'><a href="Client/Elements.html#element-instance_method" title="Helium::Client::Elements#element (method)">#element</a></span>, <span class='object_link'><a href="Client/Elements.html#
|
297
|
+
<p class="inherited"><span class='object_link'><a href="Client/Elements.html#element-instance_method" title="Helium::Client::Elements#element (method)">#element</a></span>, <span class='object_link'><a href="Client/Elements.html#element_device_configuration-instance_method" title="Helium::Client::Elements#element_device_configuration (method)">#element_device_configuration</a></span>, <span class='object_link'><a href="Client/Elements.html#element_timeseries-instance_method" title="Helium::Client::Elements#element_timeseries (method)">#element_timeseries</a></span>, <span class='object_link'><a href="Client/Elements.html#elements-instance_method" title="Helium::Client::Elements#elements (method)">#elements</a></span></p>
|
276
298
|
|
277
299
|
|
278
300
|
|
@@ -283,7 +305,7 @@
|
|
283
305
|
|
284
306
|
|
285
307
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span></h3>
|
286
|
-
<p class="inherited"><span class='object_link'><a href="Client/Labels.html#create_label-instance_method" title="Helium::Client::Labels#create_label (method)">#create_label</a></span>, <span class='object_link'><a href="Client/Labels.html#label-instance_method" title="Helium::Client::Labels#label (method)">#label</a></span>, <span class='object_link'><a href="Client/Labels.html#
|
308
|
+
<p class="inherited"><span class='object_link'><a href="Client/Labels.html#create_label-instance_method" title="Helium::Client::Labels#create_label (method)">#create_label</a></span>, <span class='object_link'><a href="Client/Labels.html#label-instance_method" title="Helium::Client::Labels#label (method)">#label</a></span>, <span class='object_link'><a href="Client/Labels.html#labels-instance_method" title="Helium::Client::Labels#labels (method)">#labels</a></span>, <span class='object_link'><a href="Client/Labels.html#update_label_sensors-instance_method" title="Helium::Client::Labels#update_label_sensors (method)">#update_label_sensors</a></span></p>
|
287
309
|
|
288
310
|
|
289
311
|
|
@@ -294,7 +316,7 @@
|
|
294
316
|
|
295
317
|
|
296
318
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span></h3>
|
297
|
-
<p class="inherited"><span class='object_link'><a href="Client/Sensors.html#create_sensor-instance_method" title="Helium::Client::Sensors#create_sensor (method)">#create_sensor</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensor-instance_method" title="Helium::Client::Sensors#sensor (method)">#sensor</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensor_timeseries-instance_method" title="Helium::Client::Sensors#sensor_timeseries (method)">#sensor_timeseries</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensors-instance_method" title="Helium::Client::Sensors#sensors (method)">#sensors</a></span></p>
|
319
|
+
<p class="inherited"><span class='object_link'><a href="Client/Sensors.html#create_sensor-instance_method" title="Helium::Client::Sensors#create_sensor (method)">#create_sensor</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensor-instance_method" title="Helium::Client::Sensors#sensor (method)">#sensor</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensor_device_configuration-instance_method" title="Helium::Client::Sensors#sensor_device_configuration (method)">#sensor_device_configuration</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensor_element-instance_method" title="Helium::Client::Sensors#sensor_element (method)">#sensor_element</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensor_timeseries-instance_method" title="Helium::Client::Sensors#sensor_timeseries (method)">#sensor_timeseries</a></span>, <span class='object_link'><a href="Client/Sensors.html#sensors-instance_method" title="Helium::Client::Sensors#sensors (method)">#sensors</a></span></p>
|
298
320
|
|
299
321
|
|
300
322
|
|
@@ -305,7 +327,7 @@
|
|
305
327
|
|
306
328
|
|
307
329
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span></h3>
|
308
|
-
<p class="inherited"><span class='object_link'><a href="Client/Organizations.html#organization-instance_method" title="Helium::Client::Organizations#organization (method)">#organization</a></span
|
330
|
+
<p class="inherited"><span class='object_link'><a href="Client/Organizations.html#organization-instance_method" title="Helium::Client::Organizations#organization (method)">#organization</a></span></p>
|
309
331
|
|
310
332
|
|
311
333
|
|
@@ -327,7 +349,7 @@
|
|
327
349
|
|
328
350
|
|
329
351
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span></h3>
|
330
|
-
<p class="inherited"><span class='object_link'><a href="Client/Http.html#base_url-instance_method" title="Helium::Client::Http#base_url (method)">#base_url</a></span>, <span class='object_link'><a href="Client/Http.html#delete-instance_method" title="Helium::Client::Http#delete (method)">#delete</a></span>, <span class='object_link'><a href="Client/Http.html#get-instance_method" title="Helium::Client::Http#get (method)">#get</a></span>, <span class='object_link'><a href="Client/Http.html#paginated_get-instance_method" title="Helium::Client::Http#paginated_get (method)">#paginated_get</a></span>, <span class='object_link'><a href="Client/Http.html#patch-instance_method" title="Helium::Client::Http#patch (method)">#patch</a></span>, <span class='object_link'><a href="Client/Http.html#post-instance_method" title="Helium::Client::Http#post (method)">#post</a></span>, <span class='object_link'><a href="Client/Http.html#url_for-instance_method" title="Helium::Client::Http#url_for (method)">#url_for</a></span></p>
|
352
|
+
<p class="inherited"><span class='object_link'><a href="Client/Http.html#base_url-instance_method" title="Helium::Client::Http#base_url (method)">#base_url</a></span>, <span class='object_link'><a href="Client/Http.html#delete-instance_method" title="Helium::Client::Http#delete (method)">#delete</a></span>, <span class='object_link'><a href="Client/Http.html#get-instance_method" title="Helium::Client::Http#get (method)">#get</a></span>, <span class='object_link'><a href="Client/Http.html#paginated_get-instance_method" title="Helium::Client::Http#paginated_get (method)">#paginated_get</a></span>, <span class='object_link'><a href="Client/Http.html#patch-instance_method" title="Helium::Client::Http#patch (method)">#patch</a></span>, <span class='object_link'><a href="Client/Http.html#post-instance_method" title="Helium::Client::Http#post (method)">#post</a></span>, <span class='object_link'><a href="Client/Http.html#put-instance_method" title="Helium::Client::Http#put (method)">#put</a></span>, <span class='object_link'><a href="Client/Http.html#url_for-instance_method" title="Helium::Client::Http#url_for (method)">#url_for</a></span></p>
|
331
353
|
|
332
354
|
|
333
355
|
|
@@ -338,7 +360,7 @@
|
|
338
360
|
|
339
361
|
|
340
362
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
|
341
|
-
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span></p>
|
363
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span>, <span class='object_link'><a href="Utils.html#kebab_case-instance_method" title="Helium::Utils#kebab_case (method)">#kebab_case</a></span></p>
|
342
364
|
<div id="constructor_details" class="method_details_list">
|
343
365
|
<h2>Constructor Details</h2>
|
344
366
|
|
@@ -367,19 +389,25 @@
|
|
367
389
|
<pre class="lines">
|
368
390
|
|
369
391
|
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
392
|
+
29
|
393
|
+
30
|
394
|
+
31
|
395
|
+
32
|
396
|
+
33
|
397
|
+
34
|
398
|
+
35
|
399
|
+
36</pre>
|
375
400
|
</td>
|
376
401
|
<td>
|
377
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line
|
402
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 29</span>
|
378
403
|
|
379
404
|
<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>
|
380
|
-
<span class='ivar'>@api_key</span>
|
381
|
-
<span class='ivar'>@api_host</span>
|
382
|
-
<span class='ivar'>@
|
405
|
+
<span class='ivar'>@api_key</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'>:api_key</span><span class='rparen'>)</span>
|
406
|
+
<span class='ivar'>@api_host</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'>:host</span><span class='comma'>,</span> <span class='const'>HOST</span><span class='rparen'>)</span>
|
407
|
+
<span class='ivar'>@api_version</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'>:api_version</span><span class='comma'>,</span> <span class='const'>API_VERSION</span><span class='rparen'>)</span>
|
408
|
+
<span class='ivar'>@verify_peer</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'>:verify_peer</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
409
|
+
<span class='ivar'>@debug</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'>:debug</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
410
|
+
<span class='ivar'>@headers</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'>:headers</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
383
411
|
<span class='kw'>end</span></pre>
|
384
412
|
</td>
|
385
413
|
</tr>
|
@@ -418,12 +446,12 @@
|
|
418
446
|
<pre class="lines">
|
419
447
|
|
420
448
|
|
421
|
-
|
422
|
-
|
423
|
-
|
449
|
+
27
|
450
|
+
28
|
451
|
+
29</pre>
|
424
452
|
</td>
|
425
453
|
<td>
|
426
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line
|
454
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 27</span>
|
427
455
|
|
428
456
|
<span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
429
457
|
<span class='ivar'>@api_key</span>
|
@@ -477,12 +505,12 @@
|
|
477
505
|
<pre class="lines">
|
478
506
|
|
479
507
|
|
480
|
-
|
481
|
-
|
482
|
-
|
508
|
+
42
|
509
|
+
43
|
510
|
+
44</pre>
|
483
511
|
</td>
|
484
512
|
<td>
|
485
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line
|
513
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 42</span>
|
486
514
|
|
487
515
|
<span class='kw'>def</span> <span class='id identifier rubyid_debug?'>debug?</span>
|
488
516
|
<span class='ivar'>@debug</span> <span class='op'>==</span> <span class='kw'>true</span>
|
@@ -507,12 +535,12 @@
|
|
507
535
|
<pre class="lines">
|
508
536
|
|
509
537
|
|
510
|
-
|
511
|
-
|
512
|
-
|
538
|
+
38
|
539
|
+
39
|
540
|
+
40</pre>
|
513
541
|
</td>
|
514
542
|
<td>
|
515
|
-
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line
|
543
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 38</span>
|
516
544
|
|
517
545
|
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
|
518
546
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><Helium::Client @debug=</span><span class='embexpr_beg'>#{</span><span class='ivar'>@debug</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>"</span></span>
|
@@ -527,9 +555,9 @@
|
|
527
555
|
</div>
|
528
556
|
|
529
557
|
<div id="footer">
|
530
|
-
Generated on Thu
|
558
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
531
559
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
532
|
-
0.9.
|
560
|
+
0.9.5 (ruby-2.3.1).
|
533
561
|
</div>
|
534
562
|
|
535
563
|
</div>
|
@@ -0,0 +1,296 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: Helium::Client::Configurations
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.5
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "Helium::Client::Configurations";
|
19
|
+
relpath = '../../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../../class_list.html"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../../_index.html">Index (C)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Helium.html" title="Helium (module)">Helium</a></span></span> » <span class='title'><span class='object_link'><a href="../Client.html" title="Helium::Client (class)">Client</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Configurations</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame" src="../../class_list.html"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><h1>Module: Helium::Client::Configurations
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
</h1>
|
69
|
+
<div class="box_info">
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Included in:</dt>
|
81
|
+
<dd><span class='object_link'><a href="../Client.html" title="Helium::Client (class)">Helium::Client</a></span></dd>
|
82
|
+
</dl>
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
<dl>
|
87
|
+
<dt>Defined in:</dt>
|
88
|
+
<dd>lib/helium/client/configurations.rb</dd>
|
89
|
+
</dl>
|
90
|
+
|
91
|
+
</div>
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
<h2>
|
102
|
+
Instance Method Summary
|
103
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
104
|
+
</h2>
|
105
|
+
|
106
|
+
<ul class="summary">
|
107
|
+
|
108
|
+
<li class="public ">
|
109
|
+
<span class="summary_signature">
|
110
|
+
|
111
|
+
<a href="#configuration-instance_method" title="#configuration (instance method)">#<strong>configuration</strong>(id) ⇒ Object </a>
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
</span>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
126
|
+
|
127
|
+
</li>
|
128
|
+
|
129
|
+
|
130
|
+
<li class="public ">
|
131
|
+
<span class="summary_signature">
|
132
|
+
|
133
|
+
<a href="#configurations-instance_method" title="#configurations (instance method)">#<strong>configurations</strong> ⇒ 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="#create_configuration-instance_method" title="#create_configuration (instance method)">#<strong>create_configuration</strong>(attributes) ⇒ Object </a>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
</span>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
<span class="summary_desc"><div class='inline'><p>Configurations are immutable, so no updates are available.</p>
|
170
|
+
</div></span>
|
171
|
+
|
172
|
+
</li>
|
173
|
+
|
174
|
+
|
175
|
+
</ul>
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<div id="instance_method_details" class="method_details_list">
|
181
|
+
<h2>Instance Method Details</h2>
|
182
|
+
|
183
|
+
|
184
|
+
<div class="method_details first">
|
185
|
+
<h3 class="signature first" id="configuration-instance_method">
|
186
|
+
|
187
|
+
#<strong>configuration</strong>(id) ⇒ <tt>Object</tt>
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
</h3><table class="source_code">
|
194
|
+
<tr>
|
195
|
+
<td>
|
196
|
+
<pre class="lines">
|
197
|
+
|
198
|
+
|
199
|
+
9
|
200
|
+
10
|
201
|
+
11</pre>
|
202
|
+
</td>
|
203
|
+
<td>
|
204
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/configurations.rb', line 9</span>
|
205
|
+
|
206
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
207
|
+
<span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
208
|
+
<span class='kw'>end</span></pre>
|
209
|
+
</td>
|
210
|
+
</tr>
|
211
|
+
</table>
|
212
|
+
</div>
|
213
|
+
|
214
|
+
<div class="method_details ">
|
215
|
+
<h3 class="signature " id="configurations-instance_method">
|
216
|
+
|
217
|
+
#<strong>configurations</strong> ⇒ <tt>Object</tt>
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
</h3><table class="source_code">
|
224
|
+
<tr>
|
225
|
+
<td>
|
226
|
+
<pre class="lines">
|
227
|
+
|
228
|
+
|
229
|
+
5
|
230
|
+
6
|
231
|
+
7</pre>
|
232
|
+
</td>
|
233
|
+
<td>
|
234
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/configurations.rb', line 5</span>
|
235
|
+
|
236
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_configurations'>configurations</span>
|
237
|
+
<span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
238
|
+
<span class='kw'>end</span></pre>
|
239
|
+
</td>
|
240
|
+
</tr>
|
241
|
+
</table>
|
242
|
+
</div>
|
243
|
+
|
244
|
+
<div class="method_details ">
|
245
|
+
<h3 class="signature " id="create_configuration-instance_method">
|
246
|
+
|
247
|
+
#<strong>create_configuration</strong>(attributes) ⇒ <tt>Object</tt>
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
</h3><div class="docstring">
|
254
|
+
<div class="discussion">
|
255
|
+
<p>Configurations are immutable, so no updates are available</p>
|
256
|
+
|
257
|
+
|
258
|
+
</div>
|
259
|
+
</div>
|
260
|
+
<div class="tags">
|
261
|
+
|
262
|
+
|
263
|
+
</div><table class="source_code">
|
264
|
+
<tr>
|
265
|
+
<td>
|
266
|
+
<pre class="lines">
|
267
|
+
|
268
|
+
|
269
|
+
14
|
270
|
+
15
|
271
|
+
16</pre>
|
272
|
+
</td>
|
273
|
+
<td>
|
274
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/configurations.rb', line 14</span>
|
275
|
+
|
276
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_configuration'>create_configuration</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
277
|
+
<span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
278
|
+
<span class='kw'>end</span></pre>
|
279
|
+
</td>
|
280
|
+
</tr>
|
281
|
+
</table>
|
282
|
+
</div>
|
283
|
+
|
284
|
+
</div>
|
285
|
+
|
286
|
+
</div>
|
287
|
+
|
288
|
+
<div id="footer">
|
289
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
290
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
291
|
+
0.9.5 (ruby-2.3.1).
|
292
|
+
</div>
|
293
|
+
|
294
|
+
</div>
|
295
|
+
</body>
|
296
|
+
</html>
|