money-open-exchange-rates 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca083dbf9fddf98dd83014ecfdd3ab592d30edcfe96b9a6b6086b66f5e99eadd
-  data.tar.gz: 3c3e381dea270d1c19843833d2c426ced7e8986678adb3ea1e3b2efcc521751d
+  metadata.gz: 533cde694f8fe852a3c3876b5433871d66aa438184978a676296c93867d58132
+  data.tar.gz: 793cc9510199cd8d4da3ac1e05bbd133e154ed167eeee585feeadeb403b0cc36
 SHA512:
-  metadata.gz: 4737d36a2bc739e9594ab3a1ecf744c242aa694c3c44f216c17969cfa188f9e635621c28dea9ba12abcf1a8e1eb6af4ffb59f3a828d10beeac678da70a003c68
-  data.tar.gz: 80aa7a95bf5b2d01562726b0cbbe95b7dbae45103632cf722469a03b521d75c284112970f8bd5603de5be7895bea890d605c061559ab94db0aa5ea85200896e2
+  metadata.gz: b8d3e1d9900ebd8ecd0c9d2c723697c0d0ba9416f9ac82c4dc0ed8264ca8822571c841441d445e55ef655fece32019a5c8c397f83ffd27766689128edbe54f0b
+  data.tar.gz: 78cb56294a55bc7f6b7f7daff77f4f5acae9cacd9516cb9e5b85544674ed3dd56898b2d138b2c5af2623ab3d583dc26af55b79d4d4437e4c915ca68b2586aca3

data/History.md

@@ -1,4 +1,11 @@
 
+v1.2.0 / 2018-03-31
+===================
+
+  * Merge pull request #51 from spk/fix-expire_rates
+    * Add force_refresh_rate_on_expire option and use api timestamp
+  * README: info currency-exchange
+
 v1.1.1 / 2018-03-30
 ===================
 

data/README.md

@@ -1,7 +1,9 @@
 # Money Open Exchange Rates
 
 A gem that calculates the exchange rate using published rates from
-[open-exchange-rates](https://openexchangerates.org/)
+[open-exchange-rates](https://openexchangerates.org/). Compatible with
+[Money](https://github.com/RubyMoney/money#currency-exchange) [currency
+exchange](http://www.rubydoc.info/gems/money/Money/Bank/VariableExchange).
 
 Check [api documentation](https://docs.openexchangerates.org/)
 
@@ -42,37 +44,56 @@ gem install money-open-exchange-rates
 
 ~~~ ruby
 require 'money/bank/open_exchange_rates_bank'
+
+# Memory store per default; for others just pass as argument a class like
+# explained in https://github.com/RubyMoney/money#exchange-rate-stores
 oxr = Money::Bank::OpenExchangeRatesBank.new
-# see https://github.com/spk/money-open-exchange-rates#cache for more info
-oxr.cache = 'path/to/file/cache.json'
 oxr.app_id = 'your app id from https://openexchangerates.org/signup'
 oxr.update_rates
 
 # (optional)
-# set the seconds after than the current rates are automatically expired
+# See https://github.com/spk/money-open-exchange-rates#cache for more info
+# Updated only when `refresh_rates` is called
+oxr.cache = 'path/to/file/cache.json'
+
+# (optional)
+# Set the seconds after than the current rates are automatically expired
 # by default, they never expire, in this example 1 day.
+# This ttl is about money store (memory, database ...) passed though
+# `Money::Bank::OpenExchangeRatesBank` as argument not about `cache` option.
+# The base time is the timestamp fetched from API.
 oxr.ttl_in_seconds = 86400
+
 # (optional)
-# set historical date of the rate
+# Set historical date of the rate
 # see https://openexchangerates.org/documentation#historical-data
 oxr.date = '2015-01-01'
+
 # (optional)
 # Set the base currency for all rates. By default, USD is used.
 # OpenExchangeRates only allows USD as base currency
 # for the free plan users.
 oxr.source = 'USD'
+
 # (optional)
 # Extend returned values with alternative, black market and digital currency
 # rates. By default, false is used
 # see: https://docs.openexchangerates.org/docs/alternative-currencies
 oxr.show_alternative = true
+
 # (optional)
-# Store in cache
-# Force rates storage in cache, this is done automaticly after TTL is expire.
+# Refresh rates, store in cache and update rates
+# Should be used on crontab/worker/scheduler `Money.default_bank.refresh_rates`
 # If you are using unicorn-worker-killer gem or on Heroku like platform,
 # you should avoid to put this on the initializer of your Rails application,
 # because will increase your OXR API usage.
-oxr.save_rates
+oxr.refresh_rates
+
+# (optional)
+# Force refresh rates cache and store on the fly when ttl is expired
+# This will slow down request on get_rate, so use at your on risk, if you don't
+# want to setup crontab/worker/scheduler for your application
+oxr.force_refresh_rate_on_expire = true
 
 Money.default_bank = oxr
 
@@ -109,22 +130,32 @@ oxr.cache = Proc.new do |text|
 end
 ~~~
 
+To update the cache call `Money.default_bank.refresh_rates` on
+crontab/worker/scheduler. This have to be done this way because the fetch can
+take some time (HTTP call) and can fail.
+
 ## Full example configuration initializer with Rails and cache
 
 ~~~ ruby
 require 'money/bank/open_exchange_rates_bank'
 
 OXR_CACHE_KEY = 'money:exchange_rates'.freeze
-oxr = Money::Bank::OpenExchangeRatesBank.new
+# ExchangeRate is an ActiveRecord model
+# more info at https://github.com/RubyMoney/money#exchange-rate-stores
+oxr = Money::Bank::OpenExchangeRatesBank.new(ExchangeRate)
 oxr.ttl_in_seconds = 86400
 oxr.cache = Proc.new do |text|
   if text
+    # only expire when refresh_rates is called or `force_refresh_rate_on_expire`
+    # option is enabled
+    # you can also set `expires_in` option on write to force fetch new rates
     Rails.cache.write(OXR_CACHE_KEY, text)
   else
     Rails.cache.read(OXR_CACHE_KEY)
   end
 end
 oxr.app_id = ENV['OXR_API_KEY']
+oxr.show_alternative = true
 oxr.update_rates
 
 Money.default_bank = oxr

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -28,6 +28,8 @@ class Money
 
       # Default base currency "base": "USD"
       OE_SOURCE = 'USD'.freeze
+      RATES_KEY = 'rates'.freeze
+      TIMESTAMP_KEY = 'timestamp'.freeze
 
       # @deprecated secure_connection is deprecated and has no effect
       def secure_connection=(*)
@@ -64,6 +66,13 @@ class Money
       # @return [String] The requested date in YYYY-MM-DD format
       attr_accessor :date
 
+      # Force refresh rates cache and store on the fly when ttl is expired
+      # This will slow down request on get_rate, so use at your on risk, if you
+      # don't want to setup crontab/worker/scheduler for your application
+      #
+      # @param [Boolean]
+      attr_accessor :force_refresh_rate_on_expire
+
       # Rates expiration Time
       #
       # @return [Time] expiration time
@@ -93,6 +102,20 @@ class Money
       # @return [Boolean] Setted show alternative
       attr_writer :show_alternative
 
+      # Set current rates timestamp
+      #
+      # @return [Time]
+      def rates_timestamp=(at)
+        @rates_timestamp = Time.at(at)
+      end
+
+      # Current rates timestamp
+      #
+      # @return [Time]
+      def rates_timestamp
+        @rates_timestamp || Time.at(0)
+      end
+
       # Set the seconds after than the current rates are automatically expired
       # by default, they never expire.
       #
@@ -144,17 +167,6 @@ class Money
         end
       end
 
-      # Save rates on cache
-      # Can raise InvalidCache
-      #
-      # @return [Proc,File]
-      def save_rates
-        return nil unless cache
-        store_in_cache(@json_response) if valid_rates?(@json_response)
-      rescue Errno::ENOENT
-        raise InvalidCache
-      end
-
       # Alias super method
       alias super_get_rate get_rate
 
@@ -171,13 +183,23 @@ class Money
         rate || calc_pair_rate_using_base(from_currency, to_currency, opts)
       end
 
+      # Fetch from url and save cache
+      #
+      # @return [Array] Array of exchange rates
+      def refresh_rates
+        read_from_url
+      end
+
+      # Alias refresh_rates method
+      alias save_rates refresh_rates
+
       # Expire rates when expired
       #
       # @return [NilClass, Time] nil if not expired or new expiration time
       def expire_rates
         return unless ttl_in_seconds
         return if rates_expiration > Time.now
-        read_from_url
+        refresh_rates if force_refresh_rate_on_expire
         update_rates
         refresh_rates_expiration
       end
@@ -205,6 +227,16 @@ class Money
 
       protected
 
+      # Save rates on cache
+      # Can raise InvalidCache
+      #
+      # @return [Proc,File]
+      def save_cache
+        store_in_cache(@json_response) if valid_rates?(@json_response)
+      rescue Errno::ENOENT
+        raise InvalidCache
+      end
+
       # Latest url if no date given
       #
       # @return [String] URL
@@ -266,7 +298,7 @@ class Money
       def read_from_url
         raise NoAppId if app_id.nil? || app_id.empty?
         @json_response = open(source_url).read
-        save_rates
+        save_cache if cache
         @json_response
       end
 
@@ -280,7 +312,7 @@ class Money
       def valid_rates?(text)
         return false unless text
         parsed = JSON.parse(text)
-        parsed && parsed.key?('rates')
+        parsed && parsed.key?(RATES_KEY) && parsed.key?(TIMESTAMP_KEY)
       rescue JSON::ParserError
         false
       end
@@ -290,14 +322,15 @@ class Money
       # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
       def exchange_rates
         doc = JSON.parse(read_from_cache || read_from_url)
-        @oer_rates = doc['rates']
+        self.rates_timestamp = doc[TIMESTAMP_KEY]
+        @oer_rates = doc[RATES_KEY]
       end
 
       # Refresh expiration from now
       #
       # @return [Time] new expiration time
       def refresh_rates_expiration
-        @rates_expiration = Time.now + ttl_in_seconds
+        @rates_expiration = rates_timestamp + ttl_in_seconds
       end
 
       # Get rate or calculate it as inverse rate

data/lib/open_exchange_rates_bank/version.rb

@@ -2,5 +2,5 @@
 
 # Module for version constant
 module OpenExchangeRatesBank
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/test/open_exchange_rates_bank_test.rb

@@ -23,7 +23,6 @@ describe Money::Bank::OpenExchangeRatesBank do
       add_to_webmock(subject)
       subject.cache = temp_cache_path
       subject.update_rates
-      subject.save_rates
     end
 
     after do
@@ -148,13 +147,10 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
 
     it 'should get from url' do
+      dont_allow(subject).save_cache
       subject.update_rates
       subject.oer_rates.wont_be_empty
     end
-
-    it 'should return nil when cache is nil' do
-      subject.save_rates.must_equal nil
-    end
   end
 
   describe 'secure_connection' do
@@ -197,7 +193,7 @@ describe Money::Bank::OpenExchangeRatesBank do
       add_to_webmock(subject)
     end
 
-    it 'should raise an error if invalid path is given to save_rates' do
+    it 'should raise an error if invalid path is given to update_rates' do
       proc { subject.update_rates }.must_raise Money::Bank::InvalidCache
     end
   end
@@ -221,7 +217,6 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
 
     it 'should save from url and get from cache' do
-      subject.save_rates
       @global_rates.wont_be_empty
       dont_allow(subject).source_url
       subject.update_rates
@@ -229,12 +224,11 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
   end
 
-  describe 'save rates' do
+  describe '#refresh_rates' do
     before do
       add_to_webmock(subject)
       subject.cache = temp_cache_path
       subject.update_rates
-      subject.save_rates
     end
 
     after do
@@ -243,7 +237,7 @@ describe Money::Bank::OpenExchangeRatesBank do
 
     it 'should allow update after save' do
       begin
-        subject.update_rates
+        subject.refresh_rates
       rescue
         assert false, 'Should allow updating after saving'
       end
@@ -252,31 +246,45 @@ describe Money::Bank::OpenExchangeRatesBank do
     it 'should not break an existing file if save fails to read' do
       initial_size = File.read(temp_cache_path).size
       stub(subject).read_from_url { '' }
-      subject.save_rates
+      subject.refresh_rates
       File.open(temp_cache_path).read.size.must_equal initial_size
     end
 
     it 'should not break an existing file if save returns json without rates' do
       initial_size = File.read(temp_cache_path).size
       stub(subject).read_from_url { '{"error": "An error"}' }
-      subject.save_rates
+      subject.refresh_rates
       File.open(temp_cache_path).read.size.must_equal initial_size
     end
 
     it 'should not break an existing file if save returns a invalid json' do
       initial_size = File.read(temp_cache_path).size
       stub(subject).read_from_url { '{invalid_json: "An error"}' }
-      subject.save_rates
+      subject.refresh_rates
       File.open(temp_cache_path).read.size.must_equal initial_size
     end
   end
 
+  describe '#rates_timestamp' do
+    before do
+      add_to_webmock(subject)
+    end
+
+    it 'should be set on update_rates' do
+      subject.update_rates
+      subject.rates_timestamp.must_equal Time.at(1_414_008_044)
+    end
+  end
+
   describe '#expire_rates' do
     before do
       add_to_webmock(subject)
-      subject.ttl_in_seconds = 1000
+      # see test/data/latest.json +4
+      subject.rates_timestamp = 1_414_008_044
+      @ttl_in_seconds = 1000
+      subject.ttl_in_seconds = @ttl_in_seconds
       @old_usd_eur_rate = 0.655
-      # see test/latest.json +52
+      # see test/data/latest.json +52
       @new_usd_eur_rate = 0.79085
       subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
       @global_rates = nil
@@ -291,47 +299,57 @@ describe Money::Bank::OpenExchangeRatesBank do
 
     describe 'when the ttl has expired' do
       it 'should update the rates' do
-        subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
-        Timecop.freeze(Time.now + 1001) do
+        Timecop.freeze(subject.rates_timestamp) do
+          subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
+        end
+        Timecop.freeze(subject.rates_timestamp + (@ttl_in_seconds + 1)) do
           subject.get_rate('USD', 'EUR').wont_equal @old_usd_eur_rate
           subject.get_rate('USD', 'EUR').must_equal @new_usd_eur_rate
         end
       end
 
       it 'should save rates' do
-        subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
-        Timecop.freeze(Time.now + 1001) do
-          subject.get_rate('USD', 'EUR').must_equal @new_usd_eur_rate
-          @global_rates.wont_be_empty
+        Timecop.freeze(subject.rates_timestamp) do
+          subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
         end
-      end
-
-      it 'should save rates and refresh it when cache is invalid' do
-        subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
-        Timecop.freeze(Time.now + 1001) do
-          @global_rates = []
+        Timecop.freeze(subject.rates_timestamp + (@ttl_in_seconds + 1)) do
           subject.get_rate('USD', 'EUR').must_equal @new_usd_eur_rate
           @global_rates.wont_be_empty
         end
       end
 
       it 'updates the next expiration time' do
-        Timecop.freeze(Time.now + 1001) do
-          exp_time = Time.now + 1000
+        Timecop.freeze(subject.rates_timestamp + (@ttl_in_seconds + 1)) do
+          exp_time = subject.rates_timestamp + @ttl_in_seconds
           subject.expire_rates
           subject.rates_expiration.must_equal exp_time
         end
       end
+
+      describe '#force_refresh_rate_on_expire' do
+        it 'should save rates and force refresh' do
+          subject.force_refresh_rate_on_expire = true
+          Timecop.freeze(subject.rates_timestamp) do
+            subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
+          end
+          Timecop.freeze(Time.now + 1001) do
+            @global_rates = []
+            subject.get_rate('USD', 'EUR').must_equal @new_usd_eur_rate
+            @global_rates.wont_be_empty
+          end
+        end
+      end
     end
 
     describe 'when the ttl has not expired' do
-      it 'not should update the rates' do
+      it 'should not update the rates' do
         exp_time = subject.rates_expiration
-        dont_allow(subject).read_from_url
-        dont_allow(subject).update_rates
-        dont_allow(subject).refresh_rates_expiration
-        subject.expire_rates
-        subject.rates_expiration.must_equal exp_time
+        Timecop.freeze(subject.rates_timestamp) do
+          dont_allow(subject).update_rates
+          dont_allow(subject).refresh_rates_expiration
+          subject.expire_rates
+          subject.rates_expiration.must_equal exp_time
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Laurent Arnoud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2018-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money