aemo 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4cc289d4d7970c23318336e42aac4062aeba374
-  data.tar.gz: 7f07cf1aa6fd5e47f23a035a82aaa51ee332fd84
+  metadata.gz: a401245a1f7b25723a1ae670079c4d58a444f8f6
+  data.tar.gz: c48680094298ec88e7cfe69d2e849c061177a2ec
 SHA512:
-  metadata.gz: 16a93457ddbf13d0eca18f0be91e8de731c9f41a7511f528a410bedbfcb37f144d7225a4148e6456c17d4cbcf9eebce6df0b05199d23402ab231509d838e9392
-  data.tar.gz: 288b14ba40832243066d5c15bf11dcc9189d2bb1926092dfc7117fef853d7c89ce505a5349bf9c9e9b597791d75ea42e716bf36d2b2e1a9f0dcdf0093d4b1885
+  metadata.gz: cc19ba3f91983da75207c8d6328ab4ecce573b849bbaddfa4720b73ce05e4db00a1f8604ad3adebe18b88755d9801894055820339d18890bc820eef6f9315e71
+  data.tar.gz: 3151c7067018f9d059ddfe27d361172aef4a2a66ad301a25a0690d336e7a95c606ff6df699434c02d1cbc325a311fb2dfadbc490682b5139eb9f808124b12941

data/.gitignore

@@ -0,0 +1,6 @@
+# Ignore Stuff
+
+# Don't include gems in the repository
+*.gem
+# Or documentation
+.yardoc/

data/aemo.gemspec

@@ -3,16 +3,15 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'aemo'
-  s.version     = '0.1.4'
+  s.version     = '0.1.5'
   s.platform    = Gem::Platform::RUBY
-  s.date        = '2014-12-05'
+  s.date        = '2015-02-07'
   s.summary     = 'AEMO Gem'
   s.description = 'Gem providing functionality for the Australian Energy Market Operator data'
   s.authors     = ['Joel Courtney']
   s.email       = ['jcourtney@cozero.com.au']
-  s.homepage    =
-    'https://bitbucket.org/jufemaiz/aemo-gem'
-  s.license       = 'MIT'
+  s.homepage    = 'https://github.com/jufemaiz/aemo'
+  s.license     = 'MIT'
   
   s.required_ruby_version     = '>= 1.9.3'
 

data/lib/aemo.rb

@@ -5,6 +5,8 @@ require 'aemo/market/interval.rb'
 require 'aemo/region.rb'
 require 'aemo/nem12.rb'
 require 'aemo/nmi.rb'
+require 'aemo/msats.rb'
 
+# AEMO Module to encapsulate all AEMO classes
 module AEMO
 end

data/lib/aemo/msats.rb

@@ -0,0 +1,222 @@
+require 'httparty'
+require 'aemo'
+require 'zip'
+require 'nokogiri'
+require 'digest/sha1'
+
+module AEMO
+
+  class MSATS
+    # Globally set request headers
+    HEADERS = {
+      'User-Agent'    => "Ruby.AEMO.MSATS.Api",
+      'Accept'        => 'text/xml',
+      'Content-Type'  => 'text/xml'
+    }
+
+    # We like to party
+    include HTTParty
+    # We like to debug
+    # debug_output $stdout
+    
+    # We like to SSLv3
+    ssl_version :SSLv3
+
+    # Where we like to party
+    base_uri 'https://msats.prod.nemnet.net.au/msats/ws/'
+  
+    def initialize(options = {})
+      @@auth = {username: nil, password: nil}
+      @retailer = 'COZEROER'
+
+      @@auth[:username]  = options[:username]        if options[:username].is_a?(String)
+      @@auth[:password]  = options[:password]        if options[:password].is_a?(String)
+      @@participant_id   = options[:participant_id]  if options[:participant_id].is_a?(String)
+    end
+  
+    # Single NMI Master (C4) Report
+    # /C4/PARTICIPANT_IDENTIFIER?transactionId=XXX&nmi=XXX&checksum=X&type=XXX&reason=XXX
+    #
+    # @param [String,AEMO::NMI] nmi   the NMI to run the master report against
+    # @param [Date,String] from_date  the from date for the master report
+    # @param [Date,String] to_date  the from date for the master report
+    # @return [Hash] A hashed view of the NMI Standing Data for a given NMI
+    def self.c4(nmi, from_date,to_date,as_at_date, options = {})
+
+      nmi         = AEMO::NMI.new(nmi) if nmi.is_a?(String)
+      from_date   = Date.parse(from_date) if from_date.is_a?(String)
+      to_date     = Date.parse(to_date) if to_date.is_a?(String)
+      as_at_date  = Date.parse(as_at_date) if as_at_date.is_a?(String)
+
+      options[:participantId]   ||= nil
+      options[:roleId]          ||= nil
+      options[:inittransId]     ||= nil
+    
+      query = {
+        transactionId:  Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+        NMI:            nmi.nmi,      # Note: AEMO is a bunch of idiots, has case sensitivity but no consistency across requests. Muppets.
+        fromDate:       from_date,
+        toDate:         to_date,
+        asatDate:       as_at_date,
+        participantId:  @@participant_id,
+        roleId:         options[:role_id],
+        inittransId:    options[:init_trans_id],
+      }
+    
+      response =  self.get( "/C4/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )    
+      response.parsed_response['aseXML']['Transactions']['Transaction']['ReportResponse']['ReportResults']
+    end
+
+    # MSATS Limits
+    # /MSATSLimits/PARTICIPANT_IDENTIFIER?transactionId=XXX
+    #
+    # @return [Hash] The report results from the MSATS Limits web service query
+    def self.msats_limits
+      query = {
+        transactionId:  Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+      }
+      response =  self.get( "/MSATSLimits/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )
+      response.parsed_response['aseXML']['Transactions']['Transaction']['ReportResponse']['ReportResults']
+    end
+  
+    # NMI Discovery - By Delivery Point Identifier
+    #
+    # @param [String] jurisdiction_code The Jurisdiction Code
+    # @param [Integer] delivery_point_identifier Delivery Point Iddentifier
+    # @return [Hash] The response
+    def self.nmi_discovery_by_delivery_point_identifier(jurisdiction_code,delivery_point_identifier)
+      raise ArgumentError, 'jurisdiction_code is not valid' unless %w(ACT NEM NSW QLD SA VIC TAS).include?(jurisdiction_code)
+      raise ArgumentError, 'delivery_point_identifier is not valid' unless delivery_point_identifier.respond_to?("to_i")
+      raise ArgumentError, 'delivery_point_identifier is not valid' if( delivery_point_identifier.to_i < 10000000 || delivery_point_identifier.to_i > 99999999)
+    
+      query = {
+        transactionId:  Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+        jurisdictionCode: jurisdiction_code,
+        deliveryPointIdentifier: delivery_point_identifier.to_i
+      }
+    
+      response =  self.get( "/NMIDiscovery/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )
+      response.parsed_response['aseXML']['Transactions']['Transaction']['NMIDiscoveryResponse']['NMIStandingData']
+    end
+
+    # NMI Discovery - By Meter Serial Numner
+    #
+    # @param [String] jurisdiction_code The Jurisdiction Code
+    # @param [Integer] meter_serial_number The meter's serial number
+    # @return [Hash] The response
+    def self.nmi_discovery_by_meter_serial_number(jurisdiction_code,meter_serial_number)
+      raise ArgumentError, 'jurisdiction_code is not valid' unless %w(ACT NEM NSW QLD SA VIC TAS).include?(jurisdiction_code)
+    
+      query = {
+        transactionId:  Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+        jurisdictionCode: jurisdiction_code,
+        meterSerialNumber: meter_serial_number.to_i
+      }
+    
+      response = self.get( "/NMIDiscovery/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )
+      response.parsed_response['aseXML']['Transactions']['Transaction']['NMIDiscoveryResponse']['NMIStandingData']
+    end
+
+    # NMI Discovery - By Address
+    #
+    # @param [String] jurisdiction_code The Jurisdiction Code
+    # @param [Integer] meter_serial_number The meter's serial number
+    # @return [Hash] The response
+    def self.nmi_discovery_by_address(jurisdiction_code,options = {})
+      raise ArgumentError, 'jurisdiction_code is not valid' unless %w(ACT NEM NSW QLD SA VIC TAS).include?(jurisdiction_code)
+    
+      options[:building_or_property_name] ||= nil
+      options[:location_descriptor] ||= nil
+      options[:lot_number] ||= nil
+      options[:flat_or_unit_number] ||= nil
+      options[:flat_or_unit_type] ||= nil
+      options[:floor_or_level_number] ||= nil
+      options[:floor_or_level_type] ||= nil
+      options[:house_number] ||= nil
+      options[:house_number_suffix] ||= nil
+      options[:street_name] ||= nil
+      options[:street_suffix] ||= nil
+      options[:street_type] ||= nil
+      options[:suburb_or_place_or_locality] ||= nil
+      options[:postcode] ||= nil
+      options[:state_or_territory] ||= jurisdiction_code
+    
+      query = {
+        transactionId:  Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+        jurisdictionCode: jurisdiction_code,
+        buildingOrPropertyName: options[:building_or_property_name],
+        locationDescriptor: options[:location_descriptor],
+        lotNumber: options[:lot_number],
+        flatOrUnitNumber: options[:flat_or_unit_number],
+        flatOrUnitType: options[:flat_or_unit_type],
+        floorOrLevelNumber: options[:floor_or_level_number],
+        floorOrLevelType: options[:floor_or_level_type],
+        houseNumber: options[:house_number],
+        houseNumberSuffix: options[:house_number_suffix],
+        streetName: options[:street_name],
+        streetSuffix: options[:street_suffix],
+        streetType: options[:street_type],
+        suburbOrPlaceOrLocality: options[:suburb_or_place_or_locality],
+        postcode: options[:postcode],
+        stateOrTerritory: options[:state_or_territory]
+      }
+    
+      response = self.get( "/NMIDiscovery/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )
+      response.parsed_response['aseXML']['Transactions']['Transaction']['NMIDiscoveryResponse']['NMIStandingData']
+    end
+
+    # NMI Detail
+    # /NMIDetail/PARTICIPANT_IDENTIFIER?transactionId=XXX&nmi=XXX&checksum=X&type=XXX&reason=XXX
+    #
+    # @return [Hash] A hashed view of the NMI Standing Data for a given NMI
+    def self.nmi_detail(nmi, options = {})
+      if nmi.is_a?(String)
+        nmi = AEMO::NMI.new(nmi)
+      end
+      options[:type]    ||= nil
+      options[:reason]  ||= nil
+    
+      query = {
+        transactionId: Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+        nmi: nmi.nmi,
+        checksum: nmi.checksum,
+        type: options[:type],
+        reason: options[:reason]
+      }
+    
+      response = self.get( "/NMIDetail/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )
+      response.parsed_response['aseXML']['Transactions']['Transaction']['NMIStandingDataResponse']['NMIStandingData']
+    end
+  
+    # Participant System Status
+    # /ParticipantSystemStatus/PARTICIPANT_IDENTIFIER?transactionId=XXX
+    #
+    # @return [Hash] The report results from the Participant System Status web service query
+    def self.system_status
+      query = {
+        transactionId:  Digest::SHA1.hexdigest(Time.now.to_s)[0..35],
+      }
+      response = self.get( "/ParticipantSystemStatus/#{@@participant_id}", basic_auth: @@auth, headers: { 'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}, query: query )
+      response.parsed_response['aseXML']['Transactions']['Transaction']['ReportResponse']['ReportResults']
+    end
+  
+  
+    # Sets the authentication credentials in a class variable.
+    #
+    # @param [String] email cl.ly email
+    # @param [String] password cl.ly password
+    # @return [Hash] authentication credentials
+    def self.authorize(participant_id,username,password)
+      @@participant_id  = participant_id
+      @@auth            = {username: username, password: password}
+    end
+    
+    # Check if credentials are available to use
+    #
+    # @return [Boolean] true/false if credentials are available
+    def self.can_authenticate?
+      !(@@participant_id.nil? || @@auth[:username].nil? || @@auth[:username].nil?)
+    end
+    
+  end
+end

data/lib/aemo/nem12.rb

@@ -385,7 +385,21 @@ module AEMO
         end
       end
       
-      base_interval = { :data_details => @data_details.last, :datetime => Time.parse("#{csv[1]}000000+1000"), :value => nil, :flag => nil}
+      # Deal with flags if necessary
+      flag = nil
+      # Based on QualityMethod and ReasonCode
+      if csv[intervals_offset + 0].length == 3 || !csv[intervals_offset + 1].nil?
+        flag ||= { quality_flag: nil, method_flag: nil, reason_code: nil }
+        if csv[intervals_offset + 0].length == 3
+          flag[:quality_flag] = csv[intervals_offset + 0][0]
+          flag[:method_flag] = csv[intervals_offset + 0][1,2]
+        end
+        unless csv[intervals_offset + 1].nil?
+          flag[:reason_code] = csv[intervals_offset + 1]
+        end
+      end
+      
+      base_interval = { data_details: @data_details.last, datetime: Time.parse("#{csv[1]}000000+1000"), value: nil, flag: flag}
 
       intervals = []
       (2..(number_of_intervals+1)).each do |i|
@@ -458,34 +472,52 @@ module AEMO
     def parse_nem12_900(line,options={})
     end
     
-    # @param nmi [String] a NMI that is to be checked for validity
-    # @return [Boolean] determines if the NMI is valid
-    def self.valid_nmi?(nmi)
-      (nmi.class == String && nmi.length == 10 && !nmi.match(/^[A-Z1-9][A-Z0-9]{9}$/).nil?)
-    end
-    
-    # @param path_to_file [String] the path to a file
-    # @return [] NEM12 object 
-    def self.parse_nem12_file(path_to_file, strict = false)
-      parse_nem12(File.read(path_to_file),strict)
+    # Turns the flag to a string
+    #
+    # @param [Hash] the object of a flag
+    # @return [String] a hyphenated string for the flag
+    def flag_to_s(flag)
+      flag_to_s = []
+      unless flag.nil?
+        flag_to_s << QUALITY_FLAGS[flag[:quality_flag]]
+        flag_to_s << METHOD_FLAGS[flag[:method_flag]][:short_descriptor]
+        flag_to_s << REASON_CODES[flag[:reason_code]]
+      end
+      flag_to_s.join(" - ")
     end
-        
+
     # @return [Array] array of a NEM12 file a given Meter + Data Stream for easy reading
     def to_a
       values = @interval_data.map do |d|
         uom = UOM[UOM_NON_SPEC_MAPPING[d[:data_details][:uom].upcase]]
-        
-        [d[:data_details][:nmi],d[:data_details][:nmi_suffix].upcase,d[:data_details][:uom],d[:datetime],d[:value],d[:flag]]
+        [ d[:data_details][:nmi],
+          d[:data_details][:nmi_suffix].upcase,
+          d[:data_details][:uom],
+          d[:datetime],
+          d[:value],
+          flag_to_s(d[:flag])]
       end
       values
     end
     
     # @return [Array] CSV of a NEM12 file a given Meter + Data Stream for easy reading
     def to_csv
-      headers = ['nmi','suffix','units','datetime','value']
+      headers = ['nmi','suffix','units','datetime','value','flags']
       ([headers]+self.to_a.map{|row| row[3]=row[3].strftime("%Y%m%d%H%M%S%z"); row}).map{|row| row.join(',')}.join("\n")
     end
     
+    # @param nmi [String] a NMI that is to be checked for validity
+    # @return [Boolean] determines if the NMI is valid
+    def self.valid_nmi?(nmi)
+      (nmi.class == String && nmi.length == 10 && !nmi.match(/^[A-Z1-9][A-Z0-9]{9}$/).nil?)
+    end
+    
+    # @param path_to_file [String] the path to a file
+    # @return [] NEM12 object 
+    def self.parse_nem12_file(path_to_file, strict = false)
+      parse_nem12(File.read(path_to_file),strict)
+    end
+        
     # @param contents [String] the path to a file
     # @return [Array[AEMO::NEM12]] An array of NEM12 objects
     def self.parse_nem12(contents, strict=false)

data/lib/aemo/nmi.rb

@@ -1,5 +1,11 @@
+require 'csv'
+require 'json'
+require 'time'
+require 'ostruct'
 module AEMO
+  # AEMO::NMI acts as an object to simplify access to data and information about a NMI and provide verification of the NMI value
   class NMI
+    # Operational Regions for the NMI
     REGIONS = {
       'ACT' => 'Australian Capital Territory',
       'NSW' => 'New South Wales',
@@ -10,366 +16,572 @@ module AEMO
       'WA'  => 'Western Australia',
       'NT'  => 'Northern Territory'
     }
-    NETWORK_SERVICE_PROVIDERS = [
-      # ACT
-      {
-        type: 'electrical',
-        key: 'ACTEWP',
-        states: ['ACT'],
-        names: ['Actew Distribution Ltd','Jemena Networks (ACT) Pty Ltd'],
-        nmi_blocks: [
-          /^NGGG[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^7001[0-9]{6}$/
+    # NMI_ALLOCATIONS as per AEMO Documentation at http://aemo.com.au/Electricity/Policies-and-Procedures/Retail-and-Metering/~/media/Files/Other/Retail%20and%20Metering/NMI_Allocation_List_v7_June_2012.ashx
+    #   Last accessed 2015-02-04
+    NMI_ALLOCATIONS = {
+      'ACTEWP' => {
+        title: 'Actew Distribution Ltd and Jemena Networks (ACT) Pty Ltd',
+        friendly_title: 'ACTEWAgl',
+        state: 'ACT',
+        type: 'electricity',
+        includes: [
+          (/^(NGGG[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(7001\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      # NSW
-      {
-        type: 'electrical',
-        key: 'ENERGYAP',
-        states: ['NSW'],
-        names: ['Ausgrid'],
-        nmi_blocks: [
-          /^NTTT[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^410[2-4][0-9]{6}$/
+      'CNRGYP' => {
+        title: 'Essential Energy',
+        friendly_title: 'Essential Energy',
+        state: 'NSW',
+        type: 'electricity',
+        includes: [
+          (/^(NAAA[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(NBBB[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(NDDD[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(NFFF[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(4001\d{6})$/),
+          (/^(4508\d{6})$/),
+          (/^(4204\d{6})$/),
+          (/^(4407\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'INTEGP',
-        states: ['NSW'],
-        names: ['Endeavour Energy'],
-        nmi_blocks: [
-          /^NEEE[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^431[0-9][0-9]{6}$/
+      'ENERGYAP' => {
+        title: 'Ausgrid',
+        friendly_title: 'Ausgrid',
+        state: 'NSW',
+        type: 'electricity',
+        includes: [
+          (/^(NCCC[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(410[234]\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'CNRGYP',
-        states: ['NSW'],
-        names: ['Essential Energy'],
-        nmi_blocks: [
-          /^NAAA[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^NBBB[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^NDDD[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^NFFF[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^4001[0-9]{6}$/,
-          /^4508[0-9]{6}$/,
-          /^4204[0-9]{6}$/,
-          /^4407[0-9]{6}$/
+      'INTEGP' => {
+        title: 'Endeavour Energy',
+        friendly_title: 'Endeavour Energy',
+        state: 'NSW',
+        type: 'electricity',
+        includes: [
+          (/^(NEEE[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(431\d{7})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'TRANSGP',
-        states: ['NSW'],
-        names: ['TransGrid'],
-        nmi_blocks: [
-          /^NCCC[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^410[2-4][0-9]{6}$/
+      'TRANSGP' => {
+        title: 'TransGrid',
+        friendly_title: 'TransGrid',
+        state: 'NSW',
+        type: 'electricity',
+        includes: [
+          (/^(NTTT[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(460810[0-8]\d{3})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'SNOWY',
-        states: ['NSW'],
-        names: ['Snowy Hydro'],
-        nmi_blocks: [
-          /^4708109[0-9]{3}$/
+      'SNOWY' => {
+        title: 'Snowy Hydro Ltd',
+        friendly_title: 'Snowy Hydro',
+        state: 'NSW',
+        type: 'electricity',
+        includes: [
+          (/^(4708109\d{3})$/)
+        ],
+        excludes: [
         ]
       },
-      # NT
-      {
-        type: 'electrical',
-        key: 'RESERVED_NT',
-        states: ['NT'],
-        names: [],
-        nmi_blocks: [
-          /^250[0-9]{7}$/
+      'NT_RESERVED' => {
+        title: 'Northern Territory Reserved Block',
+        friendly_title: 'Northern Territory Reserved Block',
+        state: 'NT',
+        type: 'electricity',
+        includes: [
+          (/^(250\d{7})$/)
+        ],
+        excludes: [
         ]
       },
-      # QUEENSLAND
-      {
-        type: 'electrical',
-        key: 'ERGONETP',
-        states: ['QLD'],
-        names: ['Ergon Energy'],
-        nmi_blocks: [
-          /^QAAA[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^QCCC[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^QDDD[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^QEEE[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^QFFF[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^QGGG[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^30[0-9]{8}$/
+      'ERGONETP' => {
+        title: 'Ergon Energy Corporation',
+        friendly_title: 'Ergon Energy',
+        state: 'QLD',
+        type: 'electricity',
+        includes: [
+          (/^(QAAA[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(QCCC[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(QDDD[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(QEEE[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(QFFF[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(QGGG[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(30\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'ENERGEXP',
-        states: ['QLD'],
-        names: ['ENERGEX'],
-        nmi_blocks: [
-          /^QB[0-9]{2}[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^31[0-9]{8}$/
+      'ENERGEXP' => {
+        title: 'ENERGEX Limited',
+        friendly_title: 'Energex',
+        state: 'QLD',
+        type: 'electricity',
+        includes: [
+          (/^(QBBB[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(31\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'PLINKP',
-        states: ['QLD'],
-        names: ['QLD Electricity Transmission Corp (Powerlink)'],
-        nmi_blocks: [
-          /^QtniW[A-HJ-NP-Z0-9]{5}$/,
-          /^320200[0-9]{4}$/
+      'PLINKP' => {
+        title: 'Qld Electricity Transmission Corp (Powerlink)',
+        friendly_title: 'Powerlink',
+        state: 'QLD',
+        type: 'electricity',
+        includes: [
+          (/^(Q[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/),
+          (/^(320200\d{4})$/)
+        ],
+        excludes: [
         ]
       },
-      # SA
-      {
-        type: 'electrical',
-        key: 'UMPLP',
-        states: ['SA'],
-        names: ['SA Power Networks'],
-        nmi_blocks: [
-          /^SAAA[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^SASMPL[0-9]{4}$/,
-          /^200[1-2][0-9]{6}$/
+      'UMPLP' => {
+        title: 'SA Power Networks',
+        friendly_title: 'SA Power Networks',
+        state: 'SA',
+        type: 'electricity',
+        includes: [
+          (/^(SAAA[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(SASMPL[\d]{4})$/),
+          (/^(200[12]\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'ETSATP',
-        states: ['SA'],
-        names: ['ElectraNet'],
-        nmi_blocks: [
-          /^StniW[A-HJ-NP-Z0-9]{5}$/,
-          /^310200[0-9]{4}$/
+      'TRANSEND' => {
+        title: 'ElectraNet SA',
+        friendly_title: 'ElectraNet SA',
+        state: 'SA',
+        type: 'electricity',
+        includes: [
+          (/^(S[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/),
+          (/^(210200\d{4})$/)
+        ],
+        excludes: [
         ]
       },
-      # TASMANIA
-      {
-        type: 'electrical',
-        key: 'AURORAP',
-        states: ['TAS'],
-        names: ['Aurora Energy'],
-        nmi_blocks: [
-          /^T00000(([0-4][0-9]{3})|(5001))$/,
-          /^8000[0-9]{6}$/,
-          /^8590[2-3][0-9]{5}$/
+      'AURORAP' => {
+        title: 'TasNetworks',
+        friendly_title: 'TasNetworks',
+        state: 'TAS',
+        type: 'electricity',
+        includes: [
+          (/^(T000000(([0-4]\d{3})|(500[01])))$/),
+          (/^(8000\d{6})$/),
+          (/^(8590[23]\d{5})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'TRANSEND',
-        states: ['TAS'],
-        names: ['Transend Networks'],
-        nmi_blocks: [
-          /^TtniW[A-HJ-NP-Z0-9]{5}$/
+      'TRANSEND' => {
+        title: 'TasNetworks',
+        friendly_title: 'TasNetworks',
+        state: 'TAS',
+        type: 'electricity',
+        includes: [
+          (/^(T[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/),
+        ],
+        excludes: [
         ]
       },
-      # VICTORIA
-      {
-        type: 'electrical',
-        key: 'CITIPP',
-        states: ['VIC'],
-        names: ['CitiPower'],
-        nmi_blocks: [
-          /^VAAA[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^610[2-3][0-9]{6}$/
+      'CITIPP' => {
+        title: 'CitiPower',
+        friendly_title: 'CitiPower',
+        state: 'VIC',
+        type: 'electricity',
+        includes: [
+          (/^(VAAA[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(610[23]\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'EASTERN',
-        states: ['VIC'],
-        names: ['AusNet'],
-        nmi_blocks: [
-          /^VBBB[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^630[5-6][0-9]{6}$/
+      'EASTERN' => {
+        title: 'SP AusNet',
+        friendly_title: 'SP AusNet DNSP',
+        state: 'VIC',
+        type: 'electricity',
+        includes: [
+          (/^(VBBB[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(630[56]\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'POWCP',
-        states: ['VIC'],
-        names: ['Powercor'],
-        nmi_blocks: [
-          /^VCCC[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^620[3-4][0-9]{6}$/
+      'POWCP' => {
+        title: 'PowerCor Australia',
+        friendly_title: 'PowerCor',
+        state: 'VIC',
+        type: 'electricity',
+        includes: [
+          (/^(VCCC[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(620[34]\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'Jemena Electricity Networks',
-        states: ['VIC'],
-        names: ['SOLARISP'],
-        nmi_blocks: [
-          /^VDDD[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^6001[0-9]{6}$/
+      'SOLARISP' => {
+        title: 'Jemena  Electricity Networks (VIC)',
+        friendly_title: 'Jemena',
+        state: 'VIC',
+        type: 'electricity',
+        includes: [
+          (/^(VDDD[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(6001\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'UNITED',
-        states: ['VIC'],
-        names: ['United Energy Distribution'],
-        nmi_blocks: [
-          /^VEEE[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^640[7-8][0-9]{6}$/
+      'UNITED' => {
+        title: 'United Energy Distribution',
+        friendly_title: 'United Energy',
+        state: 'VIC',
+        type: 'electricity',
+        includes: [
+          (/^(VEEE[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(640[78]\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'GPUPP',
-        states: ['SA'],
-        names: ['AusNet'],
-        nmi_blocks: [
-          /^VtniW[A-HJ-NP-Z0-9]{5}$/,
-          /^650900[0-9]{4}$/
+      'GPUPP' => {
+        title: 'SP AusNet TNSP',
+        friendly_title: 'SP AusNet TNSP',
+        state: 'VIC',
+        type: 'electricity',
+        includes: [
+          (/^(V[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/),
+          (/^(650900\d{4})$/)
+        ],
+        excludes: [
         ]
       },
-      # WA
-      {
-        type: 'electrical',
-        key: 'WESTERNPOWER',
-        states: ['WA'],
-        names: ['Western Power'],
-        nmi_blocks: [
-          /^WAAA[A-HJ-NP-VX-Z0-9][A-HJ-NP-Z0-9]{5}$/,
-          /^801[0-9]{7}$/,
-          /^8020[0-9]{6}$/
+      'WESTERNPOWER' => {
+        title: 'Western Power',
+        friendly_title: 'Western Power',
+        state: 'WA',
+        type: 'electricity',
+        includes: [
+          (/^(WAAA[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(800[1-9]\d{6})$/),
+          (/^(801\d{7})$/),
+          (/^(8020\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: 'GPUPP',
-        states: ['SA'],
-        names: ['AusNet'],
-        nmi_blocks: [
-          /^8021[0-9]{6}$/
+      'HORIZONPOWER' => {
+        title: 'Horizon Power',
+        friendly_title: 'Horizon Power',
+        state: 'WA',
+        type: 'electricity',
+        includes: [
+          (/^(8021\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      # GAS
-      {
+      'GAS_NSW' => {
+        title: 'GAS NSW',
+        friendly_title: 'GAS NSW',
+        state: 'NSW',
         type: 'gas',
-        key: nil,
-        states: ['NSW','ACT'],
-        names: [],
-        nmi_blocks: [
-          /^52[0-9]{8}$/
+        includes: [
+          (/^(52\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
+      'GAS_VIC' => {
+        title: 'GAS VIC',
+        friendly_title: 'GAS VIC',
+        state: 'VIC',
         type: 'gas',
-        key: nil,
-        states: ['VIC'],
-        names: [],
-        nmi_blocks: [
-          /^53[0-9]{8}$/
+        includes: [
+          (/^(53\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
+      'GAS_QLD' => {
+        title: 'GAS QLD',
+        friendly_title: 'GAS QLD',
+        state: 'QLD',
         type: 'gas',
-        key: nil,
-        states: ['QLD'],
-        names: [],
-        nmi_blocks: [
-          /^54[0-9]{8}$/
+        includes: [
+          (/^(54\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
+      'GAS_SA' => {
+        title: 'GAS SA',
+        friendly_title: 'GAS SA',
+        state: 'SA',
         type: 'gas',
-        key: nil,
-        states: ['SA'],
-        names: [],
-        nmi_blocks: [
-          /^55[0-9]{8}$/
+        includes: [
+          (/^(55\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
+      'GAS_WA' => {
+        title: 'GAS WA',
+        friendly_title: 'GAS WA',
+        state: 'WA',
         type: 'gas',
-        key: nil,
-        states: ['WA'],
-        names: [],
-        nmi_blocks: [
-          /^56[0-9]{8}$/
+        includes: [
+          (/^(56\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      {
+      'GAS_TAS' => {
+        title: 'GAS TAS',
+        friendly_title: 'GAS TAS',
+        state: 'TAS',
         type: 'gas',
-        key: nil,
-        states: ['TAS'],
-        names: [],
-        nmi_blocks: [
-          /^57[0-9]{8}$/
+        includes: [
+          (/^(57\d{8})$/)
+        ],
+        excludes: [
         ]
       },
-      # MISC
-      {
-        type: 'electrical',
-        key: nil,
-        states: [],
-        names: ['Federal Airports Corporation (Sydney Airport)'],
-        nmi_blocks: [
-          /^NJJJNR[A-HJ-NP-Z0-9]{4}$/
+      'FEDAIRPORTS' => {
+        title: 'Federal Airports Corporation (Sydney Airport)',
+        friendly_title: 'Sydney Airport',
+        state: 'NSW',
+        type: 'electricity',
+        includes: [
+          (/^(NJJJNR[A-HJ-NP-Z\d]{4})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: nil,
-        states: [],
-        names: ['Exempt Networks - various'],
-        nmi_blocks: [
-          /^NKKKNR[A-HJ-NP-Z0-9]{4}$/,
-          /^7102[0-9]{6}$/
+      'EXEMPTNETWORKS' => {
+        title: 'Exempt Networks - various',
+        friendly_title: 'Exempt Networks - various',
+        state: '',
+        type: 'electricity',
+        includes: [
+          (/^(NKKK[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/),
+          (/^(7102\d{6})$/)
+        ],
+        excludes: [
         ]
       },
-      {
-        type: 'electrical',
-        key: nil,
-        states: [],
-        names: ['AEMO Reserved Block 1'],
-        nmi_blocks: [
-          /^880[1-5][0-9]{6}$/
-        ]
-      },
-      {
-        type: 'electrical',
-        key: nil,
-        states: [],
-        names: ['AEMO Reserved Block 1'],
-        nmi_blocks: [
-          /^9[0-9]{9}$/
+      'AEMORESERVED' => {
+        title: 'AEMO Reserved',
+        friendly_title: 'AEMO Reserved',
+        state: '',
+        type: 'electricity',
+        includes: [
+          (/^(880[1-5]\d{6})$/),
+          (/^(9\d{9})$/)
+        ],
+        excludes: [
         ]
       }
-    ]
+    }
+    # Transmission Node Identifier Codes are loaded from a json file
+    #  Obtained from http://www.nemweb.com.au/
+    #  
+    #  See /lib/data for further data manipulation required
+    TNI_CODES = JSON.parse(File.read(File.join(File.dirname(__FILE__),'..','data','aemo-tni.json')))
+    # Distribution Loss Factor Codes are loaded from a json file
+    #  Obtained from MSATS, matching to DNSP from file http://www.aemo.com.au/Electricity/Market-Operations/Loss-Factors-and-Regional-Boundaries/~/media/Files/Other/loss%20factors/DLF_FINAL_V2_2014_2015.ashx
+    #  Last accessed 2015-02-06
+    #  See /lib/data for further data manipulation required
+    DLF_CODES = JSON.parse(File.read(File.join(File.dirname(__FILE__),'..','data','aemo-dlf.json')))
+    
+    # [String] National Meter Identifier
+    @nmi                          = nil
+    @msats_detail                 = nil
+    @tni                          = nil
+    @dlf                          = nil
+    @customer_classification_code = nil
+    @customer_threshold_code      = nil
+    @jurisdiction_code            = nil
+    @classification_code          = nil
+    @status                       = nil
+    @address                      = nil
+    @meters                       = nil
+    @roles                        = nil
+    
+    attr_accessor :nmi, :msats_detail, :tni, :dlf, :customer_classification_code, :customer_threshold_code, :jurisdiction_code, :classification_code, :status, :address, :meters, :roles
     
-    attr_accessor :region
+    # Initialize a NEM12 file
+    #
+    # @param nmi [String] the National Meter Identifier (NMI)
+    # @param options [Hash] a hash of options
+    # @return [AEMO::NMI] an instance of AEMO::NMI is returned
+    def initialize(nmi,options={})
+      raise ArgumentError.new("NMI is not a string") unless nmi.is_a?(String)
+      raise ArgumentError.new("NMI is not 10 characters") unless nmi.length == 10
+      raise ArgumentError.new("NMI is not constructed with valid characters") unless AEMO::NMI.valid_nmi?(nmi)
+      
+      @nmi              = nmi
+      @meters           = {}
+      @roles            = {}
+    end
 
-    def initialize(nmi)
-      @nmi = nmi
-      @network = NMI.find_network(nmi)
+    # A function to validate the instance's nmi value
+    #
+    # @return [Boolean] whether or not the nmi is valid
+    def valid_nmi?
+      AEMO::NMI.valid_nmi?(@nmi)
+    end
+  
+    # Find the Network of NMI
+    #
+    # @returns [Hash] The Network information
+    def network
+      AEMO::NMI.network(@nmi)
+    end
+  
+    # A function to calculate the checksum value for a given National Meter Identifier
+    #
+    # @param checksum_value [Integer] the checksum value to check against the current National Meter Identifier's checksum value
+    # @return [Boolean] whether or not the checksum is valid
+    def valid_checksum?(checksum_value)
+      checksum_value == self.checksum
+    end
+
+    # Checksum is a function to calculate the checksum value for a given National Meter Identifier
+    #
+    # @return [Integer] the checksum value for the current National Meter Identifier
+    def checksum
+      summation = 0
+      @nmi.reverse.split(//).each_index do |i|
+        value = nmi[nmi.length - i - 1].ord
+        if(i % 2 == 0)
+          value = value * 2
+        end
+        value = value.to_s.split(//).map{|i| i.to_i}.reduce(:+)
+        summation += value
+      end      
+      checksum = (10 - (summation % 10)) % 10
+      checksum
     end
     
+    # Provided MSATS is configured, gets the MSATS data for the NMI
+    #
+    # @return [Hash] MSATS NMI Detail data
+    def raw_msats_nmi_detail
+      raise ArgumentError, 'MSATS has no authentication credentials' unless AEMO::MSATS.can_authenticate?
+      
+      AEMO::MSATS.nmi_detail(@nmi)
+    end
     
-    def self.find_network(nmi)
-      nmi_network = nil
-      NETWORK_SERVICE_PROVIDERS.each do |network|
-        network[:nmi_blocks].each do |nmi_block|
-          nmi_network = network if nmi.match(nmi_block)
+    # Provided MSATS is configured, uses the raw MSATS data to augment NMI information
+    #
+    # @return [self] returns self
+    def update_from_msats!
+      # Update local cache
+      @msats_detail = raw_msats_nmi_detail
+      # Set the details
+      @tni                          = @msats_detail['MasterData']['TransmissionNodeIdentifier']
+      @dlf                          = @msats_detail['MasterData']['DistributionLossFactorCode']
+      @customer_classification_code = @msats_detail['MasterData']['CustomerClassificationCode']
+      @customer_threshold_code      = @msats_detail['MasterData']['CustomerThresholdCode']
+      @jurisdiction_code            = @msats_detail['MasterData']['JurisdictionCode']
+      @classification_code          = @msats_detail['MasterData']['NMIClassificationCode']
+      @status                       = @msats_detail['MasterData']['Status']
+      @address                      = @msats_detail['MasterData']['Address']
+      @meters                ||= {}
+      # Meters
+      unless @msats_detail['MeterRegister'].nil?
+        @msats_detail['MeterRegister']['Meter'].select{|x| !x['Status'].nil? }.each do |meter|
+          m = OpenStruct.new(
+            status: meter['Status'],
+            installation_type_code: meter['InstallationTypeCode'],
+            next_scheduled_read_date: meter['NextScheduledReadDate'],
+            read_type_code: meter['ReadTypeCode'],
+            registers: []
+          )
+          puts "@meters.inspect: #{@meters.inspect}"
+          @meters[meter['SerialNumber']] = m
+        end
+        @msats_detail['MeterRegister']['Meter'].select{|x| x['Status'].nil? }.each do |registers|
+          register = OpenStruct.new(
+            controlled_load: (registers['RegisterConfiguration']['Register']['ControlledLoad'] == 'Y'),
+            dial_format: registers['RegisterConfiguration']['Register']['DialFormat'],
+            multiplier: registers['RegisterConfiguration']['Register']['Multiplier'],
+            network_tariff_code: registers['RegisterConfiguration']['Register']['NetworkTariffCode'],
+            register_id: registers['RegisterConfiguration']['Register']['RegisterID'],
+            status: registers['RegisterConfiguration']['Register']['Status'],
+            time_of_day: registers['RegisterConfiguration']['Register']['TimeOfDay'],
+            unit_of_measure: registers['RegisterConfiguration']['Register']['UnitOfMeasure']
+          )
+          @meters[registers['SerialNumber']].registers << register
+        end
+      end
+      # Roles
+      unless @msats_detail['RoleAssignments'].nil?
+        @msats_detail['RoleAssignments']['RoleAssignment'].each do |role|
+          @roles[role['Role']] = role['Party']
         end
-        break unless nmi_network.nil?
       end
-      nmi_network
+
+      self
     end
-    
+  
+    # A function to validate the NMI provided
+    #
+    # @param nmi [String] the nmi to be checked
+    # @return [Boolean] whether or not the nmi is valid
+    def self.valid_nmi?(nmi)
+      ((nmi.length == 10) && !nmi.match(/^([A-HJ-NP-Z\d]{10})/).nil?)
+    end
+
+    # A function to calculate the checksum value for a given National Meter Identifier
+    #
+    # @param nmi [String] the NMI to check the checksum against
+    # @param checksum_value [Integer] the checksum value to check against the current National Meter Identifier's checksum value
+    # @return [Boolean] whether or not the checksum is valid
+    def self.valid_checksum?(nmi,checksum_value)
+      nmi = AEMO::NMI.new(nmi)
+      nmi.valid_checksum?(checksum_value)
+    end
+  
+    # Find the Network for a given NMI
+    #
+    # @param nmi [String] NMI
+    # @returns [Hash] The Network information
+    def self.network(nmi)
+      network = nil
+      AEMO::NMI::NMI_ALLOCATIONS.each_pair do |identifier, details|
+        details[:includes].each do |pattern|
+          if nmi.match(pattern)
+            network = { identifier => details }
+            break
+          end
+        end
+      end
+      network
+    end
+
     # ######### #
       protected
     # ######### #
-  
+
     def is_valid_region?(region)
       REGIONS.keys.include?(region)
     end
-  
+
   end
-end
+  
+end