money-open-exchange-rates 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e229d0e2b11a63d0b4393c6e05514ac21fc7c9b
-  data.tar.gz: cd7819397cd60f5de0b8d00cb10d83a9081541e7
+  metadata.gz: 47727fe9bad23633da19274d859b19a6178fac03
+  data.tar.gz: 2ca0a29fd3ac60268bfe16f6bc5ce5245602b5fa
 SHA512:
-  metadata.gz: bdc02f9b9ed0f60ab8fa3499428e6bab435f4b1b119dfc43fbb366f52191d7fdb87b1a330e69c1575c930ed10b560b33a1626ffa786c848c98f1d6637998996a
-  data.tar.gz: 899a474ed72d4638ac0f2dc7b372d963b51cce20b8083b77f15a2807cbb26bdd726ba570dc5f2e5e50ef90e1796a511b6efad7be8e3b310de687821753c9f3c5
+  metadata.gz: 1858044994a092557f0f9db8107ed5e6b537efe1d6d95ee8654f0df7734c83805ea906bedda731ce2729a1dbf6b7b3c5d9846292581d2671da1db6f3a8a52a68
+  data.tar.gz: 893d31e26b8cf61e5242df6253486f7205bd5ba4af50f04e88ad1bec88243747d9705a95fb1bb3df7aab68d1990835816363d72b78daecf67467c19aca751852

data/README.markdown

@@ -12,6 +12,11 @@ moe.cache = 'path/to/file/cache'
 moe.app_id = 'your app id from https://openexchangerates.org/signup'
 moe.update_rates
 
+# (optional)
+# set the seconds after than the current rates are automatically expired
+# by default, they never expire
+moe.ttl_in_seconds = 86400
+
 Money.default_bank = moe
 ```
 
@@ -20,7 +25,7 @@ perhaps with Redis or just a thread safe `Hash` (global). For example:
 
 ```ruby
 moe.cache = Proc.new do |v|
-  key = 'money:exchange_rates']
+  key = 'money:exchange_rates'
   if v
     Thread.current[key] = v
   else

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -14,7 +14,12 @@ class Money
       OER_URL = 'http://openexchangerates.org/latest.json'
 
       attr_accessor :cache, :app_id
-      attr_reader :doc, :oer_rates
+      attr_reader :doc, :oer_rates, :rates_expiration, :ttl_in_seconds
+
+      def ttl_in_seconds=(value)
+        @ttl_in_seconds = value
+        refresh_rates_expiration if ttl_in_seconds
+      end
 
       def update_rates
         exchange_rates.each do |exchange_rate|
@@ -42,15 +47,26 @@ class Money
       def exchange_with(from, to_currency)
         return from if same_currency?(from.currency, to_currency)
         rate = get_rate(from.currency, to_currency)
-        unless rate
-          from_base_rate = get_rate("USD", from.currency)
-          to_base_rate = get_rate("USD", to_currency)
-          raise(Money::Bank::UnknownRateFormat, "No conversion rate known for '#{from.currency.iso_code}' -> '#{to_currency}'") if from_base_rate.nil? || to_base_rate.nil?
-          rate = to_base_rate.to_f / from_base_rate.to_f
-        end
         Money.new(((Money::Currency.wrap(to_currency).subunit_to_unit.to_f / from.currency.subunit_to_unit.to_f) * from.cents * rate).round, to_currency)
       end
 
+      def get_rate(from_currency, to_currency)
+        expire_rates
+        super(from_currency, to_currency) || begin
+          from_base_rate = super("USD", from_currency)
+          to_base_rate = super("USD", to_currency)
+          raise(Money::Bank::UnknownRateFormat, "No conversion rate known for '#{from_currency}' -> '#{to_currency}'") if from_base_rate.nil? || to_base_rate.nil?
+          to_base_rate.to_f / from_base_rate.to_f
+        end
+      end
+
+      def expire_rates
+        if ttl_in_seconds && rates_expiration <= Time.now
+          update_rates
+          refresh_rates_expiration
+        end
+      end
+
       protected
 
       # Store the provided text data by calling the proc method provided
@@ -98,6 +114,10 @@ class Money
         @oer_rates = @doc['rates']
         @doc['rates']
       end
+
+      def refresh_rates_expiration
+        @rates_expiration = Time.now + ttl_in_seconds
+      end
     end
   end
 end

data/test/open_exchange_rates_bank_test.rb

@@ -9,8 +9,6 @@ describe Money::Bank::OpenExchangeRatesBank do
   end
 
   describe 'exchange' do
-    include RR::Adapters::TestUnit
-
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
       @bank.app_id = TEST_APP_ID
@@ -104,7 +102,6 @@ describe Money::Bank::OpenExchangeRatesBank do
   end
 
   describe 'App ID' do
-    include RR::Adapters::TestUnit
 
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
@@ -123,8 +120,6 @@ describe Money::Bank::OpenExchangeRatesBank do
   end
 
   describe 'no cache' do
