amon 0.6.0 → 0.7.0

data/README.md

@@ -3,7 +3,7 @@ Ruby Client for the AMEE AMON API
 
 This is a Ruby client library for the [AMEE](http://www.amee.com/) <abbr title="AMEE Monitoring Object Notation">AMON</abbr> <abbr title="Application Programming Interface">API</abbr>. _More details and links to be inserted once information about the API is publicly available_.
 
-This is version 0.6.0 and is built to support AMON V3: https://github.com/AMEE/amon
+This is version 0.7.0 and is built to support AMON V3: https://github.com/AMEE/amon
 
 ## Installation ##
 

data/lib/amon/device.rb

@@ -1,9 +1,13 @@
 module AMON
-  # An AMON device, containing any number of {Reading readings}, and {Measurement measurements} for those readings.
+  # An AMON device, containing any number of {Reading readings}, and
+  # {Measurement measurements} for those readings.
   class Device < Document
     # @return [String] The id of the device
     field :id, :name => 'deviceId'
 
+    # @return [Time] The latest measurement start date, if provided
+    field :earliest_measurement, :name => 'earliestMeasurement', :as => Time
+
     # @return [Time] The latest measurement start date, if provided
     field :latest_measurement, :name => 'latestMeasurement', :as => Time
 
@@ -32,8 +36,8 @@ module AMON
       @readings ||= json['readings'].map { |reading| Reading.new(self, reading) }
     end
 
-    # @return [Hash<String => Reading>] A hash allowing {Device#readings} to be retrieved by their
-    # {Reading#type}
+    # @return [Hash<String => Reading>] A hash allowing {Device#readings} to
+    #                                   be retrieved by their {Reading#type}
     def readings_by_type
       readings.inject({}) do |readings_by_type, reading|
         readings_by_type[reading.type] = reading
@@ -47,8 +51,10 @@ module AMON
       session.measurements(entity_id, id, start_date, end_date, raw)
     end
 
-    # @return [Hash<String => Measurement>] A hash allowing {Device#measurements} to be retrieved
-    # by their {Measurement#name}
+    # @return [Hash<String => Measurement>] A hash allowing
+    #                                       {Device#measurements} to be
+    #                                       retrieved by their
+    #                                       {Measurement#name}
     # @see Device#measurements
     def measurements_by_name(entity_id, start_date, end_date, raw = false)
       measurements(entity_id, start_date, end_date, raw).inject({}) do |measurements_by_name, measurement|

data/lib/amon/reading.rb

@@ -1,14 +1,19 @@
 module AMON
-  # AMON readings are 'categories' of {Measurement measurements} which are taken by {Device devices}.
-  # For example, one reading may be 'electricalInput' with the unit 'kWh'.
+  
+  # AMON readings are 'categories' of {Measurement measurements} which are
+  # taken by {Device devices}. For example, one reading may be 'electricalInput'
+  # with the unit 'kWh'.
   class Reading < DocumentPart
-    # @return [String] The type of reading, which is unique within the parent {Device device}
+    
+    # @return [String] The type of reading, which is unique within the parent
+    # {Device device}
     field :type
 
     # @return [String] An arbitrary name for the reading
     field :name
 
-    # @return [String] The units this reading records {Measurement measurements} in
+    # @return [String] The units this reading records
+    # {Measurement measurements} in
     field :unit
 
     # @return [Numeric] The resolution of the reading
@@ -17,8 +22,9 @@ module AMON
     # @return [Numeric] The accuracy of the reading
     field :accuracy
 
-    # @return ["instant", "duration"] Whether this reading records measurement values taken at a
-    # specific point in time ('instant'), or taken as an average over a period of time ('duration')
+    # @return ["instant", "duration"] Whether this reading records measurement
+    # values taken at a specific point in time ('instant'), or taken as an
+    # average over a period of time ('duration')
     field :period, :default => "instant"
 
     # @attr_reader [Device device] The device which took this measurement
@@ -41,19 +47,23 @@ module AMON
       !instantaneous?
     end
 
-    # One reading is equal to another if the devices are equal and they are the same type
+    # One reading is equal to another if the devices are equal and they are the
+    # same type
     # @return [Boolean]
     # @param [Reading] other The other reading to compare with.
     def ==(other)
       device == other.device && type == other.type
     end
 
-    # A unique id for the reading, composed of the {Device device} id, and the {#type}. So an
-    # '<code>electricalInput</code>' reading for a device with id '<code>b7ddac00-9415-012d-b57e-001c23973687</code>' would
-    # have the id '<code>b7ddac00-9415-012d-b57e-001c23973687-electricalInput</code>'.
+    # A unique id for the reading, composed of the {Device device} id, and the
+    # {#type}. So an '<code>electricalInput</code>' reading for a device with
+    # id '<code>b7ddac00-9415-012d-b57e-001c23973687</code>' would have the
+    # id '<code>b7ddac00-9415-012d-b57e-001c23973687-electricalInput</code>'.
     # @return [String] the id
     def id
       "#{device.id}-#{type}"
     end
+
   end
-end
+
+end

data/lib/amon/session.rb

@@ -1,6 +1,7 @@
 require 'uri'
 
 module AMON
+
   # Session objects take care of making the actual HTTP requests to the AMON API
   #
   # ## Caching ##
@@ -21,6 +22,7 @@ module AMON
   # at regular intervals. Alternatively, you can use {Session#clear_cache} and keep the same
   # session.
   class Session
+    
     # @return [Hash] The hash of configuration options to be used when making requests
     attr_reader :options
 
@@ -58,7 +60,11 @@ module AMON
     # @return [Device]
     def device(entity_id, device_id)
       cache(:devices, device_id) do
-        json = get("/entities/#{ URI.escape(entity_id )}/devices/#{URI.escape(device_id)};latest")['device']
+        json = get(
+          "/entities/#{ URI.escape(entity_id )}/devices/#{URI.escape(device_id)}" +
+            ";earliest" +
+            ";latest"
+        )['device']
         Device.new(self, json)
       end
     end
@@ -74,12 +80,14 @@ module AMON
     end
 
     # Retrieves measurements from the API
+    #
     # @param [String] entity_id The ID of the entity
-    # @param [String] device_id The ID of the device to get the measurements from
-    # @param [Time] start_date The starting point for the measurements
-    # @param [Time] end_date The ending point for the measurements
-    # @param [Boolean] raw Whether to return raw measurements as submitted by the hardware (may
-    # contain a lot of data), or appropriate aggregations over the time period
+    # @param [String] device_id The ID of the device to get measurements from
+    # @param [Time] start_date  The starting point for the measurements
+    # @param [Time] end_date    The ending point for the measurements
+    # @param [Boolean] raw      Whether to return raw measurements as submitted
+    #                           by the hardware (may contain a lot of data), or
+    #                           appropriate aggregations over the time period
     def measurements(entity_id, device_id, start_date, end_date, raw = false)
       cache(:measurements, [device_id, start_date, end_date, raw]) do
         device = device(entity_id, device_id)
@@ -129,5 +137,7 @@ module AMON
           }
         )
       end
+
   end
-end
+
+end

data/lib/amon/version.rb

@@ -2,7 +2,7 @@ module AMON
   # Provides details about the version of the AMON library in use.
   module Version
     MAJOR = 0
-    MINOR = 6
+    MINOR = 7
     TINY  = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amon
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - AMEE
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-09 00:00:00 Z
+date: 2012-10-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json