eu_central_bank 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wong Liang Zan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= eu_central_bank
+
+== Introduction
+
+This gem downloads the exchange rates from the European Central Bank. You can calculate exchange rates with it. It is compatible with the money gem.
+
+== Installation
+
+ $ gem install eu_central_bank
+
+== Dependencies
+
+* nokogiri
+* money
+
+== Usage
+
+With the gem, you do not need to manually add exchange rates. Calling update_rates will download the rates from the European Central Bank. The API is the same as the money gem. Feel free to use Money objects with the bank.
+
+  eu_bank = EuCentralBank.new
+  Money.default_bank = eu_bank
+  money1 = Money.new(10)
+  money1.bank # eu_bank
+
+  # call this before calculating exchange rates
+  # this will download the rates from ECB
+  eu_bank.update_rates
+
+  # exchange 100 CAD to USD
+  # API is the same as the money gem
+  eu_bank.exchange(100, "CAD", "USD") # 124
+  Money.us_dollar(100).exchange_to("CAD")  # Money.ca_dollar(124)
+
+For performance reasons, you may prefer to read from a file instead. Furthermore, ECB publishes their rates daily. It makes sense to save the rates in a file to read from.
+
+  # saves the rates in a specified location
+  eu_bank.save_rates("/some/file/location/exchange_rates.xml")
+
+  # reads the rates from the specified location
+  eu_bank.update_rates("/some/file/location/exchange_rates.xml")
+
+  # exchange 100 CAD to USD as usual
+  eu_bank.exchange(100, "CAD", "USD") # 124
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+
+== Copyright
+
+Copyright (c) 2010 Wong Liang Zan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "eu_central_bank"
+    gem.summary = %Q{Calculates exchange rates based on rates from european central bank. Money gem compatible. }
+    gem.description = %Q{This gem reads exchange rates from the european central bank website. It uses it to calculates exchange rates. It is compatible with the money gem}
+    gem.email = "zan@liangzan.net"
+    gem.homepage = "http://github.com/liangzan/eu_central_bank"
+    gem.authors = ["Wong Liang Zan"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_development_dependency "rr", ">= 0.10.11"
+    gem.add_development_dependency "shoulda", ">= 2.10.3"
+    gem.add_dependency "nokogiri", ">= 1.4.1"
+    gem.add_dependency "money", ">= 2.3.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "eu_central_bank #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/eu_central_bank.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eu_central_bank}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wong Liang Zan"]
+  s.date = %q{2010-04-21}
+  s.description = %q{This gem reads exchange rates from the european central bank website. It uses it to calculates exchange rates. It is compatible with the money gem}
+  s.email = %q{zan@liangzan.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "eu_central_bank.gemspec",
+     "lib/eu_central_bank.rb",
+     "spec/eu_central_bank_spec.rb",
+     "spec/exchange_rates.xml",
+     "spec/exchange_rates.yml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/liangzan/eu_central_bank}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Calculates exchange rates based on rates from european central bank. Money gem compatible.}
+  s.test_files = [
+    "spec/eu_central_bank_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<rr>, [">= 0.10.11"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.3"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.1"])
+      s.add_runtime_dependency(%q<money>, [">= 2.3.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<rr>, [">= 0.10.11"])
+      s.add_dependency(%q<shoulda>, [">= 2.10.3"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
+      s.add_dependency(%q<money>, [">= 2.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<rr>, [">= 0.10.11"])
+    s.add_dependency(%q<shoulda>, [">= 2.10.3"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
+    s.add_dependency(%q<money>, [">= 2.3.0"])
+  end
+end
+

data/lib/eu_central_bank.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'open-uri'
+require 'nokogiri'
+require 'money'
+
+class InvalidCache < StandardError ; end
+
+class EuCentralBank < Money::VariableExchangeBank
+
+  ECB_RATES_URL = 'http://www.ecb.int/stats/eurofxref/eurofxref-daily.xml'
+  CURRENCIES = %w(USD JPY BGN CZK DKK EEK GBP HUF LTL LVL PLN RON SEK CHF NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR INR KRW MXN MYR NZD PHP SGD THB ZAR)
+
+  def update_rates(cache=nil)
+    exchange_rates(cache).each do |exchange_rate|
+      rate = exchange_rate.attribute("rate").value.to_f
+      currency = exchange_rate.attribute("currency").value
+      add_rate("EUR", currency, rate)
+    end
+    add_rate("EUR", "EUR", 1)
+  end
+
+  def save_rates(cache)
+    raise InvalidCache if !cache
+    File.open(cache, "w") do |file|
+      io = open(ECB_RATES_URL) ;
+      io.each_line {|line| file.puts line}
+    end
+  end
+
+  def exchange(cents, from_currency, to_currency)
+    rate = get_rate(from_currency, to_currency)
+    if !rate
+      from_base_rate = get_rate("EUR", from_currency)
+      to_base_rate = get_rate("EUR", to_currency)
+      rate = to_base_rate / from_base_rate
+    end
+    (cents * rate).floor
+  end
+
+  protected
+
+  def exchange_rates(cache=nil)
+    rates_source = !!cache ? cache : ECB_RATES_URL
+    doc = Nokogiri::XML(open(rates_source))
+    doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
+  end
+
+end

data/spec/eu_central_bank_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "EuCentralBank" do
+  before(:each) do
+    @bank = EuCentralBank.new
+    @cache_path = File.expand_path(File.dirname(__FILE__) + '/exchange_rates.xml')
+    @yml_cache_path = File.expand_path(File.dirname(__FILE__) + '/exchange_rates.yml')
+    @tmp_cache_path = File.expand_path(File.dirname(__FILE__) + '/tmp/exchange_rates.xml')
+  end
+
+  after(:each) do
+    if File.exists? @tmp_cache_path
+      File.delete @tmp_cache_path
+    end
+  end
+
+  it "should save the xml file from ecb given a file path" do
+    @bank.save_rates(@tmp_cache_path)
+    File.exists?(@tmp_cache_path).should == true
+  end
+
+  it "should raise an error if an invalid path is given to save_rates" do
+    lambda { @bank.save_rates(nil) }.should raise_exception
+  end
+
+  it "should update itself with exchange rates from ecb website" do
+    stub(OpenURI::OpenRead).open(EuCentralBank::ECB_RATES_URL) {@cache_path}
+    @bank.update_rates
+    EuCentralBank::CURRENCIES.each do |currency|
+      @bank.get_rate("EUR", currency).should > 0
+    end
+  end
+
+  it "should update itself with exchange rates from cache" do
+    @bank.update_rates(@cache_path)
+    EuCentralBank::CURRENCIES.each do |currency|
+      @bank.get_rate("EUR", currency).should > 0
+    end
+  end
+
+  it "should return the correct exchange rates" do
+    EXCHANGE_RATES = YAML.load_file(@yml_cache_path)
+    @bank.update_rates(@cache_path)
+    EuCentralBank::CURRENCIES.each do |currency|
+      @bank.exchange(100, "EUR", currency).should == (EXCHANGE_RATES["currencies"][currency].to_f * 100).floor
+    end
+  end
+end

data/spec/exchange_rates.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gesmes:Envelope xmlns:gesmes="http://www.gesmes.org/xml/2002-08-01" xmlns="http://www.ecb.int/vocabulary/2002-08-01/eurofxref">
+	<gesmes:subject>Reference rates</gesmes:subject>
+	<gesmes:Sender>
+		<gesmes:name>European Central Bank</gesmes:name>
+	</gesmes:Sender>
+	<Cube>
+		<Cube time='2010-04-20'>
+			<Cube currency='USD' rate='1.3486'/>
+			<Cube currency='JPY' rate='125.32'/>
+			<Cube currency='BGN' rate='1.9558'/>
+			<Cube currency='CZK' rate='25.309'/>
+			<Cube currency='DKK' rate='7.4423'/>
+			<Cube currency='EEK' rate='15.6466'/>
+			<Cube currency='GBP' rate='0.87650'/>
+			<Cube currency='HUF' rate='264.93'/>
+			<Cube currency='LTL' rate='3.4528'/>
+			<Cube currency='LVL' rate='0.7074'/>
+			<Cube currency='PLN' rate='3.8861'/>
+			<Cube currency='RON' rate='4.1470'/>
+			<Cube currency='SEK' rate='9.6450'/>
+			<Cube currency='CHF' rate='1.4334'/>
+			<Cube currency='NOK' rate='7.9475'/>
+			<Cube currency='HRK' rate='7.2542'/>
+			<Cube currency='RUB' rate='39.2535'/>
+			<Cube currency='TRY' rate='2.0064'/>
+			<Cube currency='AUD' rate='1.4478'/>
+			<Cube currency='BRL' rate='2.3576'/>
+			<Cube currency='CAD' rate='1.3665'/>
+			<Cube currency='CNY' rate='9.2047'/>
+			<Cube currency='HKD' rate='10.4688'/>
+			<Cube currency='IDR' rate='12141.23'/>
+			<Cube currency='INR' rate='60.0060'/>
+			<Cube currency='KRW' rate='1507.69'/>
+			<Cube currency='MXN' rate='16.4647'/>
+			<Cube currency='MYR' rate='4.3209'/>
+			<Cube currency='NZD' rate='1.8961'/>
+			<Cube currency='PHP' rate='60.094'/>
+			<Cube currency='SGD' rate='1.8551'/>
+			<Cube currency='THB' rate='43.374'/>
+			<Cube currency='ZAR' rate='10.0235'/>
+		</Cube>
+	</Cube>
+</gesmes:Envelope>

data/spec/exchange_rates.yml

@@ -0,0 +1,34 @@
+currencies:
+  USD: 1.3486
+  JPY: 125.32
+  BGN: 1.9558
+  CZK: 25.309
+  DKK: 7.4423
+  EEK: 15.6466
+  GBP: 0.87650
+  HUF: 264.93
+  LTL: 3.4528
+  LVL: 0.7074
+  PLN: 3.8861
+  RON: 4.1470
+  SEK: 9.6450
+  CHF: 1.4334
+  NOK: 7.9475
+  HRK: 7.2542
+  RUB: 39.2535
+  TRY: 2.0064
+  AUD: 1.4478
+  BRL: 2.3576
+  CAD: 1.3665
+  CNY: 9.2047
+  HKD: 10.4688
+  IDR: 12141.23
+  INR: 60.0060
+  KRW: 1507.69
+  MXN: 16.4647
+  MYR: 4.3209
+  NZD: 1.8961
+  PHP: 60.094
+  SGD: 1.8551
+  THB: 43.374
+  ZAR: 10.0235

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'eu_central_bank'
+require 'spec'
+require 'spec/autorun'
+require 'shoulda'
+require 'rr'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: eu_central_bank
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wong Liang Zan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-21 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 11
+        version: 0.10.11
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: money
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id005
+description: This gem reads exchange rates from the european central bank website. It uses it to calculates exchange rates. It is compatible with the money gem
+email: zan@liangzan.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- eu_central_bank.gemspec
+- lib/eu_central_bank.rb
+- spec/eu_central_bank_spec.rb
+- spec/exchange_rates.xml
+- spec/exchange_rates.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/liangzan/eu_central_bank
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Calculates exchange rates based on rates from european central bank. Money gem compatible.
+test_files: 
+- spec/eu_central_bank_spec.rb
+- spec/spec_helper.rb