helium-ruby 0.4.0 → 0.5.0

data/lib/helium/organization.rb

@@ -2,11 +2,11 @@ module Helium
   class Organization < Resource
     attr_reader :name, :timezone
 
-    def initialize(client:, params:)
-      super(client: client, params: params)
+    def initialize(opts = {})
+      super(opts)
 
-      @name     = params.dig('attributes', 'name')
-      @timezone = params.dig('attributes', 'timezone')
+      @name     = @params.dig('attributes', 'name')
+      @timezone = @params.dig('attributes', 'timezone')
     end
 
     # TODO refactor into relationships

data/lib/helium/resource.rb

@@ -3,11 +3,103 @@ module Helium
   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')
+    def initialize(opts = {})
+      @client = opts.fetch(:client)
+      @params = opts.fetch(:params)
+
+      @id         = @params["id"]
+      @created_at = @params.dig('meta', 'created')
+      @updated_at = @params.dig('meta', 'updated')
+    end
+
+    class << self
+      # NOTE seems a bit out of place to be doing client work here, but it
+      # makes sense for the Eigenclass to be responsable for constructing
+      # instances of its inheriting class.
+
+      # Returns all resources
+      # @option opts [Client] :client A Helium::Client
+      # @return [Array<Resource>] an Array of all of the inheriting Resource
+      def all(opts = {})
+        client = opts.fetch(:client)
+
+        response = client.get("/#{resource_name}")
+        resources_data = JSON.parse(response.body)["data"]
+
+        resources = resources_data.map do |resource_data|
+          self.new(client: client, params: resource_data)
+        end
+
+        return resources
+      end
+
+      # Finds a single Resource by id
+      # @param id [String] An id to find the Resource
+      # @option opts [Client] :client A Helium::Client
+      # @return [Resource]
+      def find(id, opts = {})
+        client = opts.fetch(:client)
+
+        response = client.get("/#{resource_name}/#{id}")
+        resource_data = JSON.parse(response.body)["data"]
+
+        return self.new(client: client, params: resource_data)
+      end
+
+      # Creates a new resource with given attributes
+      # @param attributes [Hash] The attributes for the new Resource
+      # @option opts [Client] :client A Helium::Client
+      # @return [Resource]
+      def create(attributes, opts = {})
+        client = opts.fetch(:client)
+
+        path = "/#{resource_name}"
+
+        body = {
+          data: {
+            attributes: attributes,
+            type: resource_name
+          }
+        }
+
+        response = client.post(path, body: body)
+        resource_data = JSON.parse(response.body)["data"]
+
+        return self.new(client: client, params: resource_data)
+      end
+
+      private
+
+      def resource_name
+        self.name.split('::').last.downcase
+      end
+    end # << self
+
+    # Updates a Resource
+    # @param attributes [Hash] The attributes to update
+    # @return [Resource] The updated resource
+    def update(attributes)
+      path = "/#{resource_name}/#{self.id}"
+
+      body = {
+        data: {
+          attributes: attributes,
+          id: self.id,
+          type: resource_name
+        }
+      }
+
+      response = @client.patch(path, body: body)
+      resource_data = JSON.parse(response.body)["data"]
+
+      return self.class.new(client: self, params: resource_data)
+    end
+
+    # Deletes the Resource
+    # @return [Boolean] Whether the operation was successful
+    def destroy
+      path = "/#{resource_name}/#{self.id}"
+      @client.delete(path)
     end
 
     # Override equality to use id for comparisons
@@ -54,5 +146,11 @@ module Helium
     def to_json(*options)
       as_json.to_json(*options)
     end
+
+    private
+
+    def resource_name
+      self.class.name.split('::').last.downcase
+    end
   end
 end

data/lib/helium/sensor.rb

@@ -2,15 +2,22 @@ module Helium
   class Sensor < Resource
     attr_reader :name, :mac, :ports
 
-    def initialize(client:, params:)
-      super(client: client, params: params)
+    def initialize(opts = {})
+      super(opts)
 
-      @name  = params.dig('attributes', 'name')
-      @mac   = params.dig('meta', 'mac')
-      @ports = params.dig('meta', 'ports')
+      @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)
+    def timeseries(opts = {})
+      size        = opts.fetch(:size, 1000)
+      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_timeseries(self,
         size:       size,
         port:       port,
@@ -21,15 +28,6 @@ module Helium
       )
     end
 
-    # TODO CRUD methods will be generalized into the Resource object
-    def update(name:)
-      @client.update_sensor(self, name: name)
-    end
-
-    def destroy
-      @client.delete_sensor(self)
-    end
-
     # TODO can probably generalize this a bit more
     def as_json
       super.merge({

data/lib/helium/user.rb

@@ -2,11 +2,11 @@ module Helium
   class User < Resource
     attr_reader :name, :email
 
-    def initialize(client:, params:)
-      super(client: client, params: params)
+    def initialize(opts = {})
+      super(opts)
 
-      @name  = params.dig('attributes', 'name')
-      @email = params.dig('meta', 'email')
+      @name  = @params.dig('attributes', 'name')
+      @email = @params.dig('meta', 'email')
     end
 
     # TODO can probably generalize this a bit more

data/lib/helium/version.rb

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Allen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -252,9 +252,12 @@ files:
 - docs/Helium/Client/Organizations.html
 - docs/Helium/Client/Sensors.html
 - docs/Helium/Client/Users.html
+- docs/Helium/ClientError.html
 - docs/Helium/Cursor.html
 - docs/Helium/DataPoint.html
 - docs/Helium/Element.html
+- docs/Helium/Error.html
+- docs/Helium/InvalidApiKey.html
 - docs/Helium/Label.html
 - docs/Helium/Organization.html
 - docs/Helium/Resource.html
@@ -287,6 +290,7 @@ files:
 - lib/helium/cursor.rb
 - lib/helium/data_point.rb
 - lib/helium/element.rb
+- lib/helium/error.rb
 - lib/helium/label.rb
 - lib/helium/organization.rb
 - lib/helium/resource.rb