acvwilson-acvwilson-currency 0.5.0

data/lib/currency/exchange/rate/source/new_york_fed.rb

@@ -0,0 +1,127 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+require 'currency/exchange/rate/source/base'
+
+require 'net/http'
+require 'open-uri'
+require 'rexml/document'
+
+
+# Connects to http://www.newyorkfed.org/markets/fxrates/FXtoXML.cfm
+# ?FEXdate=2007%2D02%2D14%2000%3A00%3A00%2E0&FEXtime=1200 and parses XML.
+#
+# No rates are available on Saturday and Sunday.
+#
+class Currency::Exchange::Rate::Source::NewYorkFed < ::Currency::Exchange::Rate::Source::Provider
+  # Defines the pivot currency for http://xe.com/.
+  PIVOT_CURRENCY = :USD
+  
+  def initialize(*opt)
+    self.uri = 'http://www.newyorkfed.org/markets/fxrates/FXtoXML.cfm?FEXdate=#{date_YYYY}%2D#{date_MM}%2D#{date_DD}%2000%3A00%3A00%2E0&FEXTIME=1200'
+    @raw_rates = nil
+    super(*opt)
+  end
+  
+
+  # Returns 'newyorkfed.org'.
+  def name
+    'newyorkfed.org'
+  end
+
+
+  # New York Fed rates are not available on Saturday and Sunday.
+  def available?(time = nil)
+    time ||= Time.now
+    ! [0, 6].include?(time.wday) ? true : false
+  end
+
+
+  def clear_rates
+    @raw_rates = nil
+    super
+  end
+  
+
+  def raw_rates
+    rates
+    @raw_rates
+  end
+  
+
+  # The fed swaps rates on some currency pairs!
+  # See http://www.newyorkfed.org/markets/fxrates/noon.cfm (LISTS AUD!)
+  # http://www.newyorkfed.org/xml/fx.html (DOES NOT LIST AUD!)
+  @@swap_units = {
+    :AUD => true,
+    :EUR => true,
+    :NZD => true,
+    :GBP => true,
+  }
+
+
+  # Parses XML for rates.
+  def parse_rates(data = nil)
+    data = get_page_content unless data
+    
+    rates = [ ]
+
+    @raw_rates = { }
+
+    $stderr.puts "#{self}: parse_rates: data =\n#{data}" if @verbose
+
+    doc = REXML::Document.new(data).root
+    x_series = doc.elements.to_a('//frbny:Series')
+    raise ParserError, "no UNIT attribute" unless x_series
+    x_series.each do | series |
+      c1 = series.attributes['UNIT'] # WHAT TO DO WITH @UNIT_MULT?
+      raise ParserError, "no UNIT attribute" unless c1
+      c1 = c1.upcase.intern
+
+      c2 = series.elements.to_a('frbny:Key/frbny:CURR')[0].text
+      raise ParserError, "no frbny:CURR element" unless c2
+      c2 = c2.upcase.intern
+      
+      rate = series.elements.to_a('frbny:Obs/frbny:OBS_VALUE')[0]
+      raise ParserError, 'no frbny:OBS_VALUE' unless rate
+      rate = rate.text.to_f
+
+      date = series.elements.to_a('frbny:Obs/frbny:TIME_PERIOD')[0]
+      raise ParserError, 'no frbny:TIME_PERIOD' unless date
+      date = date.text
+      date = Time.parse("#{date} 12:00:00 -05:00") # USA NY => EST
+
+      # Handle arbitrary rate reciprocals!
+      if @@swap_units[c1] || @@swap_units[c2]
+        c1, c2 = c2, c1
+      end
+
+      rates << new_rate(c1, c2, rate, date)
+
+      (@raw_rates[c1] ||= { })[c2] ||= rate
+      (@raw_rates[c2] ||= { })[c1] ||= 1.0 / rate
+    end
+
+    # $stderr.puts "rates = #{rates.inspect}"
+    raise ::Currency::Exception::UnavailableRates, 
+    [
+     "No rates found in #{get_uri.inspect}",
+     :uri, get_uri,
+    ] if rates.empty?
+
+    rates
+  end
+  
+  
+  # Return a list of known base rates.
+  def load_rates(time = nil)
+    # $stderr.puts "#{self}: load_rates(#{time})" if @verbose
+    self.date = time
+    parse_rates
+  end
+  
+ 
+end # class
+
+
+

data/lib/currency/exchange/rate/source/provider.rb

@@ -0,0 +1,120 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+require 'currency/exchange/rate/source'
+
+
+# Base class for rate data providers.
+# Assumes that rate sources provide more than one rate per query.
+class Currency::Exchange::Rate::Source::Provider < Currency::Exchange::Rate::Source::Base
+
+  # Error during parsing of rates.
+  class ParserError < ::Currency::Exception::RateSourceError; end
+
+  # The URI used to access the rate source.
+  attr_accessor :uri
+  
+  # The URI path relative to uri used to access the rate source.
+  attr_accessor :uri_path
+  
+  # The Time used to query the rate source.
+  # Typically set by #load_rates.
+  attr_accessor :date
+
+  # The name is the same as its #uri.
+  alias :name :uri 
+  
+  def initialize(*args)
+    super
+    @rates = { }
+  end
+
+  # Returns the date to query for rates.
+  # Defaults to yesterday.
+  def date
+    @date || (Time.now - 24 * 60 * 60) # yesterday.
+  end
+
+
+  # Returns year of query date.
+  def date_YYYY
+    '%04d' % date.year
+  end
+
+
+  # Return month of query date.
+  def date_MM
+    '%02d' % date.month
+  end
+
+
+  # Returns day of query date.
+  def date_DD
+    '%02d' % date.day
+  end
+
+
+  # Returns the URI string as evaluated with this object.
+  def get_uri
+    uri = self.uri
+    uri = "\"#{uri}\""
+    uri = instance_eval(uri)
+    $stderr.puts "#{self}: uri = #{uri.inspect}" if @verbose
+    uri
+  end
+
+
+  # Returns the URI content.
+  def get_page_content
+    data = open(get_uri) { |data| data.read }
+    
+    data
+  end
+
+
+  # Clear cached rates from this source.
+  def clear_rates
+    @rates.clear
+    super
+  end
+
+
+  # Returns current base Rates or calls load_rates to load them from the source.
+  def rates(time = nil)
+    time = time && normalize_time(time)
+    @rates["#{time}"] ||= load_rates(time)
+  end
+  
+
+  # Returns an array of base Rates from the rate source.
+  #
+  # Subclasses must define this method.
+  def load_rates(time = nil)
+    raise Currency::Exception::SubclassResponsibility, :load_rates
+  end
+
+
+  # Return a matching base rate.
+  def get_rate(c1, c2, time)
+    rates.each do | rate |
+      return rate if 
+        rate.c1 == c1 &&
+        rate.c2 == c2 &&
+        (! time || normalize_time(rate.date) == time)
+    end
+
+    nil
+  end
+
+  alias :get_rate_base :get_rate
+
+
+  # Returns true if a rate provider is available.
+  def available?(time = nil)
+    true
+  end
+
+end # class
+
+
+

data/lib/currency/exchange/rate/source/test.rb

@@ -0,0 +1,50 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+require 'currency/exchange/rate/source/provider'
+
+# This class is a test Rate Source.
+# It can provide only fixed rates between USD, CAD and EUR.
+# Used only for test purposes.
+# DO NOT USE THESE RATES FOR A REAL APPLICATION.
+class Currency::Exchange::Rate::Source::Test < Currency::Exchange::Rate::Source::Provider
+    @@instance = nil
+
+    # Returns a singleton instance.
+    def self.instance(*opts)
+      @@instance ||= self.new(*opts)
+    end
+
+
+    def initialize(*opts)
+     self.uri = 'none://localhost/Test'
+     super(*opts)
+    end
+
+
+    def name
+      'Test'
+    end
+
+    # Test rate from :USD to :CAD.
+    def self.USD_CAD; 1.1708; end
+
+
+    # Test rate from :USD to :EUR.
+    def self.USD_EUR; 0.7737; end
+
+
+    # Test rate from :USD to :GBP.
+    def self.USD_GBP; 0.5098; end
+
+
+    # Returns test Rate for USD to [ CAD, EUR, GBP ]. 
+    def rates
+      [ new_rate(:USD, :CAD, self.class.USD_CAD),
+        new_rate(:USD, :EUR, self.class.USD_EUR),
+        new_rate(:USD, :GBP, self.class.USD_GBP) ]
+    end
+
+end # class
+
+

data/lib/currency/exchange/rate/source/the_financials.rb

