currency 0.3.3 → 0.4.0

data/test/xe_test.rb

@@ -1,29 +1,53 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
 require 'test/test_base'
+
 require 'currency' # For :type => :money
-require 'currency/exchange/xe'
+require 'currency/exchange/rate/source/xe'
 
 module Currency
 
 class XeTest < TestBase
   def setup
     super
-    # Force XE Exchange.
-    Exchange.default = Exchange::Xe.instance
   end
 
+
+  def get_rate_source
+    source = Exchange::Rate::Source::Xe.new
+    deriver = Exchange::Rate::Deriver.new(:source => source)
+  end
+
+
   def test_xe_usd_cad
-    assert_not_nil rates = Exchange.default.xe_rates
+    assert_not_nil rates = Exchange::Rate::Source.default.source.raw_rates
     assert_not_nil rates[:USD]
     assert_not_nil usd_cad = rates[:USD][:CAD]
 
     assert_not_nil usd = Money.new(123.45, :USD)
     assert_not_nil cad = usd.convert(:CAD)
 
-    assert_kind_of Numeric, m = (cad.rep.to_f / usd.rep.to_f)
+    assert_kind_of Numeric, m = (cad.to_f / usd.to_f)
     # $stderr.puts "m = #{m}"
     assert_equal_float usd_cad, m, 0.001
   end
 
+
+  def test_xe_cad_eur
+    assert_not_nil rates = Exchange::Rate::Source.default.source.raw_rates
+    assert_not_nil rates[:USD]
+    assert_not_nil usd_cad = rates[:USD][:CAD]
+    assert_not_nil usd_eur = rates[:USD][:EUR]
+
+    assert_not_nil cad = Money.new(123.45, :CAD)
+    assert_not_nil eur = cad.convert(:EUR)
+
+    assert_kind_of Numeric, m = (eur.to_f / cad.to_f)
+    # $stderr.puts "m = #{m}"
+    assert_equal_float (1.0 / usd_cad) * usd_eur, m, 0.001
+  end
+
 end
 
 end # module

metadata

@@ -3,16 +3,16 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: currency
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
-date: 2006-10-31 00:00:00 -05:00
-summary: Currency models currencies, monetary values, foreign exchanges and rates. Supports ActiveRecord.  See http://currency.rubyforge.org/files/lib/currency_rb.html for more details.
+  version: 0.4.0
+date: 2007-02-21 00:00:00 -05:00
+summary: "Currency models currencies, monetary values, foreign exchanges and rates.   Pulls live rates from http://xe.com/. Supports ActiveRecord.  For more details, see:  http://currency.rubyforge.org/files/lib/currency_rb.html  http://currency.rubyforge.org/files/README.txt http://currency.rubyforge.org/"
 require_paths: 
 - lib
 - test
 email: ruby-currency@umleta.com
 homepage: http://rubyforge.org/projects/currency
 rubyforge_project: currency
-description: Currency models currencies, monetary values, foreign exchanges and rates. Supports ActiveRecord.  See http://currency.rubyforge.org/files/lib/currency_rb.html for more details.
+description: "Currency models currencies, monetary values, foreign exchanges and rates.   Pulls live rates from http://xe.com/. Supports ActiveRecord.  For more details, see:  http://currency.rubyforge.org/files/lib/currency_rb.html  http://currency.rubyforge.org/files/README.txt http://currency.rubyforge.org/"
 autorequire: 
 default_executable: 
 bindir: bin
@@ -30,34 +30,57 @@ post_install_message:
 authors: 
 - Kurt Stephens
 files: 
+- COPYING.txt
 - ChangeLog
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- Releases.txt
+- TODO.txt
 - examples/ex1.rb
 - examples/xe1.rb
+- lib/currency.rb
 - lib/currency/active_record.rb
 - lib/currency/core_extensions.rb
-- lib/currency/currency_factory.rb
 - lib/currency/currency.rb
+- lib/currency/currency/factory.rb
 - lib/currency/currency_version.rb
 - lib/currency/exception.rb
-- lib/currency/exchange/base.rb
-- lib/currency/exchange/rate.rb
 - lib/currency/exchange.rb
-- lib/currency/exchange/test.rb
-- lib/currency/exchange/xe.rb
-- lib/currency/money_helper.rb
+- lib/currency/exchange/rate.rb
+- lib/currency/exchange/rate/deriver.rb
+- lib/currency/exchange/rate/source.rb
+- lib/currency/exchange/rate/source/base.rb
+- lib/currency/exchange/rate/source/failover.rb
+- lib/currency/exchange/rate/source/historical.rb
+- lib/currency/exchange/rate/source/historical/rate.rb
+- lib/currency/exchange/rate/source/historical/writer.rb
+- lib/currency/exchange/rate/source/new_york_fed.rb
+- lib/currency/exchange/rate/source/provider.rb
+- lib/currency/exchange/rate/source/test.rb
+- lib/currency/exchange/rate/source/the_financials.rb
+- lib/currency/exchange/rate/source/timed_cache.rb
+- lib/currency/exchange/rate/source/xe.rb
+- lib/currency/exchange/time_quantitizer.rb
+- lib/currency/formatter.rb
+- lib/currency/macro.rb
 - lib/currency/money.rb
-- lib/currency.rb
-- Manifest.txt
-- Rakefile
-- README.txt
-- Releases.txt
-- test/ar_test_base.rb
-- test/ar_simple_test.rb
+- lib/currency/money_helper.rb
+- lib/currency/parser.rb
 - test/ar_column_test.rb
+- test/ar_simple_test.rb
+- test/ar_test_base.rb
+- test/ar_test_core.rb
+- test/formatter_test.rb
+- test/historical_writer_test.rb
+- test/macro_test.rb
 - test/money_test.rb
+- test/new_york_fed_test.rb
+- test/parser_test.rb
 - test/test_base.rb
+- test/time_quantitizer_test.rb
 - test/xe_test.rb
-- TODO.txt
 test_files: []
 
 rdoc_options: []

data/lib/currency/exchange/base.rb

@@ -1,84 +0,0 @@
-# -*- ruby -*-
-#
-# = Currency::Exchange::Base
-#
-# The Currency::Exchange::Base class is the base class for
-# currency exchange rate providers.
-#
-# Currency::Exchange::Base subclasses are Currency::Exchange::Rate
-# factories.
-#
-
-module Currency
-module Exchange
-
-  # Represents a method of converting between two currencies
-  class Base
-
-    # The name of this Exchange.
-    attr_accessor :name
-
-    # If true, this Exchange will log information.
-    attr_accessor :verbose
-    
-    def initialize(*opt)
-      @name = nil
-      @rate = { }
-      opt = Hash[*opt]
-      opt.each{|k,v| self.send(k, v)}
-    end 
-
-    # Converts Money m in Currency c1 to a new
-    # Money value in Currency c2.
-    def convert(m, c2, c1 = nil)
-      c1 = m.currency if c1 == nil
-      if ( c1 == c2 )
-        m
-      else
-        Money.new(rate(c1, c2).convert(m, c1), c2)
-      end
-    end
-
-    # Flush all cached Rate.
-    def clear_rates
-      @rate.clear
-    end
-
-    # Flush any cached Rate between Currency c1 and c2.
-    def clear_rate(c1, c2, recip = true)
-      @rate[c1.code.to_s + c2.code.to_s] = nil
-      @rate[c2.code.to_s + c1.code.to_s] = nil if recip
-    end
-
-    # Returns the Rate between Currency c1 and c2.
-    #
-    # This will call #get_rate(c1, c2) if the
-    # Rate has not already been cached.
-    #
-    # Subclasses can override this method to implement
-    # rate expiration rules.
-    #
-    def rate(c1, c2)
-      (@rate[c1.code.to_s + c2.code.to_s] ||= get_rate(c1, c2)) ||
-      (@rate[c2.code.to_s + c1.code.to_s] ||= get_rate(c2, c1))
-    end
-
-    
-    # Determines and creates the Rate between Currency c1 and c2.
-    #
-    # Subclasses are required to implement this method.
-    def get_rate(c1, c2)
-      raise Exception::UnknownRate.new("Subclass responsibility: get_rate")
-    end
-
-    # Returns a simple string rep of an Exchange object.
-    def to_s
-      "#<#{self.class.name} #{self.name && self.name.inspect}>"
-    end
-
-  end # class
-
-  
-end # module
-end # module
-

data/lib/currency/exchange/test.rb

@@ -1,39 +0,0 @@
-# This class is a test Exchange.
-# It can convert only between USD and CAD.
-
-module Currency
-module Exchange
-
-  class Test < Base
-    @@instance = nil
-
-    # Returns a singleton instance.
-    def self.instance(*opts)
-      @@instance ||= self.new(*opts)
-    end
-
-    def initialize(*opts)
-      super(*opts)
-    end
-
-    # Test rate from :USD to :CAD.
-    def self.USD_CAD; 1.1708; end
-
-    # Returns test Rate for USD and CAD pairs. 
-    def get_rate(c1, c2)
-      # $stderr.puts "load_exchange_rate(#{c1}, #{c2})"
-      rate = 0.0
-      if ( c1.code == :USD && c2.code == :CAD )
-        rate = self.class.USD_CAD
-      end
-      rate > 0 ? Rate.new(c1, c2, rate, self) : nil
-    end
-
-  end # class
-
-end # module
-end # module
-
-# Install as default.
-Currency::Exchange.default = Currency::Exchange::Test.instance
-

data/lib/currency/exchange/xe.rb

