green-button-data 0.2.1 → 0.3.0

data/lib/green-button-data/interval_block.rb

@@ -0,0 +1,38 @@
+module GreenButtonData
+  class IntervalBlock < Entry
+    include Utilities
+
+    attr_accessor :length, :starts_at, :ends_at, :duration
+
+    def initialize(attributes)
+      super
+
+      @starts_at = @interval.starts_at local: true
+      @ends_at = @interval.ends_at local: true
+      @duration = @interval.duration
+      @length = @interval_readings.size
+    end
+
+    ##
+    # Returns an array representation of all the interval data
+    def to_a
+      result = []
+
+      @interval_readings.each do |interval_reading|
+        reading = {
+          starts_at: interval_reading.time_period.starts_at(local: true),
+          ends_at: interval_reading.time_period.ends_at(local: true),
+          duration: interval_reading.time_period.duration,
+          value: interval_reading.value
+        }
+
+        reading[:cost] = interval_reading.cost if interval_reading.cost
+        reading[:quality] = interval_reading.quality if interval_reading.quality
+
+        result << reading
+      end
+
+      return result
+    end
+  end
+end

data/lib/green-button-data/local_time_parameters.rb

@@ -0,0 +1,31 @@
+module GreenButtonData
+  class LocalTimeParameters < Entry
+    include Dst
+
+    attr_accessor :dst_offset, :tz_offset
+
+    def dst_starts_at(year = Time.now.year)
+      byte_to_dst_datetime(@dst_start_rule, year).to_time
+    end
+
+    def dst_ends_at(year = Time.now.year)
+      byte_to_dst_datetime(@dst_end_rule, year).to_time
+    end
+
+    def total_offset
+      @dst_offset + @tz_offset
+    end
+
+    def to_h
+      {
+        dst: {
+          starts_at: dst_starts_at,
+          ends_at: dst_ends_at,
+          offset: dst_offset
+        },
+        tz_offset: tz_offset,
+        total_offset: total_offset
+      }
+    end
+  end
+end

data/lib/green-button-data/meter_reading.rb

@@ -0,0 +1,4 @@
+module GreenButtonData
+  class MeterReading < Entry
+  end
+end

data/lib/green-button-data/model_collection.rb

@@ -0,0 +1,33 @@
+module GreenButtonData
+  class ModelCollection
+    include Enumerable
+
+    def initialize
+      @models = []
+    end
+
+    def <<(model)
+      @models << model
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      @models.each do |model|
+        yield model
+      end
+    end
+
+    def last
+      @models.last
+    end
+
+    def size
+      @models.size
+    end
+
+    def find_by_id(id)
+      self.find {|model| model.id.to_s == id.to_s }
+    end
+  end
+end

data/lib/green-button-data/parser/application_information.rb

@@ -44,17 +44,8 @@ module GreenButtonData
       element :client_name
       element :client_id
       element :client_secret
-      element :client_id_issued_at, class: Integer do |epoch|
-        Time.at(normalize_epoch(epoch)).utc.to_datetime
-      end
-      element :client_secret_expires_at, class: Integer do |epoch|
-        if epoch == 0
-          # 0 means don't expire; set it to distant future
-          DateTime.new 9999, 12, 31, 23, 59, 59
-        else
-          Time.at(normalize_epoch(epoch)).utc.to_datetime
-        end
-      end
+      element :client_id_issued_at, class: Integer
+      element :client_secret_expires_at, class: Integer
       element :redirect_uri
       element :software_id
       element :software_version

data/lib/green-button-data/parser/authorization.rb

@@ -13,10 +13,6 @@ module GreenButtonData
 
       element :status, class: Integer
 
-      def active?
-        @status > 0
-      end
-
       # TODO: Add scope parser
       element :scope
 

data/lib/green-button-data/parser/interval.rb

@@ -12,12 +12,16 @@ module GreenButtonData
         normalize_epoch t
       end
 
-      def starts_at
-        Time.at(normalize_epoch(@start)).utc.to_datetime
+      def starts_at(kwargs = {})
+        epoch_to_time @start, kwargs
       end
 
-      def ends_at
-        Time.at(normalize_epoch(@start + @duration)).utc.to_datetime
+      def ends_at(kwargs = {})
+        epoch_to_time @start + @duration, kwargs
+      end
+
+      def to_s
+        "#{starts_at} - #{ends_at}"
       end
 
       # Standard ESPI namespacing

data/lib/green-button-data/parser/interval_reading.rb

@@ -4,7 +4,10 @@ module GreenButtonData
       include SAXMachine
       include Enumerations
 
