helium-ruby 0.25.0 → 0.26.0

data/docs/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Feb 13 09:17:41 2017 by
+  Generated on Wed Apr  5 13:55:53 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.rb

@@ -19,6 +19,7 @@ require "helium/data_point"
 require "helium/element"
 require "helium/configuration"
 require "helium/device_configuration"
+require "helium/helium_script"
 
 module Helium
 end

data/lib/helium/client.rb

@@ -1,23 +1,25 @@
+require 'helium/client/configurations'
+require 'helium/client/device_configurations'
+require 'helium/client/elements'
+require 'helium/client/helium_scripts'
 require 'helium/client/http'
-require 'helium/client/users'
+require 'helium/client/labels'
 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'
+require 'helium/client/users'
 
 module Helium
   class Client
     include Helium::Utils
+    include Helium::Client::Configurations
+    include Helium::Client::DeviceConfigurations
+    include Helium::Client::Elements
+    include Helium::Client::HeliumScripts
     include Helium::Client::Http
-    include Helium::Client::Users
+    include Helium::Client::Labels
     include Helium::Client::Organizations
     include Helium::Client::Sensors
-    include Helium::Client::Labels
-    include Helium::Client::Elements
-    include Helium::Client::Configurations
-    include Helium::Client::DeviceConfigurations
+    include Helium::Client::Users
 
 
     API_VERSION = 'v1'

data/lib/helium/client/helium_scripts.rb

@@ -0,0 +1,105 @@
+require 'base64'
+
+module Helium
+  class Client
+    module HeliumScripts
+
+      def create_script(name, file_content)
+        contents = Base64.strict_encode64(file_content)
+        Script.create({ name: name , contents: contents }, client: self)
+      end
+
+      def scripts
+        Script.all(client: self)
+      end
+
+      def script(id)
+        Script.find(id, client: self)
+      end
+
+      def create_library(name, file_content)
+        contents = Base64.strict_encode64(file_content)
+        Library.create({ name: name , contents: contents }, client: self)
+      end
+
+      def libraries
+        Library.all(client: self)
+      end
+
+      def library(id)
+        Library.find(id, client: self)
+      end
+
+      def packages
+        Package.all(client: self)
+      end
+
+      def package(id)
+        Package.find(id, client: self)
+      end
+
+      def create_package(script, libraries = [], name = nil)
+        library_rels = Array(libraries).map do |lib|
+          { id: lib.id, type: 'library' }
+        end
+        body = {
+          data: {
+            attributes: {
+              name: name
+            },
+            type: 'package',
+            relationships: {
+              script: {
+                data: {
+                  id: script.id,
+                  type: 'script'
+                }
+              },
+              library: {
+                data: library_rels
+              }
+            }
+          }
+        }
+
+        response = post('/package', body: body)
+        resource_data = JSON.parse(response.body)["data"]
+        Package.new(client: self, params: resource_data)
+      end
+
+      def sensor_packages
+        SensorPackage.all(client: self)
+      end
+
+      def sensor_package(id)
+        SensorPackage.find(id, client: self)
+      end
+
+      def create_sensor_package(sensor, package)
+        body = {
+          data: {
+            type: 'sensor-package',
+            relationships: {
+              package: {
+                data: {
+                  id: package.id,
+                  type: 'package'
+                }
+              },
+              sensor: {
+                data: {
+                  id: sensor.id,
+                  type: 'sensor'
+                }
+              }
+            }
+          }
+        }
+
+        response = post('/sensor-package', body: body)
+        resource_data = JSON.parse(response.body)["data"]
+        SensorPackage.new(client: self, params: resource_data)
+      end
+    end
+  end
+end

data/lib/helium/helium_script.rb

@@ -0,0 +1,73 @@
+# The following classes are all closely related and thus included in the same file
+module Helium
+  class Script < Resource
+    attr_reader :name
+
+    def initialize(opts = {})
+      super(opts)
+      @name    = @params.dig('attributes', 'name')
+      @digest  = @params.dig('meta', 'digest')
+    end
+
+    def content
+      @content ||= @client.get(resource_path+'/content',
+                               content_type: 'application/octet-stream').body
+    end
+  end
+
+  class Library < Resource
+    attr_reader :name
+
+    def initialize(opts = {})
+      super(opts)
+      @name   = @params.dig('attributes', 'name')
+      @digest = @params.dig('meta', 'digest')
+    end
+
+    def content
+      @content ||= @client.get(resource_path+'/content',
+                               content_type: 'application/octet-stream').body
+    end
+  end
+
+  class Package < Resource
+    attr_reader :name
+
+    def initialize(opts = {})
+      super(opts)
+      @name = @params.dig('attributes', 'name')
+    end
+
+    # Script is immutable and can be cached
+    def script
+      @script ||= Script.initialize_from_path(path: "#{resource_path}/script",
+                                               client: @client)
+    end
+
+    # Libraries are immutable and can be cached
+    def libraries
+      @libs ||= Collection.new(klass: Library, client: @client,
+                               belongs_to: self)
+    end
+  end
+
+  class SensorPackage < Resource
+    attr_reader :loaded
+
+    def initialize(opts = {})
+      super(opts)
+      @loaded = @params.dig('meta', 'loaded')
+    end
+
+    # Sensor is not immutable (name can change), and should not be cached
+    def sensor
+      Sensor.initialize_from_path(path: "#{resource_path}/sensor", client: @client)
+    end
+
+    # Package is immutable and can be cached
+    def package
+      @package ||= Package.initialize_from_path(path: "#{resource_path}/package",
+                                                client: @client)
+    end
+  end
+end

data/lib/helium/sensor.rb

@@ -116,5 +116,11 @@ module Helium
       end
       self
     end
+
+    # A sensor can be associated with at most 2 sensor-packages: the loaded
+    # package and package being loaded
+    def sensor_packages
+      Collection.new(klass: SensorPackage, client: @client, belongs_to: self)
+    end
   end
 end

data/lib/helium/version.rb

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.25.0"
+  VERSION = "0.26.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Andrew Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -293,6 +293,7 @@ files:
 - lib/helium/client/configurations.rb
 - lib/helium/client/device_configurations.rb
 - lib/helium/client/elements.rb
+- lib/helium/client/helium_scripts.rb
 - lib/helium/client/http.rb
 - lib/helium/client/labels.rb
 - lib/helium/client/organizations.rb
@@ -305,6 +306,7 @@ files:
 - lib/helium/device_configuration.rb
 - lib/helium/element.rb
 - lib/helium/error.rb
+- lib/helium/helium_script.rb
 - lib/helium/label.rb
 - lib/helium/metadata.rb
 - lib/helium/organization.rb
@@ -335,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for building applications with the Helium API