helium-ruby 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbfd4c95a1135dc05274c9817a0f162d440b4484
-  data.tar.gz: a78dd6c5ba6f78b036fdb1282dca3e28b6e147a8
+  metadata.gz: b91648a288c3daa41d4c26265856513591b67986
+  data.tar.gz: d739e7f23b26dee61722fd96eb709e56f64c2af9
 SHA512:
-  metadata.gz: a8c8332d1fcd0bbf5f0b398276e33c9d3be987bbe9380720f5dce9f00c317b9c3c7e487b97c904b72f1e4d4b03f5f1fdaec52313a7e3421fffccecf537203d5a
-  data.tar.gz: d911b8b253af8e1f9da7151200f0e913f6d39fb2ff8aa05ccc2e79d2c89ae2db5454b78b525df80ab448225ac626f57b70efd0d9e1180b5f379d8061374db557
+  metadata.gz: 4bc90567717d28ea616d5b6399c1865756ecced3c92b47a2c4034118e1158d72316977511cadaffa3cdf2a05c0d100eff52ac5622866630b818739617932c302
+  data.tar.gz: c8455d1442c8fe00503d57c36f5a62ac3cb57ed31deb8792e9ff7a6cb3b4cb332728677b36f1bf003bda8799e0f92ce7cdefa93c034644ed3c96f6149e6c0d3b

data/lib/helium.rb

@@ -15,6 +15,8 @@ require "helium/label"
 require "helium/timeseries"
 require "helium/data_point"
 require "helium/element"
+require "helium/configuration"
+require "helium/device_configuration"
 
 module Helium
 end

data/lib/helium/client.rb

@@ -4,6 +4,8 @@ require 'helium/client/organizations'
 require 'helium/client/sensors'
 require 'helium/client/labels'
 require 'helium/client/elements'
+require 'helium/client/configurations'
+require 'helium/client/device_configurations'
 
 module Helium
   class Client
@@ -14,6 +16,9 @@ module Helium
     include Helium::Client::Sensors
     include Helium::Client::Labels
     include Helium::Client::Elements
+    include Helium::Client::Configurations
+    include Helium::Client::DeviceConfigurations
+
 
     API_VERSION = 1
     HOST        = 'api.helium.com'

data/lib/helium/client/configurations.rb

@@ -0,0 +1,31 @@
+module Helium
+  class Client
+    module Configurations
+
+      def configurations
+        Configuration.all(client: self)
+      end
+
+      def configuration(id)
+        Configuration.find(id, client: self)
+      end
+
+      def config_device_configurations(id)
+        path = "/configuration/#{id}/device-configuration"
+        response = get(path)
+        device_confs_data = JSON.parse(response.body)["data"]
+
+        device_confs = device_confs_data.map do |dc|
+          DeviceConfiguration.new(client: self, params: dc)
+        end
+
+        return device_confs
+      end
+
+      # Configurations are immutable, so no updates are available
+      def create_configuration(attributes)
+        Configuration.create(attributes, client: self)
+      end
+    end
+  end
+end

data/lib/helium/client/device_configurations.rb

@@ -0,0 +1,64 @@
+module Helium
+  class Client
+    module DeviceConfigurations
+
+      def device_configurations
+        DeviceConfiguration.all(client: self)
+      end
+
+      def device_configuration(id)
+        DeviceConfiguration.find(id, client: self)
+      end
+
+      def device_configuration_configuration(device_config)
+        path = "/device-configuration/#{device_config.id}/configuration"
+        response = get(path)
+        configj = JSON.parse(response.body)["data"]
+        config = Configuration.new(client: self, params: configj)
+        return config
+      end
+
+      def device_configuration_device(device_config)
+        path = "/device-configuration/#{device_config.id}/device"
+        response = get(path)
+        configj = JSON.parse(response.body)["data"]
+
+        if configj.dig("type") == "sensor"
+          device = Sensor.new(client: self, params: configj)
+        elsif configj.dig("type") == "element"
+          device = Element.new(client: self, params: configj)
+        end
+
+        return device
+      end
+
+      def create_device_configuration(device, configuration)
+        path = "/device-configuration"
+
+        body = {
+          data: {
+            type: "device-configuration",
+            relationships: {
+              configuration: {
+                data: {
+                  id: configuration.id,
+                  type: configuration.type
+                }
+              },
+              device: {
+                data: {
+                  id: device.id,
+                  type: device.type
+                }
+              }
+            }
+          }
+        }
+
+        response = post(path, body: body)
+        dc = JSON.parse(response.body)["data"]
+        return DeviceConfiguration.new(client: self, params: dc)
+      end
+    end
+  end
+end

data/lib/helium/client/elements.rb

@@ -21,6 +21,14 @@ module Helium
         return sensors
       end
 
