wits 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d486df9ea65b9fc0058ab6a54a81f80ee477491
-  data.tar.gz: e5dce967f0e42aaa04db6b24c20177dd67b6de7d
+  metadata.gz: 78a6d79cfcfb5cccda3415c8fa81f34317bd850a
+  data.tar.gz: 5aa867c5cb08a6a729e230a37782a602d081d90a
 SHA512:
-  metadata.gz: 6c2ff151979604bcc99b5bb7652375e84e8277dac586e0ecaf4c2939e82b903e2bcdba8aee6506218c80c6e327af180f85d504d36b8175582717ba75da6998d9
-  data.tar.gz: eb4c654b03ecc246ecb25d8b331635eb50d6758280915876af2ae90fad9666009ed59cfa8d2ab5d3a72f6b0470d6856b3b913fd6d3c0129a43b01373db39c5f1
+  metadata.gz: fe82f8513478fc4191df3bb779f07cd720d3f66bf6617e106f0d40510c1e6ca2287b2c381db7d8cc41867d35dd2481055299176ae6bfa2864f4e8714ab648c45
+  data.tar.gz: '0494127501073ec93724ecbd69646a3fa40d3dfbb252cf34456deeca966580148b0ccd0d1d1aba548768767dc88bb7f241b35eb839ca7807ee0f8d0de88d0f58'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-1.1.1 / 2017-05-011
+1.2.0 / 2017-07-15
+------
+* Add support for forecast prices (PRS)
+
+1.1.1 / 2017-05-11
 ------
 * Change URL from www2.electricityinfo.co.nz to electricityinfo.co.nz
+* Update runtime and development dependencies
 
 1.1.0 / 2017-03-05
 ------

data/README.md

@@ -51,9 +51,9 @@ wits officially supports MRI Ruby 2.2+ and the JRuby equivalent. wits may work f
 
 ## Usage
 
-wits can retrieve [Final/Interim Prices](https://electricityinfo.co.nz/comitFta/ftaPage.pricesMain) and [5 Minute Prices](https://electricityinfo.co.nz/comitFta/five_min_prices.main) for a given node and date.
+wits can retrieve [Final/Interim/Forecast Prices](https://electricityinfo.co.nz/help/prices.html), and [5 Minute Prices](https://electricityinfo.co.nz/help/prices.html) for a given node and date.
 
-#### Final/Interim Prices
+#### Final/Interim/Forecast Prices
 Half-hourly final/interim prices can be retrieved in the following ways:
 
 ```ruby
@@ -67,6 +67,11 @@ Wits.interim_prices('ben2201') # Defaults to the day before yesterday
 Wits.interim_prices('BEN', '29/03/2015')
 Wits.interim_prices('ben', Time.parse('29/03/2015 13:37'))
 Wits.interim_prices('BEN2201', Date.parse('29/03/2015'))
+
+Wits.forecast_prices('ben2201') # Defaults to the day before yesterday
+Wits.forecast_prices('BEN', '29/03/2015')
+Wits.forecast_prices('ben', Time.parse('29/03/2015 13:37'))
+Wits.forecast_prices('BEN2201', Date.parse('29/03/2015'))
 ```
 
 If no date-like argument is provided, data for the day before yesterday will be retrieved.
@@ -81,6 +86,10 @@ Wits.ben2201_prices(Time.parse('29/03/2015 13:37'))
 Wits.ben_interim_prices
 Wits.benmore_interim_prices('29/03/2015')
 Wits.ben2201_interim_prices(Time.parse('29/03/2015 13:37'))
+
+Wits.ben_forecast_prices
+Wits.benmore_forecast_prices('29/03/2015')
+Wits.ben2201_forecast_prices(Time.parse('29/03/2015 13:37'))
 ```
 
 For Final prices, there are shorter methods without the `_prices` suffix.

data/lib/wits/final_interim_prices.rb

@@ -25,5 +25,10 @@ module Wits
     def interim_prices(node, date = nz_current_date - 1)
       prices(node, date, INTERIM)
     end
+
+    def forecast_prices(node, date = nz_current_date, type = FORECAST)
+      csv = request_prices(node, date, type)
+      parse_csv(csv, type)
+    end
   end
 end

data/lib/wits/final_interim_prices/convenience_methods.rb

@@ -9,6 +9,7 @@ module Wits
           node_methods(node, name)
           node_prices_methods(node, name)
           node_interim_prices_methods(node, name)
+          node_forecast_prices_methods(node, name)
         end
       end
 
@@ -47,6 +48,17 @@ module Wits
         create_interim_prices_method(name.downcase.tr(' ', '_'), node)
       end
 
+      def self.node_forecast_prices_methods(node, name)
+        # def ben2201_forecast_prices
+        create_forecast_method(node.downcase, node)
+
+        # def hay_forecast_prices
+        create_forecast_method(node.downcase[0..2], node)
+
+        # def halfway_bush_forecast_prices
+        create_forecast_method(name.downcase.tr(' ', '_'), node)
+      end
+
       def self.create_prices_method(method_name, node)
         define_method method_name do |*args|
           prices(node, *args)
@@ -58,6 +70,12 @@ module Wits
           interim_prices(node, *args)
         end
       end
+
+      def self.create_forecast_method(method_prefix, node)
+        define_method "#{method_prefix}_forecast_prices" do |*args|
+          forecast_prices(node, *args)
+        end
+      end
     end
   end
 end

data/lib/wits/price_codes.rb

@@ -4,19 +4,22 @@ module Wits
     INTERIM = :interim
     AVERAGE = :average
     FIVE_MINUTE = :five_minute
+    FORECAST = :forecast
 
     PRICE_TYPES = {
       FINAL => 'F',
       INTERIM => 'T',
       AVERAGE => '5',
-      FIVE_MINUTE => 'I'
+      FIVE_MINUTE => 'I',
+      FORECAST => 'A'
     }.freeze
 
     PRICE_DESCRIPTION = {
       FINAL => 'Final',
       INTERIM => 'Interim',
       AVERAGE => 'Average Five Minute',
-      FIVE_MINUTE => 'Five Minute'
+      FIVE_MINUTE => 'Five Minute',
+      FORECAST => 'Forecast'
     }.freeze
   end
 end

data/lib/wits/version.rb

@@ -1,3 +1,3 @@
 module Wits
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/wits.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wits/version'
@@ -15,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://www.github.com/gchan/wits'
   spec.license       = 'MIT'
 
-  spec.files         = Dir['lib/**/*.rb'] + %w(CHANGELOG.md LICENSE.txt README.md wits.gemspec)
+  spec.files         = Dir['lib/**/*.rb'] + %w[CHANGELOG.md LICENSE.txt README.md wits.gemspec]
   spec.bindir        = 'bin'
   spec.require_paths = ['lib']
   spec.platform      = Gem::Platform::RUBY
@@ -34,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'multi_json', '~> 1.12.1'
   spec.add_development_dependency 'timecop', '~> 0.8.1'
   spec.add_development_dependency 'simplecov', '~> 0.14.1'
-  spec.add_development_dependency 'rubocop', '~> 0.48.1'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
   spec.add_development_dependency 'coveralls', '~> 0.8.19'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.5'
   spec.add_development_dependency 'tins', '~> 1.13.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wits
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Gordon Chan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.49.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement