mumboe-currency 0.5

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
+
+
+

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

@@ -0,0 +1,198 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+require 'currency/exchange/rate/source/base'
+
+# A timed cache for rate sources.
+#
+# This class should be used at the top-level of a rate source change,
+# to correctly check rate dates.
+#
+class Currency::Exchange::Rate::Source::TimedCache < ::Currency::Exchange::Rate::Source::Base
+  # The rate source.
+  attr_accessor :source
+  
+  # Defines the number of seconds rates until rates
+  # become invalid, causing a request of new rates.
+  #
+  # Defaults to 600 seconds.
+  attr_accessor :time_to_live
+  
+  
+  # Defines the number of random seconds to add before
+  # rates become invalid.
+  #
+  # Defaults to 30 seconds.
+  attr_accessor :time_to_live_fudge
+
+
+  # Returns the time of the last load.
+  attr_reader :rate_load_time
+
+
+  # Returns the time of the next load.
+  attr_reader :rate_reload_time
+  
+
+  # Returns source's name.
+  def name
+    source.name
+  end
+  
+  
+  def initialize(*opt)
+    self.time_to_live = 600
+    self.time_to_live_fudge = 30
+    @rate_load_time = nil
+    @rate_reload_time = nil
+    @processing_rates = false
+    @cached_rates = { }
+    @cached_rates_old = nil
+    super(*opt)
+  end
+  
+  
+  # Clears current rates.
+  def clear_rates
+    @cached_rates = { }
+    @source.clear_rates
+    super
+  end
+  
+  
+  # Returns true if the cache of Rates
+  # is expired.
+  def expired?
+    if @time_to_live &&
+        @rate_reload_time &&
+        (Time.now > @rate_reload_time)
+      
+      if @cached_rates 
+        $stderr.puts "#{self}: rates expired on #{@rate_reload_time}" if @verbose
+        
+        @cached_rates_old = @cached_rates
+      end
+  
+      clear_rates
+      
+      true
+    else
+      false
+    end
+  end
+  
+  
+  # Check expired? before returning a Rate.
+  def rate(c1, c2, time)
+    if expired?
+      clear_rates
+    end
+    super(c1, c2, time)
+  end
+
+
+  def get_rate(c1, c2, time)
+    # STDERR.puts "get_rate #{c1} #{c2} #{time}"
+    rates = load_rates(time)
+    # STDERR.puts "rates = #{rates.inspect}"
+    rate = rates && (rates.select{|x| x.c1 == c1 && x.c2 == c2}[0])
+    # STDERR.puts "rate = #{rate.inspect}"
+    rate
+  end
+  
+
+  # Returns an array of all the cached Rates.
+  def rates(time = nil)
+    load_rates(time)
+  end
+
+
+  # Returns an array of all the cached Rates.
+  def load_rates(time = nil)
+    # Check expiration.
+    expired?
+    
+    # Return rates, if cached.
+    return rates if rates = @cached_rates["#{time}"]
+    
+    # Force load of rates.
+    rates = @cached_rates["#{time}"] = _load_rates_from_source(time)
+    
+    # Update expiration.
+    _calc_rate_reload_time
+
+    return nil unless rates
+
+    # Flush old rates.
+    @cached_rates_old = nil
+        
+    rates
+  end
+  
+
+  def time_to_live=(x)
+    @time_to_live = x
+    _calc_rate_reload_time
+    x
+  end
+
+
+  def time_to_live_fudge=(x)
+    @time_to_live_fudge = x
+    _calc_rate_reload_time
+    x
+  end
+
+
+  def _calc_rate_reload_time
+    if @time_to_live && @rate_load_time
+      @rate_reload_time = @rate_load_time + (@time_to_live + (@time_to_live_fudge || 0))
+      $stderr.puts "#{self}: rates expire on #{@rate_reload_time}" if @verbose
+    end
+
+  end
+
+
+
+  def _load_rates_from_source(time = nil) # :nodoc:
+    rates = nil
+
+    begin
+      # Do not allow re-entrancy
+      raise Currency::Exception::InvalidReentrancy, "Reentry!" if @processing_rates
+      
+      # Begin processing new rate request.
+      @processing_rates = true
+
+      # Clear cached Rates.
+      clear_rates
+
+      # Load rates from the source.
+      rates = source.load_rates(time)
+      
+      # Compute new rate timestamp.
+      @rate_load_time = Time.now
+
+      # STDERR.puts "rate_load_time = #{@rate_load_time}"
+    ensure
+      # End processsing new rate request.
+      @processing_rates = false
+    
+    end
+
+    # STDERR.puts "_load_rates => #{rates.inspect}"
+
+    rates
+  end
+
+
+  # Returns true if the underlying rate provider is available.
+  def available?(time = nil)
+    source.available?(time)
+  end
+
+
+end # class
+
+
+

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

