green-button-data 0.2.1 → 0.3.0

data/spec/lib/green-button-data/local_time_parameters_spec.rb

@@ -0,0 +1,106 @@
+require "spec_helper"
+
+describe GreenButtonData::LocalTimeParameters do
+  let(:all_url) { GreenButtonData.configuration.local_time_parameters_url }
+  let(:find_url) { "#{all_url}1" }
+  let(:token) { "c51a5047-327d-4a97-9daa-1d1296d11088" }
+
+  subject { GreenButtonData::LocalTimeParameters }
+
+  let(:local_time_parameters) { subject.find(1, token: token) }
+
+  let(:dst_starts_at) { Time.new 2015, 3, 7, 18, 0, 0, '-08:00' }
+  let(:dst_ends_at) { Time.new 2015, 10, 31, 19, 0, 0, '-07:00' }
+  let(:dst_offset) { 3600 }
+  let(:tz_offset) { -18000 }
+  let(:total_offset) { dst_offset + tz_offset }
+
+  before do
+    GreenButtonData.configure do |config|
+      config.base_url = "https://services.greenbuttondata.org/DataCustodian" +
+                        "espi/1_1/resource"
+
+      config.local_time_parameters_path = "LocalTimeParameters/"
+    end
+
+    stub_request(
+      :get, all_url
+    ).to_return status: 200, body: espi_local_time_parameters
+
+    stub_request(
+      :get, find_url
+    ).to_return status: 200, body: espi_local_time_parameters
+
+    stub_request(
+      :get, "#{find_url}/"
+    ).to_return status: 200, body: espi_local_time_parameters
+  end
+
+  describe "Constructor" do
+    it "should be a valid instance of LocalTimeParameters" do
+      local_time_parameters = subject.new id: "1"
+      expect(local_time_parameters).to be_a subject
+      expect(local_time_parameters.id).to eq "1"
+    end
+  end
+
+  describe ".all" do
+    context "valid authorization" do
+      let(:collection) { subject.all token: token }
+
+      it "should return a ModelCollection" do
+        expect(collection).to be_a GreenButtonData::ModelCollection
+      end
+
+      it "should be a collection of GreenButtonData::LocalTimeParameters " +
+        "instances" do
+
+        expect(collection.first).to be_a subject
+      end
+
+      it "should populate attributes" do
+        instance = collection.first
+        expect(instance.id).to eq "1"
+        expect(instance.dst_starts_at).to eq dst_starts_at
+        expect(instance.dst_ends_at).to eq dst_ends_at
+        expect(instance.dst_offset).to eq dst_offset
+        expect(instance.tz_offset).to eq tz_offset
+      end
+    end
+  end
+
+  describe ".find" do
+    context "valid authorization" do
+      it "is an instance of LocalTimeParameters" do
+        expect(local_time_parameters).to be_a subject
+        expect(WebMock).to have_requested(:get, "#{find_url}/")
+      end
+
+      it "should populate attributes" do
+        expect(local_time_parameters.id).to eq "1"
+        expect(local_time_parameters.dst_starts_at).to eq dst_starts_at
+        expect(local_time_parameters.dst_ends_at).to eq dst_ends_at
+        expect(local_time_parameters.dst_offset).to eq dst_offset
+        expect(local_time_parameters.tz_offset).to eq tz_offset
+      end
+    end
+  end
+
+  describe "#to_h" do
+    it "should return a Hash" do
+      expect(local_time_parameters.to_h).to be_a Hash
+    end
+
+    it "should populate attributes to Hash key values" do
+      expect(local_time_parameters.to_h).to eq({
+        dst: {
+          starts_at: dst_starts_at,
+          ends_at: dst_ends_at,
+          offset: dst_offset
+        },
+        tz_offset: tz_offset,
+        total_offset: total_offset
+      })
+    end
+  end
+end

data/spec/{green-button-data → lib/green-button-data}/parser/application_information_spec.rb

@@ -90,11 +90,11 @@ describe GreenButtonData::Parser::ApplicationInformation do
     end
 
     it "should parse date when client ID was issued" do
-      expect(subject.client_id_issued_at).to eq DateTime.new 2014, 6, 19, 15
+      expect(subject.client_id_issued_at).to eq 1403190000
     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
+      expect(subject.client_secret_expires_at).to eq 0
     end
 
     it "should parse redirect URI" do
@@ -245,11 +245,11 @@ describe GreenButtonData::Parser::ApplicationInformation do
     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
+      expect(subject.client_id_issued_at).to eq 1445444481075
     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
