green-button-data 0.1.0 → 0.1.1

data/spec/fixtures/PGEUsagePoint.xml

@@ -0,0 +1,24 @@
+<ns1:feed xmlns:ns1="http://www.w3.org/2005/Atom">
+   <ns1:id xsi:type="ns1:idType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">00000000-0000-0000-0000-000000000001</ns1:id>
+   <ns1:title type="text" xsi:type="ns1:textType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Green Button Usage Feed</ns1:title>
+   <ns1:updated xsi:type="ns1:dateTimeType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2015-08-04T16:02:03.151Z</ns1:updated>
+   <ns1:link href="https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/0/UsagePoint" rel="self" xsi:type="ns1:linkType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
+   <ns1:entry>
+      <ns1:id xsi:type="ns1:idType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">00000000-0000-0000-0000-000000000002</ns1:id>
+      <ns1:link href="https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/0/UsagePoint" rel="up" xsi:type="ns1:linkType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
+      <ns1:link href="https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/0/UsagePoint/1" rel="self" xsi:type="ns1:linkType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
+      <ns1:link href="https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/0/UsagePoint/1/MeterReading" rel="related" xsi:type="ns1:linkType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
+      <ns1:link href="https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/0/UsagePoint/1/UsageSummary" rel="related" xsi:type="ns1:linkType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
+      <ns1:link href="https://api.pge.com/GreenButtonConnect/espi/1_1/resource/LocalTimeParameters/1" rel="related" xsi:type="ns1:linkType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
+      <ns1:title type="text" xsi:type="ns1:textType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Green Button Data File</ns1:title>
+      <ns1:published xsi:type="ns1:dateTimeType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2015-08-04T16:02:03.16Z</ns1:published>
+      <ns1:updated xsi:type="ns1:dateTimeType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2015-08-04T16:02:03.16Z</ns1:updated>
+      <ns1:content xsi:type="ns1:contentType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+         <ns0:UsagePoint xmlns:ns0="http://naesb.org/espi">
+            <ns0:ServiceCategory>
+               <ns0:kind>0</ns0:kind>
+            </ns0:ServiceCategory>
+         </ns0:UsagePoint>
+      </ns1:content>
+   </ns1:entry>
+</ns1:feed>

data/spec/fixtures.rb

@@ -5,7 +5,13 @@ module Fixtures
     espi_interval_block: "ESPIIntervalBlock.xml",
     espi_local_time_parameters: "ESPILocalTimeParameters.xml",
     espi_reading_type: "ESPIReadingType.xml",
-    espi_usage_point: "ESPIUsagePoint.xml"
+    espi_usage_point: "ESPIUsagePoint.xml",
+    pge_application_information: "PGEApplicationInformation.xml",
+    pge_authorization: "PGEAuthorization.xml",
+    pge_interval_block: "PGEIntervalBlock.xml",
+    pge_local_time_parameters: "PGELocalTimeParameters.xml",
+    pge_reading_type: "PGEReadingType.xml",
+    pge_usage_point: "PGEUsagePoint.xml"
   }
 
   ##

data/spec/green-button-data/parser/application_information_spec.rb

@@ -151,4 +151,158 @@ describe GreenButtonData::Parser::ApplicationInformation do
       end
     end
   end
