aemo 0.2.1 → 0.3.0.pre.rc1

data/lib/aemo/nmi.rb

@@ -4,315 +4,39 @@ require 'csv'
 require 'json'
 require 'time'
 require 'ostruct'
+
 module AEMO
+  # [AEMO::NMI]
+  #
   # AEMO::NMI acts as an object to simplify access to data and information
-  # about a NMI and provide verification of the NMI value
+  #   about a NMI and provide verification of the NMI value
+  #
+  # @author Joel Courtney
+  # @abstract Model for a National Metering Identifier.
+  # @since 2014-12-05
   class NMI
     # Operational Regions for the NMI
-    REGIONS = { 'ACT' => 'Australian Capital Territory',
-                'NSW' => 'New South Wales',
-                'QLD' => 'Queensland',
-                'SA'  => 'South Australia',
-                'TAS' => 'Tasmania',
-                'VIC' => 'Victoria',
-                'WA'  => 'Western Australia',
-                'NT'  => 'Northern Territory' }.freeze
-
-    # NMI_ALLOCATIONS as per AEMO Documentation at
-    # https://www.aemo.com.au/-/media/Files/Electricity/NEM/Retail_and_Metering/
-    #   Metering-Procedures/NMI-Allocation-List.pdf
-    #   Last accessed 2017-08-01
-    NMI_ALLOCATIONS = {
-      'ACTEWP' => {
-        title: 'Actew Distribution Ltd and Jemena Networks (ACT) Pty Ltd',
-        friendly_title: 'ACTEWAgl',
-        state: AEMO::Region.new('ACT'),
-        type: 'electricity',
-        includes: [/^(NGGG[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(7001\d{6})$/],
-        excludes: []
-      },
-      'CNRGYP' => {
-        title: 'Essential Energy',
-        friendly_title: 'Essential Energy',
-        state: AEMO::Region.new('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: []
-      },
-      'ENERGYAP' => {
-        title: 'Ausgrid',
-        friendly_title: 'Ausgrid',
-        state: AEMO::Region.new('NSW'),
-        type: 'electricity',
-        includes: [/^(NCCC[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(410[234]\d{6})$/],
-        excludes: []
-      },
-      'INTEGP' => {
-        title: 'Endeavour Energy',
-        friendly_title: 'Endeavour Energy',
-        state: AEMO::Region.new('NSW'),
-        type: 'electricity',
-        includes: [/^(NEEE[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(431\d{7})$/],
-        excludes: []
-      },
-      'TRANSGP' => {
-        title: 'TransGrid',
-        friendly_title: 'TransGrid',
-        state: AEMO::Region.new('NSW'),
-        type: 'electricity',
-        includes: [/^(NTTT[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(460810[0-8]\d{3})$/],
-        excludes: []
-      },
-      'SNOWY' => {
-        title: 'Snowy Hydro Ltd',
-        friendly_title: 'Snowy Hydro',
-        state: AEMO::Region.new('NSW'),
-        type: 'electricity',
-        includes: [/^(4708109\d{3})$/],
-        excludes: []
-      },
-      'NT_RESERVED' => {
-        title: 'Northern Territory Reserved Block',
-        friendly_title: 'Northern Territory Reserved Block',
-        state: AEMO::Region.new('NT'),
-        type: 'electricity',
-        includes: [/^(250\d{7})$/],
-        excludes: []
-      },
-      'ERGONETP' => {
-        title: 'Ergon Energy Corporation',
-        friendly_title: 'Ergon Energy',
-        state: AEMO::Region.new('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: []
-      },
-      'ENERGEXP' => {
-        title: 'ENERGEX Limited',
-        friendly_title: 'Energex',
-        state: AEMO::Region.new('QLD'),
-        type: 'electricity',
-        includes: [/^(QB\d{2}[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(31\d{8})$/],
-        excludes: []
-      },
-      'PLINKP' => {
-        title: 'Qld Electricity Transmission Corp (Powerlink)',
-        friendly_title: 'Powerlink',
-        state: AEMO::Region.new('QLD'),
-        type: 'electricity',
-        includes: [/^(Q[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/,
-                   /^(320200\d{4})$/],
-        excludes: []
-      },
-      'UMPLP' => {
-        title: 'SA Power Networks',
-        friendly_title: 'SA Power Networks',
-        state: AEMO::Region.new('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: []
-      },
-      'ETSATP' => {
-        title: 'ElectraNet SA',
-        friendly_title: 'ElectraNet SA',
-        state: AEMO::Region.new('SA'),
-        type: 'electricity',
-        includes: [/^(S[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/,
-                   /^(210200\d{4})$/],
-        excludes: []
-      },
-      'AURORAP' => {
-        title: 'TasNetworks',
-        friendly_title: 'TasNetworks',
-        state: AEMO::Region.new('TAS'),
-        type: 'electricity',
-        includes: [/^(T000000(([0-4]\d{3})|(500[01])))$/,
-                   /^(8000\d{6})$/,
-                   /^(8590[23]\d{5})$/],
-        excludes: []
-      },
-      'TRANSEND' => {
-        title: 'TasNetworks',
-        friendly_title: 'TasNetworks',
-        state: AEMO::Region.new('TAS'),
-        type: 'electricity',
-        includes: [/^(T[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/],
-        excludes: []
-      },
-      'CITIPP' => {
-        title: 'CitiPower',
-        friendly_title: 'CitiPower',
-        state: AEMO::Region.new('VIC'),
-        type: 'electricity',
-        includes: [/^(VAAA[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(610[23]\d{6})$/],
-        excludes: []
-      },
-      'EASTERN' => {
-        title: 'SP AusNet',
-        friendly_title: 'SP AusNet DNSP',
-        state: AEMO::Region.new('VIC'),
-        type: 'electricity',
-        includes: [/^(VBBB[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(630[56]\d{6})$/],
-        excludes: []
-      },
-      'POWCP' => {
-        title: 'PowerCor Australia',
-        friendly_title: 'PowerCor',
-        state: AEMO::Region.new('VIC'),
-        type: 'electricity',
-        includes: [/^(VCCC[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(620[34]\d{6})$/],
-        excludes: []
-      },
-      'SOLARISP' => {
-        title: 'Jemena  Electricity Networks (VIC)',
-        friendly_title: 'Jemena',
-        state: AEMO::Region.new('VIC'),
-        type: 'electricity',
-        includes: [/^(VDDD[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(6001\d{6})$/],
-        excludes: []
-      },
-      'UNITED' => {
-        title: 'United Energy Distribution',
-        friendly_title: 'United Energy',
-        state: AEMO::Region.new('VIC'),
-        type: 'electricity',
-        includes: [/^(VEEE[A-HJ-NP-VX-Z\d][A-HJ-NP-Z\d]{5})$/,
-                   /^(640[78]\d{6})$/],
-        excludes: []
-      },
-      'GPUPP' => {
-        title: 'SP AusNet TNSP',
-        friendly_title: 'SP AusNet TNSP',
-        state: AEMO::Region.new('VIC'),
-        type: 'electricity',
-        includes: [/^(V[A-HJ-NP-Z\d]{3}W[A-HJ-NP-Z\d]{5})$/,
-                   /^(650900\d{4})$/],
-        excludes: []
-      },
-      'WESTERNPOWER' => {
-        title: 'Western Power',
-        friendly_title: 'Western Power',
-        state: AEMO::Region.new('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: []
-      },
-      'HORIZONPOWER' => {
-        title: 'Horizon Power',
-        friendly_title: 'Horizon Power',
-        state: AEMO::Region.new('WA'),
-        type: 'electricity',
-        includes: [/^(8021\d{6})$/],
-        excludes: []
-      },
-      'GAS_NSW' => {
-        title: 'GAS NSW',
-        friendly_title: 'GAS NSW',
-        state: AEMO::Region.new('NSW'),
-        type: 'gas',
-        includes: [/^(52\d{8})$/],
-        excludes: []
-      },
-      'GAS_VIC' => {
-        title: 'GAS VIC',
-        friendly_title: 'GAS VIC',
-        state: AEMO::Region.new('VIC'),
-        type: 'gas',
-        includes: [/^(53\d{8})$/],
-        excludes: []
-      },
-      'GAS_QLD' => {
-        title: 'GAS QLD',
-        friendly_title: 'GAS QLD',
-        state: AEMO::Region.new('QLD'),
-        type: 'gas',
-        includes: [/^(54\d{8})$/],
-        excludes: []
-      },
-      'GAS_SA' => {
-        title: 'GAS SA',
-        friendly_title: 'GAS SA',
-        state: AEMO::Region.new('SA'),
-        type: 'gas',
-        includes: [/^(55\d{8})$/],
-        excludes: []
-      },
-      'GAS_WA' => {
-        title: 'GAS WA',
-        friendly_title: 'GAS WA',
-        state: AEMO::Region.new('WA'),
-        type: 'gas',
-        includes: [/^(56\d{8})$/],
-        excludes: []
-      },
-      'GAS_TAS' => {
-        title: 'GAS TAS',
-        friendly_title: 'GAS TAS',
-        state: AEMO::Region.new('TAS'),
-        type: 'gas',
-        includes: [/^(57\d{8})$/],
-        excludes: []
-      },
-      'FEDAIRPORTS' => {
-        title: 'Federal Airports Corporation (Sydney Airport)',
-        friendly_title: 'Sydney Airport',
-        state: AEMO::Region.new('NSW'),
-        type: 'electricity',
-        includes: [/^(NJJJNR[A-HJ-NP-Z\d]{4})$/],
-        excludes: []
-      },
-      '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: []
-      },
-      'AEMORESERVED' => {
-        title: 'AEMO Reserved',
-        friendly_title: 'AEMO Reserved',
-        state: '',
-        type: 'electricity',
-        includes: [/^(880[1-5]\d{6})$/,
-                   /^(9\d{9})$/],
-        excludes: []
-      }
+    REGIONS = {
+      'ACT' => 'Australian Capital Territory',
+      'NSW' => 'New South Wales',
+      'QLD' => 'Queensland',
+      'SA'  => 'South Australia',
+      'TAS' => 'Tasmania',
+      'VIC' => 'Victoria',
+      'WA'  => 'Western Australia',
+      'NT'  => 'Northern Territory'
     }.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'))).freeze
+    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
     # https://www.aemo.com.au/-/media/Files/Electricity/NEM/
@@ -321,8 +45,11 @@ module AEMO
     #
     #  Last accessed 2017-08-01
     #  See /lib/data for further data manipulation required
-    DLF_CODES = JSON.parse(File.read(File.join(File.dirname(__FILE__), '..',
-                                               'data', 'aemo-dlf.json'))).freeze
+    DLF_CODES = JSON.parse(
+      File.read(
+        File.join(File.dirname(__FILE__), '..', 'data', 'aemo-dlf.json')
+      )
+    ).freeze
 
     # [String] National Meter Identifier
     @nmi                          = nil
@@ -344,6 +71,38 @@ module AEMO
                   :jurisdiction_code, :classification_code, :status, :address,
                   :meters, :roles, :data_streams
 
+    class << self
+      # A function to validate the NMI provided
+      #
+      # @param [String] nmi the nmi to be checked
+      # @return [Boolean] whether or not the nmi is valid
+      def 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 [String] nmi the NMI to check the checksum against
+      # @param [Integer] checksum_value 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?(nmi, checksum_value)
+        nmi = AEMO::NMI.new(nmi)
+        nmi.valid_checksum?(checksum_value)
+      end
+
+      # Find the Network for a given NMI
+      #
+      # @param [String] nmi NMI
+      # @returns [AEMO::NMI::Allocation] The Network information
+      def network(nmi)
+        AEMO::NMI::Allocation.find_by_nmi(nmi)
+      end
+
+      alias allocation network
+    end
+
     # Initialize a NMI file
     #
     # @param [String] nmi the National Meter Identifier (NMI)
@@ -354,9 +113,7 @@ module AEMO
     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
-      unless AEMO::NMI.valid_nmi?(nmi)
-        raise ArgumentError, 'NMI is not constructed with valid characters'
-      end
+      raise ArgumentError, 'NMI is not constructed with valid characters' unless AEMO::NMI.valid_nmi?(nmi)
 
       @nmi          = nmi
       @meters       = []
@@ -381,6 +138,8 @@ module AEMO
       AEMO::NMI.network(@nmi)
     end
 
+    alias allocation network
+
     # A function to calculate the checksum value for a given
     # National Meter Identifier
     #
@@ -412,9 +171,7 @@ module AEMO
     #
     # @return [Hash] MSATS NMI Detail data
     def raw_msats_nmi_detail(options = {})
-      unless AEMO::MSATS.can_authenticate?
-        raise ArgumentError, 'MSATS has no authentication credentials'
-      end
+      raise ArgumentError, 'MSATS has no authentication credentials' unless AEMO::MSATS.can_authenticate?
       AEMO::MSATS.nmi_detail(@nmi, options)
     end
 
@@ -530,54 +287,18 @@ module AEMO
 
     # The current annual load in MWh
     #
+    # @todo Use TimeDifference for more accurate annualised load
     # @return [Integer] the current annual load for the meter in MWh
     def current_annual_load
       (current_daily_load * 365.2425 / 1000).to_i
     end
 
-    # A function to validate the NMI provided
-    #
-    # @param [String] nmi 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 [String] nmi the NMI to check the checksum against
-    # @param [Integer] checksum_value 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 [String] nmi 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
-
     # 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
-    def dlfc_value(datetime = DateTime.now)
+    def dlfc_value(datetime = Time.now)
       if @dlf.nil?
         raise 'No DLF set, ensure that you have set the value either via the' \
               'update_from_msats! function or manually'
@@ -585,8 +306,8 @@ module AEMO
       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 do |x|
-        DateTime.parse(x['FromDate']) <= datetime &&
-          DateTime.parse(x['ToDate']) >= datetime
+        Time.parse(x['FromDate']) <= datetime &&
+          Time.parse(x['ToDate']) >= datetime
       end
       if possible_values.empty?
         nil
@@ -600,13 +321,16 @@ module AEMO
     # @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?
+    def dlfc_values(start = Time.now, finish = Time.now)
+      if @dlf.nil?
+        raise 'No DLF set, ensure that you have set the value either via the '\
+              'update_from_msats! function or manually'
+      end
       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 'start cannot be after finish' if start > finish
-      DLF_CODES[@dlf].reject { |x| start > DateTime.parse(x['ToDate']) || finish < DateTime.parse(x['FromDate']) }
+      DLF_CODES[@dlf].reject { |x| start > Time.parse(x['ToDate']) || finish < Time.parse(x['FromDate']) }
                      .map { |x| { 'start' => x['FromDate'], 'finish' => x['ToDate'], 'value' => x['Value'].to_f } }
     end
 
@@ -614,13 +338,16 @@ module AEMO
     #
     # @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?
+    def tni_value(datetime = Time.now)
+      if @tni.nil?
+        raise 'No TNI set, ensure that you have set the value either via the '\
+              'update_from_msats! function or manually'
+      end
       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']) }
+      possible_values = TNI_CODES[@tni].select { |x| Time.parse(x['FromDate']) <= datetime && datetime <= Time.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']) }
+      possible_values = possible_values.first['mlf_data']['loss_factors'].select { |x| Time.parse(x['start']) <= datetime && datetime <= Time.parse(x['finish']) }
       return nil if possible_values.empty?
       possible_values.first['value'].to_f
     end
@@ -630,14 +357,21 @@ module AEMO
     # @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?
+    def tni_values(start = Time.now, finish = Time.now)
+      if @tni.nil?
+        raise 'No TNI set, ensure that you have set the value either via the '\
+              'update_from_msats! function or manually'
+      end
       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 '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']) }
+
+      possible_values = TNI_CODES[@tni].reject do |tni_code|
+        start > Time.parse(tni_code['ToDate']) ||
+          finish < Time.parse(tni_code['FromDate'])
+      end
+
       return nil if possible_values.empty?
       possible_values.map { |x| x['mlf_data']['loss_factors'] }
     end

data/lib/aemo/version.rb

@@ -24,7 +24,7 @@
 # @author Joel Courtney <euphemize@gmail.com>
 module AEMO
   # aemo version
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0-rc1'
 
   # aemo version split amongst different revisions
   MAJOR_VERSION, MINOR_VERSION, REVISION = VERSION.split('.').map(&:to_i)

data/lib/aemo.rb

@@ -11,9 +11,11 @@ require 'aemo/market/node.rb'
 require 'aemo/meter.rb'
 require 'aemo/nem12.rb'
 require 'aemo/nmi.rb'
+require 'aemo/nmi/allocation.rb'
 require 'aemo/msats.rb'
 require 'aemo/register.rb'
 require 'aemo/version.rb'
+require 'aemo/exceptions/invalid_nmi_allocation_type.rb'
 
 # AEMO Module to encapsulate all AEMO classes
 module AEMO

data/lib/data/xml_to_json.rb

@@ -24,8 +24,8 @@ CSV.parse(file_contents, headers: true, converters: :numeric).each do |row|
   row.headers.select { |x| x =~ /^FY\d{2}$/ }.sort.reverse.each do |fin_year|
     year = "20#{fin_year.match(/FY(\d{2})/)[1]}".to_i
     @mlf_data[row['TNI']][:loss_factors] << {
-      start: DateTime.parse("#{year - 1}-07-01T00:00:00+1000"),
-      finish: DateTime.parse("#{year}-07-01T00:00:00+1000"),
+      start: Time.parse("#{year - 1}-07-01T00:00:00+1000"),
+      finish: Time.parse("#{year}-07-01T00:00:00+1000"),
       value: row[fin_year]
     }
   end
@@ -62,8 +62,8 @@ end
       unless @mlf_data[code].nil?
         output_data_instance[:mlf_data] = @mlf_data[code].deep_dup
         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]
+          Time.parse(output_data_instance['ToDate']) < x[:start] ||
+            Time.parse(output_data_instance['FromDate']) >= x[:finish]
         end
         puts 'output_data_instance[:mlf_data][:loss_factors]: ' \
              "#{output_data_instance[:mlf_data][:loss_factors].inspect}"

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

@@ -16,14 +16,14 @@ describe AEMO::Market::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'))
+      expect(@interval.datetime).to eq(Time.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'))
+      expect(@interval.datetime(false)).to eq(Time.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'))
+      expect(@interval.datetime(false)).to eq(Time.parse('2016-03-01T00:25:00+1000'))
     end
     it 'has an interval length' do
       expect(@interval.interval_length).to eq(Time.at(300))

data/spec/lib/aemo/msats_spec.rb

@@ -48,15 +48,11 @@ describe AEMO::MSATS do
         end
 
         it 'should return a hash of information' do
-          expect(AEMO::MSATS.c4('4001234567', DateTime.now, DateTime.now, DateTime.now)).to be_a(Hash)
+          expect(AEMO::MSATS.c4('4001234567', Time.now, Time.now, Time.now)).to be_a(Hash)
         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 'invalid MSATS account' do
@@ -67,9 +63,9 @@ describe AEMO::MSATS do
         it 'should return response' do
           expect(AEMO::MSATS.c4(
             '4001234567',
-            DateTime.now,
-            DateTime.now,
-            DateTime.now
+            Time.now,
+            Time.now,
+            Time.now
           ).class).to eq(HTTParty::Response)
         end
       end