acvwilson-acvwilson-currency 0.5.0

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

data/lib/currency/exchange/time_quantitizer.rb

@@ -0,0 +1,111 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+# = Currency::Exchange::TimeQuantitizer
+#
+# The Currency::Exchange::TimeQuantitizer quantitizes time values
+# such that money values and rates at a given time
+# can be turned into a hash key, depending
+# on the rate source's temporal accuracy.
+#
+class Currency::Exchange::TimeQuantitizer
+
+  def self.current; @current ||= self.new; end
+  def self.current=(x); @current = x; end
+
+  # Time quantitization size.
+  # Defaults to 1 day.
+  attr_accessor :time_quant_size
+
+  # Time quantization offset in seconds.
+  # This is applied to epoch time before quantization.
+  # If nil, uses Time#utc_offset.
+  # Defaults to nil.
+  attr_accessor :time_quant_offset
+  
+  def initialize(*opt)
+    @time_quant_size   ||= 60 * 60 * 24
+    @time_quant_offset ||= nil
+    opt = Hash[*opt]
+    opt.each_pair{|k,v| self.send("#{k}=", v)}
+  end 
+  
+  
+  # Normalizes time to a quantitized value.
+  # For example: a time_quant_size of 60 * 60 * 24 will
+  # truncate a rate time to a particular day.
+  #
+  # Subclasses can override this method.
+  def quantitize_time(time)
+    # If nil, then nil.
+    return time unless time
+
+    # Get bucket parameters.
+    was_utc = time.utc?
+    quant_offset = time_quant_offset
+    quant_offset ||= time.utc_offset
+    # $stderr.puts "quant_offset = #{quant_offset}"
+    quant_size = time_quant_size.to_i
+    
+    # Get offset from epoch.
+    time = time.tv_sec
+    
+    # Remove offset (timezone)
+    time += quant_offset
+    
+    # Truncate to quantitize size.
+    time = (time.to_i / quant_size) * quant_size
+    
+    # Add offset (timezone)
+    time -= quant_offset
+    
+    # Convert back to Time object.
+    time = Time.at(time)
+    
+    # Quant to day?
+    # NOTE: is this due to a Ruby bug, or
+    # some wierd UTC time-flow issue, like leap-seconds.
+    if quant_size == 60 * 60 * 24 
+      time = time + 60 * 60
+      if was_utc
+        time = time.getutc
+        time = Time.utc(time.year, time.month, time.day, 0, 0, 0, 0)
+      else
+        time = Time.local(time.year, time.month, time.day, 0, 0, 0, 0)
+      end
+    end
+    
+    # Convert back to UTC?
+    time = time.getutc if was_utc
+    
+    time
+  end
+  
+  # Returns a Range of Time such that:
+  #
+  #   range.include?(time) 
+  #   ! range.include?(time + time_quant_size)
+  #   ! range.include?(time - time_quant_size)
+  #   range.exclude_end?
+  #
+  # The range.max is end-exclusive to avoid precision issues:
+  # 
+  #  t = Time.now
+  #   => Thu Feb 15 15:32:34 EST 2007
+  #  x.quantitize_time_range(t)
+  #   => Thu Feb 15 00:00:00 EST 2007...Fri Feb 16 00:00:00 EST 2007
+  #
+  def quantitize_time_range(time)
+    time_0 = quantitize_time(time)
+    time_1 = time_0 + time_quant_size.to_i
+    time_0 ... time_1
+  end
+  
+  # Returns a simple string rep.
+  def to_s
+    "#<#{self.class.name} #{quant_offset} #{quant_size}>"
+  end
+  
+end # class
+
+