helium-ruby 0.3.0 → 0.4.0

data/docs/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 18 10:50:33 2016 by
+  Generated on Mon Aug 22 15:52:19 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.3 (ruby-2.3.1).
 </div>

data/lib/helium.rb

@@ -6,10 +6,13 @@ require "helium/version"
 require "helium/utils"
 require "helium/client"
 require "helium/cursor"
+require "helium/resource"
 require "helium/user"
 require "helium/organization"
 require "helium/sensor"
+require "helium/label"
 require "helium/data_point"
+require "helium/element"
 
 module Helium
 end

data/lib/helium/client.rb

@@ -2,6 +2,8 @@ require 'helium/client/http'
 require 'helium/client/users'
 require 'helium/client/organizations'
 require 'helium/client/sensors'
+require 'helium/client/labels'
+require 'helium/client/elements'
 
 module Helium
   class Client
@@ -10,6 +12,8 @@ module Helium
     include Helium::Client::Users
     include Helium::Client::Organizations
     include Helium::Client::Sensors
+    include Helium::Client::Labels
+    include Helium::Client::Elements
 
     attr_accessor :api_key
 

data/lib/helium/client/elements.rb

@@ -0,0 +1,42 @@
+module Helium
+  class Client
+    module Elements
+      def elements
+        response = get('/element')
+        elements_data = JSON.parse(response.body)["data"]
+
+        elements = elements_data.map do |element_data|
+          Element.new(client: self, params: element_data)
+        end
+
+        return elements
+      end
+
+      def element(id)
+        response = get("/element/#{id}")
+        element_data = JSON.parse(response.body)["data"]
+
+        return Element.new(client: self, params: element_data)
+      end
+
+      def update_element(element, name:)
+        path = "/element/#{element.id}"
+
+        body = {
+          data: {
+            attributes: {
+              name: name
+            },
+            id: element.id,
+            type: "element"
+          }
+        }
+
+        response = patch(path, body: body)
+        element_data = JSON.parse(response.body)["data"]
+
+        return Element.new(client: self, params: element_data)
+      end
+    end
+  end
+end

data/lib/helium/client/labels.rb

@@ -0,0 +1,105 @@
+module Helium
+  class Client
+    module Labels
+      def labels
+        response = get('/label')
+        labels_data = JSON.parse(response.body)["data"]
+
+        labels = labels_data.map do |label_data|
+          Label.new(client: self, params: label_data)
+        end
+
+        return labels
+      end
+
+      def label(id)
+        response = get("/label/#{id}")
+        label_data = JSON.parse(response.body)["data"]
+
+        return Label.new(client: self, params: label_data)
+      end
+
+      def new_label(name:)
+        path = "/label"
+
+        body = {
+          data: {
+            attributes: {
+              name: name
+            },
+            type: "label"
+          }
+        }
+
+        response = post(path, body: body)
+        label_data = JSON.parse(response.body)["data"]
+
+        return Label.new(client: self, params: label_data)
+      end
+
+      def update_label(label, name:)
+        path = "/label/#{label.id}"
+
+        body = {
+          data: {
+            attributes: {
+              name: name
+            },
+            id: label.id,
+            type: "label"
+          }
+        }
+
+        response = patch(path, body: body)
+        label_data = JSON.parse(response.body)["data"]
+
+        return Label.new(client: self, params: label_data)
+      end
+
+      def delete_label(label)
+        path = "/label/#{label.id}"
+        delete(path)
+      end
+
+      def label_sensors(label)
+        path = "/label/#{label.id}/sensor"
+        response = get(path)
+        sensors_data = JSON.parse(response.body)["data"]
+
+        sensors = sensors_data.map do |sensor_data|
+          Sensor.new(client: self, params: sensor_data)
+        end
+
+        return sensors
+      end
+
+      def update_label_sensors(label, sensors: [])
+        path = "/label/#{label.id}/relationships/sensor"
+
+        sensors = Array(sensors)
+
+        new_sensor_data = sensors.map do |sensor|
+          {
+            id: sensor.id,
+            type: 'sensor'
+          }
+        end
+
+        body = {
+          data: new_sensor_data
+        }
+
+        response = patch(path, body: body)
+        sensors_data = JSON.parse(response.body)["data"]
+
+        # TODO: these come back deflated. need to either inflate at this point or
+        # when needed
+        sensors = sensors_data.map do |sensor_data|
+          Sensor.new(client: self, params: sensor_data)
+        end
+
+        return sensors
+      end
+    end
+  end
+end

