wits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e619dbc0e8e27a5dc2b90905bdb7e2d79d6df257
+  data.tar.gz: 274e2cac8a4ad516ef112edcd763cb5acf1bc030
+SHA512:
+  metadata.gz: 4559b72384b3e94e4233503e6edcbfa6c343bd70a176094b83bef7fd14e5d43155b9e8eb4ef80b6eb3e5a47dd5610620563319b46a88fcbd668f772e900d8e41
+  data.tar.gz: 40ef592b050dd51d134df1d55823dabd95c671d0c9c4ce3c43e412fd20748cb78efaf5df8b6999febe9dc16736dcef4a231ea8888204c4bb0812a81d84cc63b1

data/lib/wits/client.rb

@@ -0,0 +1,52 @@
+require 'wits/error'
+
+#
+# A wrapper for the chosen HTTP library that can be easily replaced
+# while keeping the Wits API and error classes consistent
+#
+module Wits
+  module Client
+    def self.get_csv(*args, &block)
+      response = get(*args, &block)
+
+      check_for_data(response)
+
+      response
+    end
+
+    def self.get(*args, &block)
+      client.get(*args, &block)
+    rescue Faraday::ClientError => error
+      handle_error(error)
+    end
+
+    def self.client
+      @client ||= Faraday.new(url: 'http://www.electricityinfo.co.nz')
+    end
+
+    private
+
+    # WITS is buggy and doesn't use status codes.
+    # This is the most reliable method of determining whether
+    # we actually have a meaningful CSV file
+    def self.check_for_data(response)
+      return unless response.body =~ /html/i ||
+                    response.body.length < 300
+
+      fail Wits::Error::ResourceNotFound
+    end
+
+    def self.handle_error(error)
+      case error
+      when Faraday::ConnectionFailed
+        raise Wits::Error::ConnectionFailed.new error
+      when Faraday::ResourceNotFound
+        raise Wits::Error::ResourceNotFound.new error
+      when Faraday::TimeoutError
+        raise Wits::Error::TimeoutError.new error
+      else # Faraday::ClientError
+        raise Wits::Error::ClientError.new error
+      end
+    end
+  end
+end

data/lib/wits/error.rb

@@ -0,0 +1,18 @@
+module Wits
+  class Error < StandardError
+    # Generic Client Error
+    ClientError = Class.new(Error)
+
+    # ConnectionFailed from Faraday
+    ConnectionFailed = Class.new(ClientError)
+
+    # TimeoutError from Faraday
+    TimeoutError = Class.new(ClientError)
+
+    # No data available from Wits
+    ResourceNotFound = Class.new(ClientError)
+
+    # Unexpected error when parsing data
+    ParsingError = Class.new(ClientError)
+  end
+end

data/lib/wits/final_interim_prices/convenience_methods.rb

@@ -0,0 +1,40 @@
+require 'wits/nodes'
+
+module Wits
+  module FinalInterimPrices
+    module ConvenienceMethods
+      Wits::Nodes.nodes.each do |node, name|
+        # def ben2201
+        define_method node.downcase do |*args|
+          prices(node, *args)
+        end
+
+        # def hay
+        define_method node.downcase[0..2] do |*args|
+          prices(node, *args)
+        end
+
+        # def halfway_bush
+        define_method name.downcase.tr(' ', '_') do |*args|
+          prices(node, *args)
+        end
+
+
+        # def ben2201_prices
+        define_method "#{node.downcase}_prices" do |*args|
+          prices(node, *args)
+        end
+
+        # def hay_prices
+        define_method "#{node.downcase[0..2]}_prices" do |*args|
+          prices(node, *args)
+        end
+
+        # def halfway_bush_prices
+        define_method "#{name.downcase.tr(' ', '_')}_prices" do |*args|
+          prices(node, *args)
+        end
+      end
+    end
+  end
+end

data/lib/wits/final_interim_prices.rb

