exchange_rates 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f53418a5a4f780eb32abd1760186c270b96d687
+  data.tar.gz: 66de054b372efc9638957322a6cc738b87eb02d3
+SHA512:
+  metadata.gz: 6c557a9a6dcdf257d7174429372e0ec01a5524f491396cd47e1d6df750ec9f3af89cd6ee00e12707efa05b2ffd903d1ef5573eeff58c8c144b368ec3bf36cf3b
+  data.tar.gz: 108226d20f7c576cfffcf6cb42b4c0f0a18a400a81b325d215d145910682bba7d13b681ce03085bdcc62da5489150124008040af3f1e51d0f12e0048329c7dc0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+exchange-rates.xml

data/README.md

@@ -21,11 +21,11 @@ Or install it yourself as:
 
 ## Usage
 
-The first task that the programmer must use is to obtain the data source. The library assumes it will be in `./exchange-rates.xml`, however the path can be set via the environment variable `EXCHANGE_RATE_FILE`, which should point to the exchange rate file. This file can be downloaded from the [ECB website](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml). 
+The first task that the programmer must use is to obtain the data source. The library assumes it will be in `./exchange-rates.xml`, however the path can be set via the environment variable `EXCHANGE_RATE_FILE`, which should point to the exchange rate file. This file can be downloaded from the [ECB website](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml).
 
-You can add this to your crontab to automatically download the updated files (where MY_PROJECT_PATH is an absolute path to your project). 
-
-    @daily curl -o MY_PROJECT_PATH/exchange-rates.xml http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml >/dev/null 2>&1
+The library will fetch this file automatically if not present, however it is your responsibility to
+maintain this file as fresh as you need it. You can download a new version with
+`ExchangeRates.fetch_rates!`.
 
 Finally if you have a different datasource, you can simply parse it and call `ExchangeRates.set_rates(data, base_currency)`, where `data` will be your currency data organized by date and `base_currency` will be the currency code to which your rates are relative to. For example:
 

data/lib/exchange_rates.rb

@@ -1,12 +1,12 @@
 require "exchange_rates/version"
 require "nokogiri"
 
-# Exchange Rates is responsible for parsing a locally available XML file 
+# Exchange Rates is responsible for parsing a locally available XML file
 # listing ratios between the base_currency and target currencies. All currencies should
 # be provided as strings with their 3 letter code.
 class ExchangeRates
   # ExchangeRates.at gives an exchange rate between two currencies at a particular
-  # date. Raises exceptions if the dates are out of range of the file or if the 
+  # date. Raises exceptions if the dates are out of range of the file or if the
   # currencies are unknown.
   def self.at(date, from, to)
     parse_rates
@@ -28,20 +28,20 @@ class ExchangeRates
       to_rate / from_rate
     else
       raise "Date out of known dates."
-    end  
+    end
   end
-  
+
   # Converts an amount of money between currencies. The options for this method are:
   #
   #    from - from currency, defaults to base_currency (typically EUR)
   #    to   - to currency, defaults to  base_currency (typically EUR)
-  #    date - date at which to perform conversion, defaults to current date
+  #    date - date at which to perform conversion, defaults to latest available date in dateset
   def self.convert(amount, opts = {})
     parse_rates
-    options = {from: @@base_currency, to: @@base_currency, date: Date.today}.merge(opts)
+    options = {from: @@base_currency, to: @@base_currency, date: @@rates.keys.sort.reverse.first}.merge(opts)
     amount.to_f * at(options[:date], options[:from], options[:to])
   end
-  
+
   # Calculates exchange rates between two currencies over all available dates.
   def self.over_time(from, to)
     parse_rates
@@ -51,9 +51,9 @@ class ExchangeRates
     end
     results
   end
-  
+
   # Reads and parses the XML data feed providing the underlying data source.
-  # The data source is currently assumed to be in the format of the European 
+  # The data source is currently assumed to be in the format of the European
   # Central Bank feed accesible at <http://www.ecb.europa.eu/stats/eurofxref/eurofxref­hist­90d.xml>
   # which provides a 90 day history of exchange rates. It is assumed that this
   # file is saved locally, best through a cron tab (see README).
@@ -63,18 +63,29 @@ class ExchangeRates
     return @@rates if @@rates
     @@base_currency = 'EUR'
     rate_file = ENV['EXCHANGE_RATE_FILE'] || './exchange-rates.xml'
-    doc = Nokogiri::XML(File.read(rate_file))
+    if File.exist?(rate_file)
+      doc = Nokogiri::XML(File.read(rate_file))
+    else
+      doc = Nokogiri::XML(fetch_rates!)
+    end
     @@rates = {}
     doc.css('Cube>Cube[time]').each do |day|
       time = Date.parse day.attr('time')
       @@rates[time] = {}
-      day.css('Cube').each{ |c| 
+      day.css('Cube').each{ |c|
         @@rates[time][c.attr('currency')] = c.attr('rate').to_f
       }
     end
     @@rates
   end
-  
+
+  # Goes and makes a request to download latest ECB data
+  def self.fetch_rates!
+    rates = Net::HTTP.get URI.parse 'http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'
+    File.write(ENV['EXCHANGE_RATE_FILE'] || './exchange-rates.xml', rates)
+    rates
+  end
+
   # Set custom rates data. The data should be a hash of hashes, where the keys in the
   # outer hash are Date objects and the keys in the inner hashes are three letter currency
   # codes. The values are floats showing the exchange rate between a currency and the base
@@ -84,17 +95,17 @@ class ExchangeRates
     @@rates = rates
     @@base_currency = base
   end
-  
+
   # Outputs an array of dates included in the current data set.
   def self.available_dates
     parse_rates
     @@rates.keys
   end
-    
+
   # Outputs an array of supported currencies.
   def self.available_currencies
     parse_rates
     @@rates.first[1].keys + [@@base_currency]
   end
-  
+
 end

data/lib/exchange_rates/version.rb

@@ -1,3 +1,3 @@
 class ExchangeRates
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/exchange_rates_spec.rb

@@ -36,11 +36,11 @@ describe ExchangeRates do
   end  
   
   it "should give the list of supported currencies" do
-    ExchangeRates.supported_currencies.should eq(%w[USD JPY BGN CZK EUR])
+    ExchangeRates.available_currencies.should eq(%w[USD JPY BGN CZK EUR])
   end
   
   it "should give the list of supported dates" do
-    ExchangeRates.supported_dates.should eq([DATE1, Date::civil(2013, 11, 20)])
+    ExchangeRates.available_dates.should eq([DATE1, Date::civil(2013, 11, 20)])
   end
 end
 

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: exchange_rates
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Jakub Hampl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: exchange_rates is a gem that allows currency conversion and rate history
@@ -67,7 +60,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -80,33 +73,26 @@ files:
 homepage: https://github.com/gampleman/exchange_rates
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1027841455123845636
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1027841455123845636
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gives historical exchange rates
 test_files:
 - spec/exchange_rates_spec.rb