-      element :cost, class: Integer
+      element :cost, class: Integer do |cost|
+        cost / 100000.0
+      end
+
       element :quality, class: Integer
       element :timePeriod, class: Interval, as: :time_period
       element :value, class: Integer

data/lib/green-button-data/parser/local_time_parameters.rb

@@ -43,63 +43,6 @@ module GreenButtonData
       element :'ns0:dstEndRule', as: :dst_end_rule
       element :'ns0:dstOffset', class: Integer, as: :dst_offset
       element :'ns0:tzOffset', class: Integer, as: :tz_offset
-
-      private
-
-      def byte_to_dst_datetime(byte, year = Time.now.year)
-        # Bits 0 - 11: seconds 0 - 3599
-        seconds = byte & BITMASK_SECOND
-
-        # Bits 12 - 16: hours 0 - 23
-        hour = (byte & BITMASK_HOUR) >> BITSHIFT_HOUR
-
-        # Bits 17 - 19: day of the week; 0 = NA, 1 - 7 (Monday = 1)
-        weekday = (byte & BITMASK_DAY_OF_WEEK) >> BITSHIFT_DAY_OF_WEEK
-
-        # Bits 20 - 24: day of the month; 0 = NA, 1 - 31
-        day = (byte & BITMASK_DAY_OF_MONTH) >> BITSHIFT_DAY_OF_MONTH
-
-        # Bits 25 - 27: DST rule 0 - 7
-        dst_rule = (byte & BITMASK_DST_RULE) >> BITSHIFT_DST_RULE
-
-        # Bits 28 - 31: month 1 - 12
-        month = (byte & BITMASK_MONTH) >> BITSHIFT_MONTH
-
-        # Raise an error unless all the values are in valid range
-        seconds.between?(0, 3599) and hour.between?(0, 23) and
-        weekday.between?(1, 7) and day.between?(0, 31) and
-        dst_rule.between?(0, 7) and month.between?(1, 12) or
-        raise RangeError, 'Invalid value range'
-
-        # In Ruby, Sunday = 0 not 7
-        weekday = weekday == 7 ? 0 : weekday
-
-        # Check the DST rule
-        dst_day = if dst_rule == 1
-          # Rule 1: DST starts/ends on Day of Week on or after the Day of Month
-          day_of_month = DateTime.new year, month, day
-          day_offset = if weekday >= day_of_month.wday
-            weekday - day_of_month.wday
-          else
-            7 + weekday - day_of_month.wday
-          end
-
-          day_of_month + day_offset
-        elsif dst_rule.between?(2, 6)
-          # Rule 2 - 6: DST starts/ends on Nth Day of Week in given month
-          # Nth Day of Week (e.g. third Friday of July)
-          nth_weekday_of year, month, weekday, dst_rule - 1
-        elsif dst_rule == 7
-          # Rule 7: DST starts/ends on last Day of Week in given month
-          last_weekday_of year, month, weekday
-        else
-          # Rule 0: DST starts/ends on the Day of Month
-          DateTime.new year, month, day
-        end
-
-        # Add the hour and seconds component to the day
-        dst_day + Rational(hour * 3600 + seconds, 86400)
-      end
     end
   end
 end

data/lib/green-button-data/parser/summary_measurement.rb

@@ -19,6 +19,18 @@ module GreenButtonData
         UNIT_SYMBOL[@uom]
       end
 
+      def raw_value
+        @value
+      end
+
+      def value
+        @value * 10.0 ** @power_of_ten_multiplier
+      end
+
+      def to_s
+        "#{value} #{uom.to_s}"
+      end
+
       # ESPI Namespacing
       element :'espi:powerOfTenMultiplier', class: Integer,
               as: :power_of_ten_multiplier

data/lib/green-button-data/reading_type.rb

