helium-ruby 0.21.0 → 0.22.0

data/docs/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 12 15:58:34 2017 by
+  Generated on Mon Feb 13 09:17:41 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.1).
 </div>

data/lib/helium/client/http.rb

@@ -2,8 +2,6 @@ module Helium
   class Client
     module Http
       BASE_HTTP_HEADERS = {
-        'Accept'        => 'application/json',
-        'Content-Type'  => 'application/json',
         'User-Agent'    => 'helium-ruby'
       }
 
@@ -36,6 +34,32 @@ module Helium
         response.code == 204
       end
 
+      # Stream data from the provided path
+      # @param [String] path a relative path
+      # @option opts [Class] :klass a class to be initialized with received data
+      # @option opts [Hash] :params a hash of params to be used as query params
+      # @yield [Helium::Resource] accepts logic to perform on the initialized Helium::Resource class
+      def stream_from(path, opts = {}, &block)
+        klass = opts.fetch(:klass)
+        params = opts.fetch(:params, {})
+        request = generate_request(path, {
+          method: :get,
+          content_type: :stream,
+          params: params
+        })
+
+        request.on_body do |chunk|
+          if chunk =~ /data:/
+            json_string = chunk[chunk.index('{')..chunk.rindex('}')]
+            json_data = JSON.parse(json_string)["data"]
+            object = klass.new(client: self, params: json_data)
+            yield object
+          end
+        end
+
+        run_request(request)
+      end
+
       def base_url
         url = "#{PROTOCOL}://#{@api_host}"
         url += "/#{@api_version}" if @api_version
@@ -53,12 +77,29 @@ module Helium
 
       private
 
-      def http_headers
-        BASE_HTTP_HEADERS
+      def http_headers(opts = {})
+        content_type = opts.fetch(:content_type, :json)
+
+        http_headers = BASE_HTTP_HEADERS
           .merge(@headers)
           .merge({
             'Authorization' => api_key
           })
+
+        case content_type
+        when :json
+          http_headers.merge!({
+            'Accept'        => 'application/json',
+            'Content-Type'  => 'application/json'
+          })
+        when :stream
+          http_headers.merge!({
+            'Accept'        => 'text/event-stream',
+            'Content-Type'  => 'text/event-stream'
+          })
+        end
+
+        return http_headers
       end
 
       def run(path, method, opts = {})
@@ -68,15 +109,16 @@ module Helium
       end
 
       def generate_request(path, opts = {})
-        method = opts.fetch(:method)
-        params = opts.fetch(:params, {})
-        body   = opts.fetch(:body, {})
-        url    = url_for(path)
+        method       = opts.fetch(:method)
+        content_type = opts.fetch(:content_type, :json)
+        params       = opts.fetch(:params, {})
+        body         = opts.fetch(:body, {})
+        url          = url_for(path)
 
         Typhoeus::Request.new(url, {
           method:         method,
           params:         params,
-          headers:        http_headers,
+          headers:        http_headers(content_type: content_type),
           ssl_verifypeer: @verify_peer,
           body:           JSON.generate(body)
         })

data/lib/helium/client/sensors.rb

@@ -45,6 +45,20 @@ module Helium
         )
       end
 
+      def sensor_live_timeseries(sensor, opts = {}, &block)
+        path = "/sensor/#{sensor.id}/timeseries/live"
+
+        params = {
+          "filter[port]"  => opts.fetch(:port, nil),
+          "filter[start]" => datetime_to_iso(opts.fetch(:start_time, nil)),
+          "filter[end]"   => datetime_to_iso(opts.fetch(:end_time, nil)),
+          "agg[type]"     => opts.fetch(:aggtype),
+          "agg[size]"     => opts.fetch(:aggsize)
+        }.delete_if { |_key, value| value.to_s.empty? }
+
+        stream_from(path, klass: Helium::DataPoint, params: params, &block)
+      end
+
       def create_sensor(attributes)
         Sensor.create(attributes, client: self)
       end

data/lib/helium/collection.rb

@@ -23,7 +23,7 @@ module Helium
     # Uses metadata filtering
     # (https://docs.helium.com/api/v1/metadata/index.html#filtering)
     # to search for a collection of resources matching the search parameters
-    # @param [Hash] a set of search criteria
+    # @param [Hash] criteria a set of search criteria
     #
     # @example Search for sensors by location
     #   client.sensors.where(location: 'Building B') #=> [Sensor, Sensor]
@@ -31,7 +31,7 @@ module Helium
     # @example Search for multiple matching search parameters
     #   client.sensors.where(departments: ['it', 'engineering']) #=> [Sensor, Sensor]
     #
-    # @return [Collection] a Collection of resources matching the provided search criteria
+    # @return [Collection] a collection of resources matching the provided search criteria
     def where(criteria)
       add_filter_criteria(criteria)
       self

data/lib/helium/sensor.rb

@@ -49,6 +49,22 @@ module Helium
       )
     end
 
+    def live_timeseries(opts = {}, &block)
+      port        = opts.fetch(:port, nil)
+      start_time  = opts.fetch(:start_time, nil)
+      end_time    = opts.fetch(:end_time, nil)
+      aggtype     = opts.fetch(:aggtype, nil)
+      aggsize     = opts.fetch(:aggsize, nil)
+
+      @client.sensor_live_timeseries(self, {
+        port:       port,
+        start_time: start_time,
+        end_time:   end_time,
+        aggtype:    aggtype,
+        aggsize:    aggsize
+      }, &block)
+    end
+
     # @return [DateTime, nil] when the resource was last seen
     def last_seen
       return nil if @last_seen.nil?

data/lib/helium/version.rb

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.21.0"
+  VERSION = "0.22.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Andrew Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-13 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus