helium-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652e7ae9d3dda85ecf853683b0e83a1abcd0746a
-  data.tar.gz: 38302545f4d2b850bc17afb890ba0efd16e6de92
+  metadata.gz: 7f6ff6d87571b6da6c446b1c0496ffa9dc47c68d
+  data.tar.gz: ef1feadb0d457c031d319592ff2e48b037da9938
 SHA512:
-  metadata.gz: cf23c7d0f425d9106b54337aba35006cd95ad4a8ac89eb3ef776a2780ba0f46dfba63d68866e651600187c56d6c07e64ac1f7a78b6a0947d66c76f9da826f4a3
-  data.tar.gz: ed941a33a010e4b567b39083ecca5a140a18bc9825632215135831cf66a956d8df63e6c4fe76efc24f00f32e8a5edd9cdf156b23b3fadd5d0037951740d5bdee
+  metadata.gz: 1e9dafbc98ae651fff679e89676048af1780a9a507f38305e2034955c623e58dcfe25a2af6c2cda41ab22e67934bc67278b96b5bd8ae1b3e932fb1d9f52bb93f
+  data.tar.gz: 56ba562ce5e1893c5faef95a8054b0464867309244bb2d71dcbbf2078a03120f0ebae5dc1f4b128d4a6ff9decc10ffb4365afd4d44fd4868ea43e68d94914e40

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/helium/helium-ruby.svg?branch=master)](https://travis-ci.org/helium/helium-ruby)
 [![Coverage Status](https://coveralls.io/repos/github/helium/helium-ruby/badge.svg?branch=master)](https://coveralls.io/github/helium/helium-ruby?branch=master)
 [![Code Climate](https://codeclimate.com/github/helium/helium-ruby/badges/gpa.svg)](https://codeclimate.com/github/helium/helium-ruby)
+[![Gem Version](https://badge.fury.io/rb/helium-ruby.svg)](https://badge.fury.io/rb/helium-ruby)
 
 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/).
 
@@ -130,14 +131,17 @@ sensor.timeseries(size: 10_000).length
 # => 10000
 ```
 
-The data points are sorted from most recent, to least recent. The `.previous` method on a `Helium::Timeseries` object will return a new `Helium::Timeseries` object with the next page of Timeseries data:
+The data points are sorted from most recent, to least recent. The `.previous` method on a `Helium::Timeseries` object will return a new `Helium::Timeseries` object with the previous page of Timeseries data. Similarly, the `.next` method on a `Helium::Timeseries` object will return the next page of timeseries data, if it exists. If not, it will return `false`.
 
 ```ruby
 timeseries = sensor.timeseries
 # => #<Helium::Timeseries:0x007ff9e10d2c48 @data_points=[#<Helium::DataPoint:0x007ff9e10d2568 @id="3595e562-c065-442e-a3af-c6f43ddb1500", @timestamp="2016-08-10T13:21:49.866Z", @value=27, @port="l">, ...
 
-timeseries.previous
+previous_timeseries = timeseries.previous
 # => #<Helium::Timeseries:0x007ff9dc141008 @data_points=[#<Helium::DataPoint:0x007ff9dc140f68 @id="1e4062cf-361d-415e-8c05-cd04954424d1", @timestamp="2016-08-10T13:11:49.353Z", @value=99804.15, @port="p">, ...
+
+previous_timeseries.next
+# =>
 ```
 
 If no previous data exists, the `.previous` method will return `false`.
@@ -147,6 +151,27 @@ sensor.timeseries.previous
 # => false
 ```
 
+#### Timeseries Aggregations
+
+In addition to returning the raw data points, Helium can return timeseries data aggregated into buckets.
+
+
+For example, if you wanted to display a graph of a sensor's temperature min, max and average readings grouped by day, you could do the following:
+
+```ruby
+data_points = sensor.timeseries(port: 't', aggtype: 'min,max,avg', aggsize: '1d')
+# => #<Helium::Timeseries:0x007fe7038c2d18 @data_points=[#<Helium::DataPoint:0x007fe7038c2c00 @client=<Helium::Client @debug=true>, @id="a93e47f4-2fb2-4336-84c0-20f83ee2988e", @timestamp="2016-08-16T00:00:00Z", @value={"max"=>22.579952, "avg"=>22.1155383392857, "min"=>21.774511}, @port="agg(t)">, ...
+
+data_points.first.min
+# => 21.774511
+
+data_points.first.max
+# => 22.579952
+
+data_points.first.avg
+# => 22.1155383392857
+```
+
 
 ## Development
 
@@ -155,7 +180,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ### Roadmap
-- [ ] Timeseries Aggregations
+- [X] Timeseries Aggregations
 - [ ] POST/PUT/DELETE users, orgs, sensors, timeseries
 - [ ] Ports
 - [ ] Labels

data/helium-ruby.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
   spec.add_development_dependency "terminal-notifier-guard", "~> 1.7.0"
   spec.add_development_dependency "simplecov", "~> 0.12.0"
+  spec.add_development_dependency "human_time", "~> 0.2.0"
 end

data/lib/helium/client/http.rb

@@ -19,7 +19,8 @@ module Helium
         request.run()
 
         if debug?
-          puts "GET #{url} #{request.response.code} #{request.response.total_time}"
+          # TODO print request method dynamically, won't always be GET
+          puts "GET #{request.url} #{request.response.code} #{request.response.total_time}"
           # puts request.response.body
         end
 

data/lib/helium/client/sensors.rb

@@ -19,12 +19,14 @@ module Helium
         return Sensor.new(client: self, params: sensor_data)
       end
 
-      def sensor_timeseries(sensor, size: 1000, port: nil, start_time: nil, end_time: nil)
+      def sensor_timeseries(sensor, size: 1000, port: nil, start_time: nil, end_time: nil, aggtype: nil, aggsize: nil)
         options = {
-          "page[size]" => size,
-          "filter[port]" => port,
+          "page[size]"    => size,
+          "filter[port]"  => port,
           "filter[start]" => datetime_to_iso(start_time),
-          "filter[end]" => datetime_to_iso(end_time)
+          "filter[end]"   => datetime_to_iso(end_time),
+          "agg[type]"     => aggtype,
+          "agg[size]"     => aggsize
         }.delete_if { |key, value| value.to_s.empty? }
 
         response = get("/sensor/#{sensor.id}/timeseries", options: options)

data/lib/helium/data_point.rb

@@ -13,5 +13,21 @@ module Helium
     def timestamp
       DateTime.parse(@timestamp)
     end
+
+    def ==(other)
+      self.id == other.id
+    end
+
+    def max
+      @value["max"]
+    end
+
+    def min
+      @value["min"]
+    end
+
+    def avg
+      @value["avg"]
+    end
   end
 end

data/lib/helium/sensor.rb

@@ -20,12 +20,14 @@ module Helium
       DateTime.parse(@updated_at)
     end
 
-    def timeseries(size: 1000, port: nil, start_time: nil, end_time: nil)
+    def timeseries(size: 1000, port: nil, start_time: nil, end_time: nil, aggtype: nil, aggsize: nil)
       @client.sensor_timeseries(self,
         size:       size,
         port:       port,
         start_time: start_time,
-        end_time:   end_time
+        end_time:   end_time,
+        aggtype:    aggtype,
+        aggsize:    aggsize
       )
     end
   end

data/lib/helium/timeseries.rb

@@ -5,14 +5,17 @@ module Helium
 
     def_delegators :@data_points, :size, :length, :last
 
-    attr_accessor :data_points, :previous_link
+    attr_accessor :data_points
 
-    def initialize(client:, params:, links:)
+    def initialize(client:, params: [], links: {})
       @client = client
+
       @data_points = params.map { |data_point_params|
         DataPoint.new(client: client, params: data_point_params)
       }
+
       @previous_link = links["prev"]
+      @next_link     = links["next"]
     end
 
     def each(&block)
@@ -23,5 +26,10 @@ module Helium
       return false if @previous_link.nil?
       @client.sensor_timeseries_by_link(@previous_link)
     end
+
+    def next
+      return false if @next_link.nil?
+      @client.sensor_timeseries_by_link(@next_link)
+    end
   end
 end

data/lib/helium/version.rb

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Allen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: human_time
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: A Ruby gem for building applications with the Helium API
 email:
 - allenan@helium.com