green-button-data 0.6.0 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWE4MjIxNGU3MGY3OGQ3M2Y4ZTc4ZjgwYjJkNmVjYzU3MmFjZTA1Mg==
+    NjFhMDE3MzUwYzQ3ZmJhOWE3MThiZmJlM2VlMjZhMGY2MzU5Yzc0Nw==
   data.tar.gz: !binary |-
-    NGYxZWY5MzMwY2Y1MDhhOTU0NmVhZTY5MDk2ODlhMWQzYWNhZTMyZg==
+    OTE2MWUzNDI1YjRiOTQ0ZWZkZWIxNTQxYzE1YzEyZTQ0YzU2NGFhZA==
 SHA512:
   metadata.gz: !binary |-
-    ZmU1NDQ1NTNjYWYyYWJkMzYzNGNmYTQ2OGExNzQ1YzRlY2UwZDQ2NTAyZjk3
-    N2ZlNTEyZGM5Zjk3MGI4ZmZkOWI4MTMzZTQ2OTgyYTgyMjkyMjhlNzE5YmRh
-    OTVlYjI4YTgyNGViNmZmNDQ2ZjEyMjBmNTgzYzY0MzY5MzU0ZjM=
+    Y2ZmODJhOWJkNTgwOTc5NWFhOWIyZmU3ZDI1YjFjMjAwNzQ2NDY0NDQyYmY4
+    ZTMwZmJjMTAxNzIwYzM0NTA4YWFmYWJlM2U3YjQ3MmRjNGY4NTU1NDRhMTgy
+    NjY1MzdlYTdiNGEwOTJhZDdiZWU1MmI1MTI3NjNiZWZlYjA4NDE=
   data.tar.gz: !binary |-
-    OWQ1ZTk4MTAzOTEwMjIwMmNkNDM1YThiMGEyMzM5OGQ5NDdjMzkwODgyMjNh
-    MWUwODdmMjNkNjU0NDlmYzA5MmM1ZGY2ZGNlNzBjZmYzMDlmMGYwMzM4Njcz
-    ZDhkNjIxMTkzNDY1ZGIyMGNiZTFjN2Q2ZTgwOGZlMzZmN2Q1ZjM=
+    YmQyZWQ0ZmRmNDYzNjEzZjg0Mzc0ZGIxNmJmNThlMWIwYjJlMzFhOGFmYjRm
+    Zjg4MmFjODhlYzE1ZmJlM2E1YzJmMDU5ZThmNTY1OGY4MmExOTUyMDM4Mjcy
+    MzU2MmQ2NjllNjRmMTk1NjBkNzAxNWRiMTgwODk1NDc5MmNjOWI=

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+languages:
+  Ruby: true
+exclude_paths:
+- "lib/green-button-data/enumerations/*.rb"
+- "lib/green-button-data/parser/*.rb"

data/.gitignore

@@ -1,8 +1,8 @@
 .bundle
 .ruby-gemset
 .ruby-version
-Gemfile.lock
 doc/
 pkg/
 rdoc/
 coverage/
+vendor/

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    green-button-data (0.6.0)
+      faraday (~> 0.9)
+      nokogiri (~> 1.6)
+      sax-machine (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    codecov (0.1.0)
+      json
+      simplecov
+      url
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (1.8.3)
+    listen (3.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    multipart-post (2.0.0)
+    nenv (0.2.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    notiffany (0.0.7)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pkg-config (1.1.7)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    sax-machine (1.3.2)
+    shellany (0.0.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    url (0.3.2)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov
+  green-button-data!
+  guard (~> 2.13)
+  guard-rspec
+  rspec (~> 3.0)
+  webmock (~> 1.21)

data/README.md

@@ -108,8 +108,8 @@ ESPI Green Button Data reference API and the other for Pacific Gas & Electric:
 
 ```ruby
 espi_base_url   = "https://services.greenbuttondata.org/DataCustodian/espi/" +
-                  "1_1/resources/"
-pge_base_url    = "https://api.pge.com/GreenButtonConnect/espi/1_1/resources/"
+                  "1_1/resource/"
+pge_base_url    = "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/"
 
 espi_client = GreenButtonData.connect base_url: "https://foo.com" do |client|
   # Override base_url configuration

data/green-button-data.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name        = 'green-button-data'
   s.version     = GreenButtonData::VERSION
 
-  s.authors     = ['Andrew Jo']
+  s.authors     = ['Andrew Jo', 'Orlando Lee']
   s.email       = 'engineering@verdigris.co'
   s.homepage    = 'http://verdigris.co'
   s.licenses    = ['BSD-2-Clause']

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

@@ -192,6 +192,66 @@ module GreenButtonData
       )
     end
 
+    def interval_block_bulk(id = nil, options = {})
+      if id.is_a? Hash
+        options = id
+        id = nil
+      end
+
+      subscription_id = options[:subscription_id]
+      bulk_file_id = options[:bulk_file_id]
+
+      get_resource(
+        @configuration.bulk_url(
+          subscription_id: subscription_id,
+          bulk_file_id: bulk_file_id
+        ),
+        id,
+        IntervalBlock,
+        sanitize_options(options)
+      )
+    end
+
+    def usage_summary_bulk(id = nil, options = {})
+      if id.is_a? Hash
+        options = id
+        id = nil
+      end
+
+      subscription_id = options[:subscription_id]
+      bulk_file_id = options[:bulk_file_id]
+
+      get_resource(
+        @configuration.bulk_url(
+          subscription_id: subscription_id,
+          bulk_file_id: bulk_file_id
+        ),
+        id,
+        UsageSummary,
+        sanitize_options(options)
+      )
+    end
+
+    def retail_customer_bulk(id = nil, options = {})
+      if id.is_a? Hash
+        options = id
+        id = nil
+      end
+
+      subscription_id = options[:subscription_id]
+      bulk_file_id = options[:bulk_file_id]
+
+      get_resource(
+        @configuration.bulk_url(
+          subscription_id: subscription_id,
+          bulk_file_id: bulk_file_id
+        ),
+        id,
+        RetailCustomer,
+        sanitize_options(options)
+      )
+    end
+
     private
 
     def get_resource(url, id = nil, klazz = nil, options = {})
@@ -214,6 +274,7 @@ module GreenButtonData
       options.delete(:subscription_id) if options.has_key? :subscription_id
       options.delete(:usage_point_id) if options.has_key? :usage_point_id
       options.delete(:usage_summary_id) if options.has_key? :usage_summary_id
+      options.delete(:bulk_file_id) if options.has_key? :bulk_file_id
       options
     end
   end

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

@@ -12,7 +12,8 @@ module GreenButtonData
                   :subscription_path,
                   :usage_point_path,
                   :usage_summary_path,
-                  :retail_customer_path
+                  :retail_customer_path,
+                  :bulk_path
 
     def application_information_url(id = nil)
       return build_url @application_information_path, id
@@ -137,6 +138,18 @@ module GreenButtonData
       end
     end
 
+    def bulk_url(kwargs = {})
+      subscription_id = kwargs[:subscription_id]
+      bulk_file_id = kwargs[:bulk_file_id]
+
+      if subscription_id && bulk_file_id
+        bulk_url = build_url(@bulk_path)
+        return "#{bulk_url}/#{subscription_id}/#{bulk_file_id}"
+      else
+        raise ArgumentError.new "Missing required arguments: subscription_id or bulk_file_id"
+      end
+    end
+
     private
 
     def build_url(path, id = nil)

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

@@ -3,7 +3,7 @@ module GreenButtonData
     include Fetchable
     include Utilities
 
-    attr_reader :id
+    attr_reader :id, :usage_point_id
     attr_accessor :token
 
     def initialize(attributes)

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

@@ -140,64 +140,83 @@ module GreenButtonData
         self.name.split('::').last
       end
 
-      def each_entry_content(feed)
-        entry_content = nil
+      def resource_from_url(url)
+        # Matches resource name in URL (e.g. ApplicationInformation)
+        resource = '([a-zA-Z]+)'
 
-        feed.entries.each do |entry|
-          # Matches resource name in URL (e.g. ApplicationInformation)
-          resource = '([a-zA-Z]+)'
+        # Matches Base 64 encoded resource ID used by PG&E for MeterReading
+        # resource identifier
+        base64_id = '\w+=*'
+
+        # Matches numeric ID with thousands separator in commas used for
+        # UsageSummary IDs for PG&E endpoints but also matches traditional
+        # digits without comma separator
+        num_id = '(\d+,*\d*)+'
+
+        # Matches GUID as the resource ID used mainly by PG&E for
+        # ApplicationInformation resource identifier
+        guid = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}' +
+                '-[0-9A-Fa-f]{12}'
+
+        # Identifier can be any of the above patterns
+        identifier = "(#{base64_id}|#{num_id}|#{guid})"
+
+        /\/(#{resource}|#{resource}\/#{identifier})\/*\z/.match(url)
+      end
+
+      def usage_point_id_from_url(url)
+        usage_point = 'UsagePoint\/(.*?)\/'
+        /(#{usage_point})/.match(url)
+      end
 
-          # Matches Base 64 encoded resource ID used by PG&E for MeterReading
-          # resource identifier
-          base64_id = '\w+=*'
+      def valid_resources
+        [
+          'applicationinformation',
+          'authorization',
+          'electricpowerusagesummary',
+          'intervalblock',
+          'localtimeparameters',
+          'readingtype',
+          'usagepoint',
+          'usagesummary',
+          'servicelocation',
+          'customeragreement'
+        ]
+      end
 
-          # Matches numeric ID with thousands separator in commas used for
-          # UsageSummary IDs for PG&E endpoints but also matches traditional
-          # digits without comma separator
-          num_id = '(\d+,*\d*)+'
+      def valid_resource?(resource)
+        resource.downcase =~ /(#{valid_resources.join('|')})/
+      end
 
-          # Matches GUID as the resource ID used mainly by PG&E for
-          # ApplicationInformation resource identifier
-          guid = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}' +
-                 '-[0-9A-Fa-f]{12}'
+      def type_match_class?(type)
+        class_name_mapping = {
+          'ServiceLocation' => 'RetailCustomer',
+          'CustomerAgreement' => 'RetailCustomer',
+          'ElectricPowerUsageSummary' => 'UsageSummary'
+        }
+        type == class_name || (class_name_mapping.has_key?(type) && class_name_mapping[type] == class_name)
+      end
+
+      def infer_content_from(entry, resource)
+        return nil unless valid_resource? resource
+        entry.content.send resource.underscore
+      end
 
-          # Identifier can be any of the above patterns
-          identifier = "(#{base64_id}|#{num_id}|#{guid})"
+      def each_entry_content(feed)
+        entry_content = nil
 
-          match_data = /\/(#{resource}|#{resource}\/#{identifier})\/*\z/.
-                       match(entry.self)
+        feed.entries.each do |entry|
+          match_data = resource_from_url(entry.self)
 
           unless match_data.nil?
             id = match_data[4] || entry.id
             type = match_data[2] || match_data[3]
+            next unless type_match_class?(type)
 
-            entry_content = case type.downcase
-
-            when 'applicationinformation'
-              entry.content.application_information
-            when 'authorization'
-              entry.content.authorization
-            when 'electricpowerusagesummary'
-              entry.content.electric_power_usage_summary
-            when 'intervalblock'
-              entry.content.interval_block
-            when 'localtimeparameters'
-              entry.content.local_time_parameters
-            when 'readingtype'
-              entry.content.reading_type
-            when 'usagepoint'
-              entry.content.usage_point
-            when 'usagesummary'
-              entry.content.usage_summary
-            when 'servicelocation'
-              entry.content.service_location
-            when 'customeragreement'
-              entry.content.customer_agreement
-            else
-              nil
-            end
-
-            yield id, entry_content, entry
+            entry_content = infer_content_from entry, type
+            match_usage_point_id = usage_point_id_from_url(entry.self)
+            usage_point_id = match_usage_point_id[2] unless match_usage_point_id.nil?
+            yield id, entry_content, entry, usage_point_id
           end
         end
       end
@@ -205,9 +224,10 @@ module GreenButtonData
       def populate_models(feed)
         models = GreenButtonData::ModelCollection.new
 
-        each_entry_content feed do |id, content, entry|
+        each_entry_content feed do |id, content, entry, usage_point_id|
           attributes_hash = attributes_to_hash(content)
           attributes_hash[:id] = id
+          attributes_hash[:usage_point_id] = usage_point_id
 
           attributes_hash[:related_urls] = construct_related_urls entry
           models << self.new(attributes_hash)

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

@@ -3,6 +3,7 @@ module GreenButtonData
     class CostAdditionalDetailLastPeriod < SummaryMeasurement
       element :note
       element :itemKind, class: Integer, as: :item_kind
+      element :amount, class: Integer, as: :amount
 
       # ESPI Namespacing
       element :'espi:note', as: :note
@@ -11,6 +12,9 @@ module GreenButtonData
       # Special case for PG&E generic namespacing
       element :'ns0:note', as: :note
       element :'ns0:itemKind', class: Integer, as: :item_kind
+
+      # Special case for SCE generic namespacing
+      element :'ns0:amount', class: Integer, as: :amount
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module GreenButtonData
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: green-button-data
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrew Jo
+- Orlando Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -102,9 +103,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .codeclimate.yml
 - .gitignore
 - .rspec
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md