money-open-exchange-rates 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2bb0f3d444f2239012893ebb5b147ea7ed833685
-  data.tar.gz: 73c55f153751549bda537ea4450fbe1dcf13b955
+SHA256:
+  metadata.gz: 1cbadeb275d02260424c03168a97965ac705de08b518e2310a58b7dd649a8b53
+  data.tar.gz: 85467d626de3da3637f10a2e9113899ea3ca40df60c845f3fef2b251c618810b
 SHA512:
-  metadata.gz: e84776814c80e1720bd0bac0014fd30b0bd58028c73d1dae3ab284ab374c25eca032c91ee6aab353e308358b977bd18776940c07908cfc871c577e180f692be6
-  data.tar.gz: 8d6cac3341389cf16dd7431b2cd32a1b61d210afd9e650ccdfe6935500a8eba1bcd68de7922a468806ad5ba0a8234cac48fab7ff3034171d45a12d214c9f770d
+  metadata.gz: 2082ea6e2ec8df6b788bda461537b1dd70896d1f849b3b4e644b9fd30a2ee3c5fa1c8168999e4555dabd9b2cf4d2a2b1c714b6c0ec61ee730236c7cd6f7426e9
+  data.tar.gz: 5128bf8ee272026571487a92828550b7e3de82f9d7bd409d014048f1cb2413a26b21fd4261e07df9bfa3105cc0ef1700686427adcfae7adfa37125199a2b056f

data/History.md

@@ -1,4 +1,17 @@
 
+v1.0.0 / 2018-03-25
+===================
+
+  * Merge pull request #41 from @b-mandelbrot /add-show-alternative
+    * Add support for black market and digital currency rates
+  * Merge pull request #42 from spk/save-rates-when-ttl-expire
+    * Save rates to cache after first fetch and add example with Rails
+    * Improve documation about cache and rates ttl
+    * Save rates when ttl expire
+  * Merge pull request #40 from @Jetbuilt / deprecate-secure_connection
+    * Closes #39 - Make all requests over https and deprecate `secure_connection`
+  * Support Ruby >= 2.0
+
 v0.7.0 / 2016-10-23
 ===================
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2016 Laurent Arnoud <laurent@spkdev.net>
+Copyright (c) 2011-2018 Laurent Arnoud <laurent@spkdev.net>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -11,8 +11,12 @@ Check [api documentation](https://docs.openexchangerates.org/)
     [180 currencies](https://docs.openexchangerates.org/docs/supported-currencies).
 * [Free plan](https://openexchangerates.org/signup) hourly updates, with USD
     base and up to 1,000 requests/month.
-* Currency caching.
+* Automatically caches API results to file or Rails cache.
 * Calculate pair rates.
+* Automatically fetches new data from API if data becomes stale when
+    `ttl_in_seconds` option is provided.
+* Support for black market and digital currency rates with `show_alternative`
+    option.
 
 ## Installation
 
@@ -48,11 +52,6 @@ oxr.update_rates
 # by default, they never expire, in this example 1 day.
 oxr.ttl_in_seconds = 86400
 # (optional)
-# use https to fetch rates from Open Exchange Rates
-# disabled by default to support free-tier users
-# see https://openexchangerates.org/documentation#https
-oxr.secure_connection = true
-# (optional)
 # set historical date of the rate
 # see https://openexchangerates.org/documentation#historical-data
 oxr.date = '2015-01-01'
@@ -61,8 +60,17 @@ oxr.date = '2015-01-01'
 # 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
 
 # Store in cache
+# Force rates storage in cache, this is done automaticly after TTL is expire.
+# 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
 
 Money.default_bank = oxr
@@ -70,7 +78,7 @@ Money.default_bank = oxr
 Money.default_bank.get_rate('USD', 'CAD')
 ~~~
 
-You can also provide a Proc as a cache to provide your own caching mechanism
+You can also provide a `Proc` as a cache to provide your own caching mechanism
 perhaps with Redis or just a thread safe `Hash` (global). For example:
 
 ~~~ ruby
@@ -84,9 +92,47 @@ oxr.cache = Proc.new do |v|
 end
 ~~~
 
+With `Rails` cache example:
+
+~~~ ruby
+OXR_CACHE_KEY = 'money:exchange_rates'.freeze
+OXR_CACHE_TTL = 10
+# using same ttl with refreshing current rates and cache
+oxr.ttl_in_seconds = OXR_CACHE_TTL
+oxr.cache = Proc.new do |text|
+  if text && !Rails.cache.exist?(OXR_CACHE_KEY)
+    Rails.cache.write(OXR_CACHE_KEY, text, expires_in: OXR_CACHE_TTL)
+  else
+    Rails.cache.read(OXR_CACHE_KEY)
+  end
+end
+~~~
+
 Unknown pair rates are transparently calculated: using inverse rate (if known),
 or using base currency rate to both currencies forming the pair.
 
+## Full example configuration initializer with Rails and cache
+
+~~~
+require 'money/bank/open_exchange_rates_bank'
+
+OXR_CACHE_KEY = 'money:exchange_rates'.freeze
+OXR_CACHE_TTL = 10
+oxr = Money::Bank::OpenExchangeRatesBank.new
+oxr.ttl_in_seconds = OXR_CACHE_TTL
+oxr.cache = Proc.new do |text|
+  if text && !Rails.cache.exist?(OXR_CACHE_KEY)
+    Rails.cache.write(OXR_CACHE_KEY, text, expires_in: OXR_CACHE_TTL)
+  else
+    Rails.cache.read(OXR_CACHE_KEY)
+  end
+end
+oxr.app_id = ENV['OXR_API_KEY']
+oxr.update_rates
+
+Money.default_bank = oxr
+~~~
+
 ## Tests
 
 ~~~
@@ -108,7 +154,7 @@ See [GitHub](https://github.com/spk/money-open-exchange-rates/graphs/contributor
 
 The MIT License
 
-Copyright © 2011-2016 Laurent Arnoud <laurent@spkdev.net>
+Copyright © 2011-2018 Laurent Arnoud <laurent@spkdev.net>
 
 ---
 [![Build](https://img.shields.io/travis-ci/spk/money-open-exchange-rates.svg)](https://travis-ci.org/spk/money-open-exchange-rates)

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'uri'
 require 'open-uri'
 require 'money'
@@ -19,28 +20,19 @@ class Money
     # OpenExchangeRatesBank base class
     class OpenExchangeRatesBank < Money::Bank::VariableExchange
       VERSION = ::OpenExchangeRatesBank::VERSION
-      BASE_URL = 'http://openexchangerates.org/api/'.freeze
+      BASE_URL = 'https://openexchangerates.org/api/'.freeze
+
       # OpenExchangeRates urls
       OER_URL = URI.join(BASE_URL, 'latest.json')
       OER_HISTORICAL_URL = URI.join(BASE_URL, 'historical/')
-      # OpenExchangeRates secure url
-      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
-      #
-      # @example
-      #   oxr.secure_connection = true
-      #
-      # @param [Boolean] true for https, false for http
-      # @return [Boolean] true for https, false for http
-      attr_accessor :secure_connection
+      # @deprecated secure_connection is deprecated and has no effect
+      def secure_connection=(*)
+        'secure_connection is deprecated and has no effect'
+      end
 
       # As of the end of August 2012 all requests to the Open Exchange Rates
       # API must have a valid app_id
@@ -82,11 +74,25 @@ class Money
       # @return [Hash] All rates as Hash
       attr_reader :oer_rates
 
+      # Unparsed OpenExchangeRates response as String
+      #
+      # @return [String] OpenExchangeRates json response
+      attr_reader :json_response
+
       # Seconds after than the current rates are automatically expired
       #
       # @return [Integer] Setted time to live in seconds
       attr_reader :ttl_in_seconds
 
+      # Set support for the black market and alternative digital currencies
+      # see https://docs.openexchangerates.org/docs/alternative-currencies
+      # @example
+      #   oxr.show_alternative = true
+      #
+      # @param [Boolean] if true show alternative
+      # @return [Boolean] Setted show alternative
+      attr_writer :show_alternative
+
       # Set the seconds after than the current rates are automatically expired
       # by default, they never expire.
       #
@@ -143,9 +149,8 @@ class Money
       #
       # @return [Proc,File]
       def save_rates
-        raise InvalidCache unless cache
-        text = read_from_url
-        store_in_cache(text) if valid_rates?(text)
+        return nil unless cache
+        store_in_cache(@json_response) if valid_rates?(@json_response)
       rescue Errno::ENOENT
         raise InvalidCache
       end
@@ -176,15 +181,24 @@ class Money
         refresh_rates_expiration
       end
 
+      # Get show alternative
+      #
+      # @return [Boolean] if true show alternative
+      def show_alternative
+        @show_alternative ||= false
+      end
+
       # Source url of openexchangerates
-      # defined with app_id and secure_connection
+      # defined with app_id
       #
       # @return [String] URL
       def source_url
         if source == OE_SOURCE
-          "#{oer_url}?app_id=#{app_id}"
+          "#{oer_url}?app_id=#{app_id}" \
+          "&show_alternative=#{show_alternative}"
         else
-          "#{oer_url}?app_id=#{app_id}&base=#{source}"
+          "#{oer_url}?app_id=#{app_id}&base=#{source}" \
+          "&show_alternative=#{show_alternative}"
         end
       end
 
@@ -205,16 +219,13 @@ class Money
       #
       # @return [String] URL
       def historical_url
-        url = OER_HISTORICAL_URL
-        url = SECURE_OER_HISTORICAL_URL if secure_connection
-        URI.join(url, "#{date}.json")
+        URI.join(OER_HISTORICAL_URL, "#{date}.json")
       end
 
       # Latest url
       #
       # @return [String] URL
       def latest_url
-        return SECURE_OER_URL if secure_connection
         OER_URL
       end
 
@@ -252,7 +263,9 @@ class Money
       # @return [String] JSON content
       def read_from_url
         raise NoAppId if app_id.nil? || app_id.empty?
-        open(source_url).read
+        @json_response = open(source_url).read
+        save_rates
+        @json_response
       end
 
       # Check validity of rates response only for store in cache

data/lib/open_exchange_rates_bank/version.rb

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

data/test/open_exchange_rates_bank_test.rb

@@ -1,15 +1,12 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 
+# rubocop:disable Metrics/BlockLength
 describe Money::Bank::OpenExchangeRatesBank do
   subject { Money::Bank::OpenExchangeRatesBank.new }
   let(:oer_url) { Money::Bank::OpenExchangeRatesBank::OER_URL }
   let(:oer_historical_url) do
     Money::Bank::OpenExchangeRatesBank::OER_HISTORICAL_URL
   end
-  let(:oer_secure_url) { Money::Bank::OpenExchangeRatesBank::SECURE_OER_URL }
-  let(:oer_historical_secure_url) do
-    Money::Bank::OpenExchangeRatesBank::SECURE_OER_HISTORICAL_URL
-  end
 
   let(:temp_cache_path) do
     data_file('tmp.json')
@@ -25,6 +22,7 @@ describe Money::Bank::OpenExchangeRatesBank do
     before do
       add_to_webmock(subject)
       subject.cache = temp_cache_path
+      subject.update_rates
       subject.save_rates
     end
 
@@ -130,7 +128,7 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
 
     it 'should raise an error if no App ID is set' do
-      proc { subject.save_rates }.must_raise Money::Bank::NoAppId
+      proc { subject.update_rates }.must_raise Money::Bank::NoAppId
     end
 
     # TODO: As App IDs are compulsory soon, need to add more tests handle
@@ -149,8 +147,8 @@ describe Money::Bank::OpenExchangeRatesBank do
       subject.oer_rates.wont_be_empty
     end
 
-    it 'should raise an error if invalid path is given to save_rates' do
-      proc { subject.save_rates }.must_raise Money::Bank::InvalidCache
+    it 'should return nil when cache is nil' do
+      subject.save_rates.must_equal nil
     end
   end
 
@@ -158,68 +156,30 @@ describe Money::Bank::OpenExchangeRatesBank do
     before do
       subject.app_id = TEST_APP_ID
     end
+    let(:source_url) do
+      "#{oer_url}#{subject.date}?app_id=#{TEST_APP_ID}&show_alternative=false"
+    end
 
     describe 'historical' do
       before do
         subject.date = '2015-01-01'
       end
 
-      def historical_url
-        "#{oer_historical_url}#{subject.date}.json?app_id=#{TEST_APP_ID}"
-      end
-
-      def historical_secure_url
-        "#{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
-        subject.secure_connection = nil
-        subject.source_url.must_equal historical_url
-        subject.source_url.must_include 'http://'
-        subject.source_url.must_include "/api/historical/#{subject.date}.json"
+      let(:historical_url) do
+        "#{oer_historical_url}#{subject.date}.json?app_id=#{TEST_APP_ID}" \
+          '&show_alternative=false'
       end
 
-      it 'should use the non-secure http url if secure_connection is false' do
-        subject.secure_connection = false
+      it 'should use the secure https url' do
         subject.source_url.must_equal historical_url
-        subject.source_url.must_include 'http://'
-        subject.source_url.must_include "/api/historical/#{subject.date}.json"
-      end
-
-      it 'should use the secure https url if secure_connection is true' do
-        subject.secure_connection = true
-        subject.source_url.must_equal historical_secure_url
         subject.source_url.must_include 'https://'
         subject.source_url.must_include "/api/historical/#{subject.date}.json"
       end
     end
 
     describe 'latest' do
-      def source_url
-        "#{oer_url}?app_id=#{TEST_APP_ID}"
-      end
-
-      def source_secure_url
-        "#{oer_secure_url}?app_id=#{TEST_APP_ID}"
-      end
-
-      it 'should use the non-secure http url if secure_connection is nil' do
-        subject.secure_connection = nil
+      it 'should use the secure https url' do
         subject.source_url.must_equal source_url
-        subject.source_url.must_include 'http://'
-        subject.source_url.must_include '/api/latest.json'
-      end
-
-      it 'should use the non-secure http url if secure_connection is false' do
-        subject.secure_connection = false
-        subject.source_url.must_equal source_url
-        subject.source_url.must_include 'http://'
-        subject.source_url.must_include '/api/latest.json'
-      end
-
-      it 'should use the secure https url if secure_connection is true' do
-        subject.secure_connection = true
-        subject.source_url.must_equal source_secure_url
         subject.source_url.must_include 'https://'
         subject.source_url.must_include '/api/latest.json'
       end
@@ -232,31 +192,26 @@ describe Money::Bank::OpenExchangeRatesBank do
       add_to_webmock(subject)
     end
 
-    it 'should get from url' do
-      subject.update_rates
-      subject.oer_rates.wont_be_empty
-    end
-
     it 'should raise an error if invalid path is given to save_rates' do
-      proc { subject.save_rates }.must_raise Money::Bank::InvalidCache
+      proc { subject.update_rates }.must_raise Money::Bank::InvalidCache
     end
   end
 
   describe 'using proc for cache' do
     before do
       @global_rates = nil
-      subject.cache = proc {|v|
+      subject.cache = proc do |v|
         if v
           @global_rates = v
         else
           @global_rates
         end
-      }
+      end
       add_to_webmock(subject)
+      subject.update_rates
     end
 
     it 'should get from url normally' do
-      subject.update_rates
       subject.oer_rates.wont_be_empty
     end
 
@@ -273,6 +228,7 @@ describe Money::Bank::OpenExchangeRatesBank do
     before do
       add_to_webmock(subject)
       subject.cache = temp_cache_path
+      subject.update_rates
       subject.save_rates
     end
 
@@ -318,12 +274,14 @@ describe Money::Bank::OpenExchangeRatesBank do
       # see test/latest.json +52
       @new_usd_eur_rate = 0.79085
       subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
-      subject.cache = temp_cache_path
-      subject.save_rates
-    end
-
-    after do
-      File.unlink(temp_cache_path)
+      @global_rates = nil
+      subject.cache = proc do |v|
+        if v
+          @global_rates = v
+        else
+          @global_rates
+        end
+      end
     end
 
     describe 'when the ttl has expired' do
@@ -335,6 +293,14 @@ describe Money::Bank::OpenExchangeRatesBank do
         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
+        end
+      end
+
       it 'updates the next expiration time' do
         Timecop.freeze(Time.now + 1001) do
           exp_time = Time.now + 1000
@@ -347,6 +313,9 @@ describe Money::Bank::OpenExchangeRatesBank do
     describe 'when the ttl has not expired' do
       it 'not should update the rates' do
         exp_time = subject.rates_expiration
+        dont_allow(subject).update_rates
+        dont_allow(subject).save_rates
+        dont_allow(subject).refresh_rates_expiration
         subject.expire_rates
         subject.rates_expiration.must_equal exp_time
       end
@@ -383,4 +352,34 @@ describe Money::Bank::OpenExchangeRatesBank do
       subject.source.must_equal 'USD'
     end
   end
+
+  describe 'show alternative' do
+    describe 'when no value given' do
+      before do
+        subject.show_alternative = nil
+      end
+
+      it 'should return the default value' do
+        subject.show_alternative.must_equal false
+      end
+
+      it 'should include show_alternative param as false' do
+        subject.source_url.must_include 'show_alternative=false'
+      end
+    end
+
+    describe 'when value is given' do
+      before do
+        subject.show_alternative = true
+      end
+
+      it 'should return the value' do
+        subject.show_alternative.must_equal true
+      end
+
+      it 'should include show_alternative param as true' do
+        subject.source_url.must_include 'show_alternative=true'
+      end
+    end
+  end
 end

data/test/open_exchange_rates_bank_test.rb.orig

@@ -0,0 +1,393 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+# rubocop:disable Metrics/BlockLength
+describe Money::Bank::OpenExchangeRatesBank do
+  subject { Money::Bank::OpenExchangeRatesBank.new }
+  let(:oer_url) { Money::Bank::OpenExchangeRatesBank::OER_URL }
+  let(:oer_historical_url) do
+    Money::Bank::OpenExchangeRatesBank::OER_HISTORICAL_URL
+  end
+
+  let(:temp_cache_path) do
+    data_file('tmp.json')
+  end
+  let(:oer_latest_path) do
+    data_file('latest.json')
+  end
+  let(:oer_historical_path) do
+    data_file('2015-01-01.json')
+  end
+
+  describe 'exchange' do
+    before do
+      add_to_webmock(subject)
+      subject.cache = temp_cache_path
+      subject.save_rates
+    end
+
+    after do
+      File.unlink(temp_cache_path)
+    end
+
+    describe 'without rates' do
+      it 'able to exchange a money to its own currency even without rates' do
+        money = Money.new(0, 'USD')
+        subject.exchange_with(money, 'USD').must_equal money
+      end
+
+      it "raise if it can't find an exchange rate" do
+        money = Money.new(0, 'USD')
+        proc { subject.exchange_with(money, 'SSP') }
+          .must_raise Money::Bank::UnknownRate
+      end
+    end
+
+    describe 'with rates' do
+      before do
+        subject.update_rates
+      end
+
+      it 'should be able to exchange money from USD to a known exchange rate' do
+        money = Money.new(100, 'USD')
+        subject.exchange_with(money, 'BBD').must_equal Money.new(200, 'BBD')
+      end
+
+      it 'should be able to exchange money from a known exchange rate to USD' do
+        money = Money.new(200, 'BBD')
+        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') }
+          .must_raise Money::Bank::UnknownRate
+      end
+    end
+  end
+
+  describe 'update_rates' do
+    before do
+      subject.app_id = TEST_APP_ID
+      subject.cache = oer_latest_path
+      subject.update_rates
+    end
+
+    it 'should update itself with exchange rates from OpenExchangeRates' do
+      subject.oer_rates.keys.each do |currency|
+        next unless Money::Currency.find(currency)
+        subject.get_rate('USD', currency).must_be :>, 0
+      end
+    end
+
+    it 'should not return 0 with integer rate' do
+      wtf = {
+        priority: 1,
+        iso_code: 'WTF',
+        name: 'WTF',
+        symbol: 'WTF',
+        subunit: 'Cent',
+        subunit_to_unit: 1000,
+        separator: '.',
+        delimiter: ','
+      }
+      Money::Currency.register(wtf)
+      subject.add_rate('USD', 'WTF', 2)
+      subject.add_rate('WTF', 'USD', 2)
+      subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
+    end
+
+    # in response to #4
+    it 'should exchange btc' do
+      btc = {
+        priority: 1,
+        iso_code: 'BTC',
+        name: 'Bitcoin',
+        symbol: 'BTC',
+        subunit: 'Cent',
+        subunit_to_unit: 1000,
+        separator: '.',
+        delimiter: ','
+      }
+      Money::Currency.register(btc)
+      rate = 13.7603
+      subject.add_rate('USD', 'BTC', 1 / 13.7603)
+      subject.add_rate('BTC', 'USD', rate)
+      subject.exchange_with(100.to_money('BTC'), 'USD').cents.must_equal 137_603
+    end
+  end
+
+  describe 'App ID' do
+    before do
+      subject.cache = temp_cache_path
+    end
+
+    it 'should raise an error if no App ID is set' do
+      proc { subject.save_rates }.must_raise Money::Bank::NoAppId
+    end
+
+    # TODO: As App IDs are compulsory soon, need to add more tests handle
+    # app_id-specific errors from
+    # https://openexchangerates.org/documentation#errors
+  end
+
+  describe 'no cache' do
+    before do
+      subject.cache = nil
+      add_to_webmock(subject)
+    end
+
+    it 'should get from url' do
+      subject.update_rates
+      subject.oer_rates.wont_be_empty
+    end
+
+    it 'should raise an error if invalid path is given to save_rates' do
+      proc { subject.save_rates }.must_raise Money::Bank::InvalidCache
+    end
+  end
+
+  describe 'secure_connection' do
+    before do
+      subject.app_id = TEST_APP_ID
+    end
+
+    describe 'historical' do
+      before do
+        subject.date = '2015-01-01'
+      end
+
+<<<<<<< HEAD
+      let(:historical_url) do
+        "#{oer_historical_url}#{subject.date}.json?app_id=#{TEST_APP_ID}&show_alternative=false"
+      end
+
+      it 'should use the secure https url' do
+=======
+      def historical_url
+        "#{oer_historical_url}#{subject.date}.json?" \
+        "app_id=#{TEST_APP_ID}&show_alternative=false"
+      end
+
+      def historical_secure_url
+        "#{oer_historical_secure_url}#{subject.date}.json?" \
+        "app_id=#{TEST_APP_ID}&show_alternative=false"
+      end
+
+      it 'should use the non-secure http url if secure_connection is nil' do
+        subject.secure_connection = nil
+        subject.source_url.must_equal historical_url
+        subject.source_url.must_include 'http://'
+        subject.source_url.must_include "/api/historical/#{subject.date}.json"
+      end
+
+      it 'should use the non-secure http url if secure_connection is false' do
+        subject.secure_connection = false
+>>>>>>> Fix offenses
+        subject.source_url.must_equal historical_url
+        subject.source_url.must_include 'https://'
+        subject.source_url.must_include "/api/historical/#{subject.date}.json"
+      end
+    end
+
+    describe 'latest' do
+      it 'should use the secure https url' do
+        subject.source_url.must_equal source_secure_url
+        subject.source_url.must_include 'https://'
+        subject.source_url.must_include '/api/latest.json'
+      end
+    end
+  end
+
+  describe 'no valid file for cache' do
+    before do
+      subject.cache = "space_dir#{rand(999_999_999)}/out_space_file.json"
+      add_to_webmock(subject)
+    end
+
+    it 'should get from url' do
+      subject.update_rates
+      subject.oer_rates.wont_be_empty
+    end
+
+    it 'should raise an error if invalid path is given to save_rates' do
+      proc { subject.save_rates }.must_raise Money::Bank::InvalidCache
+    end
+  end
+
+  describe 'using proc for cache' do
+    before do
+      @global_rates = nil
+      subject.cache = proc do |v|
+        if v
+          @global_rates = v
+        else
+          @global_rates
+        end
+      end
+      add_to_webmock(subject)
+    end
+
+    it 'should get from url normally' do
+      subject.update_rates
+      subject.oer_rates.wont_be_empty
+    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
+      subject.oer_rates.wont_be_empty
+    end
+  end
+
+  describe 'save rates' do
+    before do
+      add_to_webmock(subject)
+      subject.cache = temp_cache_path
+      subject.save_rates
+    end
+
+    after do
+      File.unlink(temp_cache_path)
+    end
+
+    it 'should allow update after save' do
+      begin
+        subject.update_rates
+      rescue
+        assert false, 'Should allow updating after saving'
+      end
+    end
+
+    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
+      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
+      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
+      File.open(temp_cache_path).read.size.must_equal initial_size
+    end
+  end
+
+  describe '#expire_rates' do
+    before do
+      add_to_webmock(subject)
+      subject.ttl_in_seconds = 1000
+      @old_usd_eur_rate = 0.655
+      # see test/latest.json +52
+      @new_usd_eur_rate = 0.79085
+      subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
+      subject.cache = temp_cache_path
+      subject.save_rates
+    end
+
+    after do
+      File.unlink(temp_cache_path)
+    end
+
+    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
+          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 'updates the next expiration time' do
+        Timecop.freeze(Time.now + 1001) do
+          exp_time = Time.now + 1000
+          subject.expire_rates
+          subject.rates_expiration.must_equal exp_time
+        end
+      end
+    end
+
+    describe 'when the ttl has not expired' do
+      it 'not should update the rates' do
+        exp_time = subject.rates_expiration
+        subject.expire_rates
+        subject.rates_expiration.must_equal exp_time
+      end
+    end
+  end
+
+  describe 'historical' do
+    before do
+      add_to_webmock(subject)
+      # see test/latest.json +52
+      @latest_usd_eur_rate = 0.79085
+      # see test/2015-01-01.json +52
+      @old_usd_eur_rate = 0.830151
+      subject.update_rates
+    end
+
+    it 'should be different than the latest' do
+      subject.get_rate('USD', 'EUR').must_equal @latest_usd_eur_rate
+      subject.date = '2015-01-01'
+      add_to_webmock(subject, oer_historical_path)
+      subject.update_rates
+      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
+
+  describe 'show alternative' do
+    describe 'when no value given' do
+      before do
+        subject.show_alternative = nil
+      end
+
+      it 'should return the default value' do
+        subject.show_alternative.must_equal false
+      end
+
+      it 'should include show_alternative param as false' do
+        subject.source_url.must_include 'show_alternative=false'
+      end
+    end
+
+    describe 'when value is given' do
+      before do
+        subject.show_alternative = true
+      end
+
+      it 'should return the value' do
+        subject.show_alternative.must_equal true
+      end
+
+      it 'should include show_alternative param as true' do
+        subject.source_url.must_include 'show_alternative=true'
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'rr'
 require 'webmock/minitest'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Laurent Arnoud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.7'
+        version: '6.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.7'
+        version: '6.8'
 - !ruby/object:Gem::Dependency
   name: monetize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.49.0
 description: A gem that calculates the exchange rate using published rates from open-exchange-rates.
   Compatible with the money gem.
 email: laurent@spkdev.net
@@ -142,6 +142,7 @@ files:
 - test/integration/Gemfile.lock
 - test/integration/api.rb
 - test/open_exchange_rates_bank_test.rb
+- test/open_exchange_rates_bank_test.rb.orig
 - test/test_helper.rb
 homepage: http://github.com/spk/money-open-exchange-rates
 licenses:
@@ -155,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A gem that calculates the exchange rate using published rates from open-exchange-rates.