rk_fx_rates 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a28cba1b8c8892ef3a80a2c47d77400db00a5763
-  data.tar.gz: 64d674a910a34d4e52e0f68a225ed47b4b7f0187
+  metadata.gz: 225f06ee6d4cc91ec236835358e7045a474fa735
+  data.tar.gz: d0808a1d0c945e5bcc8cd57f910465be741ee812
 SHA512:
-  metadata.gz: 058483c08426b1cf35715950b3ecb6681badc5ee7d7eb822e70f168b005f50b61ed1ddcf096f79b0b154eb79f9280e669d94a4f9b7ec61903623297e211a92a2
-  data.tar.gz: cc150c931632cc9938b72ca6b432faba37023de6625008424924bc552cffc361500046bbed3a05cc305ede2350d15f667394a0f93bce38e489aced7102fe456b
+  metadata.gz: bdb068e5b17f183941b755930f1c95c8f9a9d62b3afb57fb98eddbaad4788585bca9cd632443a67b52eb9f7e424da2a3cb58a8ffb81c3f434c24f8e8c991e321
+  data.tar.gz: 5a714ffb902a523ccc9dd301fc37c883ae1fefbc373b3760e7e2d6522ba5e80d618dcab508c6b5bb2618c0caf7988beab0dd271c647cfb3e37c24f3ac0eb4ae1

data/lib/rk_fx_rates.rb

@@ -23,11 +23,14 @@ module RkFxRates
   class ExchangeRate
     include HTTParty
 
+
+    # Load Ecb as default provider
   	def initialize(source = RkFxRates::Provider::Ecb)
   		@source = source
       @fx_hash = retrieve
   	end
 
+    # Only download the latest update when the stored data is outdated or not available
     def retrieve
       retrieve_latest unless File.exists?('exchange_rates.store')
       fx_hash = YAML::load_file('exchange_rates.store')['rates']
@@ -46,6 +49,7 @@ module RkFxRates
       return fx_hash
     end
 
+    # calculates the rate by converting to EUR first
     def at(date, from_currency, to_currency)
       return to_euro(date, from_currency) * from_euro(date, to_currency)
     end
@@ -54,8 +58,9 @@ module RkFxRates
       @fx_hash["data"].first[1].keys
     end
 
+    # returns collection in Ruby::Date format
     def available_dates
-      return @fx_hash["data"].keys
+      @fx_hash["data"].keys
     end
 
     private
@@ -76,5 +81,6 @@ module RkFxRates
         store['rates'] = fx_hash        
       end
     end
-  end 
-end
+    
+  end # class ExchangeRate
+end # module RkFxRates

data/lib/rk_fx_rates/provider/ecb.rb

@@ -1,11 +1,14 @@
 module RkFxRates
   module Provider
+
+    # Exchange rates over the last 90 days rom the European Central Bank
     class Ecb
       
       def self.data_url
         return 'http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'        
       end
 
+      # convert xml to a defined default format
       # see rk_fx_rates.rb for data structure description
       def self.generate_fx_hash(data)
         fx_hash = Hash.new

data/lib/rk_fx_rates/version.rb

@@ -1,3 +1,3 @@
 module RkFxRates
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/lib/rk_fx_rates_spec.rb

@@ -3,6 +3,9 @@ require 'spec_helper'
 describe RkFxRates do
 
   before(:each) do
+    # too slow
+    # File.delete('exchange_rates.store')
+    @date = Chronic.parse('last monday').to_date
     @fx_api = RkFxRates::ExchangeRate.new
   end
 
@@ -17,18 +20,16 @@ describe RkFxRates do
   # using the last monday to make sure the test runs with a weekday date
   # simplified case with Euro as the start currency
   it "should calcute the Exchange rate from EUR to USD" do
-    date = Chronic.parse('last monday').to_date
-    @fx_api.at( date, 'EUR', 'USD' ).should be > 1.2
+    @fx_api.at( @date, 'EUR', 'USD' ).should be > 1.2
   end
 
   it "should calculate the exchange rate from GBP to USD" do
-    date = Chronic.parse('last monday').to_date
-    @fx_api.at(date, 'GBP', 'USD').should be > 1.5
+    @fx_api.at( @date, 'GBP', 'USD').should be > 1.5
   end
 
   it "should calculate the exchange rate from EUR to EUR" do
     date = Chronic.parse('last monday').to_date
-    @fx_api.at(date, 'EUR', 'EUR').should be == 1.0
+    @fx_api.at( @date, 'EUR', 'EUR').should be == 1.0
   end
 
   it "should provide a list with the available currencies" do
@@ -36,8 +37,7 @@ describe RkFxRates do
   end
 
   it "should provide a list with the available dates" do
-    date = Chronic.parse('last monday').to_date
-    @fx_api.available_dates.should include(date)
+    @fx_api.available_dates.should include(@date)
   end
 
   context "with existing and current data" do
@@ -47,8 +47,7 @@ describe RkFxRates do
     end
 
     it "should not download the data again" do
-      date = Chronic.parse('last monday').to_date
-      @fx_api.at(date, 'GBP', 'USD').should be > 1.5
+      @fx_api.at( @date, 'GBP', 'USD').should be > 1.5
     end
 
     after(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rk_fx_rates
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rainer Kuhn