@@ -0,0 +1,82 @@
+module GreenButtonData
+  class ReadingType < Entry
+    include Enumerations
+
+    attr_reader :consumption_tier, :cpp, :tou
+
+    def accumulation_behaviour
+      get_enum_symbol ACCUMULATION, @accumulation_behaviour
+    end
+
+    def commodity
+      get_enum_symbol COMMODITY, @commodity
+    end
+
+    def currency
+      get_enum_symbol CURRENCY, @currency
+    end
+
+    def data_qualifier
+      get_enum_symbol DATA_QUALIFIER, @data_qualifier
+    end
+
+    def default_quality
+      get_enum_symbol QUALITY_OF_READING, @default_quality
+    end
+
+    def flow_direction
+      get_enum_symbol FLOW_DIRECTION, @flow_direction
+    end
+
+    def interval_length
+      @interval_length
+    end
+
+    def kind
+      get_enum_symbol MEASUREMENT, @kind
+    end
+
+    def measuring_period
+      get_enum_symbol TIME_ATTRIBUTE, @measuring_period
+    end
+
+    def phase
+      get_enum_symbol PHASE_CODE, @phase
+    end
+
+    def scale_factor
+      10.0 ** @power_of_ten_multiplier
+    end
+
+    def time_attribute
+      get_enum_symbol TIME_PERIOD_OF_INTEREST, @time_attribute
+    end
+
+    def unit_of_measurement
+      get_enum_symbol UNIT_SYMBOL, @uom
+    end
+
+    alias_method :unit, :unit_of_measurement
+    alias_method :uom, :unit_of_measurement
+
+    def to_h
+      {
+        accumulation_behaviour: accumulation_behaviour,
+        commodity: commodity,
+        consumption_tier: consumption_tier,
+        cpp: cpp,
+        currency: currency,
+        data_qualifier: data_qualifier,
+        default_quality: default_quality,
+        flow_direction: flow_direction,
+        kind: kind,
+        measuring_period: measuring_period,
+        phase: phase,
+        scale_factor: scale_factor,
+        time_attribute: time_attribute,
+        tou: tou,
+        unit_of_measurement: unit_of_measurement
+      }
+    end
+  end
+end

data/lib/green-button-data/relations.rb

@@ -0,0 +1,24 @@
+module GreenButtonData
+  module Relations
+
+    ##
+    # Extracts related URLs from an Entry
+    #
+    # ==== Arguments
+    #
+    # * +entry+ - An instance of GreenButtonData::Parser::Entry
+    def construct_related_urls(entry)
+      related_urls = {}
+
+      entry.related.each do |related_url|
+        match_data = /\/(\w+)(\/(\d+))*$/.match(related_url)
+
+        unless match_data.nil?
+          related_urls[:"#{match_data[1].underscore}"] = related_url
+        end
+      end
+
+      related_urls
+    end
+  end
+end

data/lib/green-button-data/usage_point.rb

@@ -0,0 +1,27 @@
+module GreenButtonData
+  class UsagePoint < Entry
+    include Enumerations
+
+    attr_accessor :service_category
+
+    def initialize(attributes)
+      super
+
+      # If deprecated usage summary name is used, create an alias
+      if self.class.instance_methods.grep(/electric_power_usage/).size > 0
+        warn "DEPRECATED: ElectricPowerUsageSummary has been renamed to UsageSummary"
+        singleton_class.class_eval do
+          alias_method :usage_summaries, :electric_power_usage_summaries
+        end
+      end
+    end
+
+    def service_category
+      SERVICE[@kind]
+    end
+
+    def usage_summary_url
+      return @usage_summary_url || @electric_power_usage_summary_url
+    end
+  end
+end

data/lib/green-button-data/usage_summary.rb

@@ -0,0 +1,36 @@
+module GreenButtonData
+  class UsageSummary < Entry
+    include Enumerations
+    include Utilities
+
+    attr_reader :billing_period,
+                :overall_consumption_last_period
+
+    attr_writer :commodity,
+                :quality_of_reading
+
+    def commodity
+      if @commodity.is_a? Numeric
+        COMMODITY[@commodity]
+      elsif @commodity.is_a? Symbol
+        @commodity
+      end
+    end
+
+    def quality_of_reading
+      if @quality_of_reading.is_a? Numeric
+        QUALITY_OF_READING[@quality_of_reading]
+      elsif @quality_of_reading.is_a? Symbol
+        @quality_of_reading
+      end
+    end
+
+    def status_timestamp(kwargs = {})
+      epoch_to_time @status_time_stamp, kwargs
+    end
+
+    def to_s
+      "#{@billing_period}: #{@overall_consumption_last_period}"
+    end
+  end
+end

data/lib/green-button-data/utilities.rb

@@ -34,6 +34,16 @@ module GreenButtonData
       end
     end
 
+    def epoch_to_time(epoch, kwargs = {})
+      time = Time.at normalize_epoch(epoch)
+
+      if kwargs[:local] == true
+        return time.localtime
+      else
+        return time.utc
+      end
+    end
+
     ##
     # Retrieves the first Sunday of the month
     #
@@ -102,5 +112,22 @@ module GreenButtonData
 
       last_day - day_offset
     end
+
+    ##
+    # Returns a hash representation of object instance's attributes
+    #
+    # ==== Arguments
+    #
+    # * +obj+ - an object
+    def attributes_to_hash(obj)
+      attributes_hash = {}
+
+      obj.instance_variables.each do |var|
+        attr_name = var.to_s.delete('@').to_sym
+        attributes_hash[attr_name] = obj.instance_variable_get(var)
+      end
+
+      return attributes_hash
+    end
   end
 end