@@ -0,0 +1,70 @@
+require 'csv'
+require 'wits/nodes'
+require 'wits/helpers'
+require 'wits/client'
+require 'wits/error'
+require 'wits/final_interim_prices/convenience_methods'
+
+module Wits
+  module FinalInterimPrices
+    extend self
+    extend Helpers
+    extend ConvenienceMethods
+
+    def self.extended(base)
+      base.extend Helpers
+      base.extend ConvenienceMethods
+    end
+
+    def prices(node, date = Date.today - 2)
+      node = format_node(node)
+      date = format_date(date)
+
+      request_prices(node, date)
+    end
+
+    private
+
+    def request_prices(node, date)
+      response = Wits::Client.get_csv do |request|
+        request.url(
+          'comitFta/ftaPage.download',
+          pNode: node,
+          pDate: date
+        )
+      end
+
+      parse_prices_csv(response.body)
+    end
+
+    def parse_prices_csv(csv)
+      csv = CSV.parse(csv)
+
+      price_type, node, date = read_prices_header(csv)
+      prices                 = process_prices(csv, date)
+
+      format_prices(node, date, prices, price_type)
+    rescue StandardError => error
+      raise Wits::Error::ParsingError.new(error)
+    end
+
+    def read_prices_header(csv)
+      header_regexp = %r{(.*) Prices for Node (.{3}\d{4}) on (\d{2}\/\d{2}\/\d{4})}
+
+      header = csv.shift.shift
+      price_type, node, date = header.match(header_regexp).captures
+
+      date = Date.parse date
+
+      csv.shift # discard second header
+
+      [price_type, node, date]
+    end
+
+    def process_prices(csv, date)
+      csv.map do |time, trading_period, price|
+        format_price(date, time, trading_period, price)
+      end
+    end
+  end
+end

data/lib/wits/five_minute_prices/convenience_methods.rb

@@ -0,0 +1,40 @@
+require 'wits/nodes'
+
+module Wits
+  module FiveMinutePrices
+    module ConvenienceMethods
+      Wits::Nodes.nodes.each do |node, name|
+        # def ben2201_five_minute_prices
+        define_method "#{node.downcase}_five_minute_prices" do |*args|
+          five_minute_prices(node, *args)
+        end
+
+        # def hay_five_minute_prices
+        define_method "#{node.downcase[0..2]}_five_minute_prices" do |*args|
+          five_minute_prices(node, *args)
+        end
+
+        # def halfway_bush_five_minute_prices
+        define_method "#{name.downcase.tr(' ', '_')}_five_minute_prices" do |*args|
+          five_minute_prices(node, *args)
+        end
+
+
+        # def ben2201_avgerage_five_minute_prices
+        define_method "#{node.downcase}_average_five_minute_prices" do |*args|
+          average_five_minute_prices(node, *args)
+        end
+
+        # def hay_avgerage_five_minute_prices
+        define_method "#{node.downcase[0..2]}_average_five_minute_prices" do |*args|
+          average_five_minute_prices(node, *args)
+        end
+
+        # def halfway_bush_avgerage_five_minute_prices
+        define_method "#{name.downcase.tr(' ', '_')}_average_five_minute_prices" do |*args|
+          average_five_minute_prices(node, *args)
+        end
+      end
+    end
+  end
+end

data/lib/wits/five_minute_prices.rb

@@ -0,0 +1,86 @@
+require 'csv'
+require 'wits/nodes'
+require 'wits/helpers'
+require 'wits/client'
+require 'wits/error'
+require 'wits/five_minute_prices/convenience_methods'
+
+module Wits
+  module FiveMinutePrices
+    extend self
+    extend Helpers
+    extend ConvenienceMethods
+
+    def self.extended(base)
+      base.extend Helpers
+      base.extend ConvenienceMethods
+    end
+
+    def average_five_minute_prices(node, date = Date.today - 2)
+      five_minute_prices(node, date, :average)
+    end
+
+    def five_minute_prices(node, date = Date.today - 2, type = :price )
+      node = format_node(node)
+      date = format_date(date)
+      type = format_price_type(type)
+
+      request_five_min_prices(node, date, type)
+    end
+
+    private
+
+    def format_price_type(type)
+      if type == :price
+        'Price'
+      else
+        'Average'
+      end
+    end
+
+    def request_five_min_prices(node, date, type)
+      response = Wits::Client.get_csv do |request|
+        request.url(
+          'comitFta/five_min_prices.download',
+          INchoice:    'SEL', # Mandatory
+          INdate:       date,
+          INgip:        node,
+          INperiodfrom: 1,
+          INperiodto:   50,
+          INtype:       type
+        )
+      end
+
+      parse_five_min_csv(response.body, type)
+    end
+
+    def parse_five_min_csv(csv, type)
+      csv = CSV.parse(csv.sub("\r\n", "\n"))
+
+      node, date = process_five_min_metadata(csv)
+      prices     = process_five_min_prices(csv)
+      price_type = 'Five Minute'
+
+      price_type = "Average #{price_type}" if type == 'Average'
+
+      format_prices(node, date, prices, price_type)
+    rescue StandardError => error
+      raise Wits::Error::ParsingError.new(error)
+    end
+
+    def process_five_min_metadata(csv)
+      csv.shift # discard header
+
+      node = csv.first[0]
+      date = Date.parse csv.first[1]
+
+      [node, date]
+    end
+
+    def process_five_min_prices(csv)
+      csv.map do |_node, date, trading_period, time, price, *_|
+        format_price(date, time, trading_period, price)
+      end
+    end
+  end
+end

