aemo 0.1.19 → 0.1.20

data/spec/fixtures/MSATS/nmi_discovery_by_address.xml

@@ -0,0 +1,141 @@
+<?xml version="1.0" ?>
+<ase:aseXML xmlns:ase="urn:aseXML:r31" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:aseXML:r31 http://www.nemmco.com.au/aseXML/schemas/r31/aseXML_r31.xsd">
+  <Header>
+    <From description="Australian Energy Market Operator Limited">NEMMCO</From>
+    <To description="COzero Energy Retail Pty Ltd">COZEROER</To>
+    <MessageID>NEMMCO-MSG-600298046</MessageID>
+    <MessageDate>2016-03-23T16:12:34+10:00</MessageDate>
+    <TransactionGroup>NMID</TransactionGroup>
+    <Priority>High</Priority>
+    <SecurityContext>NEMMCOBATCH</SecurityContext>
+    <Market>NEM</Market>
+  </Header>
+  <Transactions>
+    <Transaction transactionID="NMID-600298046" transactionDate="2016-03-23T16:12:34+10:00" initiatingTransactionID="1234567890">
+<NMIDiscoveryResponse version="r17">
+<NMIStandingData xsi:type="ase:ElectricityStandingData" version="r31">
+  <NMI checksum="7">4000000000</NMI>
+<MasterData>
+  <Address>
+    <StructuredAddress>
+      <FlatOrUnit>
+        <FlatOrUnitType>SITE</FlatOrUnitType>
+        <FlatOrUnitNumber>0</FlatOrUnitNumber>
+      </FlatOrUnit>
+      <BuildingOrPropertyName>PARLIAMENT HOUSE</BuildingOrPropertyName>
+      <LocationDescriptor>HUT PARLIAMENT HOUSE TELSTRA</LocationDescriptor>
+      <House>
+        <HouseNumber>6</HouseNumber>
+      </House>
+      <Street>
+        <StreetName>MACQUARIE</StreetName>
+        <StreetType>ST</StreetType>
+      </Street>
+    </StructuredAddress>
+    <SuburbOrPlaceOrLocality>SYDNEY</SuburbOrPlaceOrLocality>
+    <StateOrTerritory>NSW</StateOrTerritory>
+    <PostCode>2000</PostCode>
+  </Address>
+  <CustomerClassificationCode>BUSINESS</CustomerClassificationCode>
+  <CustomerThresholdCode>LOW</CustomerThresholdCode>
+</MasterData>
+  <RoleAssignments>
+    <RoleAssignment>
+      <Party>ENERGYAP</Party>
+      <Role>LNSP</Role>
+    </RoleAssignment>
+  </RoleAssignments>
+</NMIStandingData>
+<NMIStandingData xsi:type="ase:ElectricityStandingData" version="r31">
+  <NMI checksum="4">4000000001</NMI>
+<MasterData>
+  <Address>
+    <StructuredAddress>
+      <BuildingOrPropertyName>PARLIAMENT HOUSE</BuildingOrPropertyName>
+      <LocationDescriptor>SUPPLY 3</LocationDescriptor>
+      <House>
+        <HouseNumber>6</HouseNumber>
+      </House>
+      <Street>
+        <StreetName>MACQUARIE</StreetName>
+        <StreetType>ST</StreetType>
+      </Street>
+    </StructuredAddress>
+    <SuburbOrPlaceOrLocality>SYDNEY</SuburbOrPlaceOrLocality>
+    <StateOrTerritory>NSW</StateOrTerritory>
+    <PostCode>2000</PostCode>
+  </Address>
+  <CustomerClassificationCode>BUSINESS</CustomerClassificationCode>
+  <CustomerThresholdCode>HIGH</CustomerThresholdCode>
+</MasterData>
+  <RoleAssignments>
+    <RoleAssignment>
+      <Party>ENERGYAP</Party>
+      <Role>LNSP</Role>
+    </RoleAssignment>
+  </RoleAssignments>
+</NMIStandingData>
+<NMIStandingData xsi:type="ase:ElectricityStandingData" version="r31">
+  <NMI checksum="8">4000000002</NMI>
+<MasterData>
+  <Address>
+    <StructuredAddress>
+      <BuildingOrPropertyName>PARLIAMENT HOUSE</BuildingOrPropertyName>
+      <House>
+        <HouseNumber>6</HouseNumber>
+      </House>
+      <Street>
+        <StreetName>MACQUARIE</StreetName>
+        <StreetType>ST</StreetType>
+      </Street>
+    </StructuredAddress>
+    <SuburbOrPlaceOrLocality>SYDNEY</SuburbOrPlaceOrLocality>
+    <StateOrTerritory>NSW</StateOrTerritory>
+    <PostCode>2000</PostCode>
+  </Address>
+  <CustomerClassificationCode>BUSINESS</CustomerClassificationCode>
+  <CustomerThresholdCode>LOW</CustomerThresholdCode>
+</MasterData>
+  <RoleAssignments>
+    <RoleAssignment>
+      <Party>ENERGYAP</Party>
+      <Role>LNSP</Role>
+    </RoleAssignment>
+  </RoleAssignments>
+</NMIStandingData>
+<NMIStandingData xsi:type="ase:ElectricityStandingData" version="r31">
+  <NMI checksum="6">4000000003</NMI>
+<MasterData>
+  <Address>
+    <StructuredAddress>
+      <BuildingOrPropertyName>PARLIAMENT HOUSE</BuildingOrPropertyName>
+      <LocationDescriptor>SUPPLIES 1 AND 2</LocationDescriptor>
+      <House>
+        <HouseNumber>6</HouseNumber>
+      </House>
+      <Street>
+        <StreetName>MACQUARIE</StreetName>
+        <StreetType>ST</StreetType>
+      </Street>
+    </StructuredAddress>
+    <SuburbOrPlaceOrLocality>SYDNEY</SuburbOrPlaceOrLocality>
+    <StateOrTerritory>NSW</StateOrTerritory>
+    <PostCode>2000</PostCode>
+  </Address>
+  <CustomerClassificationCode>BUSINESS</CustomerClassificationCode>
+  <CustomerThresholdCode>HIGH</CustomerThresholdCode>
+</MasterData>
+  <RoleAssignments>
+    <RoleAssignment>
+      <Party>ENERGYAP</Party>
+      <Role>LNSP</Role>
+    </RoleAssignment>
+  </RoleAssignments>
+</NMIStandingData>
+        <Event severity="Information">
+          <Code>0</Code>
+        </Event>
+</NMIDiscoveryResponse>
+    </Transaction>
+  </Transactions>
+</ase:aseXML>

data/spec/fixtures/MSATS/participant_system_status.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" ?>
+<ase:aseXML xmlns:ase="urn:aseXML:r32" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:aseXML:r32 http://www.nemmco.com.au/aseXML/schemas/r32/aseXML_r32.xsd">
+  <Header>
+    <From description="Australian Energy Market Operator Limited">NEMMCO</From>
+    <To description="Energy Retail">ER</To>
+    <MessageID>NEMMCO-MSG-666</MessageID>
+    <MessageDate>2016-01-01T00:00:00+10:00</MessageDate>
+    <TransactionGroup>CATS</TransactionGroup>
+    <Priority>Medium</Priority>
+    <SecurityContext>NEMMCOBATCH</SecurityContext>
+    <Market>NEM</Market>
+  </Header>
+  <Transactions>
+    <Transaction transactionID="CATS-666" transactionDate="2016-01-01T00:00:00+10:00" initiatingTransactionID="1234567890">
+      <ReportResponse version="r10">
+        <ReportParameters xsi:type="ase:GenericReportParameters">
+          <ReportName>ParticipantSystemStatus</ReportName>
+        </ReportParameters>
+        <ReportResults xsi:type="ase:CATSParticipantSystemStatusReportFormat">
+          <ParticipantSystemsStatus>
+          </ParticipantSystemsStatus>
+        </ReportResults>
+        <Event severity="Information">
+          <Code>0</Code>
+          <Explanation>Success</Explanation>
+        </Event>
+      </ReportResponse>
+    </Transaction>
+  </Transactions>
+</ase:aseXML>

data/spec/lib/aemo/market/interval_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe AEMO::Market::Interval do
+  describe 'AEMO::Market::Interval contstants' do
+    it 'has INTERVALS' do
+      expect(AEMO::Market::Interval::INTERVALS).to eq({trading: 'Trading',dispatch: 'Dispatch'})
+    end
+  end
+  describe 'AEMO::Market::Interval instance methods' do
+    before(:each) do
+      @interval = AEMO::Market::Interval.new("2016-03-01T00:30:00", {'REGION' => 'NSW', 'TOTALDEMAND' => 1000.23, 'RRP' => 76.54, 'PERIODTYPE' => 'TRADING'})
+    end
+    it 'creates a valid interval' do
+      expect {AEMO::Market::Interval.new("2016-03-01T00:30:00", {'REGION' => 'NSW', 'TOTALDEMAND' => 1000.23, 'RRP' => 76.54, 'PERIODTYPE' => 'TRADING'})}.not_to raise_error
+    end
+    it 'has a trailing datetime' do
+      expect(@interval.datetime).to eq(DateTime.parse("2016-03-01T00:30:00+1000"))
+    end
+    it 'has a leading datetime' do
+      expect(@interval.datetime(false)).to eq(DateTime.parse("2016-03-01T00:00:00+1000"))
+    end
+    it 'has a leading datetime for dispatch' do
+      @interval = AEMO::Market::Interval.new("2016-03-01T00:30:00", {'REGION' => 'NSW', 'TOTALDEMAND' => 1000.23, 'RRP' => 76.54, 'PERIODTYPE' => ''})
+      expect(@interval.datetime(false)).to eq(DateTime.parse("2016-03-01T00:25:00+1000"))
+    end
+    it 'has an interval length' do
+      expect(@interval.interval_length).to eq(Time.at(300))
+    end
+    it 'is a trading interval' do
+      expect(@interval.interval_type).to eq(:trading)
+    end
+    it 'is a trading interval' do
+      expect(@interval.is_trading?).to eq(true)
+      expect(@interval.is_dispatch?).to eq(false)
+    end
+    it 'is a dispatch interval' do
+      @interval = AEMO::Market::Interval.new("2016-03-01T00:30:00", {'REGION' => 'NSW', 'TOTALDEMAND' => 1000.23, 'RRP' => 76.54, 'PERIODTYPE' => ''})
+      expect(@interval.interval_type).to eq(:dispatch)
+    end
+    it 'is a dispatch interval' do
+      @interval = AEMO::Market::Interval.new("2016-03-01T00:30:00", {'REGION' => 'NSW', 'TOTALDEMAND' => 1000.23, 'RRP' => 76.54, 'PERIODTYPE' => ''})
+      expect(@interval.is_trading?).to eq(false)
+      expect(@interval.is_dispatch?).to eq(true)
+    end
+    it 'has a valid value' do
+      expect(@interval.value).to eq((@interval.total_demand * @interval.rrp).round(2))
+    end
+  end
+end

data/spec/lib/aemo/market_spec.rb

@@ -1,16 +1,22 @@
 require 'spec_helper'
 
 describe AEMO::Market do
-  describe '.regions' do
-    it "returns the SupportedFormats constant" do
-      expect(AEMO::Market.regions).to eq(AEMO::Region::REGIONS)
+  it "returns the SupportedFormats constant for subclasses" do
+    class MyParser < HTTParty::Parser
+      SupportedFormats = {"application/atom+xml" => :atom}
     end
+    expect(MyParser.formats).to eq({"application/atom+xml" => :atom})
+  end
+
+  describe 'Dispatch data' do
+    it 'has an array of data' do
+      expect(AEMO::Market.current_dispatch('NSW').class).to eq(Array)
+    end
+  end
 
-    it "returns the SupportedFormats constant for subclasses" do
-      class MyParser < HTTParty::Parser
-        SupportedFormats = {"application/atom+xml" => :atom}
-      end
-      expect(MyParser.formats).to eq({"application/atom+xml" => :atom})
+  describe 'Trading data' do
+    it 'has an array of data' do
+      expect(AEMO::Market.current_trading('NSW').class).to eq(Array)
     end
   end
 end