@@ -0,0 +1,191 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+require 'currency/exchange/rate/source/base'
+
+require 'net/http'
+require 'open-uri'
+require 'rexml/document'
+
+
+# Connects to http://www.thefinancials.com and parses XML.
+#
+# This is for demonstration purposes.
+#
+class Currency::Exchange::Rate::Source::TheFinancials < ::Currency::Exchange::Rate::Source::Provider
+  # Defines the pivot currency for http://thefinancials.com/.
+  PIVOT_CURRENCY = :USD
+  
+  def initialize(*opt)
+    @raw_rates = nil
+    self.uri_path = 'syndicated/UNKNOWN/fxrates.xml'
+    super(*opt)
+    self.uri = "http://www.thefinancials.com/#{self.uri_path}"
+  end
+  
+
+  # Returns 'thefinancials.com'.
+  def name
+    'thefinancials.org'
+  end
+
+
+#  def get_page_content
+#    test_content
+#  end
+
+
+  def clear_rates
+    @raw_rates = nil
+    super
+  end
+  
+
+  def raw_rates
+    rates
+    @raw_rates
+  end
+
+
+  # Parses XML for rates.
+  def parse_rates(data = nil)
+    data = get_page_content unless data
+    
+    rates = [ ]
+
+    @raw_rates = { }
+
+    # $stderr.puts "parse_rates: data = #{data}"
+
+    doc = REXML::Document.new(data).root
+    doc.elements.to_a('//record').each do | record |
+      c1_c2 = record.elements.to_a('symbol')[0].text
+      md = /([A-Z][A-Z][A-Z]).*?([A-Z][A-Z][A-Z])/.match(c1_c2)
+      c1, c2 = md[1], md[2]
+
+      c1 = c1.upcase.intern
+      c2 = c2.upcase.intern
+      
+      rate = record.elements.to_a('last')[0].text.to_f
+
+      date = record.elements.to_a('date')[0].text
+      date = Time.parse("#{date} 12:00:00 -05:00") # USA NY => EST
+
+      rates << new_rate(c1, c2, rate, date)
+
+      (@raw_rates[c1] ||= { })[c2] ||= rate
+    end
+
+    rates
+  end
+  
+  
+  # Return a list of known base rates.
+  def load_rates(time = nil)
+    self.date = time
+    parse_rates
+  end
+  
+ 
+  def test_content
+    <<EOF
+<?xml version="1.0" ?> 
+<TFCRecords>
+<record>
+<symbol>USD/EUR</symbol> 
+<date>10/25/2001</date> 
+<last>1.115822</last> 
+</record>
+<record>
+<symbol>USD/AUD</symbol> 
+<date>10/25/2001</date> 
+<last>1.975114</last> 
+</record>
+<record>
+<symbol>USD/CAD</symbol> 
+<date>10/25/2001</date> 
+<last>1.57775</last> 
+</record>
+<record>
+<symbol>USD/CNY</symbol> 
+<date>10/25/2001</date> 
+<last>8.2769</last> 
+</record>
+<record>
+<symbol>USD/ESP</symbol> 
+<date>10/25/2001</date> 
+<last>185.65725</last> 
+</record>
+<record>
+<symbol>USD/GBP</symbol> 
+<date>10/25/2001</date> 
+<last>0.698849867830019</last> 
+</record>
+<record>
+<symbol>USD/HKD</symbol> 
+<date>10/25/2001</date> 
+<last>7.7999</last> 
+</record>
+<record>
+<symbol>USD/IDR</symbol> 
+<date>10/25/2001</date> 
+<last>10265</last> 
+</record>
+<record>
+<symbol>USD/INR</symbol> 
+<date>10/25/2001</date> 
+<last>48.01</last> 
+</record>
+<record>
+<symbol>USD/JPY</symbol> 
+<date>10/25/2001</date> 
+<last>122.68</last> 
+</record>
+<record>
+<symbol>USD/KRW</symbol> 
+<date>10/25/2001</date> 
+<last>1293.5</last> 
+</record>
+<record>
+<symbol>USD/MYR</symbol> 
+<date>10/25/2001</date> 
+<last>3.8</last> 
+</record>
+<record>
+<symbol>USD/NZD</symbol> 
+<date>10/25/2001</date> 
+<last>2.41485</last> 
+</record>
+<record>
+<symbol>USD/PHP</symbol> 
+<date>10/25/2001</date> 
+<last>52.05</last> 
+</record>
+<record>
+<symbol>USD/PKR</symbol> 
+<date>10/25/2001</date> 
+<last>61.6</last> 
+</record>
+<record>
+<symbol>USD/SGD</symbol> 
+<date>10/25/2001</date> 
+<last>1.82615</last> 
+</record>
+<record>
+<symbol>USD/THB</symbol> 
+<date>10/25/2001</date> 
+<last>44.88</last> 
+</record>
+<record>
+<symbol>USD/TWD</symbol> 
+<date>10/25/2001</date> 
+<last>34.54</last> 
+</record>
+</TFCRecords>
+EOF
+  end
+
+end # class
+
+
+