@@ -0,0 +1,165 @@
+# 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'
+# Cant use REXML because of missing </form> tags -- 2007/03/11
+# require 'rexml/document'
+
+# Connects to http://xe.com and parses "XE.com Quick Cross Rates"
+# from home page HTML.
+#
+class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source::Provider
+
+  # Defines the pivot currency for http://xe.com/.
+  PIVOT_CURRENCY = :USD
+  
+  def initialize(*opt)
+    self.uri = 'http://xe.com/'
+    self.pivot_currency = PIVOT_CURRENCY
+    @raw_rates = nil
+    super(*opt)
+  end
+  
+
+  # Returns 'xe.com'.
+  def name
+    'xe.com'
+  end
+
+
+  def clear_rates
+    @raw_rates = nil
+    super
+  end
+  
+
+  # Returns a cached Hash of rates:
+  #
+  #    xe.raw_rates[:USD][:CAD] => 1.0134
+  #
+  def raw_rates
+    # Force load of rates
+    @raw_rates ||= parse_page_rates
+  end
+  
+  
+
+  # Parses http://xe.com homepage HTML for
+  # quick rates of 10 currencies.
+  def parse_page_rates(data = nil)
+    data = get_page_content unless data
+
+    @lines = data = data.split(/\n/);
+
+    # xe.com no longer gives date/time.
+    # Remove usecs.
+    time = Time.at(Time.new.to_i).getutc
+    @rate_timestamp = time
+
+    eat_lines_until /More currencies\.\.\.<\/a>/i
+    eat_lines_until /^\s*<tr>/i
+    eat_lines_until /^\s*<tr>/i
+    
+    # Read first table row to get position for each currency
+    currency = [ ]
+    eat_lines_until /^\s*<\/tr>/i do 
+      if md = /<td[^>]+?>.*?\/> ([A-Z][A-Z][A-Z])<\/td>/.match(@line)
+        cur = md[1].intern
+        cur_i = currency.size
+        currency.push(cur)
+        $stderr.puts "Found currency header: #{cur.inspect} at #{cur_i}" if @verbose
+      end
+    end
+    raise ParserError, "Currencies header not found" if currency.empty?
+    
+
+    # Skip until "1 USD ="
+    eat_lines_until /^\s*<td[^>]+?> 1&nbsp;+USD&nbsp;=/
+     
+    # Read first row of 1 USD = ...
+    rate = { }
+    cur_i = -1 
+    eat_lines_until /^\s*<\/tr>/i do 
+      # Grok:
+      #
+      #   <td align="center" class="cur2 currencyA">114.676</td>\n
+      #
+      # AND
+      #
+      #   <td align="center" class="cur2 currencyA"><div id="positionImage">0.9502\n
+      #
+      if md = /<td[^>]+?>\s*(<div[^>]+?>\s*)?(\d+\.\d+)\s*(<\/td>)?/i.match(@line)
+        usd_to_cur = md[2].to_f
+        cur_i = cur_i + 1
+        cur = currency[cur_i]
+        raise ParserError, "Currency not found at column #{cur_i}" unless cur
+        next if cur.to_s == PIVOT_CURRENCY.to_s
+        (rate[PIVOT_CURRENCY] ||= {})[cur] = usd_to_cur
+        (rate[cur] ||= { })[PIVOT_CURRENCY] ||= 1.0 / usd_to_cur
+        $stderr.puts "#{cur.inspect} => #{usd_to_cur}" if @verbose
+      end
+    end
+
+    raise ::Currency::Exception::UnavailableRates, "No rates found in #{get_uri.inspect}" if rate.keys.empty?
+
+    raise ParserError, 
+    [
+     "Not all currencies found", 
+     :expected_currences, currency,
+     :found_currencies, rate.keys,
+     :missing_currencies, currency - rate.keys,
+    ] if rate.keys.size != currency.size
+
+    @lines = @line = nil
+
+    raise ParserError, "Rate date not found" unless @rate_timestamp
+
+    rate
+  end
+
+
+  def eat_lines_until(rx)
+    until @lines.empty?
+      @line = @lines.shift
+      if md = rx.match(@line)
+        $stderr.puts "\nMATCHED #{@line.inspect} WITH #{rx.inspect} AT LINES:\n#{@lines[0..4].inspect}" if @verbose
+        return md
+      end
+      yield @line if block_given?
+    end
+
+    raise ParserError, [ 'eat_lines_until failed', :rx, rx ]
+
+    false
+  end
+
+  
+  # Return a list of known base rates.
+  def load_rates(time = nil)
+    if time
+      $stderr.puts "#{self}: WARNING CANNOT SUPPLY HISTORICAL RATES" unless @time_warning
+      @time_warning = true
+    end
+
+    rates = raw_rates # Load rates
+    rates_pivot = rates[PIVOT_CURRENCY]
+    raise ::Currency::Exception::UnknownRate,
+    [ 
+     "Cannot get base rate #{PIVOT_CURRENCY.inspect}",
+     :pivot_currency, PIVOT_CURRENCY,
+    ] unless rates_pivot
+    
+    result = rates_pivot.keys.collect do | c2 | 
+      new_rate(PIVOT_CURRENCY, c2, rates_pivot[c2], @rate_timestamp)
+    end
+    
+    result
+  end
+  
+ 
+end # class
+
+