currency 0.4.2 → 0.4.3

data/Releases.txt

@@ -1,5 +1,13 @@
 = Currency Release History
 
+== Release 0.4.3: 2007/04/01
+
+* Added available? checks for NewYorkFed.
+* Created new UnavailableRates exception for rate providers that return no rates (New York Fed on weekends).
+* Fixed xe.com rate dates.
+* Refactored exceptions.
+* Fixed comments.
+
 == Release 0.4.2: 2007/03/11
 
 * Missing Manifest changes

data/TODO.txt

@@ -1 +1,5 @@
 
+= Currency To Do List
+
+* Refactor all configuration class variables into Currency::Config
+* Refactor all cached values into objects that can be reinstantiated on a per-thread basis

data/lib/currency/config.rb

@@ -4,6 +4,9 @@
 # The Currency::Config class is responsible for
 # maintaining global configuration for the Currency package.
 #
+# TO DO:
+# 
+# Migrate all class variable configurations to this object.
 class Currency::Config
   @@default = nil
 
@@ -12,7 +15,8 @@ class Currency::Config
   # If one is not specfied an instance is
   # created.  This is a global, not thread-local.
   def self.default 
-    @@default ||= self.new
+    @@default ||= 
+      self.new
   end
   
   # Sets the default Currency::Config object.
@@ -26,13 +30,15 @@ class Currency::Config
   # If #current= has not been called and #default= has not been called,
   # then UndefinedExchange is raised.
   def self.current
-    Thread.current[:currency_config] ||= self.default || (raise ::Currency::Exception::UndefinedConfig.new("Currency::Config.default not defined"))
+    Thread.current[:Currency__Config] ||= 
+      self.default || 
+      (raise ::Currency::Exception::UndefinedConfig.new("Currency::Config.default not defined"))
   end
   
   # Sets the current Currency::Config object used
   # in the current thread.
   def self.current=(x)
-    Thread.current[:currency_config] = x
+    Thread.current[:Currency__Config] = x
   end
 
   # Clones the current configuration and makes it current
@@ -56,11 +62,19 @@ class Currency::Config
   end
 
   
+  @@identity = Proc.new { |x| x } # :nodoc:
   
+  # Returns the current Float conversion filter.
+  # Can be used to set rounding or truncation policies when converting
+  # Float values to Money values.
+  # Defaults to an identity function.
+  # See Float#Money_rep.
   def float_ref_filter
-    @float_ref_filter ||= Proc.new { |x| x }
+    @float_ref_filter ||= 
+      @@identity
   end
   
+  # Sets the current Float conversion filter.
   def float_ref_filter=(x)
     @float_ref_filter = x
   end

data/lib/currency/core_extensions.rb

@@ -2,7 +2,7 @@
 # See LICENSE.txt for details.
 
 
-# External representation mixin
+
 class Object 
   # Exact conversion to Money representation value.
   def money(*opts)
@@ -11,7 +11,7 @@ class Object
 end
 
 
-# External representation mixin
+
 class Integer 
   # Exact conversion to Money representation value.
   def Money_rep(currency, time = nil)
@@ -20,7 +20,7 @@ class Integer
 end
 
 
-# External representation mixin
+
 class Float 
   # Inexact conversion to Money representation value.
   def Money_rep(currency, time = nil)  
@@ -29,7 +29,7 @@ class Float
 end
 
 
-# External representation mixin
+
 class String
   # Exact conversion to Money representation value.
   def Money_rep(currency, time = nil)

data/lib/currency/currency.rb

@@ -48,6 +48,10 @@ class Currency::Currency
       self.code = code
       self.symbol = symbol
       self.scale = scale
+
+      @formatter =
+        @parser = 
+        nil
     end
 
 

data/lib/currency/currency_version.rb

@@ -1,5 +1,5 @@
 module Currency
-  CurrencyVersion = '0.4.2'
+  CurrencyVersion = '0.4.3'
 end
 # DO NOT EDIT
 # This file is auto-generated by build scripts.

data/lib/currency/exception.rb

@@ -6,7 +6,7 @@ module Currency::Exception
     class Base < ::Exception
     end
 
-    # Error during string parsing.
+    # Error during parsing of Money values from String.
     class InvalidMoneyString < Base
     end
 
@@ -34,6 +34,14 @@ module Currency::Exception
     class UnknownRate < Base
     end
 
+    # Error if an Exchange Rate Source.
+    class RateSourceError < Base
+    end
+
+    # Error if an Exchange Rate Source cannot supply any rates.
+    class UnavailableRates < Base
+    end
+
     # Error if an Exchange::Rate is not valid.
     class InvalidRate < Base
     end

data/lib/currency/exchange.rb

@@ -27,7 +27,7 @@ module Currency::Exchange
     end
 
     # Returns the current Currency::Exchange object used during
-    # explicit and implicit Money conversions.
+    # explicit and implicit Money trading.
     # 
     # If #current= has not been called and #default= has not been called,
     # then UndefinedExchange is raised.