data/lib/helium/cursor.rb

@@ -29,6 +29,10 @@ module Helium
       end
     end
 
+    def to_json(*options)
+      self.map(&:as_json).to_json(*options)
+    end
+
     private
 
     def fetch_next_page

data/lib/helium/data_point.rb

@@ -1,10 +1,10 @@
 module Helium
-  class DataPoint
-    attr_accessor :id, :timestamp, :value, :port
+  class DataPoint < Resource
+    attr_reader :timestamp, :value, :port
 
     def initialize(client:, params:)
-      @client     = client
-      @id         = params["id"]
+      super(client: client, params: params)
+
       @timestamp  = params.dig("attributes", "timestamp")
       @value      = params.dig("attributes", "value")
       @port       = params.dig("attributes", "port")
@@ -14,20 +14,40 @@ module Helium
       DateTime.parse(@timestamp)
     end
 
-    def ==(other)
-      self.id == other.id
-    end
-
     def max
+      return nil unless @value.is_a?(Hash)
       @value["max"]
     end
 
     def min
+      return nil unless @value.is_a?(Hash)
       @value["min"]
     end
 
     def avg
+      return nil unless @value.is_a?(Hash)
       @value["avg"]
     end
+
+    def aggregate?
+      [max, min, avg].none? { |agg_value| agg_value.nil? }
+    end
+
+    def as_json
+      j = super.merge({
+        timestamp: timestamp,
+        port: port
+      })
+
+      if aggregate?
+        j[:max] = max
+        j[:min] = min
+        j[:avg] = avg
+      else
+        j[:value] = value
+      end
+
+      j
+    end
   end
 end

data/lib/helium/element.rb

@@ -0,0 +1,27 @@
+module Helium
+  class Element < Resource
+    attr_reader :name, :mac, :versions
+
+    def initialize(client:, params:)
+      super(client: client, params: params)
+
+      @name     = params.dig("attributes", "name")
+      @mac      = params.dig("meta", "mac")
+      @versions = params.dig("meta", "versions")
+    end
+
+    # TODO these kinds of methods should be generalized into a Resource object
+    def update(name:)
+      @client.update_element(self, name: name)
+    end
+
+    # TODO can probably generalize this a bit more
+    def as_json
+      super.merge({
+        name: name,
+        mac: mac,
+        versions: versions
+      })
+    end
+  end
+end

data/lib/helium/label.rb

@@ -0,0 +1,44 @@
+module Helium
+  class Label < Resource
+    attr_reader :name
+
+    def initialize(client:, params:)
+      super(client: client, params: params)
+
+      @name = params.dig("attributes", "name")
+    end
+
+    def update(name:)
+      @client.update_label(self, name: name)
+    end
+
+    def destroy
+      @client.delete_label(self)
+    end
+
+    # TODO: would be nice to wrap this in a proxy collection, that way
+    # we could do something like label.sensors << new_sensor
+    def sensors
+      @client.label_sensors(self)
+    end
+
+    def add_sensors(sensors_to_add = [])
+      sensors_to_add = Array(sensors_to_add)
+
+      @client.update_label_sensors(self, sensors: sensors + sensors_to_add)
+    end
+
+    def remove_sensors(sensors_to_remove = [])
+      sensors_to_remove = Array(sensors_to_remove)
+
+      @client.update_label_sensors(self, sensors: sensors - sensors_to_remove)
+    end
+
+    # TODO can probably generalize this a bit more
+    def as_json
+      super.merge({
+        name: name
+      })
+    end
+  end
+end

data/lib/helium/organization.rb