+      def element_device_configuration(element)
+        path = "/element/#{element.id}/device-configuration"
+        response = get(path)
+        dc_data = JSON.parse(response.body)["data"]
+        # dc_data is an array, but there will only be one for one
+        return  DeviceConfiguration.new(client: self, params: dc_data[0])
+      end
+
       def element_timeseries(element, opts = {})
         path = "/element/#{element.id}/timeseries"
 

data/lib/helium/client/sensors.rb

@@ -30,6 +30,14 @@ module Helium
         return labels
       end
 
+      def sensor_device_configuration(sensor)
+        path = "/sensor/#{sensor.id}/device-configuration"
+        response = get(path)
+        dc_data = JSON.parse(response.body)["data"]
+        # dc_data is an array, but there will only be one for one
+        return  DeviceConfiguration.new(client: self, params: dc_data[0])
+      end
+
       def sensor_timeseries(sensor, opts = {})
         path = "/sensor/#{sensor.id}/timeseries"
 

data/lib/helium/configuration.rb

@@ -0,0 +1,15 @@
+module Helium
+  class Configuration < Resource
+    attr_reader :settings
+
+    def initialize(opts = {})
+      super(opts)
+      @settings = @params.dig('attributes')
+    end
+
+    def device_configurations
+      @client.config_device_configurations(self.id)
+    end
+
+  end
+end

data/lib/helium/device_configuration.rb

@@ -0,0 +1,23 @@
+module Helium
+  class DeviceConfiguration < Resource
+    attr_reader :loaded
+
+    def initialize(opts = {})
+      super(opts)
+      @loaded = @params.dig('meta', 'loaded')
+    end
+
+    def device
+      @client.device_configuration_device(self)
+    end
+
+    def configuration
+      @client.device_configuration_configuration(self)
+    end
+
+    def as_json
+      super.merge({ loaded: loaded })
+    end
+
+  end
+end

data/lib/helium/element.rb

@@ -14,6 +14,10 @@ module Helium
       @client.element_sensors(self)
     end
 
+    def device_configuration
+      @client.element_device_configuration(self)
+    end
+
     # @return [DateTime, nil] when the resource was last seen
     def last_seen
       return nil if @last_seen.nil?

data/lib/helium/error.rb

@@ -9,7 +9,12 @@ module Helium
     # @return [Helium::Error]
     def self.from_response(response)
       status  = response.code
-      message = JSON.parse(response.body)["errors"].first["detail"]
+      # Default the error message in the case of no error body
+      message = if response.body && response.body.length >= 2
+                  JSON.parse(response.body)["errors"].first["detail"]
+                else
+                  "Unknown error with code: #{response.code}"
+                end
 
       klass =  case status
                when 401   then Helium::InvalidApiKey

data/lib/helium/resource.rb

@@ -2,6 +2,7 @@ module Helium
   # Abstract base class for Helium Resources returned by the API
   class Resource
     attr_reader :id, :type, :params
+    include Helium::Utils
 
     def initialize(opts = {})
       @client = opts.fetch(:client)
@@ -14,6 +15,8 @@ module Helium
     end
 
     class << self
+      include Helium::Utils
+
       # NOTE seems a bit out of place to be doing client work here, but it
       # makes sense for the Eigenclass to be responsible for constructing
       # instances of its inheriting class.
@@ -76,7 +79,7 @@ module Helium
       private
 
       def resource_name
-        self.name.split('::').last.downcase
+        kebab_case(self.name.split('::').last)
       end
     end # << self
 
@@ -161,7 +164,7 @@ module Helium
     private
 
     def resource_name
-      self.class.name.split('::').last.downcase
+      kebab_case(self.class.name.split('::').last)
     end
   end
 end

data/lib/helium/sensor.rb

@@ -23,6 +23,10 @@ module Helium
       @client.sensor_labels(self)
     end
 
+    def device_configuration
+      @client.sensor_device_configuration(self)
+    end
+
     def timeseries(opts = {})
       size        = opts.fetch(:size, 1000)
       port        = opts.fetch(:port, nil)

data/lib/helium/utils.rb

@@ -4,5 +4,9 @@ module Helium
       return nil if datetime.nil?
       Time.parse(datetime.to_s).utc.iso8601
     end
+
+    def kebab_case(string)
+      string.gsub(/(.)([A-Z])/,'\1-\2').downcase
+    end
   end
 end

data/lib/helium/version.rb

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Andrew Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -283,14 +283,18 @@ files:
 - helium-ruby.gemspec
 - lib/helium.rb
 - lib/helium/client.rb
+- lib/helium/client/configurations.rb
+- lib/helium/client/device_configurations.rb
 - lib/helium/client/elements.rb
 - lib/helium/client/http.rb
 - lib/helium/client/labels.rb
 - lib/helium/client/organizations.rb
 - lib/helium/client/sensors.rb
 - lib/helium/client/users.rb
+- lib/helium/configuration.rb
 - lib/helium/cursor.rb
 - lib/helium/data_point.rb
+- lib/helium/device_configuration.rb
 - lib/helium/element.rb
 - lib/helium/error.rb
 - lib/helium/label.rb