data/lib/currency/exchange/rate.rb

@@ -60,6 +60,17 @@ class Currency::Exchange::Rate
       @date = date
       @derived = derived
       @reciprocal = reciprocal
+      
+      #
+      @rate_avg =
+        @rate_samples =
+        @rate_lo =
+        @rate_hi =
+        @rate_date_0 =
+        @rate_date_1 =
+        @date_0 =
+        @date_1 =
+        nil
 
       if opts
         opts.each_pair do | k, v |

data/lib/currency/exchange/rate/deriver.rb

@@ -140,6 +140,12 @@ class Currency::Exchange::Rate::Deriver < Currency::Exchange::Rate::Source::Base
   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/historical/writer.rb

@@ -3,6 +3,10 @@ require 'currency/exchange/rate/source/historical'
 
 # Responsible for writing historical rates from a rate source.
 class Currency::Exchange::Rate::Source::Historical::Writer
+
+  # Error during handling of historical rates.
+  class Error < ::Currency::Exception::Base; end
+
   # The source of rates.
   attr_accessor :source
 
@@ -187,7 +191,11 @@ class Currency::Exchange::Rate::Source::Historical::Writer
         if existing_rate
           stored_h_rates << existing_rate # Already existed.
         else
-          rr.save!
+          begin
+            rr.save!
+          rescue Object => err
+            raise Error, "During save of #{rr.inspect} : #{err.inspect}"
+          end
           stored_h_rates << rr # Written.
         end
       end

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

@@ -11,7 +11,7 @@ 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.
 #
-# This is for demonstration purposes.
+# 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/.
@@ -30,6 +30,13 @@ class Currency::Exchange::Rate::Source::NewYorkFed < ::Currency::Exchange::Rate:
   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
@@ -53,16 +60,24 @@ class Currency::Exchange::Rate::Source::NewYorkFed < ::Currency::Exchange::Rate:
     $stderr.puts "#{self}: parse_rates: data =\n#{data}" if @verbose
 
     doc = REXML::Document.new(data).root
-    doc.elements.to_a('//frbny:Series').each do | series |
+    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].text.to_f
+      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].text
+      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
 
       rates << new_rate(c1, c2, rate, date)
@@ -72,6 +87,7 @@ class Currency::Exchange::Rate::Source::NewYorkFed < ::Currency::Exchange::Rate:
     end
 
     # $stderr.puts "rates = #{rates.inspect}"
+    raise ::Currency::Exception::UnavailableRates, "No rates found in #{get_uri.inspect}" if rates.empty?
 
     rates
   end

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

@@ -7,6 +7,10 @@ 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
   
@@ -99,6 +103,12 @@ class Currency::Exchange::Rate::Source::Provider < Currency::Exchange::Rate::Sou
 
   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/xe.rb

@@ -11,10 +11,7 @@ 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
-  class ParserError < ::Currency::Exception::Base; end
 
   # Defines the pivot currency for http://xe.com/.
   PIVOT_CURRENCY = :USD
@@ -57,7 +54,10 @@ class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source:
 
     @lines = data = data.split(/\n/);
 
-    @rate_timestamp = nil
+    # 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
@@ -73,7 +73,7 @@ class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source:
         $stderr.puts "Found currency header: #{cur.inspect} at #{cur_i}" if @verbose
       end
     end
-    raise ParseError, "Currencies header not found" if currency.empty?
+    raise ParserError, "Currencies header not found" if currency.empty?
     
 
     # Skip until "1 USD ="
@@ -87,18 +87,21 @@ class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source:
         usd_to_cur = md[1].to_f
         cur_i = cur_i + 1
         cur = currency[cur_i]
-        raise ParseError, "Currency not found at column #{cur_i}" unless cur
+        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 ParseError, "Currency rates not found" if rate.keys.empty?
-    raise ParseError, "Not all rates found" if rate.keys.size != currency.size
+
+    raise ::Currency::Exception::UnavailableRates, "No rates found in #{get_uri.inspect}" if rate.keys.empty?
+    raise ParserError, "Not all rates found" if rate.keys.size != currency.size
     
     @lines = @line = nil
 
+    raise ParserError, "Rate date not found" unless @rate_timestamp
+
     rate
   end
 
@@ -112,7 +115,7 @@ class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source:
       end
       yield @line if block_given?
     end
-    raise ParseError, rx.inspect
+    raise ParserError, rx.inspect
     false
   end
 

data/lib/currency/formatter.rb

@@ -34,6 +34,10 @@ class Currency::Formatter
 
     
     def initialize(opts = @@empty_hash)
+      @template =
+        @template_proc =
+        nil
+
       opts.each_pair{ | k, v | self.send("#{k}=", v) }
     end
 

data/lib/currency/money.rb

@@ -98,11 +98,12 @@ class Currency::Money
 
 
     # Construct from post-scaled internal representation.
