aemo 0.2.1 → 0.3.0.pre.rc1

data/spec/lib/aemo/nmi/allocation_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe AEMO::NMI::Allocation do
+  # ---
+  # CLASS METHODS
+  # ---
+  describe '.all' do
+    it 'should return an array of all the Allocations' do
+      expect(AEMO::NMI::Allocation.all).to be_a Array
+      expect(AEMO::NMI::Allocation.all.first).to be_a AEMO::NMI::Allocation
+    end
+  end
+
+  describe '.each' do
+    it 'should return an enumerable of all the Allocations' do
+      expect(AEMO::NMI::Allocation.each).to be_a Enumerable
+    end
+  end
+
+  describe '.first' do
+    it 'should return the first Allocation' do
+      expect(AEMO::NMI::Allocation.first).to be_a AEMO::NMI::Allocation
+    end
+  end
+
+  # ---
+  # INSTANCE METHODS
+  # ---
+  describe '#initialize' do
+    context 'valid' do
+      it 'should return an Allocation' do
+        expect(AEMO::NMI::Allocation.new('My great LNSP', :electricity)).to be_a AEMO::NMI::Allocation
+        expect(AEMO::NMI::Allocation.new('My great LNSP', 'electricity')).to be_a AEMO::NMI::Allocation
+        expect(AEMO::NMI::Allocation.new('My great gas LNSP', :gas)).to be_a AEMO::NMI::Allocation
+        expect(AEMO::NMI::Allocation.new('My great gas LNSP', 'gas')).to be_a AEMO::NMI::Allocation
+      end
+    end
+    context 'invalid' do
+      it 'should raise an InvalidNMIAllocationType error' do
+        expect { AEMO::NMI::Allocation.new('My terrible LNSP', :water) }.to raise_error AEMO::InvalidNMIAllocationType
+        expect { AEMO::NMI::Allocation.new('My terrible LNSP', :broccoli) }.to raise_error AEMO::InvalidNMIAllocationType
+        expect { AEMO::NMI::Allocation.new('My terrible LNSP', 'Ch4') }.to raise_error AEMO::InvalidNMIAllocationType
+        expect { AEMO::NMI::Allocation.new('My terrible LNSP', 'Natural gas') }.to raise_error AEMO::InvalidNMIAllocationType
+        expect { AEMO::NMI::Allocation.new('My terrible LNSP', :coal) }.to raise_error AEMO::InvalidNMIAllocationType
+      end
+    end
+  end
+end

data/spec/lib/aemo/nmi_spec.rb

@@ -9,11 +9,6 @@ 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)
@@ -57,10 +52,10 @@ describe AEMO::NMI do
     end
   end
 
-  describe '.network?(nmi)' do
+  describe '.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')
+      expect(network.title).to eq('Ausgrid')
     end
     it 'should return NIL for an unallocated NMI' do
       network = AEMO::NMI.network('ZZZZZZZZZZZZ')
@@ -68,6 +63,17 @@ describe AEMO::NMI do
     end
   end
 
+  describe '.allocation(nmi)' do
+    it 'should return an Allocation for a NMI' do
+      allocation = AEMO::NMI.allocation('NCCCC00000')
+      expect(allocation.title).to eq('Ausgrid')
+    end
+    it 'should return NIL for an unallocated NMI' do
+      allocation = AEMO::NMI.allocation('ZZZZZZZZZZZZ')
+      expect(allocation).to eq(nil)
+    end
+  end
+
   # ---
   # INSTANCE METHODS
   # ---
@@ -131,7 +137,9 @@ describe AEMO::NMI do
     it 'should return a network for a valid NMI' do
       json.each do |nmi|
         a_nmi = AEMO::NMI.new(nmi['nmi'])
-        expect(a_nmi.network.class).to eq(Hash) unless a_nmi.network.nil?
+        next if a_nmi.network.nil?
+        expect(a_nmi.network).to be_a AEMO::NMI::Allocation
+        expect(a_nmi.allocation).to be_a AEMO::NMI::Allocation
       end
     end
     # Negative test cases

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aemo
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0.pre.rc1
 platform: ruby
 authors:
 - Joel Courtney
@@ -13,99 +13,99 @@ cert_chain: []
 date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 4.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 4.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 0.15.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 0.15.6
 - !ruby/object:Gem::Dependency
-  name: multi_xml
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.7.5
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.6
-    - - "<"
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.6
-    - - "<"
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -252,20 +252,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.52.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.52.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.52.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.52.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -358,6 +358,7 @@ extra_rdoc_files: []
 files:
 - lib/aemo.rb
 - lib/aemo/dispatchable.rb
+- lib/aemo/exceptions/invalid_nmi_allocation_type.rb
 - lib/aemo/market.rb
 - lib/aemo/market/interval.rb
 - lib/aemo/market/node.rb
@@ -366,6 +367,7 @@ files:
 - lib/aemo/nem12.rb
 - lib/aemo/nem13.rb
 - lib/aemo/nmi.rb
+- lib/aemo/nmi/allocation.rb
 - lib/aemo/region.rb
 - lib/aemo/register.rb
 - lib/aemo/version.rb
@@ -494,6 +496,7 @@ files:
 - spec/lib/aemo/meter_spec.rb
 - spec/lib/aemo/msats_spec.rb
 - spec/lib/aemo/nem12_spec.rb
+- spec/lib/aemo/nmi/allocation_spec.rb
 - spec/lib/aemo/nmi_spec.rb
 - spec/lib/aemo/region_spec.rb
 - spec/spec.opts
@@ -510,12 +513,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6
@@ -641,6 +644,7 @@ test_files:
 - spec/lib/aemo/meter_spec.rb
 - spec/lib/aemo/msats_spec.rb
 - spec/lib/aemo/nem12_spec.rb
+- spec/lib/aemo/nmi/allocation_spec.rb
 - spec/lib/aemo/nmi_spec.rb
 - spec/lib/aemo/region_spec.rb
 - spec/spec.opts