data/lib/wits/helpers.rb

@@ -0,0 +1,55 @@
+require 'tzinfo'
+require 'wits/nodes'
+
+module Wits
+  module Helpers
+    private
+
+    def format_node(node)
+      node = node.to_s.upcase
+
+      if node.length == 3
+        Wits::Nodes.node_short_codes[node.to_sym]
+      else
+        node
+      end
+    end
+
+    def format_date(date)
+      if date.respond_to?(:strftime)
+        date.strftime('%d/%m/%Y')
+      else
+        date
+      end
+    end
+
+    def format_price(date, time, trading_period, price)
+      {
+        time: parse_nz_time(date, time),
+        trading_period: trading_period.to_i,
+        price: price.to_f
+      }
+    end
+
+    def format_prices(node, date, prices, price_type)
+      {
+        node_code: node,
+        node_short_code: node[0..2],
+        node_name: Wits::Nodes.nodes[node.to_sym],
+        price_type: price_type,
+        date: date,
+        prices: prices.sort_by { |price| price[:time] }
+      }
+    end
+
+    def parse_nz_time(date, time)
+      tz = TZInfo::Timezone.get('Pacific/Auckland')
+
+      # Timezone information of the Time object is ignored by TZInfo
+      time = Time.parse("#{date} #{time}")
+
+      # Output in local time
+      tz.local_to_utc(time).localtime
+    end
+  end
+end

data/lib/wits/nodes.rb

@@ -0,0 +1,47 @@
+module Wits
+  module Nodes
+    extend self
+
+    NODES = {
+      BEN2201: 'Benmore',
+      HWB2201: 'Halfway Bush',
+      HAY2201: 'Haywards',
+      HLY2201: 'Huntly',
+      INV2201: 'Invercargill',
+      ISL2201: 'Islington',
+      OTA2201: 'Otahuhu',
+      STK2201: 'Stoke',
+      SFD2201: 'Stratford',
+      TUI1101: 'Tuai',
+      WKM2201: 'Whakamaru'
+    }.freeze
+
+    NODE_NAMES = NODES.invert.freeze
+
+    SHORT_CODES = {
+      BEN: 'BEN2201',
+      HWB: 'HWB2201',
+      HAY: 'HAY2201',
+      HLY: 'HLY2201',
+      INV: 'INV2201',
+      ISL: 'ISL2201',
+      OTA: 'OTA2201',
+      STK: 'STK2201',
+      SFD: 'SFD2201',
+      TUI: 'TUI1101',
+      WKM: 'WKM2201'
+    }.freeze
+
+    def nodes
+      NODES
+    end
+
+    def node_names
+      NODE_NAMES
+    end
+
+    def node_short_codes
+      SHORT_CODES
+    end
+  end
+end

data/lib/wits/version.rb

@@ -0,0 +1,3 @@
+module Wits
+  VERSION = "0.1.0"
+end

data/lib/wits.rb

@@ -0,0 +1,12 @@
+require 'faraday'
+
+require 'wits/version'
+require 'wits/nodes'
+require 'wits/final_interim_prices'
+require 'wits/five_minute_prices'
+
+module Wits
+  extend Wits::Nodes
+  extend Wits::FinalInterimPrices
+  extend Wits::FiveMinutePrices
+end

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: wits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gordon Chan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: |-
+  This client library interfaces with WITS (Wholesale and
+      information trading system) to fetch New Zealand electricity data, preparing it
+      to be consumed by Ruby code.
+email:
+- developer.gordon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wits.rb
+- lib/wits/client.rb
+- lib/wits/error.rb
+- lib/wits/final_interim_prices.rb
+- lib/wits/final_interim_prices/convenience_methods.rb
+- lib/wits/five_minute_prices.rb
+- lib/wits/five_minute_prices/convenience_methods.rb
+- lib/wits/helpers.rb
+- lib/wits/nodes.rb
+- lib/wits/version.rb
+homepage: https://www.github.com/gchan/wits
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Retrieves electricity data from WITS Free to Air
+test_files: []
+has_rdoc: