green-button-data 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGY5ZWIwYjc2ODMxMDk0NjM2NTA5OTkyNzJhODhiNWQ1ZGE0MWM0Yw==
+    MWE4MjIxNGU3MGY3OGQ3M2Y4ZTc4ZjgwYjJkNmVjYzU3MmFjZTA1Mg==
   data.tar.gz: !binary |-
-    MDQ0MTJkOTc0OWI3OTkyNjc5MmQ1NzE2NWUzYzAwZGFhMjBhMDZiMA==
+    NGYxZWY5MzMwY2Y1MDhhOTU0NmVhZTY5MDk2ODlhMWQzYWNhZTMyZg==
 SHA512:
   metadata.gz: !binary |-
-    NGU2MmY5NDYwZTAzN2VhZGIxNzliYzVmYmQzYWMwOGVjMDkxNjY0NDE5Yjkw
-    ZmM2MTIxMmRmNTM4MzdlYjI2NWI1MDUxYzMzNzM2ZWRmODRiYTdlZjg2MGQw
-    OWFjMDI4ZDJlYzZhMGFmZmEwYTAwMTVlYTVhNGRiOGEyOTA5MmE=
+    ZmU1NDQ1NTNjYWYyYWJkMzYzNGNmYTQ2OGExNzQ1YzRlY2UwZDQ2NTAyZjk3
+    N2ZlNTEyZGM5Zjk3MGI4ZmZkOWI4MTMzZTQ2OTgyYTgyMjkyMjhlNzE5YmRh
+    OTVlYjI4YTgyNGViNmZmNDQ2ZjEyMjBmNTgzYzY0MzY5MzU0ZjM=
   data.tar.gz: !binary |-
-    YjY0YWQ5ZGFkN2RjODFiNDcxMjlkNWM5N2U0M2UwYjNjZDJkYWViMzBlZWRj
-    OTNjN2M2MjQ3ZmVjY2MyMmU0ZjBhMWJkMDJiMGI5MmI5ZWEwNzdlNjJhMTNm
-    ZDNkY2FkZWM3M2UzN2I2YjBiMjQ5OGFmN2Y3ZjJlZjQzMjlmNDI=
+    OWQ1ZTk4MTAzOTEwMjIwMmNkNDM1YThiMGEyMzM5OGQ5NDdjMzkwODgyMjNh
+    MWUwODdmMjNkNjU0NDlmYzA5MmM1ZGY2ZGNlNzBjZmYzMDlmMGYwMzM4Njcz
+    ZDhkNjIxMTkzNDY1ZGIyMGNiZTFjN2Q2ZTgwOGZlMzZmN2Q1ZjM=

data/green-button-data.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://verdigris.co'
   s.licenses    = ['BSD-2-Clause']
 
-  s.summary     = 'Parser for Green Button data format'
+  s.summary     = 'Client and parser for Green Button API'
   s.description = 'Green Button Data is a Ruby gem that can consume Green ' +
                   'Button APIs and parse the Green Button data XML schema ' +
                   'very quickly. It uses an event-driven SAX parser which ' +

data/lib/green-button-data.rb

@@ -20,6 +20,7 @@ require 'green-button-data/meter_reading'
 require 'green-button-data/reading_type'
 require 'green-button-data/usage_point'
 require 'green-button-data/usage_summary'
+require 'green-button-data/retail_customer'
 require 'green-button-data/client'
 
 module GreenButtonData

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

@@ -174,6 +174,24 @@ module GreenButtonData
       )
     end
 
+    def retail_customer(id = nil, options = {})
+      if id.is_a? Hash
+        options = id
+        id = nil
+      end
+
+      retail_customer_id = options[:subscription_id]
+
+      get_resource(
+        @configuration.retail_customer_url(
+          subscription_id: retail_customer_id
+        ),
+        id,
+        RetailCustomer,
+        sanitize_options(options)
+      )
+    end
+
     private
 
     def get_resource(url, id = nil, klazz = nil, options = {})

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

@@ -11,7 +11,8 @@ module GreenButtonData
                   :reading_type_path,
                   :subscription_path,
                   :usage_point_path,
-                  :usage_summary_path
+                  :usage_summary_path,
+                  :retail_customer_path
 
     def application_information_url(id = nil)
       return build_url @application_information_path, id
@@ -125,6 +126,17 @@ module GreenButtonData
       end
     end
 
+    def retail_customer_url(kwargs = {})
+      retail_customer_id = kwargs[:subscription_id]
+
+      if retail_customer_id
+        retail_customer_url = build_url(@retail_customer_path)
+        return "#{retail_customer_url}/#{retail_customer_id}"
+      else
+        raise ArgumentError.new "Missing required arguments: subscription_id"
+      end
+    end
+
     private
 
     def build_url(path, id = nil)

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

@@ -189,6 +189,10 @@ module GreenButtonData
               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

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

@@ -28,6 +28,7 @@ module GreenButtonData
 
         reading[:cost] = interval_reading.cost if interval_reading.cost
         reading[:quality] = interval_reading.quality if interval_reading.quality
+        reading[:tou] = interval_reading.tou if interval_reading.tou
 
         result << reading
       end

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

@@ -11,6 +11,11 @@ require 'green-button-data/parser/summary_measurement'
 require 'green-button-data/parser/cost_additional_detail_last_period'
 require 'green-button-data/parser/usage_point'
 require 'green-button-data/parser/usage_summary'
+require 'green-button-data/parser/street_detail'
+require 'green-button-data/parser/town_detail'
+require 'green-button-data/parser/main_address'
+require 'green-button-data/parser/service_location'
+require 'green-button-data/parser/customer_agreement'
 require 'green-button-data/parser/content'
 require 'green-button-data/parser/entry'
 require 'green-button-data/parser/feed'

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

@@ -17,6 +17,10 @@ module GreenButtonData
       element :ReadingType, class: ReadingType, as: :reading_type
       element :UsagePoint, class: UsagePoint, as: :usage_point
       element :UsageSummary, class: UsageSummary, as: :usage_summary
+      element :ServiceLocation, class: ServiceLocation,
+              as: :service_location
+      element :CustomerAgreement, class: CustomerAgreement,
+              as: :customer_agreement
 
       # ESPI Namespacing
       element :'espi:ApplicationInformation', class: ApplicationInformation,
@@ -33,6 +37,10 @@ module GreenButtonData
       element :'espi:ReadingType', class: ReadingType, as: :reading_type
       element :'espi:UsagePoint', class: UsagePoint, as: :usage_point
       element :'espi:UsageSummary', class: UsageSummary, as: :usage_summary
+      element :'espi:ServiceLocation', class: ServiceLocation,
+              as: :service_location
+      element :'espi:CustomerAgreement', class: CustomerAgreement,
+              as: :customer_agreement
 
       # Special case for PG&E generic namespaces
       element :'ns0:ApplicationInformation', class: ApplicationInformation,
@@ -44,6 +52,10 @@ module GreenButtonData
       element :'ns0:ReadingType', class: ReadingType, as: :reading_type
       element :'ns0:UsagePoint', class: UsagePoint, as: :usage_point
       element :'ns0:UsageSummary', class: UsageSummary, as: :usage_summary
+      element :'ns0:ServiceLocation', class: ServiceLocation,
+              as: :service_location
+      element :'ns0:CustomerAgreement', class: CustomerAgreement,
+              as: :customer_agreement
     end
   end
 end

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

@@ -1,36 +1,14 @@
 module GreenButtonData
   module Parser
-    class CostAdditionalDetailLastPeriod
-      include SAXMachine
-
-      element :powerOfTenMultiplier, class: Integer,
-              as: :power_of_ten_multiplier
-      element :uom, class: Integer
-      element :value, class: Integer
+    class CostAdditionalDetailLastPeriod < SummaryMeasurement
       element :note
       element :itemKind, class: Integer, as: :item_kind
 
-      def value
-        @value
-      end
-
-      def note
-        @note
-      end
-
       # ESPI Namespacing
-      element :'espi:powerOfTenMultiplier', class: Integer,
-              as: :power_of_ten_multiplier
-      element :'espi:uom', class: Integer, as: :uom
-      element :'espi:value', class: Integer, as: :value
       element :'espi:note', as: :note
       element :'espi:itemKind', class: Integer, as: :item_kind
 
       # Special case for PG&E generic namespacing
-      element :'ns0:powerOfTenMultiplier', class: Integer,
-              as: :power_of_ten_multiplier
-      element :'ns0:uom', class: Integer, as: :uom
-      element :'ns0:value', class: Integer, as: :value
       element :'ns0:note', as: :note
       element :'ns0:itemKind', class: Integer, as: :item_kind
     end

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

@@ -0,0 +1,15 @@
+module GreenButtonData
+  module Parser
+    class CustomerAgreement
+      include SAXMachine
+
+      element :name, as: :customer_agreement_id
+
+      # ESPI Namespacing
+      element :'espi:name', as: :customer_agreement_id
+
+      # Special case for PG&E generic namespacing
+      element :'ns0:name', as: :customer_agreement_id
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module GreenButtonData
+  module Parser
+    class MainAddress
+      include SAXMachine
+
+      def town_detail_info
+         [town, state, zipcode].join(',')
+      end
+
+      def town
+        town_detail.name
+      end
+
+      def state
+        town_detail.state_or_province
+      end
+
+      def zipcode
+        town_detail.code.gsub(/\s+/, "")
+      end
+
+      def address_general
+        street_detail.address_general
+      end
+
+      def to_s
+        address_general + ',' + town_detail_info
+      end
+
+      element :town_detail, class: TownDetail, as: :town_detail
+      element :street_detail, class: StreetDetail, as: :town_detail
+
+
+      # ESPI Namespacing
+      element :'espi:townDetail', class: TownDetail, as: :town_detail
+      element :'espi:streetDetail', class: StreetDetail, as: :street_detail
+
+      # Special case for PG&E generic namespacing
+      element :'ns0:townDetail', class: TownDetail, as: :town_detail
+      element :'ns0:streetDetail', class: StreetDetail, as: :street_detail
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module GreenButtonData
+  module Parser
+    class ServiceLocation
+      include SAXMachine
+
+      element :main_address, class: MainAddress, as: :main_address
+
+      # ESPI Namespacing
+      element :'espi:mainAddress', class: MainAddress, as: :main_address
+
+      # Special case for PG&E generic namespacing
+      element :'ns0:mainAddress', class: MainAddress, as: :main_address
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module GreenButtonData
+  module Parser
+    class StreetDetail
+      include SAXMachine
+
+      element :address_general, as: :address_general
+
+      # ESPI Namespacing
+      element :'espi:addressGeneral', as: :address_general
+
+      # Special case for PG&E generic namespacing
+      element :'ns0:addressGeneral', as: :address_general
+    end
+  end
+end
+

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

@@ -0,0 +1,21 @@
+module GreenButtonData
+  module Parser
+    class TownDetail
+      include SAXMachine
+
+      element :state_or_province, as: :state_or_province
+      element :code, as: :code
+      element :name, as: :name
+
+      # ESPI Namespacing
+      element :'espi:stateOrProvince', as: :state_or_province
+      element :'espi:code', as: :code
+      element :'espi:name', as: :name
+
+      # Special case for PG&E generic namespacing
+      element :'ns0:stateOrProvince', as: :state_or_province
+      element :'ns0:code', as: :code
+      element :'ns0:name', as: :name
+    end
+  end
+end

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

@@ -56,6 +56,10 @@ module GreenButtonData
         Time.at(normalize_epoch(@status_time_stamp)).utc.to_datetime
       end
 
+      def cost
+        @bill_last_period / 100_000.0
+      end
+
       # ESPI Namespacing
       element :'espi:billingPeriod', class: Interval, as: :billing_period
       element :'espi:billLastPeriod', class: Integer, as: :bill_last_period

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

@@ -0,0 +1,40 @@
+module GreenButtonData
+  class RetailCustomer < Entry
+    def has_address?
+      present?(address_general)
+    end
+
+    def has_agreement_id_map?
+      present?(customer_agreement_id)
+    end
+
+    def address_general
+      @main_address.to_s
+    end
+
+    def agreement_id_service_uuid_map
+      {
+        customer_agreement_id: customer_agreement_id,
+        service_uuid: service_uuid
+      }
+    end
+
+    private
+
+    def service_uuid
+      @id
+    end
+
+    def customer_agreement_id
+      @customer_agreement_id
+    end
+
+    def present?(data)
+      !blank?(data)
+    end
+
+    def blank?(data)
+      data.respond_to?(:empty?) ? !!data.empty? : !data
+    end
+  end
+end

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

@@ -34,5 +34,9 @@ module GreenButtonData
     def to_s
       "#{@billing_period}: #{@overall_consumption_last_period}"
     end
+
+    def cost
+      @bill_last_period / 100_000.0
+    end
   end
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: green-button-data
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Jo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -152,20 +152,26 @@ files:
 - lib/green-button-data/parser/authorization.rb
 - lib/green-button-data/parser/content.rb
 - lib/green-button-data/parser/cost_additional_detail_last_period.rb
+- lib/green-button-data/parser/customer_agreement.rb
 - lib/green-button-data/parser/entry.rb
 - lib/green-button-data/parser/feed.rb
 - lib/green-button-data/parser/interval.rb
 - lib/green-button-data/parser/interval_block.rb
 - lib/green-button-data/parser/interval_reading.rb
 - lib/green-button-data/parser/local_time_parameters.rb
+- lib/green-button-data/parser/main_address.rb
 - lib/green-button-data/parser/rational_number.rb
 - lib/green-button-data/parser/reading_type.rb
 - lib/green-button-data/parser/service_category.rb
+- lib/green-button-data/parser/service_location.rb
+- lib/green-button-data/parser/street_detail.rb
 - lib/green-button-data/parser/summary_measurement.rb
+- lib/green-button-data/parser/town_detail.rb
 - lib/green-button-data/parser/usage_point.rb
 - lib/green-button-data/parser/usage_summary.rb
 - lib/green-button-data/reading_type.rb
 - lib/green-button-data/relations.rb
+- lib/green-button-data/retail_customer.rb
 - lib/green-button-data/usage_point.rb
 - lib/green-button-data/usage_summary.rb
 - lib/green-button-data/utilities.rb
@@ -193,6 +199,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Parser for Green Button data format
+summary: Client and parser for Green Button API
 test_files: []
 has_rdoc: