money-open-exchange-rates 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49fa457e043bb1b5a72dfad8f43613bc2098cbf3
-  data.tar.gz: 8ae046254ab9f8744f937a5220605e5947013a6a
+  metadata.gz: 41260f2f17ea64c1a2519d473a7c584225a4dd48
+  data.tar.gz: 06b22a394ddb683769ce63bfd487bc9a621c3941
 SHA512:
-  metadata.gz: 47d4718451656dc368c7d034753f21e172875501470ae973425ccb1bcfbcf2b3694d0eb6e73ad50273b1b89330d89136cec5495d1cc37e700a049f355441e6f3
-  data.tar.gz: 0aafaf01ae251afe65453cdb89c46031c063591ea589e0e0b1c383cf1d768dd71502fce4c53c9b04ca111fe32e558d98d26aef043d1e2df73dfe6473c3b413f1
+  metadata.gz: 83f5bc3cc460e263bcdc3cd691cdac931686239323aa26ebd274f1db89e46ffa8091116e18dee550c3c8da4568f052086559d69fb42a056ea220a13cdfe3ba54
+  data.tar.gz: f7535398b1e704cc7d65d09efb4595788521c0bd678ebed0ddb00d0fd00a0faba8123459c15d0bb94dd7280087f2add16068be80fbcfec5bd4726357c8b417c0

data/History.md

@@ -1,4 +1,12 @@
 
+v0.6.0 / 2016-09-13
+==================
+
+  * Merge pull request #29 from @xsve / pairrates
+    * Implemented rate calculation for any pair of currencies via base currency
+  * Update travis ruby list
+  * Fix usage of URI.join instead of File.join
+
 v0.5.0 / 2016-08-12
 ===================
 

data/README.md

@@ -65,6 +65,9 @@ moe.cache = Proc.new do |v|
 end
 ~~~
 
+Unknown pair rates are transparently calculated: using inverse rate (if known),
+or using base currency rate to both currencies forming the pair.
+
 ## Tests
 
 ~~~

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+require 'uri'
 require 'open-uri'
 require 'money'
 require 'json'
 require File.expand_path('../../../open_exchange_rates_bank/version', __FILE__)
 
 # Money gem class
+# rubocop:disable ClassLength
 class Money
   # https://github.com/RubyMoney/money#exchange-rate-stores
   module Bank
@@ -19,11 +21,16 @@ class Money
       VERSION = ::OpenExchangeRatesBank::VERSION
       BASE_URL = 'http://openexchangerates.org/api'.freeze
       # OpenExchangeRates urls
-      OER_URL = File.join(BASE_URL, 'latest.json')
-      OER_HISTORICAL_URL = File.join(BASE_URL, 'historical', '%s.json')
+      OER_URL = URI.join(BASE_URL, 'latest.json')
+      OER_HISTORICAL_URL = URI.join(BASE_URL, '/historical/')
       # OpenExchangeRates secure url
-      SECURE_OER_URL = OER_URL.gsub('http:', 'https:')
-      SECURE_OER_HISTORICAL_URL = OER_HISTORICAL_URL.gsub('http:', 'https:')
+      SECURE_OER_URL = OER_URL.clone
+      SECURE_OER_URL.scheme = 'https'
+      SECURE_OER_HISTORICAL_URL = OER_HISTORICAL_URL.clone
+      SECURE_OER_HISTORICAL_URL.scheme = 'https'
+
+      # Default base currency "base": "USD"
+      OE_SOURCE = 'USD'.freeze
 
       # use https to fetch rates from Open Exchange Rates
       # disabled by default to support free-tier users
@@ -64,6 +71,28 @@ class Money
         @ttl_in_seconds
       end
 
+      # Set the base currency for all rates. By default, USD is used.
+      # OpenExchangeRates only allows USD as base currency
+      # for the free plan users.
+      #
+      # @example
+      #   source = 'USD'
+      #
+      # @param value [String] Currency code, ISO 3166-1 alpha-3
+      #
+      # @return [String] chosen base currency
+      def source=(value)
+        @source = Money::Currency.find(value.to_s).iso_code
+      rescue
+        @source = OE_SOURCE
+      end
+
+      # Get the base currency for all rates. By default, USD is used.
+      # @return [String] base currency
+      def source
+        @source ||= OE_SOURCE
+      end
+
       # Update all rates from openexchangerates JSON
       # @return [Array] Array of exchange rates
       def update_rates
@@ -71,8 +100,8 @@ class Money
           rate = exchange_rate.last
           currency = exchange_rate.first
           next unless Money::Currency.find(currency)
-          set_rate('USD', currency, rate)
-          set_rate(currency, 'USD', 1.0 / rate)
+          set_rate(source, currency, rate)
+          set_rate(currency, source, 1.0 / rate)
         end
       end
 
@@ -88,14 +117,19 @@ class Money
         raise InvalidCache
       end
 
+      # Alias super method
+      alias super_get_rate get_rate
+
       # Override Money `get_rate` method for caching
       # @param [String] from_currency Currency ISO code. ex. 'USD'
       # @param [String] to_currency Currency ISO code. ex. 'CAD'
       #
       # @return [Numeric] rate.
       def get_rate(from_currency, to_currency, opts = {})
+        super if opts[:call_super]
         expire_rates
-        super
+        rate = get_rate_or_calc_inverse(from_currency, to_currency, opts)
+        rate || calc_pair_rate_using_base(from_currency, to_currency, opts)
       end
 
       # Expire rates when expired
@@ -110,7 +144,11 @@ class Money
       # defined with app_id and secure_connection
       # @return [String] URL
       def source_url
-        "#{oer_url}?app_id=#{app_id}"
+        if source == OE_SOURCE
+          "#{oer_url}?app_id=#{app_id}"
+        else
+          "#{oer_url}?app_id=#{app_id}&base=#{source}"
+        end
       end
 
       protected
@@ -130,7 +168,7 @@ class Money
       def historical_url
         url = OER_HISTORICAL_URL
         url = SECURE_OER_HISTORICAL_URL if secure_connection
-        url % date
+        URI.join(url, "#{date}.json")
       end
 
       # Latest url
@@ -200,6 +238,40 @@ class Money
       def refresh_rates_expiration
         @rates_expiration = Time.now + ttl_in_seconds
       end
+
+      # Get rate or calculate it as inverse rate
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      #
+      # @return [Numeric] rate or rate calculated as inverse rate.
+      def get_rate_or_calc_inverse(from_currency, to_currency, opts = {})
+        rate = super_get_rate(from_currency, to_currency, opts)
+        unless rate
+          # Tries to calculate an inverse rate
+          inverse_rate = super_get_rate(to_currency, from_currency, opts)
+          if inverse_rate
+            rate = 1.0 / inverse_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        rate
+      end
+
+      # Tries to calculate a pair rate using base currency rate
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      #
+      # @return [Numeric] rate or nil if cannot calculate rate.
+      def calc_pair_rate_using_base(from_currency, to_currency, opts)
+        from_base_rate = get_rate_or_calc_inverse(source, from_currency, opts)
+        to_base_rate   = get_rate_or_calc_inverse(source, to_currency, opts)
+        if to_base_rate && from_base_rate
+          rate = to_base_rate.to_f / from_base_rate
+          add_rate(from_currency, to_currency, rate)
+          return rate
+        end
+        nil
+      end
     end
   end
 end

data/lib/open_exchange_rates_bank/version.rb

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

data/test/open_exchange_rates_bank_test.rb

@@ -60,6 +60,11 @@ describe Money::Bank::OpenExchangeRatesBank do
         subject.exchange_with(money, 'USD').must_equal Money.new(100, 'USD')
       end
 
+      it 'should be able to exchange money when direct rate is unknown' do
+        money = Money.new(100, 'BBD')
+        subject.exchange_with(money, 'BMD').must_equal Money.new(50, 'BMD')
+      end
+
       it "should raise if it can't find an exchange rate" do
         money = Money.new(0, 'USD')
         proc { subject.exchange_with(money, 'SSP') }
@@ -160,13 +165,11 @@ describe Money::Bank::OpenExchangeRatesBank do
       end
 
       def historical_url
-        format("#{oer_historical_url}?app_id=#{TEST_APP_ID}",
-               subject.date)
+        "#{oer_historical_url}#{subject.date}.json?app_id=#{TEST_APP_ID}"
       end
 
       def historical_secure_url
-        format("#{oer_historical_secure_url}?app_id=#{TEST_APP_ID}",
-               subject.date)
+        "#{oer_historical_secure_url}#{subject.date}.json?app_id=#{TEST_APP_ID}"
       end
 
       it 'should use the non-secure http url if secure_connection is nil' do
@@ -368,4 +371,16 @@ describe Money::Bank::OpenExchangeRatesBank do
       subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
     end
   end
+
+  describe 'source currency' do
+    it 'should be changed when a known currency is given' do
+      subject.source = 'EUR'
+      subject.source.must_equal 'EUR'
+    end
+
+    it 'should use USD when given unknown currency' do
+      subject.source = 'invalid'
+      subject.source.must_equal 'USD'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Laurent Arnoud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money