data/spec/lib/aemo/msats_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe AEMO::MSATS do
+  describe 'instance methods' do
+    it 'creates a new instance' do
+      expect(AEMO::MSATS.new.class).to eq(AEMO::MSATS)
+    end
+  end
+
+  describe 'class methods' do
+    describe 'nmi details' do
+      before(:each) do
+        AEMO::MSATS.authorize("ER","ER","ER")
+      end
+
+      it 'should get data for a valid nmi' do
+        nmi_detail_query = AEMO::MSATS.nmi_detail('4001234567')
+        expect(nmi_detail_query.class).to eq(Hash)
+      end
+      it 'should get a 404 for a nonexistent nmi' do
+        nmi_detail_query = AEMO::MSATS.nmi_detail('4001234566')
+        # TODO workout what the different errors are here...
+      end
+      it 'should raise an error for a bad nmi' do
+        expect {AEMO::MSATS.nmi_detail('BOBISAFISH')}.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#c4' do
+      before(:each) do
+        AEMO::MSATS.authorize("ER","ER","ER")
+      end
+
+      it 'should return a hash of information' do
+        AEMO::MSATS.c4("4001234567",DateTime.now,DateTime.now,DateTime.now)
+      end
+      it 'should raise an error for a bad nmi' do
+        expect {AEMO::MSATS.c4('BOBISAFISH')}.to raise_error(ArgumentError)
+      end
+      it 'should return a hash of information' do
+        AEMO::MSATS.c4("4001234566",DateTime.now,DateTime.now,DateTime.now)
+        # TODO workout what the different errors are here...
+      end
+    end
+
+    describe '#msats_limits' do
+      before(:each) do
+        AEMO::MSATS.authorize("ER","ER","ER")
+      end
+
+      it 'should give details of msats_limits' do
+        expect(AEMO::MSATS.msats_limits.class).to eq(Hash)
+      end
+    end
+
+    describe '#nmi_discovery_by_*' do
+      before(:each) do
+        AEMO::MSATS.authorize("ER","ER","ER")
+      end
+      it 'should find by address' do
+        expect(AEMO::MSATS.nmi_discovery_by_address('NSW',{ house_number: 6, street_name: 'Macquarie', suburb_or_place_or_locality: 'Sydney', postcode: 2000}).class).to eq(Array)
+      end
+      it 'should find by meter_serial_number' do
+        expect(AEMO::MSATS.nmi_discovery_by_meter_serial_number('NSW',666).class).to eq(Array)
+      end
+      it 'should find by meter_serial_number' do
+        expect {AEMO::MSATS.nmi_discovery_by_delivery_point_identifier('NSW',666)}.to raise_error(ArgumentError)
+      end
+      it 'should find by meter_serial_number' do
+        expect(AEMO::MSATS.nmi_discovery_by_delivery_point_identifier('NSW',10000001).class).to eq(Array)
+      end
+    end
+
+    describe '#system_status' do
+      before(:each) do
+        AEMO::MSATS.authorize("ER","ER","ER")
+      end
+      it 'should provide a status' do
+        AEMO::MSATS.system_status
+      end
+    end
+
+  end
+end

data/spec/lib/aemo/nem12_spec.rb

@@ -11,23 +11,6 @@ describe AEMO::NEM12 do
     end
   end
 
-  describe '.valid_nmi?' do
-    it 'should validate nmi' do
-      json.each do |nmi|
-        expect(AEMO::NEM12.valid_nmi?(nmi['nmi'])).to eq(true)
-      end
-    end
-  end
-
-  describe '#nmi_checksum' do
-    it 'should return nmi checksum' do
-      json.each do |nmi|
-        nem12 = AEMO::NEM12.new(nmi['nmi'])
-        expect(nem12.nmi_checksum).to eq(nmi['checksum'])
-      end
-    end
-  end
-
   describe '#parse_nem12' do
   end
 
@@ -39,22 +22,37 @@ describe AEMO::NEM12 do
     end
   end
 
-  describe 'parse_nem12_100' do
+  describe '#parse_nem12_100' do
+    it 'should raise datetime error' do
+      expect {AEMO::NEM12.parse_nem12_100('100,NEM12,666,CNRGYMDP,NEMMCO')}.to raise_error(ArgumentError)
+    end
+    it 'should raise datetime error' do
+      expect {AEMO::NEM12.parse_nem12_100('100,NEM12,666,CNRGYMDP,NEMMCO', {strict: true})}.to raise_error(ArgumentError)
+    end
+    it 'should not raise an error' do
+      expect {AEMO::NEM12.parse_nem12_100('100,NEM12,201603010000,CNRGYMDP,NEMMCO', {strict: true})}.not_to raise_error
+    end
   end
 
-  describe 'parse_nem12_200' do
+  describe '#parse_nem12_200' do
+    before(:each) do
+      @nem12 = AEMO::NEM12.parse_nem12_100('100,NEM12,201603010000,CNRGYMDP,NEMMCO', {strict: true})
+    end
   end
 
-  describe 'parse_nem12_300' do
+  describe '#parse_nem12_300' do
   end
 
-  describe 'parse_nem12_400' do
+  describe '#parse_nem12_400' do
   end
 
-  describe 'parse_nem12_500' do
+  describe '#parse_nem12_500' do
   end
 
-  describe 'parse_nem12_900' do
+  describe '#parse_nem12_900' do
   end
 
+  describe '#flag_to_s' do
+
+  end
 end

data/spec/lib/aemo/nmi_spec.rb

@@ -131,4 +131,82 @@ describe AEMO::NMI do
     end
   end
 
+  describe "#friendly_address" do
+    it 'should return the empty string if the address is not a hash' do
+      nmi = AEMO::NMI.new("4001234567")
+      nmi.address = "An address"
+      expect(nmi.friendly_address).to eq('')
+    end
+    it 'should return a friendly address if the address is a hash' do
+      nmi = AEMO::NMI.new("4001234567")
+      nmi.address = { number: '1', street: 'Bob', street_type: 'Street'}
+      expect(nmi.friendly_address).to eq('1, Bob, Street')
+    end
+  end
+
+  describe "#current_daily_load" do
+    it "should return zero for no data" do
+      @nmi = AEMO::NMI.new("4001234567")
+      expect(@nmi.current_daily_load).to eq(0)
+    end
+  end
+
+  describe "#meters_by_status" do
+    before(:each) do
+      @nmi = AEMO::NMI.new("4001234567")
+      @nmi.meters = [OpenStruct.new(status: 'C'),OpenStruct.new(status: 'R')]
+    end
+    it 'should return current meters' do
+      expect(@nmi.meters_by_status.count).to eq(1)
+    end
+    it 'should return retired meters' do
+      expect(@nmi.meters_by_status('R').count).to eq(1)
+    end
+    it 'should return zero meters for weird status' do
+      expect(@nmi.meters_by_status('TMP').count).to eq(0)
+    end
+  end
+
+  describe "distribution loss factors" do
+    before(:each) do
+      @nmi = AEMO::NMI.new("4001234567")
+      @nmi.dlf = "BL0A"
+      @nmi.tni = "NGN2"
+    end
+    it "has a valid DLF Code" do
+      expect(@nmi.dlf).to eq("BL0A")
+    end
+    it "has a DLF value" do
+      expect(@nmi.dlfc_value.class).to eq(Float)
+    end
+  end
+
+  describe "transmission node identifiers and loss factors" do
+    before(:each) do
+      @nmi = AEMO::NMI.new("4001234567")
+      @nmi.dlf = "BL0A"
+      @nmi.tni = "NGN2"
+    end
+    it "has a valid TNI Code" do
+      expect(@nmi.tni).to eq("NGN2")
+    end
+    it "has a TNI value" do
+      expect(@nmi.tni_value.class).to eq(Float)
+    end
+  end
+
+  describe "MSATS functions" do
+    it 'should get data' do
+      AEMO::MSATS.authorize("ER","ER","ER")
+      nmi = AEMO::NMI.new('4001234567')
+      nmi.update_from_msats!
+      expect(nmi.msats_detail).to_not eq(nil)
+    end
+    it 'should return the hash of raw data' do
+      AEMO::MSATS.authorize("ER","ER","ER")
+      nmi = AEMO::NMI.new('4001234567')
+      expect(nmi.raw_msats_nmi_detail.class).to eq(Hash)
+    end
+  end
+
 end