+      expect(subject.client_secret_expires_at).to eq 0
     end
 
     it "should parse redirect URI" do

data/spec/{green-button-data → lib/green-button-data}/parser/authorization_spec.rb

@@ -42,12 +42,6 @@ describe GreenButtonData::Parser::Authorization do
     it "should parse authorization URI" do
       expect(subject.authorization_uri).to eq "https://services.greenbuttondata.org/DataCustodian/espi/1_1/resource/Authorization/4"
     end
-
-    describe "#active?" do
-      it "should return true if status is not 0" do
-        expect(subject.active?).to eq true
-      end
-    end
   end
 
   context "PG&E namespace" do
@@ -91,11 +85,5 @@ describe GreenButtonData::Parser::Authorization do
     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 → lib/green-button-data}/parser/entry_spec.rb

@@ -19,7 +19,7 @@ describe GreenButtonData::Parser::Entry do
     end
 
     it "should parse self" do
-      expect(subject.self).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/1"
+      expect(subject.self).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2"
     end
 
     it "should parse related" do

data/spec/{green-button-data → lib/green-button-data}/parser/interval_block_spec.rb

@@ -26,13 +26,13 @@ describe GreenButtonData::Parser::IntervalBlock do
 
     describe "#starts_at" do
       it "should return the start datetime" do
-        expect(subject.starts_at).to eq DateTime.new 2013, 1, 1, 5
+        expect(subject.starts_at).to eq DateTime.new(2013, 1, 1, 5).to_time
       end
     end
 
     describe "#ends_at" do
       it "should return the end datetime" do
-        expect(subject.ends_at).to eq DateTime.new 2013, 2, 1, 5
+        expect(subject.ends_at).to eq DateTime.new(2013, 2, 1, 5).to_time
       end
     end
   end
@@ -62,13 +62,13 @@ describe GreenButtonData::Parser::IntervalBlock do
 
     describe "#starts_at" do
       it "should return the start datetime" do
-        expect(subject.starts_at).to eq DateTime.new 2015, 4, 30, 7
+        expect(subject.starts_at).to eq DateTime.new(2015, 4, 30, 7).to_time
       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
+        expect(subject.ends_at).to eq DateTime.new(2015, 8, 3, 7).to_time
       end
     end
   end

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

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+describe GreenButtonData::ReadingType do
+  let(:all_url) { GreenButtonData.configuration.reading_type_url }
+  let(:find_url) { "#{all_url}11" }
+  let(:token) { "c51a5047-327d-4a97-9daa-1d1296d11088" }
+
+  subject { GreenButtonData::ReadingType }
+
+  let(:reading_type) { subject.find(11, token: token) }
+
+  let(:accumulation_behaviour) { :delta_data }
+  let(:commodity) { :electricity_secondary_metered }
+  let(:currency) { :usd }
+  let(:data_qualifier) { :normal }
+  let(:flow_direction) { :forward }
+  let(:interval_length) { 300 }
+  let(:kind) { :energy }
+  let(:phase) { :s12_n }
+  let(:time_attribute) { :none }
+  let(:scale_factor) { 1.0 }
+  let(:unit_of_measurement) { :Wh }
+
+  before do
+    GreenButtonData.configure do |config|
+      config.base_url = "https://services.greenbuttondata.org/DataCustodian" +
+                        "espi/1_1/resource"
+
+      config.reading_type_path = "ReadingType/"
+    end
+
+    stub_request(:get, all_url).to_return status: 200, body: espi_reading_types
+    stub_request(:get, find_url).to_return status: 200, body: espi_reading_type
+
+    stub_request(
+      :get, "#{find_url}/"
+    ).to_return status: 200, body: espi_reading_type
+  end
+
+  describe "Constructor" do
+    it "should be a valid instance of ReadingType" do
+      reading_type = subject.new id: "1"
+      expect(reading_type).to be_a subject
+      expect(reading_type.id).to eq "1"
+    end
+  end
+
+  describe ".all" do
+    context "valid authorization" do
+      let(:collection) { subject.all token: token }
+
+      it "should return a ModelCollection" do
+        expect(collection).to be_a GreenButtonData::ModelCollection
+      end
+
+      it "should be a collection of GreenButtonData::ReadingType instances" do
+        expect(collection.first).to be_a subject
+      end
+
+      it "should populate attributes" do
+        instance = collection.first
+        expect(instance.id).to eq "11"
+        expect(instance.accumulation_behaviour).to eq accumulation_behaviour
+        expect(instance.commodity).to eq commodity
+        expect(instance.currency).to eq currency
+        expect(instance.data_qualifier).to eq data_qualifier
+        expect(instance.flow_direction).to eq flow_direction
+        expect(instance.interval_length).to eq interval_length
+        expect(instance.kind).to eq kind
+        expect(instance.phase).to eq phase
+        expect(instance.time_attribute).to eq time_attribute
+        expect(instance.scale_factor).to eq scale_factor
+        expect(instance.unit_of_measurement).to eq unit_of_measurement
+      end
+    end
+  end
+
+  describe ".find" do
+    context "valid authorization" do
+      it "is an instance of ReadingType" do
+        expect(reading_type).to be_a subject
+        expect(WebMock).to have_requested(:get, "#{find_url}/")
+      end
+
+      it "should populate attributes" do
+        expect(reading_type.id).to eq "11"
+        expect(reading_type.accumulation_behaviour).to eq accumulation_behaviour
+        expect(reading_type.commodity).to eq commodity
+        expect(reading_type.currency).to eq currency
+        expect(reading_type.data_qualifier).to eq data_qualifier
+        expect(reading_type.flow_direction).to eq flow_direction
+        expect(reading_type.interval_length).to eq interval_length
+        expect(reading_type.kind).to eq kind
+        expect(reading_type.phase).to eq phase
+        expect(reading_type.time_attribute).to eq time_attribute
+        expect(reading_type.scale_factor).to eq scale_factor
+        expect(reading_type.unit_of_measurement).to eq unit_of_measurement
+      end
+    end
+  end
+
+  describe "#to_h" do
+    it "should return a Hash" do
+      expect(reading_type.to_h).to be_a Hash
+    end
+
+    it "should populate attributes to Hash key values" do
+      expect(reading_type.to_h).to eq({
+        accumulation_behaviour: accumulation_behaviour,
+        commodity: commodity,
+        consumption_tier: nil,
+        cpp: nil,
+        currency: currency,
+        data_qualifier: data_qualifier,
+        default_quality: nil,
+        flow_direction: flow_direction,
+        kind: kind,
+        measuring_period: nil,
+        phase: phase,
+        scale_factor: scale_factor,
+        time_attribute: time_attribute,
+        tou: nil,
+        unit_of_measurement: unit_of_measurement
+      })
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+require "spec_helper"
+
+describe GreenButtonData::UsagePoint do
+  let(:all_url) { GreenButtonData.configuration.usage_point_url subscription_id: 5 }
+  let :find_url do
+    "#{all_url}2"
+  end
+  let(:token) { "53520584-d640-4812-a721-8a1afa459ff7" }
+
+  subject { GreenButtonData::UsagePoint }
+
+  let(:usage_point) { subject.find(2, subscription_id: 5, token: token) }
+
+  before do
+    GreenButtonData.configure do |config|
+      config.base_url = "https://services.greenbuttondata.org/DataCustodian/" +
+                        "espi/1_1/resource"
+      config.subscription_path = "Subscription/"
+      config.usage_point_path = "UsagePoint/"
+    end
+
+    stub_request(:get, all_url).to_return status: 200, body: espi_usage_points
+
+    stub_request(:get, find_url).to_return status: 200, body: espi_usage_point
+
+    stub_request(
+      :get, "#{find_url}/"
+    ).to_return status: 200, body: espi_usage_point
+  end
+
+  describe "Constructor" do
+    it "should be a valid instance of UsagePoint" do
+      usage_point = subject.new id: "1"
+      expect(usage_point).to be_a GreenButtonData::UsagePoint
+      expect(usage_point.id).to eq "1"
+    end
+  end
+
+  describe ".all" do
+    context "valid authorization" do
+      let(:collection) { subject.all(subscription_id: 5, token: token) }
+
+      it "should return a ModelCollection" do
+        expect(collection).to be_a GreenButtonData::ModelCollection
+      end
+
+      it "should be a collection of GreenButtonData::UsagePoint instances" do
+        expect(collection.first).to be_a GreenButtonData::UsagePoint
+      end
+
+      it "should populate attributes" do
+        expect(collection.first.id).to eq "1"
+        expect(collection.first.local_time_parameters_url).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/LocalTimeParameters/1"
+        expect(collection.first.meter_reading_url).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading"
+        expect(collection.first.electric_power_usage_summary_url).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/ElectricPowerUsageSummary"
+        expect(collection.first.service_category).to eq :electricity
+      end
+    end
+  end
+
+  describe ".find" do
+    context "valid authorization" do
+      it "is an instance of UsagePoint" do
+        expect(usage_point).to be_a GreenButtonData::UsagePoint
+        expect(WebMock).to have_requested(:get, "#{find_url}/")
+      end
+
+      it "should populate attributes" do
+        expect(usage_point.id).to eq "2"
+        expect(usage_point.local_time_parameters_url).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/LocalTimeParameters/1"
+        expect(usage_point.meter_reading_url).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/MeterReading"
+        expect(usage_point.electric_power_usage_summary_url).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/ElectricPowerUsageSummary"
+        expect(usage_point.service_category).to eq :electricity
+      end
+    end
+  end
+
+  describe "relations" do
+    let :meter_readings_url do
+      "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/MeterReading"
+    end
+
+    let :meter_reading_url do
+      "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/MeterReading/1"
+    end
+
+    let :usage_summaries_url do
+      "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/ElectricPowerUsageSummary"
+    end
+
+    let :usage_summary_url do
+      "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/ElectricPowerUsageSummary/1"
+    end
+
+    let :interval_blocks_url do
+      "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/2/MeterReading/1/IntervalBlock"
+    end
+
+    context "id of related resource is not specified" do
+      before do
+        stub_request(:get, meter_readings_url).
+        to_return status: 200, body: espi_usage_point_meter_readings
+
+        stub_request(:get, usage_summaries_url).
+        to_return status: 200, body: espi_usage_summaries
+      end
+
+      it "should lazy load all related resources" do
+        expect(usage_point.meter_readings).to be_a GreenButtonData::ModelCollection
+        expect(usage_point.meter_readings.size).to eq 1
+        expect(usage_point.meter_readings.first).to be_a GreenButtonData::MeterReading
+        expect(usage_point.meter_readings.first.id).to eq "1"
+        expect(a_request(:get, meter_readings_url)).to have_been_made.once
+
+        expect(usage_point.usage_summaries).to be_a GreenButtonData::ModelCollection
+        expect(usage_point.usage_summaries.first).to be_a GreenButtonData::UsageSummary
+        expect(usage_point.usage_summaries.first.id).to eq "1"
+        expect(a_request(:get, usage_summaries_url)).to have_been_made.once
+      end
+
+      it "should use cached results on subsequent calls" do
+        expect(usage_point.meter_readings).to be_a GreenButtonData::ModelCollection
+        expect(WebMock).not_to have_requested :get, meter_readings_url
+        expect(usage_point.usage_summaries).to be_a GreenButtonData::ModelCollection
+        expect(WebMock).not_to have_requested :get, usage_summaries_url
+      end
+    end
+
+    context "id of related resource is specified" do
+      before do
+        stub_request(:get, meter_reading_url).
+        to_return status: 200, body: espi_usage_point_meter_reading
+
+        stub_request(:get, interval_blocks_url).
+        to_return status: 200, body: espi_interval_block
+
+        stub_request(:get, usage_summary_url).
+        to_return status: 200, body: espi_usage_summary
+      end
+
+      it "should lazy load a related resource that matches id" do
+        expect(usage_point.meter_readings(1)).to be_a GreenButtonData::MeterReading
+        expect(WebMock).to have_requested :get, meter_reading_url
+        expect(usage_point.meter_readings.size).to eq 1
+        expect(usage_point.meter_readings.first).to be_a GreenButtonData::MeterReading
+        expect(usage_point.meter_readings.first.id).to eq "1"
+
+        expect(usage_point.usage_summaries(1)).to be_a GreenButtonData::UsageSummary
+        expect(WebMock).to have_requested :get, usage_summary_url
+        expect(usage_point.usage_summaries.size).to eq 1
+        expect(usage_point.usage_summaries.first).to be_a GreenButtonData::UsageSummary
+        expect(usage_point.usage_summaries.first.id).to eq "1"
+      end
+
+      it "should use cached results on subsequent calls" do
+        expect(usage_point.meter_readings(1)).to be_a GreenButtonData::MeterReading
+        expect(usage_point.meter_readings(1)).to be_a GreenButtonData::MeterReading
+        expect(a_request(:get, meter_reading_url)).to have_been_made.once
+      end
+
+      it "should lazy load a related resource two levels deep" do
+        expect(usage_point.meter_readings(1).interval_blocks).to be_a GreenButtonData::ModelCollection
+        expect(usage_point.meter_readings(1).interval_blocks.first).to be_a GreenButtonData::IntervalBlock
+      end
+    end
+  end
+end