@@ -1,27 +1,24 @@
 module Helium
-  class Organization
-    attr_accessor :id, :name, :timezone, :created_at, :updated_at
+  class Organization < Resource
+    attr_reader :name, :timezone
 
     def initialize(client:, params:)
-      @client     = client
-      @id         = params["id"]
-      @name       = params["attributes"]["name"]
-      @timezone   = params["attributes"]["timezone"]
-      @created_at = params["meta"]["created"]
-      @updated_at = params["meta"]["updated"]
-    end
-
-    def created_at
-      DateTime.parse(@created_at)
-    end
+      super(client: client, params: params)
 
-    def updated_at
-      DateTime.parse(@updated_at)
+      @name     = params.dig('attributes', 'name')
+      @timezone = params.dig('attributes', 'timezone')
     end
 
     # TODO refactor into relationships
     def users
       @client.organization_users
     end
+
+    def as_json
+      super.merge({
+        name: name,
+        timezone: timezone
+      })
+    end
   end
 end

data/lib/helium/resource.rb

@@ -0,0 +1,58 @@
+module Helium
+  # Abstract base class for Helium Resources returned by the API
+  class Resource
+    attr_reader :id
+
+    def initialize(client:, params:)
+      @client     = client
+      @id         = params["id"]
+      @created_at = params.dig('meta', 'created')
+      @updated_at = params.dig('meta', 'updated')
+    end
+
+    # Override equality to use id for comparisons
+    # @return [Boolean]
+    def ==(other)
+      self.id == other.id
+    end
+
+    # Override equality to use id for comparisons
+    # @return [Boolean]
+    def eql?(other)
+      self == other
+    end
+
+    # Override equality to use id for comparisons
+    # @return [Integer]
+    def hash
+      id.hash
+    end
+
+    # @return [DateTime, nil] when the resource was created
+    def created_at
+      return nil if @created_at.nil?
+      @_created_at ||= DateTime.parse(@created_at)
+    end
+
+    # @return [DateTime, nil] when the resource was last updated
+    def updated_at
+      return nil if @updated_at.nil?
+      @_updated_at ||= DateTime.parse(@updated_at)
+    end
+
+    # Inheriting resources should implement this with super
+    # @return [Hash] a Hash of the object's attributes for JSON
+    def as_json
+      {
+        id: id,
+        created_at: created_at,
+        updated_at: updated_at
+      }
+    end
+
+    # @return [String] a JSON-encoded String representing the resource
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/helium/sensor.rb

@@ -1,23 +1,13 @@
 module Helium
-  class Sensor
-    attr_accessor :id, :name, :mac, :ports, :created_at, :updated_at
+  class Sensor < Resource
+    attr_reader :name, :mac, :ports
 
     def initialize(client:, params:)
-      @client     = client
-      @id         = params["id"]
-      @name       = params["attributes"]["name"]
-      @mac        = params["meta"]["mac"]
-      @ports      = params["meta"]["ports"]
-      @created_at = params["meta"]["created"]
-      @updated_at = params["meta"]["updated"]
-    end
-
-    def created_at
-      DateTime.parse(@created_at)
-    end
+      super(client: client, params: params)
 
-    def updated_at
-      DateTime.parse(@updated_at)
+      @name  = params.dig('attributes', 'name')
+      @mac   = params.dig('meta', 'mac')
+      @ports = params.dig('meta', 'ports')
     end
 
     def timeseries(size: 1000, port: nil, start_time: nil, end_time: nil, aggtype: nil, aggsize: nil)
@@ -31,7 +21,7 @@ module Helium
       )
     end
 
-    # TODO these kinds of methods should be generalized into a Resource object
+    # TODO CRUD methods will be generalized into the Resource object
     def update(name:)
       @client.update_sensor(self, name: name)
     end
@@ -39,5 +29,14 @@ module Helium
     def destroy
       @client.delete_sensor(self)
     end
+
+    # TODO can probably generalize this a bit more
+    def as_json
+      super.merge({
+        name: name,
+        mac: mac,
+        ports: ports
+      })
+    end
   end
 end