eu_central_bank 0.3.5 → 0.3.6

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,50 +1,50 @@
-= eu_central_bank changelog
+# eu_central_bank changelog
 
-== 0.3.0 (Jan 29 2012)
+## 0.3.0 (Jan 29 2012)
 
 * Updated Money dependency to 4.0.1
 * Fixed deprecated rake tasks
 
-== 0.2.4 (Sep 14 2011)
+## 0.2.4 (Sep 14 2011)
 
 * Merged pull request #6: support currencies without subunits
 
-== 0.2.3 (Sep 8 2011)
+## 0.2.3 (Sep 8 2011)
 
 * Updated Nokogiri dependency to 1.5.0
 
-== 0.2.2 (Jul 13 2011)
+## 0.2.2 (Jul 13 2011)
 
 * Fixed #2 versioning bug
 
-== 0.2.1 (Jul 13 2011-yanked)
+## 0.2.1 (Jul 13 2011-yanked)
 
 * Updated dependencies to run with Money 3.7.x
 
-== 0.2.0 (Feb 19 2011)
+## 0.2.0 (Feb 19 2011)
 
 * Changed to use rounding instead of flooring dues to issues with negative number amounts
 
-== 0.1.5 (Jan 18 2011)
+## 0.1.5 (Jan 18 2011)
 
 * Updated the money dependency on the gemspec
 
-== 0.1.4 (Jan 18 2011)
+## 0.1.4 (Jan 18 2011)
 
 * Removed the Estonian Kroon from the list of currencies as EU Central Bank does not list it anymore
 
-== 0.1.3 (December 18 2010)
+## 0.1.3 (December 18 2010)
 
 * Fixed the gemspec bug
 
-== 0.1.2 (December 15 2010)
+## 0.1.2 (December 15 2010)
 
 * Clean up dependencies
 
-== 0.1.1 (July 17 2010)
+## 0.1.1 (July 17 2010)
 
 * Added the exchange_with method from money gem
 
-== 0.1.0 (April 21 2010)
+## 0.1.0 (April 21 2010)
 
 * Initial gem release

data/README.md

@@ -0,0 +1,73 @@
+# eu_central_bank
+
+{<img src="https://secure.travis-ci.org/RubyMoney/eu_central_bank.png?branch=master" alt="Build Status" />}[http://travis-ci.org/RubyMoney/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.
+
+``` ruby
+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") # Money.new(80, "USD")
+Money.us_dollar(100).exchange_to("CAD")  # Money.new(124, "CAD")
+
+# using the new exchange_with method
+eu_bank.exchange_with(Money.new(100, "CAD"), "USD") # Money.new(80, "USD")
+```
+
+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. It also adds an __update_at__ field so that you can manage the update.
+
+``` ruby
+# cached location
+cache = "/some/file/location/exchange_rates.xml"
+
+# saves the rates in a specified location
+eu_bank.save_rates(cache)
+
+# reads the rates from the specified location
+eu_bank.update_rates(cache)
+
+if !@bank.rates_updated_at || @bank.rates_updated_at < Time.now - 1.days
+  @bank.save_rates(cache)
+  @bank.update_rates(cache)
+end
+
+# exchange 100 CAD to USD as usual
+eu_bank.exchange_with(Money.new(100, "CAD"), "USD") # Money.new(80, "USD")
+```
+
+## 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-2013 RubyMoney. See LICENSE for details.

data/lib/eu_central_bank.rb

@@ -8,12 +8,13 @@ class InvalidCache < StandardError ; end
 class EuCentralBank < Money::Bank::VariableExchange
 
   attr_accessor :last_updated
+  attr_accessor :rates_updated_at
 
   ECB_RATES_URL = 'http://www.ecb.int/stats/eurofxref/eurofxref-daily.xml'
   CURRENCIES = %w(USD JPY BGN CZK DKK GBP HUF ILS 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)
-    update_parsed_rates(exchange_rates(cache))
+    update_parsed_rates(doc(cache))
   end
 
   def save_rates(cache)
@@ -25,7 +26,7 @@ class EuCentralBank < Money::Bank::VariableExchange
   end
 
   def update_rates_from_s(content)
-    update_parsed_rates(exchange_rates_from_s(content))
+    update_parsed_rates(doc_from_s(content))
   end
 
   def save_rates_to_s
@@ -48,24 +49,28 @@ class EuCentralBank < Money::Bank::VariableExchange
 
   protected
 
-  def exchange_rates(cache=nil)
+  def doc(cache)
     rates_source = !!cache ? cache : ECB_RATES_URL
-    doc = Nokogiri::XML(open(rates_source))
-    doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
+    Nokogiri::XML(open(rates_source))
   end
 
-  def exchange_rates_from_s(content)
-    doc = Nokogiri::XML(content)
-    doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
+  def doc_from_s(content)
+    Nokogiri::XML(content)
   end
 
-  def update_parsed_rates(rates)
+  def update_parsed_rates(doc)
+    rates = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
+
     rates.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)
+
+    rates_updated_at = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube/@time').first.value
+    @rates_updated_at = Time.parse(rates_updated_at)
+
     @last_updated = Time.now
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: eu_central_bank
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
 - Wong Liang Zan
 - Shane Emmons
-- Thorsten Bottger
+- Thorsten Böttger
 - Jonathan Eisenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -103,9 +103,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/eu_central_bank.rb
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - LICENSE
-- README.rdoc
+- README.md
 homepage: http://github.com/RubyMoney/eu_central_bank
 licenses: []
 post_install_message: 
@@ -118,6 +118,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -209299811093199673
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -126,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Calculates exchange rates based on rates from european central bank. Money

data/README.rdoc

@@ -1,61 +0,0 @@
-= eu_central_bank
-
-{<img src="https://secure.travis-ci.org/RubyMoney/eu_central_bank.png?branch=master" alt="Build Status" />}[http://travis-ci.org/RubyMoney/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") # Money.new(80, "USD")
-  Money.us_dollar(100).exchange_to("CAD")  # Money.new(124, "CAD")
-
-  # using the new exchange_with method
-  eu_bank.exchange_with(Money.new(100, "CAD"), "USD") # Money.new(80, "USD")
-
-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_with(Money.new(100, "CAD"), "USD") # Money.new(80, "USD")
-
-== 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 RubyMoney. See LICENSE for details.