green-button-data 0.4.1 → 0.4.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjY1ZGViODMxZWUwODVmMjM5YTA2MDRiNTA0ZGVkNTQ0MThlZWM0Ng==
-  data.tar.gz: !binary |-
-    OWM5YWU0ZjU4NThjN2E0NjdlNGFhM2M1ZWRkYTgyZjllM2MxZGEyYQ==
+SHA1:
+  metadata.gz: 1ceb62da3fba8372097a53e504b7a9a5873dd2ff
+  data.tar.gz: 44fc0e9c4c3ee4a6ffac789714a250322cd8c3ef
 SHA512:
-  metadata.gz: !binary |-
-    MjBjOWM2YTYzODJlNDgxZjE1OWZlOGNlNTcwY2Y5YTg2ZDI3Y2UzZGEzMWQw
-    ZGU1OTAzMzU5M2MwOWJkODcxZDU4MjhkNTRmMmQzY2Y3YjdkNmM0YzVjMTIy
-    YjgwMWU3N2I5OWJlMWMzMWI1Y2JjYWQ0OTQ3Y2JiN2Q4ZjViYjE=
-  data.tar.gz: !binary |-
-    N2NlMWZkNzVjZjBlNDQ4YmFhNzA0ZjhlNzcwZDEyOGJmNGUyNjY0OTcxMTk4
-    YmMyMzg4YzQ3NDcyZmY4MzhhYWM0MWQ5OTA0ZjUzMjU2YTg3ZDM0OTk0YzY2
-    NTg0NTAyZjE1ZTY4NzUyMzAwYWUyNWQ5YzFhNTUyYjFlODc0Y2E=
+  metadata.gz: 69d63b6058a2eae2b6339c59ae2acd5adfc5a68ab19b87bbba35e4ad797b59ad5849970aa8593c496cff0e4fc417cea0d6d9bd5e0d0155dc64eca1d04b1b2a56
+  data.tar.gz: e0367553136129ea42ff0c84f8abb185256e0d2d73bc984840f4a8178691193c3a1bc31142069b323b77342bde47522aa215eff085fc183b85b9e72d93bf3c6b

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

@@ -49,7 +49,7 @@ module GreenButtonData
       end
 
       id ||= options[:interval_block_id]
-      meter_reading_id = options[:meter_Reading_id]
+      meter_reading_id = options[:meter_reading_id]
       usage_point_id = options[:usage_point_id]
       subscription_id = options[:subscription_id]
 

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

@@ -14,9 +14,7 @@ module GreenButtonData
                   :usage_summary_path
 
     def application_information_url(id = nil)
-      uri = URI.join @base_url, @application_information_path
-      uri = URI.join uri, "#{id}/" if id
-      return uri.to_s
+      return build_url @application_information_path, id
     end
 
     def application_information_url=(url)
@@ -26,9 +24,7 @@ module GreenButtonData
     end
 
     def authorization_url(id = nil)
-      uri = URI.join @base_url, @authorization_path
-      uri = URI.join uri, "#{id}/" if id
-      return uri.to_s
+      return build_url @authorization_path, id
     end
 
     def authorization_url=(url)
@@ -61,9 +57,7 @@ module GreenButtonData
     end
 
     def local_time_parameters_url(id = nil)
-      uri = URI.join @base_url, @local_time_parameters_path
-      uri = URI.join uri, "#{id}/" if id
-      return uri.to_s
+      return build_url @local_time_parameters_path, id
     end
 
     def meter_reading_url(kwargs = {})
@@ -88,16 +82,11 @@ module GreenButtonData
     end
 
     def reading_type_url(id = nil)
-      uri = URI.join @base_url, @reading_type_path
-      uri = URI.join uri, "#{id}/" if id
-
-      return uri.to_s
+      return build_url @reading_type_path, id
     end
 
     def subscription_url(id)
-      uri = URI.join @base_url, @subscription_path
-      uri = URI.join uri, "#{id}/" if id
-      return uri.to_s
+      return build_url @subscription_path, id
     end
 
     def usage_point_url(kwargs = {})
@@ -135,5 +124,14 @@ module GreenButtonData
                                 " usage_point_id"
       end
     end
+
+    private
+
+    def build_url(path, id = nil)
+      uri = URI.join @base_url, path
+      uri = URI.join uri, "#{id}/" if id
+
+      return uri.to_s
+    end
   end
 end

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