-    include RR::Adapters::TestUnit
-
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
       @bank.cache = nil
@@ -143,7 +138,6 @@ describe Money::Bank::OpenExchangeRatesBank do
   end
 
   describe 'no valid file for cache' do
-    include RR::Adapters::TestUnit
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
       @bank.cache = "space_dir#{rand(999999999)}/out_space_file.json"
@@ -162,8 +156,6 @@ describe Money::Bank::OpenExchangeRatesBank do
   end
 
   describe 'using proc for cache' do
-    include RR::Adapters::TestUnit
-
     before :each do
       $global_rates = nil
       @bank = Money::Bank::OpenExchangeRatesBank.new
@@ -195,8 +187,6 @@ describe Money::Bank::OpenExchangeRatesBank do
   end
 
   describe 'save rates' do
-    include RR::Adapters::TestUnit
-
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
       @bank.app_id = TEST_APP_ID
@@ -239,4 +229,88 @@ describe Money::Bank::OpenExchangeRatesBank do
       File.delete @temp_cache_path
     end
   end
+
+  describe 'get rate' do
+    subject { Money::Bank::OpenExchangeRatesBank.new }
+    LVL_TO_LTL =  5
+    USD_TO_RUB = 50
+    USD_TO_EUR = 1.3
+
+    before do
+      # some kind of stubbing base class
+      Money::Bank::VariableExchange.class_eval do
+        def get_rate(from, to)
+          if from == 'LVL' && to == 'LTL'
+            LVL_TO_LTL
+          elsif from == 'USD' && to == 'RUB'
+            USD_TO_RUB
+          elsif from == 'USD' && to == 'EUR'
+            USD_TO_EUR
+          else
+            nil
+          end
+        end
+      end
+    end
+
+    it 'returns rate if Money::Bank::VariableExchange#get_rate returns rate' do
+      subject.get_rate('LVL','LTL').must_equal LVL_TO_LTL
+    end
+
+    describe 'calculate cross rate using "USD" rate value if no data was returned by Money::Bank::VariableExchange#get_rate' do
+
+      it 'returns cross rate if "USD" rates for provided currencies exist' do
+        eur_to_rub_cross_rate = USD_TO_RUB / USD_TO_EUR
+        subject.get_rate('EUR', 'RUB').must_equal eur_to_rub_cross_rate
+      end
+
+      it 'raises Money::Bank::UnknownRateFormat if no cross rates found' do
+        ->{ subject.get_rate('ZAR', 'ZMK') }.must_raise Money::Bank::UnknownRateFormat
+      end
+    end
+  end
+
+  describe '#expire_rates' do
+    before do
+      @bank = Money::Bank::OpenExchangeRatesBank.new
+      @bank.app_id = TEST_APP_ID
+      @bank.ttl_in_seconds = 1000
+      @usd_eur_rate = 0.655
+      @bank.add_rate('USD', 'EUR', @usd_eur_rate)
+      @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
+      @bank.cache = @temp_cache_path
+      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+    end
+
+    describe 'when the ttl has expired' do
+      before do
+        new_time = Time.now + 1001
+        Timecop.freeze(new_time)
+      end
+
+      after do
+        Timecop.return
+      end
+
+      it 'should update the rates' do
+        @bank.update_rates
+        @bank.get_rate('USD', 'EUR').wont_equal @usd_eur_rate
+      end
+
+      it 'updates the next expiration time' do
+        exp_time = Time.now + 1000
+
+        @bank.expire_rates
+        @bank.rates_expiration.must_equal exp_time
+      end
+    end
+
+    describe 'when the ttl has not expired' do
+      it 'not should update the rates' do
+        exp_time = @bank.rates_expiration
+        @bank.expire_rates
+        @bank.rates_expiration.must_equal exp_time
+      end
+    end
+  end
 end

data/test/test_helper.rb

@@ -2,6 +2,10 @@
 require 'minitest/autorun'
 require 'rr'
 require 'money/bank/open_exchange_rates_bank'
+require 'monetize/core_extensions'
+require 'timecop'
+require 'pry'
+Money.silence_core_extensions_deprecations = true
 
 TEST_APP_ID_PATH = File.join(File.dirname(__FILE__), '..', 'TEST_APP_ID')
 TEST_APP_ID = ENV['TEST_APP_ID'] || File.read(TEST_APP_ID_PATH)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Laurent Arnoud
@@ -9,76 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.7.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 description: A gem that calculates the exchange rate using published rates from open-exchange-rates.
@@ -89,15 +117,16 @@ extensions: []
 extra_rdoc_files:
 - README.markdown
 files:
+- Gemfile
 - LICENSE
 - README.markdown
-- Gemfile
 - lib/money/bank/open_exchange_rates_bank.rb
 - test/latest.json
-- test/test_helper.rb
 - test/open_exchange_rates_bank_test.rb
+- test/test_helper.rb
 homepage: http://github.com/spk/money-open-exchange-rates
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -105,17 +134,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A gem that calculates the exchange rate using published rates from open-exchange-rates.