xrate 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38091bf237eb0b4f2a4547bd7e1252ad2b94c1bc0d34afe53e2339ebdffa7aac
-  data.tar.gz: f04b189d4f24013c8aa7b50d7afe32cbed09e615b404dbd9b2dcb63885801207
+  metadata.gz: 42283c21f607751e2038cf4f3cca867aaa48b1aaaa98af19ca6fefba7bcf0493
+  data.tar.gz: 740e9e2c3a233068a3b67755d22c6ee0060b687b2f0f6dd92b5bdf7fb59ef783
 SHA512:
-  metadata.gz: a5bbc4e89ac04305364dea713ad77253030abc067988783f1d4a75de7fc89feb0aed0c3d0626767c80fd8dab63e57ee9395f8069cb5c97d9dab155ebae27c469
-  data.tar.gz: c06f2f5bc45fff34ffe411026223ad0c3c4526bed433d8d633d5ce988ac13b351ba5ebf2edddb0ee62b06a131d4eccce93eb543a4d2618cf63427767cbb701d6
+  metadata.gz: 866853d5403916db473e36a2c1bf45eec894bb262790eaa16a3ee83f3ed528cba2b09a5edb9c39aec45e0722e96db4790b92ded3511c0dfddb2d9d38b98c7f33
+  data.tar.gz: 2746022c870330e728145087b7fc773320c6468871b319bdc9789830277a217bc4c3f39aaf82538ed4b3ee0e0f7072e40f706f6225a35f72fbb27a50889dc721

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xrate (0.1.0)
+    xrate (0.1.3)
       nokogiri (~> 1.8)
 
 GEM

data/README.md

@@ -19,18 +19,18 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+### Environment variables
+Xrate assumes that all rates will be against a base currency defined in the environment variable `XRATE_BASE_CURRENCY`, for example "EUR".
 
-    $ gem install xrate
+Exchange rate datasets will often have missing data, due to market closures (e.g. weekends and religious/national holidays).  To handle this, Xrate will fall back to the last available datapoint, within a given number of days.  This fallback range *must* be provided in the environment variable `XRATE_FALLBACK_DAYS`.  A sensible default for this is 4, as this will cover Easter and any Christmas that spans a weekend.  You can increase/decrease this depending on the dataset and the accuracy your application requires.
 
+### Local database table
 Xrate stores a cache of the current exhange rates in the database and assumes `ActiveRecord` is present.  To generate the migration for this table, run `rails generate xrate:install` and `rails db:migrate` to run the migration.
 
-Xrate assumes that all rates will be against a base currency defined in the environment variable "XRATE_BASE_CURRENCY".
-
 ## Usage
 To get the last 90 days of exhange rate data from the [European Central Bank](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml), run `rake xrate:import`.  This can be run on a regular basis to keep your rate cache up to date.  Note, Xrate will always take the last import as correct, overwriting any previous stored rates.
 
-Lookups are made by running `Xrate::ExchangeRate.at({date}, {source}, {target})`
+Lookups are made by running `Xrate::ExchangeRate.at({date}, {source_currency}, {target_currency})`
 
 ### Example
 To find out the how much £1 was worth in USD the day before brexit, you would run:

data/lib/xrate/exchange_rate.rb

@@ -4,28 +4,33 @@ require "unconvertable_currency_exception"
 
 module Xrate
   class ExchangeRate
-    def self.at(date, from, target)
-      get_rate_at(date, from, target) or
+    def self.at(date, from_currency, target_currency)
+      date_range = (date - fallback_days)..date
+      get_latest(date_range, from_currency, target_currency) or
         raise Xrate::UnconvertableCurrencyException
     end
 
-    def self.get_rate_at(date, from, target)
-      if from == ENV.fetch("XRATE_BASE_CURRENCY")
-        Xrate::Rate.where(date: date, currency: target).first&.rate
+    def self.get_latest(date_range, from_currency, target_currency)
+      if from_currency == ENV.fetch("XRATE_BASE_CURRENCY")
+        Xrate::Rate.where(date: date_range, currency: target_currency).first&.rate
       else
-        calculate_rate(date, from, target)
+        calculate_rate(date_range, from_currency, target_currency)
       end
     end
 
-    def self.calculate_rate(date, from, target)
+    def self.calculate_rate(date_range, from_currency, target_currency)
       begin
-        base_to_from = Xrate::Rate.where(date: date, currency: from).first&.rate
-        base_to_target = Xrate::Rate.where(date: date, currency: target).first&.rate
+        base_to_from = Xrate::Rate.where(date: date_range, currency: from_currency).first&.rate
+        base_to_target = Xrate::Rate.where(date: date_range, currency: target_currency).first&.rate
 
         base_to_target / base_to_from
       rescue NoMethodError # handle divide by zero
         nil
       end
     end
+
+    def self.fallback_days
+      ENV.fetch("XRATE_FALLBACK_DAYS").to_i
+    end
   end
 end

data/lib/xrate/rate.rb

@@ -3,6 +3,8 @@ require "active_record"
 module Xrate
   class Rate < ActiveRecord::Base
     self.table_name = "xrate_exchange_rates"
+    default_scope { order(date: :desc) }
+
     validates :currency, uniqueness: { scope: :date }
     validates :currency, :rate, :date, presence: true
   end

data/lib/xrate/version.rb

@@ -1,3 +1,3 @@
 module Xrate
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xrate
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sam Ward