+
+  context "PG&E namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :application_information do
+      feed.parse(pge_application_information)
+          .entries
+          .first
+          .content
+          .application_information
+    end
+
+    subject { application_information }
+
+    it "should parse data custodian id" do
+      expect(subject.data_custodian_id).to eq "PGE"
+    end
+
+    it "should parse data custodian application status" do
+      expect(subject.data_custodian_application_status).to eq 2
+    end
+
+    it "should parse data custodian scope selection URI" do
+      expect(subject.data_custodian_scope_selection_screen_uri).to eq "https://sharemydata.pge.com/myAuthorization/?clientId=0&verified=true"
+    end
+
+    it "should parse data custodian bulk request URI" do
+      expect(subject.data_custodian_bulk_request_uri).to eq "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/0"
+    end
+
+    it "should parse data custodian resource endpoint" do
+      expect(subject.data_custodian_resource_endpoint).to eq "https://api.pge.com/GreenButtonConnect/espi/1_1/resource"
+    end
+
+    it "should parse third party application type" do
+      expect(subject.third_party_application_type).to eq 1
+    end
+
+    it "should parse third party application use" do
+      expect(subject.third_party_application_use).to eq nil
+    end
+
+    it "should parse third party application description" do
+      expect(subject.third_party_application_description).to eq "Verdigris is an energy intelligence solution that shows facilities managers how their buildings use energy at the equipment level--all in real time."
+    end
+
+    it "should parse third party phone number" do
+      expect(subject.third_party_phone).to eq "6502273888"
+    end
+
+    it "should parse third party scope selection URI" do
+      expect(subject.third_party_scope_selection_screen_uri).to eq "http://api.example.com/espi/pge"
+    end
+
+    it "should parse third party user portal URI" do
+      expect(subject.third_party_user_portal_screen_uri).to eq "https://www.example.com"
+    end
+
+    it "should parse third party notify URI" do
+      expect(subject.third_party_notify_uri).to eq "https://api.example.com/espi/pge/notify"
+    end
+
+    it "should parse authorization server URI" do
+      expect(subject.authorization_server_uri).to eq "https://api.pge.com"
+    end
+
+    it "should parse authorization server's authorization endpoint" do
+      expect(subject.authorization_server_authorization_endpoint).to eq "https://api.pge.com/datacustodian/oauth/v2/authorize"
+    end
+
+    it "should parse authorization server's registration endpoint" do
+      expect(subject.authorization_server_registration_endpoint).to eq nil
+    end
+
+    it "should parse authorization server's token endpoint" do
+      expect(subject.authorization_server_token_endpoint).to eq "https://api.pge.com/datacustodian/oauth/v2/token"
+    end
+
+    it "should parse token endpoint's authentication method" do
+      expect(subject.token_endpoint_auth_method).to eq "client_secret_basic"
+    end
+
+    it "should parse client name" do
+      expect(subject.client_name).to eq "Verdigris Technologies, Inc."
+    end
+
+    it "should parse client id" do
+      expect(subject.client_id).to eq "verdigris"
+    end
+
+    it "should parse client secret" do
+      expect(subject.client_secret).to eq "foobar"
+    end
+
+    it "should parse date when client ID was issued" do
+      expect(subject.client_id_issued_at).to eq DateTime.new 2015, 10, 21, 16, 21, 21
+    end
+
+    it "should parse when client secret expires" do
+      expect(subject.client_secret_expires_at).to eq DateTime.new 9999, 12, 31, 23, 59, 59
+    end
+
+    it "should parse redirect URI" do
+      expect(subject.redirect_uri).to eq "http://api.example.com/espi/pge/callback"
+    end
+
+    it "should parse software id" do
+      expect(subject.software_id).to eq "NA"
+    end
+
+    it "should parse software version" do
+      expect(subject.software_version).to eq "NA"
+    end
+
+    it "should parse scopes" do
+      expect(subject.scopes.size).to eq 1
+      expect(subject.scopes.first).to eq "FB=1_3_4_5_8_13_14_15_18_19_31_32_35_37_38_39_40;IntervalDuration=900_3600;BlockDuration=Daily;HistoryLength=63072000;SubscriptionFrequency=Daily;"
+    end
+
+    it "should parse grant types" do
+      expect(subject.grant_types.size).to eq 3
+      expect(subject.grant_types.first).to eq "authorization_code"
+    end
+
+    it "should parse response types" do
+      expect(subject.response_types.size).to eq 1
+      expect(subject.response_types.first).to eq "code"
+    end
+
+    it "should parse registration_client_uri" do
+      expect(subject.registration_client_uri).to eq "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ApplicationInformation/00000000-2222-4444-6666-8888aaaacccc"
+    end
+
+    it "should parse registration_access_token" do
+      expect(subject.registration_access_token).to eq "00001111-2222-3333-4444-cccceeeeffff"
+    end
+
+    describe "#application_status" do
+      it "should return application status as a symbol" do
+        expect(subject.application_status).to eq :production
+      end
+    end
+
+    describe "#application_type" do
+      it "should return application type as a symbol" do
+        expect(subject.application_type).to eq :web
+      end
+    end
+
+    describe "#application_use" do
+      it "should return application use as a symbol" do
+        expect(subject.application_use).to eq nil
+      end
+    end
+  end
 end