-    # using the same currency:
+    # using the same currency.
     #
     #    x = Currency.Money("1.98", :USD)
-    #    x.new_rep(100) => "$1.00 USD"
+    #    x.new_rep(123) => USD $1.23
     #
+    # time defaults to self.time.
     def new_rep(r, time = nil)
       time ||= @time
       x = self.class.new(0, @currency, time)
@@ -177,7 +178,7 @@ class Currency::Money
     end
 
     # Compares Money values.
-    # Will convert x currency before comparision.
+    # Will convert x to self.currency before comparision.
     def <=>(x)
       if @currency == x.currency
         @rep <=> x.rep

data/lib/currency/parser.rb

@@ -21,7 +21,8 @@ class Currency::Parser
   @@default = nil
   # Get the default Formatter.
   def self.default
-    @@default || self.new
+    @@default ||=
+      self.new
   end
 
 
@@ -32,6 +33,9 @@ class Currency::Parser
   
 
   def initialize(opt = { })
+    @time =
+      @currency =
+      nil
     opt.each_pair{ | k, v | self.send("#{k}=", v) }
   end
 

data/test/historical_writer_test.rb

@@ -77,6 +77,7 @@ class HistoricalWriterTest < ArTestBase
   def writer_src2
     writer = test_writer
     writer.source = @src2
+    return unless writer.source.available?
     rates = writer.write_rates
     assert_not_nil rates
     assert rates.size > 0
@@ -105,18 +106,20 @@ class HistoricalWriterTest < ArTestBase
     deriver = Exchange::Rate::Deriver.new(:source => source)
     Exchange::Rate::Source.default = deriver
 
-    rates = source.get_raw_rates
-    #$stderr.puts "historical rates = #{rates.inspect}"
+    assert_not_nil rates = source.get_raw_rates
+    assert ! rates.empty?
+    # $stderr.puts "historical rates = #{rates.inspect}"
 
-    rates = source.get_rates
-    #$stderr.puts "historical rates = #{rates.inspect}"
+    assert_not_nil rates = source.get_rates
+    assert ! rates.empty?
+    # $stderr.puts "historical rates = #{rates.inspect}"
     
-    assert_not_nil m_usd = ::Currency::Money('1234.56', :USD, :now)
-    #$stderr.puts "m_usd = #{m_usd.to_s(:code => true)}"
+    assert_not_nil m_usd = ::Currency.Money('1234.56', :USD, :now)
+    # $stderr.puts "m_usd = #{m_usd.to_s(:code => true)}"
     assert_not_nil m_eur = m_usd.convert(:EUR)
-    #$stderr.puts "m_eur = #{m_eur.to_s(:code => true)}"
+    # $stderr.puts "m_eur = #{m_eur.to_s(:code => true)}"
 
-   end
+  end
 
 
   def assert_h_rates(rates, writer = nil)

data/test/new_york_fed_test.rb

@@ -14,16 +14,30 @@ class NewYorkFedTest < TestBase
   end
 
 
+  @@available = nil
+
+  # New York Fed rates are not available on Saturday and Sunday.
+  def available?
+    if @@available == nil
+      @@available = @source.available?
+      STDERR.puts "Warning: NewYorkFed unavailable on Saturday and Sunday, skipping tests."
+    end
+    @@available
+  end
+
+
   def get_rate_source
-    # Force XE Exchange.
+    # Force NewYorkFed Exchange.
     verbose = false
-    source = Exchange::Rate::Source::NewYorkFed.new(:verbose => verbose)
+    source = @source = Exchange::Rate::Source::NewYorkFed.new(:verbose => verbose)
     deriver = Exchange::Rate::Deriver.new(:source => source, :verbose => source.verbose)
   end
 
 
 
   def test_usd_cad
+    return unless available?
+
     assert_not_nil rates = Exchange::Rate::Source.default.source.raw_rates
     assert_not_nil rates[:USD]
     assert_not_nil usd_cad = rates[:USD][:CAD]
@@ -38,6 +52,8 @@ class NewYorkFedTest < TestBase
 
 
   def test_cad_eur
+    return unless available?
+
     assert_not_nil rates = Exchange::Rate::Source.default.source.raw_rates
     assert_not_nil rates[:USD]
     assert_not_nil usd_cad = rates[:USD][:CAD]

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: currency
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
-date: 2007-03-11 00:00:00 -06:00
+  version: 0.4.3
+date: 2007-04-01 00:00:00 -04:00
 summary: "Currency models currencies, monetary values, foreign exchanges rates.   Pulls live and historical rates from http://xe.com/, http://newyorkfed.org/, http://thefinancials.com/. Can store/retrieve historical rate data from database using ActiveRecord. Can store/retrieve Money values using ActiveRecord.  For more details, see:  http://currency.rubyforge.org/ http://currency.rubyforge.org/files/README.txt"
 require_paths: 
 - lib