aemo 0.1.4 → 0.1.5

data/lib/data/xml-to-json.rb

@@ -0,0 +1,54 @@
+require 'nokogiri'
+require 'json'
+require 'csv'
+
+@path  = Dir.pwd
+@files = Dir.entries(@path).reject{|f| %w(. ..).include?(f)}
+
+@mlf_data = {}
+@dlf_data = {}
+
+# Let's get the CSV Data first
+
+# TNI to MLF
+CSV.open(File.join(@path,"tni-mlf-codes.csv"), headers: true, converters: :numeric).each do |row|
+  @mlf_data[row["TNI"]] ||= { location: row['Location'], voltage: row['Voltage'], loss_factors: [] }
+  @mlf_data[row["TNI"]][:loss_factors] << { start: Date.parse('2014-07-01'), finish: Date.parse('2015-06-30'), value: row['FY15']}
+  @mlf_data[row["TNI"]][:loss_factors] << { start: Date.parse('2013-07-01'), finish: Date.parse('2014-06-30'), value: row['FY14']}
+end
+
+# TNI to MLF
+CSV.open(File.join(@path,"aemo-dlf-dnsp.csv"), headers: true, converters: :numeric).each do |row|
+  @dlf_data[row["dlf_code"]] ||= row['nsp_code']
+end
+
+
+# Now to create the DLF and TNI output JSON files for use
+@files.select{|x| ['aemo-tni.xml','aemo-dlf.xml'].include?(x) }.each do |file|
+  output_file = file.gsub('.xml','.json')
+  output_data = {}
+  open_file = File.open(File.join(@path,file))
+  xml = Nokogiri::XML(open_file) {|c| c.options = Nokogiri::XML::ParseOptions::NOBLANKS }
+  open_file.close
+  
+  xml.xpath("//Row").each do |row|
+    row_children = row.children
+    code = row_children.find{ |x| x.name == 'Code' }.children.first.text
+    output_data[code] ||= []
+    output_data_instance = {}
+    row_children.each do |row_child|
+      output_data_instance[row_child.name] = row_child.children.first.text
+    end
+    if file.match(/tni/)
+      output_data_instance[:mlf_data] = @mlf_data[code]
+    elsif file.match(/dlf/)
+      output_data_instance[:nsp_code] = @dlf_data[code]
+    end
+    output_data[code] << output_data_instance
+  end
+  
+  File.open(File.join(@path,output_file),'w') do |write_file|
+    write_file.write(output_data.to_json)
+  end
+end
+

data/spec/aemo/nem12_spec.rb

@@ -31,7 +31,6 @@ describe AEMO::NEM12 do
   describe '.parse_nem12_file' do
     it 'should parse a file' do
       Dir.entries(File.join(File.dirname(__FILE__),'..','fixtures','NEM12')).reject{|f| %w(. .. .DS_Store).include?(f)}.each do |file|
-        puts file
         nem12 = AEMO::NEM12.parse_nem12_file(File.join(File.dirname(__FILE__),'..','fixtures','NEM12',file))
       end
     end

data/spec/aemo/nmi_spec.rb

@@ -0,0 +1,131 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'json'
+
+describe AEMO::NMI do
+  # ---
+  # CLASS CONSTANTS
+  # ---
+  describe '::NMI_ALLOCATIONS' do
+    it "should be a hash" do
+      expect(AEMO::NMI::NMI_ALLOCATIONS.class).to eq(Hash)
+    end
+  end
+  describe '::TNI_CODES' do
+    it "should be a hash" do
+      expect(AEMO::NMI::TNI_CODES.class).to eq(Hash)
+    end
+  end
+  describe '::DLF_CODES' do
+    it "should be a hash" do
+      expect(AEMO::NMI::DLF_CODES.class).to eq(Hash)
+    end
+  end
+  
+  # ---
+  # CLASS METHODS
+  # ---
+  describe '.valid_nmi?(nmi)' do
+    it 'should validate nmi' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        expect(AEMO::NMI.valid_nmi?(nmi['nmi'])).to eq(true)
+      end
+    end
+    it "should invalidate" do
+      expect(AEMO::NMI.valid_nmi?("OOOOOOOOOO")).to eq(false)
+    end
+    it "should invalidate" do
+      expect(AEMO::NMI.valid_nmi?("NM100")).to eq(false)
+    end
+    it "should invalidate" do
+      expect{AEMO::NMI.valid_nmi?()}.to raise_error(ArgumentError)
+    end
+  end
+  
+  describe '.self.valid_checksum?(nmi,checksum)' do
+    it 'should validate valid nmi and checksums' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        expect(AEMO::NMI.valid_checksum?(nmi['nmi'],nmi['checksum'])).to eq(true)
+      end
+    end
+  end
+  
+  describe '.self.network?(nmi)' do
+    it 'should return a network for an allocated NMI' do
+      network = AEMO::NMI.network('NCCCC00000')
+      expect(network.to_a[0].last[:title]).to eq('Ausgrid')
+    end
+    it 'should return NIL for an unallocated NMI' do
+      network = AEMO::NMI.network('ZZZZZZZZZZZZ')
+      expect(network).to eq(nil)
+    end
+  end
+  
+  # ---
+  # INSTANCE METHODS
+  # ---
+  describe '#initialize' do
+    it "should raise an ArgumentError error" do
+      expect{ AEMO::NMI.new("OOOOOOOOOO") }.to raise_error(ArgumentError)
+    end
+    it "should raise an ArgumentError error" do
+      expect{ AEMO::NMI.new("NM100") }.to raise_error(ArgumentError)
+    end
+    it "should raise an ArgumentError error" do
+      expect{ AEMO::NMI.new() }.to raise_error(ArgumentError)
+    end
+  end
+  describe '#valid_nmi?' do
+    it 'should validate nmi' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        _nmi = AEMO::NMI.new(nmi['nmi'])
+        expect(_nmi.valid_nmi?).to eq(true)
+      end
+    end
+  end
+  
+  describe '#checksum' do
+    it 'should return NMI\'s checksum' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        _nmi = AEMO::NMI.new(nmi['nmi'])
+        expect(_nmi.checksum).to eq(nmi['checksum'])
+      end
+    end
+  end
+  
+  describe '#valid_checksum?(checksum)' do
+    it 'should validate valid checksums' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        _nmi = AEMO::NMI.new(nmi['nmi'])
+        expect(_nmi.valid_checksum?(nmi['checksum'])).to eq(true)
+      end
+    end
+    it 'should not validate invalid checksums' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        _nmi = AEMO::NMI.new(nmi['nmi'])
+        expect(_nmi.valid_checksum?((1+nmi['checksum'])%10)).to eq(false)
+      end
+    end
+  end
+  
+  describe '#network' do
+    # Positive test cases
+    it 'should return a network for a valid NMI' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        _nmi = AEMO::NMI.new(nmi['nmi'])
+        unless _nmi.network.nil?
+          expect(_nmi.network.class).to eq(Hash)
+        end
+      end
+    end
+    # Negative test cases
+    it 'should not return a network for a NMI not allocated to a network' do
+      JSON.parse(File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures','nmi_checksum.json')))).each do |nmi|
+        _nmi = AEMO::NMI.new(nmi['nmi'])
+        if _nmi.network.nil?
+          expect(_nmi.network.class).to eq(NilClass)
+        end
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 $:.push File.expand_path("../lib", __FILE__)
 
 require 'aemo'
-require 'aemo/nem12'
+require 'aemo/nem12'
+# require 'aemo/nmi'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aemo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Joel Courtney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -72,6 +72,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -80,12 +81,21 @@ files:
 - lib/aemo/dispatchable.rb
 - lib/aemo/market.rb
 - lib/aemo/market/interval.rb
+- lib/aemo/msats.rb
 - lib/aemo/nem12.rb
 - lib/aemo/nem13.rb
 - lib/aemo/nmi.rb
 - lib/aemo/region.rb
+- lib/data/TNI-MLF-Codes.csv
+- lib/data/aemo-dlf-dnsp.csv
+- lib/data/aemo-dlf.json
+- lib/data/aemo-dlf.xml
+- lib/data/aemo-tni.json
+- lib/data/aemo-tni.xml
+- lib/data/xml-to-json.rb
 - spec/aemo/market_spec.rb
 - spec/aemo/nem12_spec.rb
+- spec/aemo/nmi_spec.rb
 - spec/aemo/region_spec.rb
 - spec/aemo_spec.rb
 - spec/fixtures/GRAPH_30NSW1.csv
@@ -192,7 +202,7 @@ files:
 - spec/fixtures/nmi_checksum.json
 - spec/spec.opts
 - spec/spec_helper.rb
-homepage: https://bitbucket.org/jufemaiz/aemo-gem
+homepage: https://github.com/jufemaiz/aemo
 licenses:
 - MIT
 metadata: {}
@@ -219,6 +229,7 @@ summary: AEMO Gem
 test_files:
 - spec/aemo/market_spec.rb
 - spec/aemo/nem12_spec.rb
+- spec/aemo/nmi_spec.rb
 - spec/aemo/region_spec.rb
 - spec/aemo_spec.rb
 - spec/fixtures/GRAPH_30NSW1.csv
@@ -325,3 +336,4 @@ test_files:
 - spec/fixtures/nmi_checksum.json
 - spec/spec.opts
 - spec/spec_helper.rb
+has_rdoc: