helium-ruby 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a6daafb411fdb428681d8ec0afadf04316eee11
-  data.tar.gz: 3d051f6d3e8c470b29dc1bc738bf317b10229255
+  metadata.gz: 30c4a15c82d31767bf2f28abc9cd6435594fae73
+  data.tar.gz: 7e4c7c626c8da7fd6a4f02880a26564dbc6bc873
 SHA512:
-  metadata.gz: 0fc04b7f6627428cfa36c159338f70971ec87d150e2a480b3f021d42920277526651bca7b69f41d0add057294e2703350429eb02f4aa9141da7178e3d72dcb98
-  data.tar.gz: 95d515f2105a68912d8521b3db0d0697ba8191694edb9c83a04c776c7c3393a060543b30f87017a785eaafe4e4720d4be3424f98c56517d400e33ac47523ec2e
+  metadata.gz: 7a18ac3aefcddf109ad0c5ea352aaf7b10e944b7464a8eaab27e61a6e1730437350c54842ed21822a4a7686eb4ca915357e4f1d0935eb5e70b70f8ffdf7693b5
+  data.tar.gz: c16197c1d1a371cabe17da76baad9f766b937add2f9985a199ecce720a717f3cb1b761426decc50fc577cea75550a43b5e852d91353cf6fbad16bfaf8c65e04b

data/README.md

@@ -8,14 +8,14 @@
 A Ruby gem for building applications with the Helium API. [Helium](https://www.helium.com/) is an integrated platform of smart sensors, communication, edge and cloud compute that enables numerous sensing applications. For more information about the underlying REST API, check out [the Helium docs](https://docs.helium.com/).
 
 
-##  Helium Documentation and Community Support 
+##  Helium Documentation and Community Support
 
 
-* **helium-ruby docs** - Documentation for the gem's source can be found [here](https://helium.github.io/helium-ruby/): 
+* **helium-ruby docs** - Documentation for the gem's source can be found [here](https://helium.github.io/helium-ruby/):
 
-* **Helium Docs** Complete documenation for all parts of Helium can be found at [docs.helium.com](https://docs/helium.com). 
+* **Helium Docs** Complete documenation for all parts of Helium can be found at [docs.helium.com](https://docs/helium.com).
 
-* **chat.helium.com** - If you have questions or ideas about how to use this code - or any part of Helium - head over the [chat.helium.com](https://chat.helium.com). We're standing by to help. 
+* **chat.helium.com** - If you have questions or ideas about how to use this code - or any part of Helium - head over the [chat.helium.com](http://chat.helium.com). We're standing by to help.
 
 
 ## Installation
@@ -185,6 +185,15 @@ data_points.first.avg
 
 A full list of aggregation types and sizes can be found here: https://docs.helium.com/docs/timeseries#aggregations.
 
+#### Creating Timeseries data
+
+Data points can be written to a sensor's timeseries data.
+
+```ruby
+sensor.timeseries.create(port: "power level", value: "over 9000", timestamp: DateTime.now)
+# => #<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">
+```
+
 ### Elements
 
 #### Get all Elements
@@ -206,6 +215,15 @@ element.update(name: "A New Name")
 # => #<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>
 ```
 
+#### Creating Timeseries data
+
+Data points can be written to an element's timeseries data.
+
+```ruby
+element.timeseries.create(port: "power level", value: "over 9000", timestamp: DateTime.now)
+# => #<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">
+```
+
 ### Labels
 
 Sensors can be grouped together under a named label.

data/lib/helium.rb

@@ -12,6 +12,7 @@ require "helium/user"
 require "helium/organization"
 require "helium/sensor"
 require "helium/label"
+require "helium/timeseries"
 require "helium/data_point"
 require "helium/element"
 

data/lib/helium/client/elements.rb

@@ -33,7 +33,11 @@ module Helium
           "agg[size]"     => opts.fetch(:aggsize)
         }.delete_if { |_key, value| value.to_s.empty? }
 
-        paginated_get(path, klass: Helium::DataPoint, params: params)
+        paginated_get(path,
+          klass:        Helium::DataPoint,
+          cursor_klass: Helium::Timeseries,
+          params:       params
+        )
       end
     end
   end

data/lib/helium/client/http.rb

@@ -13,9 +13,10 @@ module Helium
 
       def paginated_get(path, opts = {})
         klass  = opts.fetch(:klass)
+        cursor_klass  = opts.fetch(:cursor_klass, Helium::Cursor)
         params = opts.fetch(:params, {})
 
-        Cursor.new(client: self, path: path, klass: klass, params: params)
+        cursor_klass.new(client: self, path: path, klass: klass, params: params)
       end
 
       def post(path, opts = {})

data/lib/helium/client/sensors.rb

@@ -21,7 +21,11 @@ module Helium
           "agg[size]"     => opts.fetch(:aggsize)
         }.delete_if { |_key, value| value.to_s.empty? }
 
-        paginated_get(path, klass: Helium::DataPoint, params: params)
+        paginated_get(path,
+          klass:        Helium::DataPoint,
+          cursor_klass: Helium::Timeseries,
+          params:       params
+        )
       end
 
       def create_sensor(attributes)

data/lib/helium/element.rb

@@ -1,25 +1,31 @@
 module Helium
   class Element < Resource
-    attr_reader :name, :mac, :versions
+    attr_reader :name, :mac, :last_seen
 
     def initialize(opts = {})
       super(opts)
 
-      @name     = @params.dig("attributes", "name")
-      @mac      = @params.dig("meta", "mac")
-      @versions = @params.dig("meta", "versions")
+      @name      = @params.dig("attributes", "name")
+      @mac       = @params.dig("meta", "mac")
+      @last_seen = @params.dig('meta', 'last-seen')
     end
 
     def sensors
       @client.element_sensors(self)
     end
 
+    # @return [DateTime, nil] when the resource was last seen
+    def last_seen
+      return nil if @last_seen.nil?
+      @_last_seen ||= DateTime.parse(@last_seen)
+    end
+
     # TODO can probably generalize this a bit more
     def as_json
       super.merge({
         name: name,
         mac: mac,
-        versions: versions
+        last_seen: last_seen
       })
     end
 

data/lib/helium/sensor.rb

@@ -1,6 +1,6 @@
 module Helium
   class Sensor < Resource
-    attr_reader :name, :mac, :ports, :last_seen, :firmware
+    attr_reader :name, :mac, :ports, :last_seen
 
     def initialize(opts = {})
       super(opts)
@@ -9,7 +9,6 @@ module Helium
       @mac       = @params.dig('meta', 'mac')
       @ports     = @params.dig('meta', 'ports')
       @last_seen = @params.dig('meta', 'last-seen')
-      @firmware  = @params.dig('meta', 'versions', 'sensor')
     end
 
     def self.all_path
@@ -57,7 +56,6 @@ module Helium
         mac: mac,
         ports: ports,
         last_seen: last_seen,
-        firmware: firmware,
         labels: labels
       })
     end

data/lib/helium/timeseries.rb

@@ -0,0 +1,33 @@
+module Helium
+  class Timeseries < Cursor
+    include Helium::Utils
+
+    # Creates a new data point on this timeseries
+    # @option opts [String] :port A port for the data point
+    # @option opts [String] :value A value for the data point
+    # @option opts [DateTime] :timestamp A timestamp for the data point. If not provided, it will default to the current time.
+    # @return [DataPoint]
+    def create(opts = {})
+      port      = opts.fetch(:port)
+      value     = opts.fetch(:value)
+      timestamp = opts.fetch(:timestamp, DateTime.now)
+
+      body = {
+        data: {
+          attributes: {
+            port:      port,
+            value:     value,
+            timestamp: datetime_to_iso(timestamp)
+          },
+          type: 'data-point'
+        }
+      }
+
+      response = @client.post(@path, body: body)
+      resource_data = JSON.parse(response.body)["data"]
+
+      return DataPoint.new(client: self, params: resource_data)
+    end
+
+  end
+end

data/lib/helium/version.rb

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Andrew Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -297,6 +297,7 @@ files:
 - lib/helium/organization.rb
 - lib/helium/resource.rb
 - lib/helium/sensor.rb
+- lib/helium/timeseries.rb
 - lib/helium/user.rb
 - lib/helium/utils.rb
 - lib/helium/version.rb