data/spec/green-button-data/parser/authorization_spec.rb

@@ -49,4 +49,53 @@ describe GreenButtonData::Parser::Authorization do
       end
     end
   end
+
+  context "PG&E namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :authorization do
+      feed.parse(pge_authorization)
+          .entries
+          .first
+          .content
+          .authorization
+    end
+
+    subject { authorization }
+
+    it "should parse authorized period" do
+      expect(subject.authorized_period.start).to eq 1440585200
+      expect(subject.authorized_period.duration).to eq 2519636580
+    end
+
+    it "should parse published period" do
+      expect(subject.published_period.start).to eq 1395513200
+      expect(subject.published_period.duration).to eq 2520267300
+    end
+
+    it "should parse expiry date" do
+      expect(subject.expires_at).to eq DateTime.new 2015, 8, 27, 10, 7, 9
+    end
+
+    it "should parse status" do
+      expect(subject.status).to eq 1
+    end
+
+    it "should parse scope" do
+      expect(subject.scope).to eq "FB=1_3_4_5_8_13_14_15_18_19_31_32_35_37_38_39_40;IntervalDuration=900_3600;BlockDuration=Daily;HistoryLength=63072000;SubscriptionFrequency=Daily;AccountCollection=1;"
+    end
+
+    it "should parse resource URI" do
+      expect(subject.resource_uri).to eq "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/0"
+    end
+
+    it "should parse authorization URI" do
+      expect(subject.authorization_uri).to eq "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/0"
+    end
+
+    describe "#active?" do
+      it "should return true if status is not 0" do
+        expect(subject.active?).to eq true
+      end
+    end
+  end
 end

data/spec/green-button-data/parser/interval_block_spec.rb

@@ -36,4 +36,40 @@ describe GreenButtonData::Parser::IntervalBlock do
       end
     end
   end
+
+  context "PG&E namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :interval_block do
+      feed.parse(pge_interval_block).entries.last.content.interval_block
+    end
+
+    subject { interval_block }
+
+    it "should parse interval" do
+      expect(subject.interval).to be_an_instance_of GreenButtonData::Parser::Interval
+    end
+
+    it "should parse interval readings" do
+      expect(subject.interval_readings.size).to eq 2280
+      expect(subject.interval_readings.first).to be_an_instance_of GreenButtonData::Parser::IntervalReading
+    end
+
+    describe "#duration" do
+      it "should return the duration of the current interval block" do
+        expect(subject.duration).to eq 8208000
+      end
+    end
+
+    describe "#starts_at" do
+      it "should return the start datetime" do
+        expect(subject.starts_at).to eq DateTime.new 2015, 4, 30, 7
+      end
+    end
+
+    describe "#ends_at" do
+      it "should return the end datetime" do
+        expect(subject.ends_at).to eq DateTime.new 2015, 8, 3, 7
+      end
+    end
+  end
 end

data/spec/green-button-data/parser/local_time_parameter_spec.rb

@@ -53,4 +53,57 @@ describe GreenButtonData::Parser::LocalTimeParameters do
       end
     end
   end
+
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :local_time_parameters do
+      feed.parse(pge_local_time_parameters)
+          .entries
+          .first
+          .content
+          .local_time_parameters
+    end
+
+    subject { local_time_parameters }
+
+    it "should parse DST start rule" do
+      expect(subject.dst_start_rule).to eq 0x360e2000
+    end
+
+    it "should parse DST end rule" do
+      expect(subject.dst_end_rule).to eq 0xb40e2000
+    end
+
+    it "should parse DST offset" do
+      expect(subject.dst_offset).to eq 3600
+    end
+
+    it "should parse timezone offset" do
+      expect(subject.tz_offset).to eq -28800
+    end
+
+    describe "#dst_starts_at" do
+      it "should return DateTime object representation of DST rule" do
+        expect(subject.dst_starts_at(2015)).to eq DateTime.new 2015, 3, 8, 2
+      end
+    end
+
+    describe "#dst_ends_at" do
+      it "should return DateTime object representation of DST rule" do
+        expect(subject.dst_ends_at(2015)).to eq DateTime.new 2015, 11, 1, 2
+      end
+    end
+
+    describe "#total_offset" do
+      it "should return total offset from DST and timezone offsets in seconds" do
+        expect(subject.total_offset).to eq -25200
+      end
+    end
+
+    describe "#total_offset_hours" do
+      it "should return total offset in hours" do
+        expect(subject.total_offset_hours).to eq -7
+      end
+    end
+  end
 end

data/spec/green-button-data/parser/reading_type_spec.rb

@@ -73,4 +73,77 @@ describe GreenButtonData::Parser::ReadingType do
       expect(subject.argument).to eq nil
     end
   end
+
+  context "PG&E namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :reading_type do
+      feed.parse(pge_reading_type).entries.first.content.reading_type
+    end
+
+    subject { reading_type }
+
+    it "should parse accumulation behavior" do
+      expect(subject.accumulation_behaviour).to eq :delta_data
+    end
+
+    it "should parse commodity" do
+      expect(subject.commodity).to eq :electricity_secondary_metered
+    end
+
+    it "should parse consumption tier" do
+      expect(subject.consumption_tier).to eq nil
+    end
+
+    it "should parse currency" do
+      expect(subject.currency).to eq nil
+    end
+
+    it "should parse data qualifier" do
+      expect(subject.data_qualifier).to eq :normal
+    end
+
+    it "should parse flow direction" do
+      expect(subject.flow_direction).to eq :forward
+    end
+
+    it "should parse interval length" do
+      expect(subject.interval_length).to eq 900
+    end
+
+    it "should parse measurement kind" do
+      expect(subject.kind).to eq :energy
+    end
+
+    it "should parse phase" do
+      expect(subject.phase).to eq :s12_n
+    end
+
+    it "should parse power of ten multiplier" do
+      expect(subject.power_of_ten_multiplier).to eq 1000
+    end
+
+    it "should parse time attribute" do
+      expect(subject.time_attribute).to eq :none
+    end
+
+    it "should parse unit of measurement" do
+      expect(subject.uom).to eq :Wh
+    end
+
+    it "should parse cpp" do
+      expect(subject.cpp).to eq nil
+    end
+
+    it "should parse interharmonic" do
+      expect(subject.interharmonic).to eq nil
+    end
+
+    it "should parse measuring period" do
+      expect(subject.measuring_period).to eq :fifteen_minute
+    end
+
+    it "should parse argument" do
+      expect(subject.argument).to eq nil
+    end
+  end
 end

data/spec/green-button-data/parser/usage_point_spec.rb

@@ -19,4 +19,23 @@ describe GreenButtonData::Parser::UsagePoint do
       end
     end
   end
+
+  context "PG&E namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :usage_point do
+      feed.parse(espi_usage_point).entries.first.content.usage_point
+    end
+
+    subject { usage_point }
+
+    it "should parse kind" do
+      expect(subject.kind).to eq 0
+    end
+
+    describe "#service_category" do
+      it "should return service category as a symbol" do
+        expect(subject.service_category).to eq :electricity
+      end
+    end
+  end
 end