@@ -1,250 +0,0 @@
-# Connects to http://xe.com and parses "XE.com Quick Cross Rates"
-# from home page HTML.
-
-require 'net/http'
-require 'open-uri'
-
-module Currency
-module Exchange
-
-  class Xe < Base
-    @@instance = nil
-    # Returns a singleton instance.
-    def self.instance(*opts)
-      @@instance ||= self.new(*opts)
-    end
-
-    # Defaults to "http://xe.com/"
-    attr_accessor :uri
-
-    # 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
-
-    # This Exchange's name is the same as its #uri.
-    def name
-      uri
-    end
-
-    def initialize(*opt)
-      self.uri = 'http://xe.com/'
-      self.time_to_live = 600
-      self.time_to_live_fudge = 30
-      @xe_rates = nil
-      super(*opt)
-    end
-
-    def clear_rates
-      @xe_rates && @xe_rates.clear
-      super
-    end
-
-    def expired?
-      if @time_to_live &&
-         @xe_rates_renew_time &&
-         (Time.now > @xe_rates_renew_time)
-
-        if @xe_rates 
-          $stderr.puts "#{self}: rates expired on #{@xe_rates_renew_time}" if @verbose
-          
-          @old_rates ||= @xe_rates
-         
-          @xe_rates = nil
-        end
-
-        true
-      else
-        false
-      end
-    end
-
-    # Check expired? before returning a Rate.
-    def rate(c1, c2)
-      if expired?
-        clear_rates
-      end
-      super(c1, c2)
-    end
-
-    # Returns a cached Hash of rates:
-    #
-    #    xe.xe_rates[:USD][:CAD] => 1.0134
-    #
-    def xe_rates
-      old_rates = nil
-      # Check expiration.
-      expired?
-
-      # Return rates, if cached.
-      return @xe_rates if @xe_rates
-
-      # Force load of rates
-      @xe_rates = xe_rates_load
-
-      # Flush old rates.
-      @old_rates = nil
-
-      # Update expiration.
-      if time_to_live
-        @xe_rates_renew_time = @rate_timestamp + (time_to_live + (time_to_live_fudge || 0))
-        $stderr.puts "#{self}: rates expire on #{@xe_rates_renew_time}" if @verbose
-      end
-      
-      @xe_rates
-    end
-
-    def xe_rates_load
-      # Do not allow re-entrancy
-      raise "Reentrant!" if @processing_rates
-
-      # Begin processing new rate request.
-      @processing_rates = true
-
-      # Clear cached Rates.
-      clear_rates
-
-      # Parse rates from HTML page.
-      rates = parse_page_rates
-      
-      unless rates 
-        # FIXME: raise Exception::???
-        return rates 
-      end
-
-      # Compute new rate timeps
-      @rate_timestamp = Time.now # TODO: Extract this from HTML page!
-
-      # End processsing new rate request.
-      @processing_rates = false
-
-      rates
-    end
-
-
-    # Returns the URI content.
-    def get_page
-      data = open(uri) { |data| data.read }
-      
-      data = data.split(/[\r\n]/)
-
-      data
-    end
-
-    # Parses http://xe.com homepage HTML for
-    # quick rates of 10 currencies.
-    def parse_page_rates(data = nil)
-      data = get_page unless data
-      
-      # Chomp after
-      until data.empty?
-        line = data.pop
-        break if line =~ /Need More currencies\?/
-      end
-
-      # Chomp before
-      until data.empty?
-        line = data.shift
-        break if line =~ /XE.com Quick Cross Rates/
-      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]
-          (rate[:USD] ||= {})[cur] = usd_to_cur
-        end
-      end
-
-      rate
-    end
-
-    # Loads cached rates from xe.com and creates Rate objects
-    # for 10 currencies.
-    def get_rate(c1, c2)
-      rates = xe_rates # Load rates
-
-      # $stderr.puts "load_exchange_rate(#{c1}, #{c2})"
-      rate = 0.0
-      r1 = nil
-      r2 = nil
-
-      rates_usd = rates[:USD]
-
-      raise Exception::UnknownRate.new("#{self}: base rate :USD") unless rates_usd
-
-      if ( c1.code == :USD && (r2 = rates_usd[c2.code]) )
-        rate = r2
-      elsif ( c2.code == :USD && (r1 = rates_usd[c2.code]) )
-        rate = 1.0 / r1
-      elsif ( (r1 = rates_usd[c1.code]) && (r2 = rates_usd[c2.code]) )
-        rate = r2 / r1
-      end
-
-      # $stderr.puts "XE Rate: #{c1.code} / #{c2.code} = #{rate}"
-
-      rate > 0 ? Rate.new(c1, c2, rate, self, @rate_timestamp) : nil
-    end
-
-  end # class
-
-end # module
-end # module
-
-
-# Install as default.
-Currency::Exchange.default = Currency::Exchange::Xe.instance
-