@@ -68,16 +68,17 @@ module GreenButtonData
       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'
+      validate_dst_rules dst_rule, month, weekday, day, hour, seconds
 
       # In Ruby, Sunday = 0 not 7
       weekday = weekday == 7 ? 0 : weekday
 
-      # Check the DST rule
-      dst_day = if dst_rule == 1
+      # Add the hour and seconds component to the day
+      dst_datetime dst_rule, year, month, weekday, day, hour, seconds
+    end
+
+    def dst_datetime(dst_rule, year, month, weekday, day, hour, seconds)
+      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
@@ -97,10 +98,14 @@ module GreenButtonData
       else
         # Rule 0: DST starts/ends on the Day of Month
         DateTime.new year, month, day
-      end
+      end + Rational(hour * 3600 + seconds, 86400)
+    end
 
-      # Add the hour and seconds component to the day
-      dst_day + Rational(hour * 3600 + seconds, 86400)
+    def validate_dst_rules(dst_rule, month, weekday, day, hour, seconds)
+      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'
     end
   end
 end

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

@@ -9,9 +9,7 @@ module GreenButtonData
     def initialize(attributes)
       # Automagically sets instance variables from attribute hash parsed from
       # the GreenButtonData::Parser classes
-      attributes.each do |key, value|
-        self.instance_variable_set :"@#{key}", value
-      end
+      init_instance_vars attributes
 
       # Handle relations via related_urls
       @related_urls.is_a?(Hash) and @related_urls.each do |key, value|
@@ -21,56 +19,7 @@ module GreenButtonData
         end
 
         # Define accessor methods from pluralized resource names
-        self.class.send :define_method, "#{key.to_s.pluralize}" do |*args|
-          id = args[0]
-          options = args[1]
-
-          klazz_name = "GreenButtonData::#{key.to_s.camelize}"
-
-          # Handle deprecations
-          klazz_name.gsub! /ElectricPowerUsageSummary/, 'UsageSummary'
-
-          klazz = class_from_name klazz_name
-
-          collection = self.instance_variable_get "@#{key.to_s.pluralize}"
-          url = self.instance_variable_get "@#{key}_url"
-
-          # Make the ID argument optional
-          options ||= if id.is_a?(Hash)
-            id
-          else
-            {}
-          end
-
-          result = if id.is_a?(Numeric) || id.is_a?(String) || id.is_a?(Symbol)
-            # Try returning cached results first
-            collection and instance = collection.find_by_id(id)
-            cache_miss = instance.nil?
-
-            # On cache miss or forced reload, send API request
-            instance = if !options[:reload] && instance
-              instance
-            else
-              klazz.find "#{url}/#{id}", options
-            end
-
-            # Cache the result
-            collection ||= ModelCollection.new
-            collection << instance if cache_miss
-
-            instance
-          else
-            if !options[:reload] && collection
-              collection
-            else
-              collection = klazz.all url, options
-            end
-          end
-
-          self.instance_variable_set :"@#{key.to_s.pluralize}", collection
-
-          return result
-        end
+        define_attr_accessors key
       end
     end # initialize
 
@@ -83,5 +32,80 @@ module GreenButtonData
         value
       end
     end
+
+    private
+
+    def init_instance_vars(attributes)
+      attributes.each do |key, value|
+        self.instance_variable_set :"@#{key}", value
+      end
+    end
+
+    def define_attr_accessors(resource)
+      self.class.send :define_method, "#{resource.to_s.pluralize}" do |*args|
+        id = args[0]
+        options = args[1]
+
+        # Make the ID argument optional
+        options ||= if id.is_a?(Hash)
+          id
+        else
+          {}
+        end
+
+        if id.is_a?(Numeric) || id.is_a?(String) || id.is_a?(Symbol)
+          get_or_fetch_entry id, resource, options
+        else
+          get_or_fetch_collection resource, options
+        end
+      end
+    end
+
+    def klazz_name(name)
+      str = "GreenButtonData::#{name}"
+      str.gsub! /ElectricPowerUsageSummary/, 'UsageSummary'
+      return str
+    end
+
+    def get_or_fetch_collection(resource, options = {})
+      klazz = class_from_name klazz_name(resource.to_s.camelize)
+      url = self.instance_variable_get "@#{resource}_url"
+      collection = self.instance_variable_get "@#{resource.to_s.pluralize}"
+
+      collection = if !options[:reload] && collection
+        collection
+      else
+        collection = klazz.all url, options
+      end
+
+      self.instance_variable_set :"@#{resource.to_s.pluralize}", collection
+
+      return collection
+    end
+
+    def get_or_fetch_entry(id, resource, options = {})
+      klazz = class_from_name klazz_name(resource.to_s.camelize)
+      url = self.instance_variable_get "@#{resource}_url"
+      collection = self.instance_variable_get "@#{resource.to_s.pluralize}"
+
+      # Try returning cached results first
+      collection and instance = collection.find_by_id(id)
+      cache_miss = instance.nil?
+
+      # On cache miss or forced reload, send API request
+      instance = if !options[:reload] && instance
+        instance
+      else
+        klazz.find "#{url}/#{id}", options
+      end
+
+      # Cache the result
+      collection ||= ModelCollection.new
+      collection << instance if cache_miss
+
+      self.instance_variable_set :"@#{resource.to_s.pluralize}", collection
+
+      instance
+    end
   end # Entry
 end # GreenButtonData

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

