neurio 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 488f5c1086893d8fea4198e70eb742941b49d565
-  data.tar.gz: a3af973e89fa390c9ac8d39d5dcfd39885041f75
+  metadata.gz: 21fef552b4b70cb5489a9ce83408f748a1605b48
+  data.tar.gz: 3d7ab4772cf23e30c614b4ca8d0783f7c37860f8
 SHA512:
-  metadata.gz: d5f6db2b12cd6883537ff826214b54503022bba68e8831b4fedbd309ef4c7573d09f290ab01256cf9088ca255f01965e3a1d8caae6ecedd18a2c25c7626b7d13
-  data.tar.gz: 282eb981f7becbda6ee49010ef9db2e4c147b82a8f41981c489c160a7158368bda44e1b85ed10d10ce1c03dca5f2b610c747612625cc8107d405ec14e133e063
+  metadata.gz: 6f00738845047878ee0717997c29eee6f0dbc9c08bd208e2ac51cc89a4990b04cd62083ee9bf664cd46225b5924c5693540fd4eddb87bc7dead7844af3f773d6
+  data.tar.gz: 7e7482419de38a39cc9839a1e1d810d607567338c77644feced46aebe8b928dfd2a5f3333e6f962d7c60cccb5bdc427c90682f1083f0897a1e102250ced8b383

data/lib/neurio.rb

@@ -1,44 +1,45 @@
 require 'httparty'
+require_relative 'neurio/reading'
 
 class Neurio
   include HTTParty
   base_uri "https://api.neur.io"
   
-  class Reading
-    attr_reader :consumption_power, :consumption_energy, :timestamp
-    def initialize(values)
-      @timestamp = DateTime.parse(values["timestamp"]).to_time
-      @consumption_power = values["consumptionPower"]
-      @consumption_energy = values["consumptionEnergy"]
-    end
-  end
-  
-  
+  # Construct a new Neurio API instance
+  #
+  # @param options [Hash] configuration options
+  # @option options client_id [String] the Neurio client id
+  # @option options client_secret [String] the Neurio client secret
   def initialize(options)
     @client_secret = options[:client_secret]
     @client_id = options[:client_id]
     raise ArgumentError.new("client_id and client_secret must be specified") unless @client_secret && @client_id
   end
   
+  # Get the most recent sensor reading
+  #
+  # @param sensor_id [String] The sensor id to retrieve data for
+  # @return [Neurio::Reading]
   def last(sensor_id = default_sensor_id)
     headers =  {"content_type" => "application/json", "authorization" => "Bearer #{token}"}
     query = {"sensorId" => sensor_id}
     response = self.class.get("/v1/samples/live/last", :headers => headers, :query => query)
-    Reading.new(response)
-  end
-  
-  def user
-    unless @user
-      headers =  {"content_type" => "application/json", "authorization" => "Bearer #{token}"}
-      @user = self.class.get("/v1/users/current", :headers => headers)
-    end
-    @user
+    Reading.new(response, sensor_id)
   end
   
+
+  # Look up the ID of the first (and usually only) sensor associated with this account
+  #
+  # @return [String] The Neurio sensorId
   def default_sensor_id
     user["locations"][0]["sensors"][0]["sensorId"]
   end
   
+  # Get recent sensor readings since last_timestamp.
+  #
+  # @param last_timestamp [DateTime] Timestamp of last sample already received.  API defaults to 2 minutes ago if omitted.
+  # @param sensor_id [String] The sensor id to retrieve data for
+  # @return [Array<Neurio::Reading>] Array of sensor readings
   def live(last_timestamp = nil, sensor_id = default_sensor_id)
     headers =  {"content_type" => "application/json", "authorization" => "Bearer #{token}"}
     query = {"sensorId" => sensor_id}
@@ -47,10 +48,11 @@ class Neurio
     end
     
     response = self.class.get("/v1/samples/live", :headers => headers, :query => query)
-    response.map{|x| Reading.new(x)}
+    response.map{|x| Reading.new(x, sensor_id)}
   end
 
   private
+  # Obtain an API token for this client
   def token
     unless @token
       options = {"grant_type" => "client_credentials", "client_id" => @client_id, "client_secret" => @client_secret}
@@ -60,5 +62,15 @@ class Neurio
     end
     @token
   end
+  
+  # Obtain a user object associated with the token
+  def user
+    unless @user
+      headers =  {"content_type" => "application/json", "authorization" => "Bearer #{token}"}
+      @user = self.class.get("/v1/users/current", :headers => headers)
+    end
+    @user
+  end
+  
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neurio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joe Francis
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-    - - ">="
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: '3.3'
 description: API functionality for Neurio energy monitoring devices.  See http://neur.io/
 email: joe@lostapathy.com
 executables: []
@@ -57,8 +79,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Neurio API
 test_files: []
+has_rdoc: