ce-greenbutton 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99c0de9e3a288e6750ba5fe4886b27948954c56d
-  data.tar.gz: 6fc9f7a405b59b6dda74c499d8a175ea058d4dac
+  metadata.gz: ba4f33d5d5e82159337dce595af28f30ebe75961
+  data.tar.gz: b579aed9fe338345181f20428f0f6bb3ebfad9e2
 SHA512:
-  metadata.gz: 3b4673328dbfd1a7c01e28db58397fefa2ff81ffea8b22ee5c7a2795314025ac81770d1dfe199c4300636acff23fa0c04840f6ccde882051e201d90cb42c61c9
-  data.tar.gz: 71699309ae8e2776c3b3a6c9b6363ecd1acfac31191f71a048f89ba996f4f813e9f39231ddc01a5c21f8f94ef48c51533b40eb80ae5c5c7e3d2fb0df489d7bef
+  metadata.gz: 660404ef29fc51b9bd63ea193e3f8f07d9f9c0cbd5f35c7ef473957f1849f16d2176c25d8d80bfda7c465570d38b833be036e1c02792f506c55691e1cbac6b2d
+  data.tar.gz: 2a63974c5daf497f890d175c9165de4ee9c9ceee3bf0d941df7ea4c8985cd8cacfa855faa89009eda7dc9a1fe62889d3a796050aa80788175ba24d9c19a1d513

data/README.md

@@ -8,7 +8,7 @@ The increased size of data by time was a significant factor in designing this mo
 
 ### Why SAX and why sax-machine?
 Unlike [DOM](http://en.wikipedia.org/wiki/Document_Object_Model), SAX need not to load the whole file into memory for parsing. It is an event driven parsing.
-As we don't need power featchers of DOM like XPath for example, so SAX is ideal for data size scalability.
+As we don't need power features of DOM like XPath for example, so SAX is ideal for data size scalability.
 
 
 The [SAX Machine](https://github.com/pauldix/sax-machine) provides a simple and elegant binding interface that binds xml elements to Ruby objects and properties.
@@ -20,14 +20,12 @@ The [SAX Machine](https://github.com/pauldix/sax-machine) provides a simple and
 3. [TomDoc](http://www.rubydoc.info/gems/tomdoc/0.2.5/frames#Installation) is used
 
 
-
-
 ## Installation
 
 Using [bundler](http://bundler.io/), add this line to your application's Gemfile:
 
 ```ruby
-gem 'greenbutton'
+gem 'ce-greenbutton'
 ```
 
 And then execute:
@@ -36,7 +34,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install greenbutton
+    $ gem install ce-greenbutton
 
 The parser uses [SAX Machine](https://github.com/pauldix/sax-machine) and will install it as dependency.
 
@@ -54,13 +52,27 @@ gb = GreenButton.download_data('your access token', 'http://greenbutton.data.url
 
 The following will download and parse all 2013 data for subscription
 
-```ruby
-require 'greenbutton'
-GreenButton.config(reg_access_token: "your access token",
-                  application_information_url: "http://app_info_url")
-gb = GreenButton.download_data('your access token', 'http://greenbutton.data.url'
-                               Date.new(2013,1,1), Date.new(2013,12,31))
-```
+        ```ruby
+        require 'ce-greenbutton'
+        GreenButton.config(reg_access_token: "your access token",
+                          application_information_url: "http://app_info_url")
+        gb = GreenButton.download_data('your access token', 'http://greenbutton.data.url'
+                                       Date.new(2013,1,1), Date.new(2013,12,31))
+
+        ```
+The following will download and parse data from FTP
+
+        ```ruby
+        require 'ce-greenbutton'
+        GreenButton.config(reg_access_token: "your access token",
+                          application_information_url: "http://app_info_url",
+                          ftp_host: "your ftp host",
+                          ftp_user: "your ftp user name",
+                          ftp_password: "your ftp password",
+                          ftp_path: "your ftp directory containing data")
+        gb = GreenButton.download_data_ftp('your application id', Time.new(2015,3,19,1,1,1,0), "your utility name")
+        ```
+
 ### Notes on usage
 1. The access token is an OAuth2 access token.
 2. The GreenButton.config must be called before the first call to download_data
@@ -69,11 +81,18 @@ gb = GreenButton.download_data('your access token', 'http://greenbutton.data.url
     * application information url: https://services.greenbuttondata.org:443/DataCustodian/espi/1_1/resource/ApplicationInformation/2
     * access_token: 688b026c-665f-4994-9139-6b21b13fbeee
     * data url (resource): https://services.greenbuttondata.org/DataCustodian/espi/1_1/resource/Batch/Subscription/6
+    * ftp_host: us1.hostedftp.com
+    * ftp_user: clearlyenergy
+    * ftp_password: store_clearly
+    * ftp_path : SDGETest
+    * application_id: 10066_CONSUMPTION
+    * utility_name: CLEARLY
+    * time (for ftp): Time.new(2015,3,19,1,1,1,0)
 
 
 **Note, the call to `config` is mandatory before the first usage of the module.**
 
-the returning result of the download_data call is an array of GbDataDescription
+the returning result of the download_data or download_data_ftp call is an array of GbDataDescription
 and it can be accessed like that.
 
 ```ruby

data/lib/ce-greenbutton/elements/gb_application_information.rb

@@ -2,16 +2,20 @@
 require 'sax-machine'
 module GreenButton
   module Parser
-  # a sax-machine mapping for the ApplicationInformation structure.
-  #
-  # For example
-  #   app_info = GbApplicationInformation.parse(open(application_information.xml))
-  #
-  # Author ahmed.seddiq
-  # Version 1.0
-  class GbApplicationInformation
+    # a sax-machine mapping for the ApplicationInformation structure.
+    #
+    # For example
+    #   app_info = GbApplicationInformation.parse(open(application_information.xml))
+    #
+    # Author ahmed.seddiq
+    # Version 1.0
+    class GbApplicationInformation
       include SAXMachine
+      # Elements with "espi" namespace
       element :'espi:dataCustodianId', as: :data_custodian_id
+
+      # Elements without namespace
+      element :dataCustodianId, as: :data_custodian_id
     end
   end
 end

data/lib/ce-greenbutton/elements/gb_content.rb

@@ -17,10 +17,19 @@ module GreenButton
     # Version: 1.0
     class GbContent
       include SAXMachine
+
+      # Elements with "espi" namespace
       element :'espi:UsagePoint', class: GbUsagePoint, as: :usage_point
       element :'espi:IntervalBlock', class: GbIntervalBlock, as: :interval_block
       element :'espi:LocalTimeParameters', class: GbLocalTimeParameters, as: :local_time_parameters
       element :'espi:ReadingType', class: GbReadingType, as: :reading_type
+
+      # Elements without namespace
+      element :UsagePoint, class: GbUsagePoint, as: :usage_point
+      element :IntervalBlock, class: GbIntervalBlock, as: :interval_block
+      element :LocalTimeParameters, class: GbLocalTimeParameters, as: :local_time_parameters
+      element :ReadingType, class: GbReadingType, as: :reading_type
+      
     end
   end
 end

data/lib/ce-greenbutton/elements/gb_interval.rb

@@ -13,8 +13,14 @@ module GreenButton
     # Version: 1.0
     class GbInterval
       include SAXMachine
+
+      # Elements with "espi" namespace
       element :'espi:duration', class: Integer,  as: :duration
       element :'espi:start',  class: Integer, as: :start
+  
+      # Elements without namespace
+      element :duration, class: Integer,  as: :duration
+      element :start,  class: Integer, as: :start
     end
 
   end

data/lib/ce-greenbutton/elements/gb_interval_block.rb

@@ -16,8 +16,14 @@ module GreenButton
     # Version: 1.0
     class GbIntervalBlock
       include SAXMachine
+
+      # Elements with "espi" namespace
       element :'espi:interval', class: GbInterval, as: :interval
       elements :'espi:IntervalReading', class: GbIntervalReading, as: :readings
+  
+      # Elements without namespace
+      element :interval, class: GbInterval, as: :interval
+      elements :IntervalReading, class: GbIntervalReading, as: :readings
     end
 
   end

data/lib/ce-greenbutton/elements/gb_interval_reading.rb

@@ -15,8 +15,14 @@ module GreenButton
     # Version: 1.0
     class GbIntervalReading < GbInterval
       include SAXMachine
+
+      # Elements with "espi" namespace
       element :'espi:value', class: Integer, as: :value
       element :'espi:cost', class: Integer, as: :cost
+  
+      # Elements without namespace
+      element :value, class: Integer, as: :value
+      element :cost, class: Integer, as: :cost
     end
   end
 end

data/lib/ce-greenbutton/elements/gb_local_time_parameters.rb

@@ -19,7 +19,12 @@ module GreenButton
 
       attr_accessor :dst_start_time
       attr_accessor :dst_end_time
+      attr_accessor :tz_offset
 
+      # an instance representing the EDT timezone
+      EDT = GbLocalTimeParameters.new(tz_offset: -14400)
+
+      # Elements with "espi" namespace
       element :'espi:dstEndRule', as: :dst_end_rule do |rule|
         @dst_end_time = to_time(rule)
         rule
@@ -31,6 +36,19 @@ module GreenButton
       element :'espi:dstOffset', class: Integer, as: :dst_offset
       element :'espi:tzOffset', class: Integer, as: :tz_offset
 
+
+      # Elements without namespace
+      element :dstEndRule, as: :dst_end_rule do |rule|
+        @dst_end_time = to_time(rule)
+        rule
+      end
+      element :dstStartRule, as: :dst_start_rule do |rule|
+        @dst_start_time = to_time(rule)
+        rule
+      end
+      element :dstOffset, class: Integer, as: :dst_offset
+      element :tzOffset, class: Integer, as: :tz_offset
+
       # Converts time to local based on the given time configuration.
       #
       # The time after applying the rules in the time_config
@@ -39,8 +57,10 @@ module GreenButton
         # apply timezone offset
         time += self.tz_offset
         # apply dst offset
-        if Time.now.between?(@dst_start_time, @dst_end_time)
-          time += self.dst_offset
+        unless @dst_start_time.nil? or @dst_end_time.nil?
+          if Time.now.between?(@dst_start_time, @dst_end_time)
+            time += self.dst_offset
+          end
         end
         Time.at(time)
       end

data/lib/ce-greenbutton/elements/gb_reading_type.rb

@@ -14,10 +14,18 @@ module GreenButton
     # Version: 1.0
     class GbReadingType
       include SAXMachine
+
+      # Elements with "espi" namespace
       element :'espi:commodity', class: Integer, as: :commodity
       element :'espi:currency', class: Integer, as: :currency
       element :'espi:uom', class: Integer, as: :uom
       element :'espi:powerOfTenMultiplier', class: Integer, as: :power_of_ten_multiplier
+  
+      # Elements without namespace
+      element :commodity, class: Integer, as: :commodity
+      element :currency, class: Integer, as: :currency
+      element :uom, class: Integer, as: :uom
+      element :powerOfTenMultiplier, class: Integer, as: :power_of_ten_multiplier
     end
   end
 end

data/lib/ce-greenbutton/elements/gb_usage_point.rb

@@ -14,7 +14,12 @@ module GreenButton
     # Version: 1.0
     class GbUsagePoint
       include SAXMachine
+
+      # Elements with "espi" namespace
       element :'espi:kind', class: Integer, as: :kind
+  
+      # Elements without namespace
+      element :kind, class: Integer, as: :kind
     end
   end
 end

data/lib/ce-greenbutton/interpreters/electricity_interpreter.rb

@@ -5,6 +5,7 @@ require 'ce-greenbutton'
 require 'ce-greenbutton/model/gb_data_description'
 require 'ce-greenbutton/model/gb_data'
 require 'ce-greenbutton/model/gb_data_reading'
+require 'ce-greenbutton/elements/gb_local_time_parameters'
 
 module GreenButton
   module Interpreters
@@ -39,10 +40,14 @@ module GreenButton
         raise GreenButton::InvalidGbDataError, 'Missing MeterReading data' if meter_readings.nil?
 
         time_config = feed.get_related(usage_point, 'LocalTimeParameters')
-        raise GreenButton::InvalidGbDataError, 'Missing LocalTimeParameters data' if time_config.nil?
+        # raise GreenButton::InvalidGbDataError, 'Missing LocalTimeParameters data' if time_config.nil?
 
         # get the actual time parameters from the entry.content
-        time_config = time_config.content.local_time_parameters
+        if time_config.nil?
+          time_config = GreenButton::Parser::GbLocalTimeParameters::EDT
+        else
+          time_config = time_config.content.local_time_parameters
+        end
 
         # We can have multiple meter readings per usage point.
         unless meter_readings.is_a? Array

data/lib/ce-greenbutton/parser.rb

@@ -31,11 +31,20 @@ module GreenButton
       feed = Parser::GbDataFeed.parse(input)
       entries = {}
       feed.entries.each do |entry|
+        # map self link to this entry
         entries[entry.self] = entry
-        if entries[entry.up].nil?
-          entries[entry.up] = []
+
+        # add this entry to the up link
+
+        # the "up" link will be the "self" link after removing the id part
+        # if there is no id part in the "self" link, the "up" link is used.
+        up_link = /(.*)\/\d+$/.match(entry.self)[1]
+        up_link = entry.up if up_link.nil?
+
+        if entries[up_link].nil?
+          entries[up_link] = []
         end
-        entries[entry.up] << entry
+        entries[up_link] << entry
         entry.link = nil
       end
 

data/lib/ce-greenbutton/version.rb

@@ -1,3 +1,3 @@
 module GreenButton
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/ce-greenbutton.rb

@@ -127,39 +127,9 @@ module GreenButton
     ftp_url = "ftp://#{@ftp_user}:#{@ftp_password}@#{@ftp_host}/#{@ftp_path}/" +
       "D_#{utility_name}_#{application_id}_#{time.strftime('%Y%m%d%H%M%S')}.XML"
 
-    parse_data(@ftp_user, open(ftp_url))
+    parse_data(open(ftp_url))
   end
 
-
-  def self.parse_file_data(data)
-    feed = GreenButton::Parser.parse(data)
-    gb = []
-    unsupported_kinds = []
-    feed.entries.each_pair do |key, entry|
-      if entry.is_a? GreenButton::Parser::GbEntry
-        if entry.type == 'UsagePoint'
-          usage_point = entry.content.usage_point
-          if @interpreters[usage_point.kind].nil?
-            unsupported_kinds << usage_point.kind
-          else
-            gb_data_description = @interpreters[usage_point.kind]
-                                      .get_gb_data_description(entry, feed)
-            gb_data_description.custodian = nil
-            gb_data_description.user_id = nil
-            gb << gb_data_description
-          end
-
-        end
-      end
-    end
-    if gb.length == 0 and unsupported_kinds.length > 0
-      raise InvalidGbDataError, "Received unsupported GreenButton data #{unsupported_kinds.to_s}
-          Only Electricity (kind = 0) is supported."
-    end
-    gb
-  end
-
-
   # Parses the given greenbutton data to the corresponding ruby objects.
   #
   # user_id - identifies the owner of the data.
@@ -168,7 +138,7 @@ module GreenButton
   #
   # Returns the parsed array of gb_data_description
   private
-  def self.parse_data(user_id, data)
+  def self.parse_data(user_id = nil, data)
     # get ApplicationInformation
     app_info = GreenButton::Parser::GbApplicationInformation.
         parse(open(@application_information_url,
@@ -187,7 +157,7 @@ module GreenButton
             gb_data_description = @interpreters[usage_point.kind]
                                       .get_gb_data_description(entry, feed)
             gb_data_description.custodian = app_info.data_custodian_id
-            gb_data_description.user_id = user_id
+            gb_data_description.user_id = user_id unless user_id.nil?
             gb << gb_data_description
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ce-greenbutton
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ahmed.seddiq
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler