amon 0.4.3 → 0.5.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.4.3 and is built to support AMON V3: https://github.com/AMEE/amon
+This is version 0.5.0 and is built to support AMON V3: https://github.com/AMEE/amon
 
 ## Installation ##
 

data/lib/amon/measurement.rb

@@ -1,6 +1,8 @@
 module AMON
+
   # A measurement corresponding to a {Reading} of a {Device}
   class Measurement < DocumentPart
+    
     # @return [String] The measurement's name
     field :type
     alias :name :type
@@ -9,17 +11,24 @@ module AMON
     field :value
 
     # @return [Time] The measurement's timestamp, if provided
-    field :timestamp,  :as => Time
+    field :timestamp, :as => Time
 
     # @return [Time] The measurement's start date, if provided
     field :start_date, :name => 'startDate', :as => Time
 
     # @return [Time] The measurement's end date, if provided
-    field :end_date,   :name => 'endDate',   :as => Time
+    field :end_date, :name => 'endDate', :as => Time
 
     # @attr_reader [Device] device The device which took this measurement
     alias_method :device, :parent
 
+    # @return [Boolean] Is the measurement an aggregated (i.e. non-raw) value?
+    field :aggregated
+
+    # @return [Array] The "aggregation" array, including expectedPoints and
+    #                 aggregatedPoints.
+    field :aggregation
+
     # A measurement is instantaneous if it is given with a single timestamp. If, on the other hand,
     # start and end dates are provided, it is durational.
     # @return [Boolean]
@@ -52,5 +61,27 @@ module AMON
         start_date + (end_date - start_date) / 2
       end
     end
+
+    def aggregated_points
+      if aggregated
+        if aggregation.nil?
+          0
+        else
+          aggregation['aggregatedPoints']
+        end
+      end
+    end
+
+    def expected_points
+      if aggregated
+        if aggregation.nil?
+          0
+        else
+          aggregation['expectedPoints']
+        end
+      end
+    end
+
   end
-end
+
+end

data/lib/amon/session.rb

@@ -84,7 +84,9 @@ module AMON
       cache(:measurements, [device_id, start_date, end_date, raw]) do
         device = device(entity_id, device_id)
         measurements = get(
-          "/entities/#{ URI.escape(entity_id) }/devices/#{ URI.escape(device.id) }/measurements?" +
+          "/entities/#{ URI.escape(entity_id) }/devices/#{ URI.escape(device.id) }/measurements" +
+            ";aggregation" + 
+            "?" +
             "raw="       + raw.to_s + "&" +
             "startDate=" + start_date.utc.xmlschema + "&" +
             "endDate="   + end_date.utc.xmlschema

data/lib/amon/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amon
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 3
-  version: 0.4.3
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - AMEE