@@ -25,15 +25,7 @@ module GreenButtonData
           url = nil
         end
 
-        url_options = url_options(options)
-
-        url ||= if url_options.keys.size > 0
-          GreenButtonData.configuration.send(
-            "#{class_name.underscore}_url", url_options(options)
-          )
-        else
-          GreenButtonData.configuration.send "#{class_name.underscore}_url"
-        end
+        url ||= url_path_prefix url_options(options)
 
         @url = url
         @options = options
@@ -76,15 +68,7 @@ module GreenButtonData
         url = if id =~ /\A#{URI::regexp}\z/
           id
         else
-          url_options = url_options options
-
-          path_prefix = if url_options.keys.size > 0
-            GreenButtonData.configuration.send(
-              "#{class_name.underscore}_url", url_options(options)
-            )
-          else
-            GreenButtonData.configuration.send "#{class_name.underscore}_url"
-          end
+          path_prefix = url_path_prefix url_options(options)
 
           URI.join(path_prefix, "#{id}/").to_s
         end
@@ -257,6 +241,16 @@ module GreenButtonData
 
         return url_options
       end
+
+      def url_path_prefix(options)
+        if options.keys.size > 0
+          GreenButtonData.configuration.send(
+            "#{class_name.underscore}_url", options
+          )
+        else
+          GreenButtonData.configuration.send "#{class_name.underscore}_url"
+        end
+      end
     end # ClassMethods
   end # Fetchable
 end # GreenButtonData

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

@@ -16,11 +16,11 @@ module GreenButtonData
       @dst_offset + @tz_offset
     end
 
-    def to_h
+    def to_h(year = Time.now.year)
       {
         dst: {
-          starts_at: dst_starts_at,
-          ends_at: dst_ends_at,
+          starts_at: dst_starts_at(year),
+          ends_at: dst_ends_at(year),
           offset: dst_offset
         },
         tz_offset: tz_offset,

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

@@ -59,7 +59,7 @@ module GreenButtonData
       # need to be added before hitting the first Sunday of month
       day_offset = first_weekday == 0 ? 0 : 7 - first_weekday
 
-      # Return first Monday of the month
+      # Return first Sunday of the month
       first_day + day_offset
     end
 
@@ -78,10 +78,11 @@ module GreenButtonData
     # To retrieve third Friday of July 2015,
     #     nth_weekday_of 2015, 7, 5, 3
     def nth_weekday_of(year = Time.now.year, month = Time.now.month,
-                             weekday = 0, week = 1)
+                       weekday = 0, week = 1)
+      first_day = DateTime.new year, month, 1
 
       # Day offset needed for Nth day of the week
-      first_sunday_of(year, month) + weekday + (week - 1) * 7
+      first_day + weekday_offset(first_day.wday, weekday) + (week - 1) * 7
     end
 
     ##
@@ -110,7 +111,15 @@ module GreenButtonData
         7 + last_weekday - weekday
       end
 
-      last_day - day_offset
+      last_day - weekday_offset(weekday, last_weekday)
+    end
+
+    def weekday_offset(first_weekday, second_weekday)
+      if second_weekday >= first_weekday
+        second_weekday - first_weekday
+      else
+        7 + second_weekday - first_weekday
+      end
     end
 
     ##

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

@@ -1,3 +1,3 @@
 module GreenButtonData
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: green-button-data
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Andrew Jo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -179,17 +179,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Parser for Green Button data format