currency 0.3.3 → 0.4.0

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

@@ -0,0 +1,190 @@
+# 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)
+    self.uri = 'http://www.thefinancials.com/XXXXXXX'
+    @raw_rates = nil
+    super(*opt)
+  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,144 @@
+# 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 source's name.
+  def name
+    source.name
+  end
+  
+  
+  def initialize(*opt)
+    self.time_to_live = 600
+    self.time_to_live_fudge = 30
+    @rate_timestamp = nil
+    @processing_rates = false
+    super(*opt)
+  end
+  
+  
+  # Clears current rates.
+  def clear_rates
+    @cached_rates.clear
+    @source.clear_rates
+    super
+  end
+  
+  
+  # Returns true if the cache of Rates
+  # is expired.
+  def expired?
+    if @time_to_live &&
+        @rates_renew_time &&
+        (Time.now > @rates_renew_time)
+      
+      if @cached_rates 
+        $stderr.puts "#{self}: rates expired on #{@rates_renew_time}" if @verbose
+        
+        @cached_rates_old ||= @cashed_rates
+        
+        @cached_rates = nil
+      end
+      
+      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
+
+  
+  # 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 @cached_rates if @cashed_rates
+    
+    # Force load of rates
+    @cached_rates = _load_rates_from_source(time)
+    
+    # Flush old rates.
+    @cached_rates_old = nil
+    
+    # Update expiration.
+    if time_to_live
+      @rates_renew_time = @rate_timestamp + (time_to_live + (time_to_live_fudge || 0))
+      $stderr.puts "#{self}: rates expire on #{@rates_renew_time}" if @verbose
+    end
+    
+    @rates
+  end
+  
+
+  def _load_rates_from_source(time = nil) # :nodoc:
+    # Do not allow re-entrancy
+    raise "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)
+      
+    unless rates 
+      # FIXME: raise Exception::???
+      return rates 
+    end
+
+    # Compute new rate timestamp.
+    @rate_timestamp = Time.now
+
+    # End processsing new rate request.
+    @processing_rates = false
+    
+    rates
+  end
+
+
+end # class
+
+
+

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

@@ -0,0 +1,166 @@
+# 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'
+
+# Connects to http://xe.com and parses "XE.com Quick Cross Rates"
+# from home page HTML.
+#
+# This is for demonstration purposes.
+#
+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.xe_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
+
+    data = data.split(/[\r\n]/)
+    
+    @rate_timestamp = nil
+
+    # Chomp after
+    until data.empty?
+      line = data.pop
+      break if line =~ /Need More currencies\?/
+    end
+    
+    # Chomp before Quick Cross Rates
+    until data.empty?
+      line = data.shift
+      break if line =~ /XE.com Quick Cross Rates/
+    end
+
+    # Look for date.
+    md = nil
+    until data.empty?
+      line = data.shift
+      break if md = /rates as of (\d\d\d\d)\.(\d\d)\.(\d\d)\s+(\d\d):(\d\d).*GMT/.match(line)
+    end
+    if md
+      yyyy, mm, dd, h, m = md[1].to_i, md[2].to_i, md[3].to_i, md[4].to_i, md[5].to_i
+      @rate_timestamp = Time.gm(yyyy, mm, dd, h, m, 0, 0) rescue nil
+      #$stderr.puts "parsed #{md[0].inspect} => #{yyyy}, #{mm}, #{dd}, #{h}, #{m}"
+      #$stderr.puts "  => #{@rate_timestamp && @rate_timestamp.xmlschema}"
+    end
+
+    until data.empty?
+      line = data.shift
+      break if line =~ /Confused about how to use the rates/i
+    end
+    
+    until data.empty?
+      line = data.shift
+      break if line =~ /^\s*<\/tr>/i
+    end
+    # $stderr.puts "#{data[0..4].inspect}"
+    
+    # Read first table row to get position for each currency
+    currency = [ ]
+    until data.empty?
+      line = data.shift
+      break if line =~ /^\s*<\/tr>/i
+      if md = /<td><IMG .+ ALT="([A-Z][A-Z][A-Z])"/i.match(line) #"
+        cur = md[1].intern
+        cur_i = currency.size
+        currency.push(cur)
+        # $stderr.puts "Found currency header: #{cur.inspect} at #{cur_i}"
+      end
+    end
+    
+    # $stderr.puts "#{data[0..4].inspect}"
+    
+    # Skip blank <tr>
+    until data.empty?
+      line = data.shift
+      break if line =~ /^\s*<td>.+1.+USD.+=/
+    end
+    
+    until data.empty?
+      line = data.shift
+      break if line =~ /^\s*<\/tr>/i
+    end
+    
+    # $stderr.puts "#{data[0..4].inspect}"
+    
+    # Read first row of 1 USD = ...
+    
+    rate = { }
+    cur_i = -1
+    until data.empty?
+      line = data.shift
+      break if cur_i < 0 && line =~ /^\s*<\/tr>/i  
+      if md = /<td>\s+(\d+\.\d+)\s+<\/td>/.match(line)
+        usd_to_cur = md[1].to_f
+        cur_i = cur_i + 1
+        cur = currency[cur_i]
+        next 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
+    
+    rate
+  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.new("#{self}: cannot get base rate #{PIVOT_CURRENCY.inspect}") 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
+
+