amon 0.9.0 → 0.10.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.9.0 and is built to support AMON V3: https://github.com/AMEE/amon
+This is version 0.10.0 and is built to support AMON V3: https://github.com/AMEE/amon
 
 ## Installation ##
 

data/lib/amon/device.rb

@@ -1,7 +1,9 @@
 module AMON
+  
   # 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'
 
@@ -46,6 +48,21 @@ module AMON
       @readings ||= json['readings'].map { |reading| Reading.new(self, reading) }
     end
 
+    # @return [Numeric] The 30 day completeness ratio (0 to 1) for the device
+    def completeness_30d
+      @completeness_30d ||= get_completeness_30d
+    end
+
+    # @return [Numeric] The 6 month completeness ratio (0 to 1) for the device
+    def completeness_6m
+      @completeness_6m ||= get_completeness_6m
+    end
+
+    # @return [Numeric] The all time completeness ratio (0 to 1) for the device
+    def completeness
+      @completeness ||= get_completeness
+    end
+
     # @return [Hash<String => Reading>] A hash allowing {Device#readings} to
     #                                   be retrieved by their {Reading#type}
     def readings_by_type
@@ -73,5 +90,42 @@ module AMON
         measurements_by_name
       end
     end
+
+    private
+
+      def get_completeness_30d
+        unless json['completenessRatios'].nil?
+          json['completenessRatios'].each do |completeness_info|
+            if completeness_info['period'] == 'thirty_days'
+              return completeness_info['ratio']
+            end
+          end
+        end
+        return 0
+      end
+
+      def get_completeness_6m
+        unless json['completenessRatios'].nil?
+          json['completenessRatios'].each do |completeness_info|
+            if completeness_info['period'] == 'six_months'
+              return completeness_info['ratio']
+            end
+          end
+        end
+        return 0
+      end
+
+      def get_completeness
+        unless json['completenessRatios'].nil?
+          json['completenessRatios'].each do |completeness_info|
+            if completeness_info['period'] == 'full_history'
+              return completeness_info['ratio']
+            end
+          end
+        end
+        return 0
+      end
+
   end
-end
+   
+end

data/lib/amon/entity.rb

@@ -1,6 +1,8 @@
 module AMON
+
   # An AMON entity, such as a house, business park, or building floor
   class Entity < Document
+    
     # @return [String] The id for this entity
     field :id,                 :name => 'entityId'
 
@@ -16,9 +18,61 @@ module AMON
       @devices ||= device_ids.map { |device_id| session.device(id, device_id) }
     end
 
-    # @return [Array<MeteringPoint>] The metering points associated with this entity
+    # @return [Array<MeteringPoint>] The metering points associated with the entity
     def metering_points
       @metering_points ||= metering_point_ids.map { |id| session.metering_point(id) }
     end
+
+    # @return [Numeric] The 30 day completeness ratio (0 to 1) for the entity
+    def completeness_30d
+      @completeness_30d ||= get_completeness_30d
+    end
+
+    # @return [Numeric] The 6 month completeness ratio (0 to 1) for the entity
+    def completeness_6m
+      @completeness_6m ||= get_completeness_6m
+    end
+
+    # @return [Numeric] The all time completeness ratio (0 to 1) for the entity
+    def completeness
+      @completeness ||= get_completeness
+    end
+
+    private
+
+      def get_completeness_30d
+        unless json['completenessRatios'].nil?
+          json['completenessRatios'].each do |completeness_info|
+            if completeness_info['period'] == 'thirty_days'
+              return completeness_info['ratio']
+            end
+          end
+        end
+        return 0
+      end
+
+      def get_completeness_6m
+        unless json['completenessRatios'].nil?
+          json['completenessRatios'].each do |completeness_info|
+            if completeness_info['period'] == 'six_months'
+              return completeness_info['ratio']
+            end
+          end
+        end
+        return 0
+      end
+
+      def get_completeness
+        unless json['completenessRatios'].nil?
+          json['completenessRatios'].each do |completeness_info|
+            if completeness_info['period'] == 'full_history'
+              return completeness_info['ratio']
+            end
+          end
+        end
+        return 0
+      end
+
   end
-end
+
+end

data/lib/amon/session.rb

@@ -63,7 +63,8 @@ module AMON
         json = get(
           "/entities/#{ URI.escape(entity_id )}/devices/#{URI.escape(device_id)}" +
             ";earliest" +
-            ";latest"
+            ";latest" +
+            ";completeness"
         )['device']
         Device.new(self, json)
       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 = 9
+    MINOR = 10
     TINY  = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amon
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 55
   prerelease: 
   segments: 
   - 0
-  - 9
+  - 10
   - 0
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors: 
 - AMEE
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-24 00:00:00 Z
+date: 2012-11-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json