aemo 0.1.27 → 0.1.28

data/lib/aemo/nem13.rb

@@ -1,5 +1,4 @@
 module AEMO
   class NEM13
-    
   end
-end
+end

data/lib/aemo/nmi.rb

@@ -15,9 +15,10 @@ module AEMO
       'VIC' => 'Victoria',
       'WA'  => 'Western Australia',
       'NT'  => 'Northern Territory'
-    }
-    # 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
+    }.freeze
+
+    # 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 2016-05-15
     NMI_ALLOCATIONS = {
       'ACTEWP' => {
         title: 'Actew Distribution Ltd and Jemena Networks (ACT) Pty Ltd',
@@ -192,7 +193,7 @@ module AEMO
         state: 'TAS',
         type: 'electricity',
         includes: [
-          /^(T[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/,
+          /^(T[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/
         ],
         excludes: [
         ]
@@ -395,17 +396,17 @@ module AEMO
         excludes: [
         ]
       }
-    }
+    }.freeze
     # 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')))
+    TNI_CODES = JSON.parse(File.read(File.join(File.dirname(__FILE__), '..', 'data', 'aemo-tni.json'))).freeze
     # 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
+    #  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')))
+    DLF_CODES = JSON.parse(File.read(File.join(File.dirname(__FILE__), '..', 'data', 'aemo-dlf.json'))).freeze
 
     # [String] National Meter Identifier
     @nmi                          = nil
@@ -424,20 +425,24 @@ module AEMO
 
     attr_accessor :nmi, :msats_detail, :tni, :dlf, :customer_classification_code, :customer_threshold_code, :jurisdiction_code, :classification_code, :status, :address, :meters, :roles, :data_streams
 
-    # Initialize a NEM12 file
+    # Initialize a NMI file
     #
     # @param nmi [String] the National Meter Identifier (NMI)
     # @param options [Hash] a hash of options
+    # @option options [Hash] :msats_detail MSATS details as per #parse_msats_detail requirements
     # @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)
+    def initialize(nmi, options = {})
+      raise ArgumentError, 'NMI is not a string' unless nmi.is_a?(String)
+      raise ArgumentError, 'NMI is not 10 characters' unless nmi.length == 10
+      raise ArgumentError, 'NMI is not constructed with valid characters' unless AEMO::NMI.valid_nmi?(nmi)
+
+      @nmi          = nmi
+      @meters       = []
+      @roles        = {}
+      @data_streams = []
+      @msats_detail = options[:msats_detail]
 
-      @nmi              = nmi
-      @meters           = []
-      @roles            = {}
-      @data_streams     = []
+      parse_msats_detail unless @msats_detail.nil?
     end
 
     # A function to validate the instance's nmi value
@@ -459,7 +464,7 @@ module AEMO
     # @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
+      checksum_value == checksum
     end
 
     # Checksum is a function to calculate the checksum value for a given National Meter Identifier
@@ -469,10 +474,8 @@ module AEMO
       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(:+)
+        value *= 2 if i.even?
+        value = value.to_s.split(//).map(&:to_i).reduce(:+)
         summation += value
       end
       checksum = (10 - (summation % 10)) % 10
@@ -482,18 +485,26 @@ module AEMO
     # Provided MSATS is configured, gets the MSATS data for the NMI
     #
     # @return [Hash] MSATS NMI Detail data
-    def raw_msats_nmi_detail(options={})
-      raise ArgumentError, 'MSATS has no authentication credentials' unless AEMO::MSATS.can_authenticate?
-
-      AEMO::MSATS.nmi_detail(@nmi,options)
+    def raw_msats_nmi_detail(options = {})
+      raise ArgumentError,
+            'MSATS has no authentication credentials' unless AEMO::MSATS.can_authenticate?
+      AEMO::MSATS.nmi_detail(@nmi, options)
     end
 
     # Provided MSATS is configured, uses the raw MSATS data to augment NMI information
     #
     # @return [self] returns self
-    def update_from_msats!(options={})
+    def update_from_msats!(options = {})
       # Update local cache
       @msats_detail = raw_msats_nmi_detail(options)
+      parse_msats_detail
+      self
+    end
+
+    # Turns raw MSATS junk into useful things
+    #
+    # @return [self] returns self
+    def parse_msats_detail
       # Set the details if there are any
       unless @msats_detail['MasterData'].nil?
         @tni                          = @msats_detail['MasterData']['TransmissionNodeIdentifier']
@@ -512,7 +523,7 @@ module AEMO
       unless @msats_detail['MeterRegister'].nil?
         meters = @msats_detail['MeterRegister']['Meter']
         meters = [meters] if meters.is_a?(Hash)
-        meters.select{|x| !x['Status'].nil? }.each do |meter|
+        meters.select { |x| !x['Status'].nil? }.each do |meter|
           @meters << OpenStruct.new(
             status: meter['Status'],
             installation_type_code: meter['InstallationTypeCode'],
@@ -522,9 +533,9 @@ module AEMO
             serial_number: meter['SerialNumber']
           )
         end
-        meters.select{|x| x['Status'].nil? }.each do |registers|
-          m = @meters.find{|x| x.serial_number == registers['SerialNumber']}
-          m.registers << register = OpenStruct.new(
+        meters.select { |x| x['Status'].nil? }.each do |registers|
+          m = @meters.find { |x| x.serial_number == registers['SerialNumber'] }
+          m.registers << OpenStruct.new(
             controlled_load: (registers['RegisterConfiguration']['Register']['ControlledLoad'] == 'Y'),
             dial_format: registers['RegisterConfiguration']['Register']['DialFormat'],
             multiplier: registers['RegisterConfiguration']['Register']['Multiplier'],
@@ -549,7 +560,13 @@ module AEMO
         data_streams = @msats_detail['DataStreams']['DataStream']
         data_streams = [data_streams] if data_streams.is_a?(Hash) # Deal with issue of only one existing
         data_streams.each do |stream|
-          @data_streams << OpenStruct.new(suffix: stream['Suffix'], profile_name: stream['ProfileName'],averaged_daily_load: stream['AveragedDailyLoad'], data_stream_type: stream['DataStreamType'],status: stream['Status'])
+          @data_streams << OpenStruct.new(
+            suffix: stream['Suffix'],
+            profile_name: stream['ProfileName'],
+            averaged_daily_load: stream['AveragedDailyLoad'],
+            data_stream_type: stream['DataStreamType'],
+            status: stream['Status']
+          )
         end
       end
       self
@@ -561,7 +578,12 @@ module AEMO
     def friendly_address
       friendly_address = ''
       if @address.is_a?(Hash)
-        friendly_address = @address.values.map{|x| x.is_a?(Hash) ? x.values.map{|y| y.is_a?(Hash) ? y.values.join(" ") : y }.join(" ") : x }.join(", ")
+        friendly_address = @address.values.map do |x|
+          if x.is_a?(Hash)
+            x = x.values.map { |y| y.is_a?(Hash) ? y.values.join(' ') : y }.join(' ')
+          end
+          x
+        end.join(', ')
       end
       friendly_address
     end
@@ -571,7 +593,7 @@ module AEMO
     # @param status [String] the stateus [C|R]
     # @return [Array<OpenStruct>] Returns an array of OpenStructs for Meters with the status provided
     def meters_by_status(status = 'C')
-      @meters.select{|x| x.status == "#{status}"}
+      @meters.select { |x| x.status == status.to_s }
     end
 
     # Returns the data_stream OpenStructs for the requested status (A/I)
@@ -579,14 +601,14 @@ module AEMO
     # @param status [String] the stateus [A|I]
     # @return [Array<OpenStruct>] Returns an array of OpenStructs for the current Meters
     def data_streams_by_status(status = 'A')
-      @data_streams.select{|x| x.status == "#{status}"}
+      @data_streams.select { |x| x.status == status.to_s }
     end
 
     # The current daily load
     #
     # @return [Integer] the current daily load for the meter
     def current_daily_load
-      data_streams_by_status().inject(0) { |sum, stream| sum += stream.averaged_daily_load.to_i }
+      data_streams_by_status.map { |x| x.averaged_daily_load.to_i }.inject(0, :+)
     end
 
     # A function to validate the NMI provided
@@ -602,7 +624,7 @@ module AEMO
     # @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)
+    def self.valid_checksum?(nmi, checksum_value)
       nmi = AEMO::NMI.new(nmi)
       nmi.valid_checksum?(checksum_value)
     end
@@ -626,14 +648,14 @@ module AEMO
 
     # A function to return the distribution loss factor value for a given date
     #
-    # @param [DateTime,Time] datetime the date for the distribution loss factor value
-    # @return [nil,float] the distribution loss factor value
+    # @param [DateTime, Time] datetime the date for the distribution loss factor value
+    # @return [nil, float] the distribution loss factor value
     def dlfc_value(datetime = DateTime.now)
       raise 'No DLF set, ensure that you have set the value either via the update_from_msats! function or manually' if @dlf.nil?
       raise 'DLF is invalid' unless DLF_CODES.keys.include?(@dlf)
-      raise 'Invalid date' unless [DateTime,Time].include?(datetime.class)
-      possible_values = DLF_CODES[@dlf].select{|x| DateTime.parse(x['FromDate']) <= datetime && datetime <= DateTime.parse(x['ToDate']) }
-      if possible_values.length == 0
+      raise 'Invalid date' unless [DateTime, Time].include?(datetime.class)
+      possible_values = DLF_CODES[@dlf].select { |x| DateTime.parse(x['FromDate']) <= datetime && datetime <= DateTime.parse(x['ToDate']) }
+      if possible_values.empty?
         nil
       else
         possible_values.first['Value'].to_f
@@ -642,66 +664,50 @@ module AEMO
 
     # A function to return the distribution loss factor value for a given date
     #
-    # @param [DateTime,Time] start the date for the distribution loss factor value
-    # @param [DateTime,Time] finish the date for the distribution loss factor value
-    # @return [Array(Hash)] array of hashes of start,finish and value
-    def dlfc_values(start = DateTime.now, finish=DateTime.now)
+    # @param [DateTime, Time] start the date for the distribution loss factor value
+    # @param [DateTime, Time] finish the date for the distribution loss factor value
+    # @return [Array(Hash)] array of hashes of start, finish and value
+    def dlfc_values(start = DateTime.now, finish = DateTime.now)
       raise 'No DLF set, ensure that you have set the value either via the update_from_msats! function or manually' if @dlf.nil?
       raise 'DLF is invalid' unless DLF_CODES.keys.include?(@dlf)
-      raise 'Invalid start' unless [DateTime,Time].include?(start.class)
-      raise 'Invalid finish' unless [DateTime,Time].include?(finish.class)
+      raise 'Invalid start' unless [DateTime, Time].include?(start.class)
+      raise 'Invalid finish' unless [DateTime, Time].include?(finish.class)
       raise 'start cannot be after finish' if start > finish
-      DLF_CODES[@dlf].reject{|x| start > DateTime.parse(x['ToDate']) || finish < DateTime.parse(x['FromDate']) }.map{|x| { 'start' => x['FromDate'], 'finish' => x['ToDate'], 'value' => x['Value'].to_f}}
+      DLF_CODES[@dlf].reject { |x| start > DateTime.parse(x['ToDate']) || finish < DateTime.parse(x['FromDate']) }
+                     .map { |x| { 'start' => x['FromDate'], 'finish' => x['ToDate'], 'value' => x['Value'].to_f } }
     end
 
     # A function to return the transmission node identifier loss factor value for a given date
     #
-    # @param [DateTime,Time] datetime the date for the distribution loss factor value
-    # @return [nil,float] the transmission node identifier loss factor value
+    # @param [DateTime, Time] datetime the date for the distribution loss factor value
+    # @return [nil, float] the transmission node identifier loss factor value
     def tni_value(datetime = DateTime.now)
       raise 'No TNI set, ensure that you have set the value either via the update_from_msats! function or manually' if @tni.nil?
       raise 'TNI is invalid' unless TNI_CODES.keys.include?(@tni)
-      raise 'Invalid date' unless [DateTime,Time].include?(datetime.class)
-      possible_values = TNI_CODES[@tni].select{|x| DateTime.parse(x['FromDate']) <= datetime && datetime <= DateTime.parse(x['ToDate']) }
-      if possible_values.length == 0
-        nil
-      else
-        possible_values = possible_values.first['mlf_data']['loss_factors'].select{|x| DateTime.parse(x['start']) <= datetime && datetime <= DateTime.parse(x['finish']) }
-        if possible_values.length == 0
-          nil
-        else
-          possible_values.first['value'].to_f
-        end
-      end
+      raise 'Invalid date' unless [DateTime, Time].include?(datetime.class)
+      possible_values = TNI_CODES[@tni].select { |x| DateTime.parse(x['FromDate']) <= datetime && datetime <= DateTime.parse(x['ToDate']) }
+      return nil if possible_values.empty?
+      possible_values = possible_values.first['mlf_data']['loss_factors'].select { |x| DateTime.parse(x['start']) <= datetime && datetime <= DateTime.parse(x['finish']) }
+      return nil if possible_values.empty?
+      possible_values.first['value'].to_f
     end
 
     # A function to return the transmission node identifier loss factor value for a given date
     #
-    # @param [DateTime,Time] start the date for the distribution loss factor value
-    # @param [DateTime,Time] finish the date for the distribution loss factor value
-    # @return [Array(Hash)] array of hashes of start,finish and value
-    def tni_values(start=DateTime.now,finish=DateTime.now)
+    # @param [DateTime, Time] start the date for the distribution loss factor value
+    # @param [DateTime, Time] finish the date for the distribution loss factor value
+    # @return [Array(Hash)] array of hashes of start, finish and value
+    def tni_values(start = DateTime.now, finish = DateTime.now)
       raise 'No TNI set, ensure that you have set the value either via the update_from_msats! function or manually' if @tni.nil?
       raise 'TNI is invalid' unless TNI_CODES.keys.include?(@tni)
-      raise 'Invalid start' unless [DateTime,Time].include?(start.class)
-      raise 'Invalid finish' unless [DateTime,Time].include?(finish.class)
+      raise 'Invalid start' unless [DateTime, Time].include?(start.class)
+      raise 'Invalid finish' unless [DateTime, Time].include?(finish.class)
       raise 'start cannot be after finish' if start > finish
-      possible_values = TNI_CODES[@tni].reject{|x| start > DateTime.parse(x['ToDate']) || finish < DateTime.parse(x['FromDate']) }
-      tni_values = []
-      if possible_values.length == 0
-        nil
-      else
-        possible_values.each do |possible_value|
-          tni_values += possible_value['mlf_data']['loss_factors'].reject{|x| start > DateTime.parse(x['finish']) || finish < DateTime.parse(x['start']) }
-        end
-      end
-      tni_values
+      possible_values = TNI_CODES[@tni]
+                        .reject { |x| start > DateTime.parse(x['ToDate']) || finish < DateTime.parse(x['FromDate']) }
+                        .reject { |x| start > DateTime.parse(x['finish']) || finish < DateTime.parse(x['start']) }
+      return nil if possible_values.empty?
+      possible_values.map { |x| x['mlf_data']['loss_factors'] }
     end
-
-    # ######### #
-      protected
-    # ######### #
-
   end
-
 end

data/lib/aemo/region.rb

@@ -1,6 +1,10 @@
 module AEMO
+  # AEMO::Region
+  #
+  # @author Joel Courtney
+  # @abstract
+  # @since 0.1.0
   class Region
-
     # Regions under juristiction
     REGIONS = {
       'ACT' => 'Australian Capital Territory',
@@ -11,12 +15,12 @@ module AEMO
       'VIC' => 'Victoria',
       'NT'  => 'Northern Territory',
       'WA'  => 'Western Australia'
-    }
+    }.freeze
 
     attr_accessor :region
 
     def initialize(region)
-      raise ArgumentError.new("Region '#{region}' is not valid.") unless is_valid_region?(region)
+      raise ArgumentError, "Region '#{region}' is not valid." unless valid_region?(region)
       @region = region
       @current_trading = []
       @current_dispatch = []
@@ -35,30 +39,27 @@ module AEMO
     end
 
     def current_dispatch
-      if @current_dispatch.length == 0 || @current_dispatch.last.datetime != (Time.now - Time.now.to_i % 300)
+      if @current_dispatch.empty? || @current_dispatch.last.datetime != (Time.now - Time.now.to_i % 300)
         @current_dispatch = AEMO::Market.current_dispatch(@region)
       end
       @current_dispatch
     end
 
     def current_trading
-      if @current_trading.length == 0 || @current_trading.reject{|i| i.period_type != 'TRADE'}.last.datetime != (Time.now - Time.now.to_i % 300)
+      if @current_trading.empty? || @current_trading.reject { |i| i.period_type != 'TRADE' }.last.datetime != (Time.now - Time.now.to_i % 300)
         @current_trading = AEMO::Market.current_trading(@region)
       end
       @current_trading
     end
 
     def self.all
-      REGIONS.keys.map{|k| AEMO::Region.new(k)}
+      REGIONS.keys.map { |k| AEMO::Region.new(k) }
     end
 
-    # ######### #
-      protected
-    # ######### #
+    protected
 
-    def is_valid_region?(region)
+    def valid_region?(region)
       REGIONS.keys.include?(region)
     end
-
   end
 end

data/lib/aemo/version.rb

@@ -2,14 +2,14 @@
 #
 # Copyright 2014 Joel Courtney
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
+# Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 #    http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
+# distributed under the License is distributed on an 'AS IS' BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
@@ -22,7 +22,7 @@
 # @author Joel Courtney <euphemize@gmail.com>
 module AEMO
   # aemo version
-  VERSION = '0.1.27'
+  VERSION = '0.1.28'.freeze
 
   # aemo version split amongst different revisions
   MAJOR_VERSION, MINOR_VERSION, REVISION = VERSION.split('.').map(&:to_i)

data/lib/data/xml_to_json.rb

@@ -0,0 +1,62 @@
+require 'nokogiri'
+require 'json'
+require 'csv'
+require 'active_support/all'
+
+@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: DateTime.parse('2015-07-01T00:00:00+1000'), finish: DateTime.parse('2016-07-01T00:00:00+1000'), value: row['FY16'] }
+  @mlf_data[row['TNI']][:loss_factors] << { start: DateTime.parse('2014-07-01T00:00:00+1000'), finish: DateTime.parse('2015-07-01T00:00:00+1000'), value: row['FY15'] }
+  @mlf_data[row['TNI']][:loss_factors] << { start: DateTime.parse('2013-07-01T00:00:00+1000'), finish: DateTime.parse('2014-07-01T00:00:00+1000'), 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 =~ /tni/
+      puts "output_data_instance: #{output_data_instance.inspect}"
+      output_data_instance[:mlf_data] = {}
+      unless @mlf_data[code].nil?
+        output_data_instance[:mlf_data] = @mlf_data[code].deep_dup
+        output_data_instance[:mlf_data][:loss_factors] = output_data_instance[:mlf_data][:loss_factors].reject do |x|
+          DateTime.parse(output_data_instance['ToDate']) < x[:start] || DateTime.parse(output_data_instance['FromDate']) >= x[:finish]
+        end
+        puts "output_data_instance[:mlf_data][:loss_factors]: #{output_data_instance[:mlf_data][:loss_factors].inspect}"
+      end
+    elsif file =~ /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