currencylayer-historical-bank 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f13d512a100631703bce783678d23f2ed8f49bde
+  data.tar.gz: bad37b4cad23a26ade8b03554b4578bffa081ca4
+SHA512:
+  metadata.gz: b5b419e7153236ff6d600b8f5061414616245ffd568ecb4bb4c6a5a093135938ab015600af956e856073dbd63ae292727c52ef3d664d0cb28b4a64fc5db7b748
+  data.tar.gz: 314d2525d4a57fd6c377af83703abbadf44245c6b81e5566f5238e8fb1bb95464891fc035c3601c4cbf419a3caac6c403649dbef9890d58c9efe6a3526d9d250

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+A gem that calculates the exchange rate using published rates from
+[currencylayer.com](https://currencylayer.com/)
+
+## Currencylayer API
+
+~~~ json
+{
+  "timestamp": 1441101909,
+  "source": "USD",
+  "quotes": {
+      /* 168 currencies */
+      "USDAUD": 1.413637,
+      "USDCAD": 1.316495,
+      "USDCHF": 0.96355,
+      "USDEUR": 0.888466,
+      "USDBTC": 0.004322, /* Includes Bitcoin currency! */
+      ...
+      }
+}
+~~~
+
+See more about Currencylayer product plans on https://currencylayer.com/product.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'currencylayer-historical-bank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install currencylayer-historical-bank
+
+## Usage
+
+~~~ ruby
+# Minimal requirements
+require 'money/bank/currencylayer_historical_bank'
+mclb = Money::Bank::CurrencylayerHistoricalBank.new
+mclb.access_key = 'your access_key from https://currencylayer.com/product'
+
+# Update rates (get new rates from remote if expired or access rates from cache)
+mclb.update_rates
+
+# Force update rates from remote and store in cache
+# mclb.update_rates(true)
+
+# (optional)
+# Set the base currency for all rates. By default, USD is used.
+# CurrencylayerHistoricalBank only allows USD as base currency for the free plan users.
+mclb.source = 'EUR'
+
+# (optional)
+# Set the seconds after than the current rates are automatically expired
+# by default, they never expire, in this example 1 day.
+mclb.ttl_in_seconds = 86400
+
+# (optional)
+# Use https to fetch rates from CurrencylayerHistoricalBank
+# CurrencylayerHistoricalBank only allows http as connection for the free plan users.
+mclb.secure_connection = true
+
+# Define cache (string or pathname)
+mclb.cache = 'path/to/file/cache'
+
+# Set money default bank to currencylayer bank
+Money.default_bank = mclb
+~~~
+
+### More methods
+
+~~~ ruby
+mclb = Money::Bank::CurrencylayerHistoricalBank.new
+
+# Returns the base currency set for all rates.
+mclb.source
+
+# Expires rates if the expiration time is reached.
+mclb.expire_rates!
+
+# Return true if the expiration time is reached.
+mclb.expired?
+
+# Get the API source url.
+mclb.source_url
+
+# Get the rates timestamp of the last API request.
+mclb.rates_timestamp
+~~~
+
+### How to exchange
+
+~~~ ruby
+# Exchange 1000 cents (10.0 USD) to EUR
+Money.new(1000, 'USD').exchange_to('EUR')        # => #<Money fractional:89 currency:EUR>
+Money.new(1000, 'USD').exchange_to('EUR').to_f   # => 8.9
+
+# Format
+Money.new(1000, 'USD').exchange_to('EUR').format # => €8.90
+
+# Get the rate
+Money.default_bank.get_rate('USD', 'CAD')        # => 0.9
+~~~
+
+See more on https://github.com/RubyMoney/money.
+
+### Using gem money-rails
+
+You can also use it in Rails with the gem [money-rails](https://github.com/RubyMoney/money-rails).
+
+~~~ ruby
+require 'money/bank/currencylayer_bank'
+
+MoneyRails.configure do |config|
+  mclb = Money::Bank::CurrencylayerHistoricalBank.new
+  mclb.access_key = 'your access_key from https://currencylayer.com/product'
+  mclb.update_rates
+
+  config.default_bank = mclb
+end
+~~~
+
+### Cache
+
+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
+mclb.cache = Proc.new do |v|
+  key = 'money:currencylayer_bank'
+  if v
+    Thread.current[key] = v
+  else
+    Thread.current[key]
+  end
+end
+~~~
+
+## Process
+
+The gem fetches all rates in a cache with USD as base currency. It's possible to compute the rate between any of the currencies by calculating a pair rate using base USD rate.
+
+## Tests
+
+You can place your own key on a file or environment
+variable named TEST_ACCESS_KEY and then run:
+
+~~~
+bundle exec rake
+~~~
+
+## Refs
+
+* Gem [money](https://github.com/RubyMoney/money)
+* Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
+* Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
+
+## Other Implementations
+
+* Gem [currencylayer](https://github.com/askuratovsky/currencylayer)
+* Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
+* Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
+* Gem [eu_central_bank](https://github.com/RubyMoney/eu_central_bank)
+* Gem [nordea](https://github.com/matiaskorhonen/nordea)
+* Gem [google_currency](https://github.com/RubyMoney/google_currency)
+
+## Contributing
+
+1. Fork it ( https://github.com/[your-username]/currencylayer-historical-bank/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The MIT License
+
+Copyright (c) 2017

data/lib/money/bank/currencylayer_historical_bank.rb

@@ -0,0 +1,301 @@
+# encoding: UTF-8
+require 'open-uri'
+require 'money'
+require 'json'
+
+# Money gem class
+class Money
+  # https://github.com/RubyMoney/money#exchange-rate-stores
+  module Bank
+    # Invalid cache, file not found or cache empty
+    class InvalidCache < StandardError; end
+
+    # App id not set error
+    class NoAccessKey < StandardError; end
+
+    # CurrencylayerBank base class
+    # rubocop:disable Metrics/ClassLength
+    class CurrencylayerHistoricalBank < Money::Bank::VariableExchange
+      # CurrencylayerBank url
+      CL_URL = 'http://apilayer.net/api/live'.freeze
+      # CurrencylayerBank historical url
+      CL_HISTORICAL_URL = 'http://apilayer.net/api/historical'.freeze
+      # CurrencylayerBank secure url
+      CL_SECURE_URL = CL_URL.gsub('http:', 'https:').freeze
+      # Default base currency
+      CL_SOURCE = 'USD'.freeze
+
+      # Use https to fetch rates from CurrencylayerBank
+      # CurrencylayerBank only allows http as connection
+      # for the free plan users.
+      attr_accessor :secure_connection
+
+      # API must have a valid access_key
+      attr_accessor :access_key
+
+      # Fetch historical rates on selected date
+      attr_accessor :historical_date
+
+      # Cache accessor, can be a String or a Proc
+      attr_accessor :cache
+
+      # Rates expiration Time
+      attr_reader :rates_expiration
+
+      # Parsed CurrencylayerBank result as Hash
+      attr_reader :rates
+
+      # Seconds after than the current rates are automatically expired
+      attr_reader :ttl_in_seconds
+
+      # Set the base currency for all rates. By default, USD is used.
+      # CurrencylayerBank 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).try(:iso_code) || CL_SOURCE
+      end
+
+      # Get the base currency for all rates. By default, USD is used.
+      # @return [String] base currency
+      def source
+        @source ||= CL_SOURCE
+      end
+
+      # Set the seconds after than the current rates are automatically expired
+      # by default, they never expire.
+      #
+      # @example
+      #   ttl_in_seconds = 86400 # will expire the rates in one day
+      #
+      # @param value [Integer] time to live in seconds
+      #
+      # @return [Integer] chosen time to live in seconds
+      def ttl_in_seconds=(value)
+        @ttl_in_seconds = value
+        refresh_rates_expiration!
+        @ttl_in_seconds
+      end
+
+      # Update all rates from CurrencylayerBank JSON
+      # @return [Array] array of exchange rates
+      def update_rates(straight = false)
+        exchange_rates(straight).each do |exchange_rate|
+          currency = exchange_rate.first[3..-1]
+          rate = exchange_rate.last
+          next unless Money::Currency.find(currency)
+          add_rate(source, currency, rate)
+          add_rate(currency, source, 1.0 / rate)
+        end
+      end
+
+      # 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 = {}) # rubocop:disable all
+        @historical_date = Date.parse(opts[:date]).strftime("%Y-%m-%d") if opts[:date]
+        expire_rates!
+        rate = super
+        unless rate
+          # Tries to calculate an inverse rate
+          inverse_rate = super(to_currency, from_currency, opts)
+          if inverse_rate
+            rate = 1.0 / inverse_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        unless rate
+          # Tries to calculate a pair rate using base currency rate
+          from_base_rate = super(source, from_currency, opts)
+          unless from_base_rate
+            from_inverse_rate = super(from_currency, source, opts)
+            from_base_rate = 1.0 / from_inverse_rate if from_inverse_rate
+          end
+          to_base_rate = super(source, to_currency, opts)
+          unless to_base_rate
+            to_inverse_rate = super(to_currency, source, opts)
+            to_base_rate = 1.0 / to_inverse_rate if to_inverse_rate
+          end
+          if to_base_rate && from_base_rate
+            rate = to_base_rate / from_base_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        rate
+      end
+
+      # Fetch new rates if cached rates are expired
+      # @return [Boolean] true if rates are expired and updated from remote
+      def expire_rates!
+        if expired?
+          update_rates(true)
+          true
+        else
+          false
+        end
+      end
+
+      # Check if rates are expired
+      # @return [Boolean] true if rates are expired
+      def expired?
+        return true if historical_date
+        rates_expiration ? rates_expiration <= Time.now : true
+      end
+
+      # Source url of CurrencylayerBank
+      # defined with access_key and secure_connection
+      # @return [String] the remote API url
+      def source_url
+        raise NoAccessKey if access_key.nil? || access_key.empty?
+        cl_url = historical_date ? CL_HISTORICAL_URL : CL_URL
+        cl_url = CL_SECURE_URL if secure_connection
+
+        base_url = "#{cl_url}?source=#{source}&access_key=#{access_key}"
+        if historical_date
+          date_url = "&date=#{historical_date}"
+          base_url = base_url + date_url
+        end
+
+        base_url
+      end
+
+      # Get the timestamp of rates
+      # @return [Time] time object or nil
+      def rates_timestamp
+        @rates_timestamp ||= init_rates_timestamp
+      end
+
+      protected
+
+      # Sets the rates timestamp from parsed JSON content
+      #
+      # @example
+      #   set_rates_timestamp("{\"timestamp\": 1441049528,
+      #                         \"quotes\": {\"USDAED\": 3.67304}}")
+      #
+      # @param raw_rates [String] parsed JSON content, default is nil
+      # @return [Time] time object with rates timestamp
+      def init_rates_timestamp(raw_rates = nil)
+        raw = raw_rates || raw_rates_careful
+        @rates_timestamp = Time.at(raw['timestamp']) if raw.key?('timestamp')
+      end
+
+      # Store the provided text data by calling the proc method provided
+      # for the cache, or write to the cache file.
+      #
+      # @example
+      #   store_in_cache("{\"quotes\": {\"USDAED\": 3.67304}}")
+      #
+      # @param text [String] parsed JSON content
+      # @return [String,Integer]
+      def store_in_cache(text)
+        if cache.is_a?(Proc)
+          cache.call(text)
+        elsif cache.is_a?(String) || cache.is_a?(Pathname)
+          write_to_file(text)
+        end
+      end
+
+      # Writes content to file cache
+      # @param text [String] parsed JSON content
+      # @return [String,Integer]
+      def write_to_file(text)
+        open(cache, 'w') do |f|
+          f.write(text)
+        end
+      rescue Errno::ENOENT
+        raise InvalidCache
+      end
+
+      # Read from cache when exist
+      # @return [Proc,String] parsed JSON content
+      def read_from_cache
+        if cache.is_a?(Proc)
+          cache.call(nil)
+        elsif (cache.is_a?(String) || cache.is_a?(Pathname)) &&
+              File.exist?(cache)
+          open(cache).read
+        end
+      end
+
+      # Get remote content and store in cache
+      # @return [String] unparsed JSON content
+      def read_from_url
+        text = open_url
+        if valid_rates?(text)
+          refresh_rates_expiration!
+          store_in_cache(text) if cache
+        end
+        text
+      end
+
+      # Opens an url and reads the content
+      # @return [String] unparsed JSON content
+      def open_url
+        open(source_url).read
+      end
+
+      # Check validity of rates response only for store in cache
+      #
+      # @example
+      #   valid_rates?("{\"quotes\": {\"USDAED\": 3.67304}}")
+      #
+      # @param [String] text is JSON content
+      # @return [Boolean] valid or not
+      def valid_rates?(text)
+        parsed = JSON.parse(text)
+        parsed && parsed.key?('quotes')
+      rescue JSON::ParserError
+        false
+      end
+
+      # Get exchange rates with different strategies
+      #
+      # @example
+      #   exchange_rates(true)
+      #   exchange_rates
+      #
+      # @param straight [Boolean] true for straight, default is careful
+      # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
+      def exchange_rates(straight = false)
+        @rates = if straight
+                   raw_rates_straight['quotes']
+                 else
+                   raw_rates_careful['quotes']
+                 end
+      end
+
+      # Get raw exchange rates from cache and then from url
+      # @return [String] JSON content
+      def raw_rates_careful
+        JSON.parse(read_from_cache.to_s)
+      rescue JSON::ParserError
+        raw_rates_straight
+      end
+
+      # Get raw exchange rates from url
+      # @return [String] JSON content
+      def raw_rates_straight
+        raw_rates = JSON.parse(read_from_url)
+        init_rates_timestamp(raw_rates)
+        raw_rates
+      rescue JSON::ParserError
+        { 'quotes' => {} }
+      end
+
+      # Refresh expiration from now
+      # return [Time] new expiration time
+      def refresh_rates_expiration!
+        @rates_expiration = Time.now + ttl_in_seconds unless ttl_in_seconds.nil?
+      end
+    end
+  end
+end

data/test/TEST_ACCESS_KEY

@@ -0,0 +1 @@
+your access_key from https://currencylayer.com/product

data/test/currencylayer_bank_test.rb

@@ -0,0 +1,296 @@
+# encoding: UTF-8
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+describe Money::Bank::CurrencylayerHistoricalBank do
+  subject { Money::Bank::CurrencylayerHistoricalBank.new }
+  let(:url) { Money::Bank::CurrencylayerHistoricalBank::CL_URL }
+  let(:secure_url) { Money::Bank::CurrencylayerHistoricalBank::CL_SECURE_URL }
+  let(:source) { Money::Bank::CurrencylayerHistoricalBank::CL_SOURCE }
+  let(:temp_cache_path) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'temp.json'))
+  end
+  let(:data_path) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'live.json'))
+  end
+
+  describe 'exchange' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+      subject.update_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 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 'cache rates' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(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).open_url { '' }
+      subject.update_rates
+      File.read(temp_cache_path).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).open_url { '{ "error": "An error" }' }
+      subject.update_rates
+      File.read(temp_cache_path).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).open_url { '{ invalid_json: "An error" }' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
+    end
+  end
+
+  describe 'no cache' do
+    before do
+      subject.cache = nil
+      subject.access_key = TEST_ACCESS_KEY
+      stub(subject).source_url { data_path }
+    end
+
+    it 'should get from url' do
+      subject.update_rates
+      subject.rates.wont_be_empty
+    end
+  end
+
+  describe 'no valid file for cache' do
+    before do
+      subject.cache = "space_dir#{rand(999_999_999)}/out_space_file.json"
+      subject.access_key = TEST_ACCESS_KEY
+      stub(subject).source_url { data_path }
+    end
+
+    it 'should raise an error if invalid path is given' do
+      proc { subject.update_rates }.must_raise Money::Bank::InvalidCache
+    end
+  end
+
+  describe 'using proc for cache' do
+    before :each do
+      @global_rates = nil
+      subject.cache = proc { |v|
+        if v
+          @global_rates = v
+        else
+          @global_rates
+        end
+      }
+      subject.access_key = TEST_ACCESS_KEY
+    end
+
+    it 'should get from url normally' do
+      stub(subject).source_url { data_path }
+      subject.update_rates
+      subject.rates.wont_be_empty
+    end
+
+    it 'should save from url and get from cache' do
+      stub(subject).source_url { data_path }
+      subject.update_rates
+      @global_rates.wont_be_empty
+      dont_allow(subject).source_url
+      subject.update_rates
+      subject.rates.wont_be_empty
+    end
+  end
+
+  describe '#secure_connection' do
+    it "should use the non-secure http url if secure_connection isn't set" do
+      subject.secure_connection = nil
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{url}?source=#{source}&"\
+                                    "access_key=#{TEST_ACCESS_KEY}"
+    end
+
+    it 'should use the non-secure http url if secure_connection is false' do
+      subject.secure_connection = false
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{url}?source=#{source}&"\
+                                    "access_key=#{TEST_ACCESS_KEY}"
+    end
+
+    it 'should use the secure https url if secure_connection is set to true' do
+      subject.secure_connection = true
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{secure_url}?source=#{source}&"\
+                                    "access_key=#{TEST_ACCESS_KEY}"
+      subject.source_url.must_include 'https://'
+    end
+  end
+
+  describe '#update_rates' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = data_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
+    end
+
+    it 'should update itself with exchange rates from CurrencylayerBank' do
+      subject.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
+  end
+
+  describe '#access_key' do
+    before do
+      subject.cache = temp_cache_path
+      stub(OpenURI::OpenRead).open(url) { File.read data_path }
+    end
+
+    it 'should raise an error if no access key is set' do
+      proc { subject.update_rates }.must_raise Money::Bank::NoAccessKey
+    end
+  end
+
+  describe '#expire_rates!' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.ttl_in_seconds = 1000
+      @old_usd_eur_rate = 0.655
+      # see test/live.json +54
+      @new_usd_eur_rate = 0.886584
+      subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
+    end
+
+    describe 'when the ttl has expired' do
+      it 'should update the rates' do
+        Timecop.freeze(subject.rates_timestamp + 1000) do
+          subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
+        end
+        Timecop.freeze(subject.rates_timestamp + 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(subject.rates_timestamp + 1001) do
+          exp_time = subject.rates_timestamp + 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
+        subject.update_rates
+        exp_time = subject.rates_expiration
+        subject.expire_rates!
+        subject.rates_expiration.must_equal exp_time
+      end
+    end
+  end
+
+  describe '#rates_timestamp' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
+    end
+
+    it 'should return 1970-01-01 datetime if no rates' do
+      stub(subject).open_url { '' }
+      subject.update_rates
+      subject.rates_timestamp.must_equal Time.at(0)
+    end
+
+    it 'should return a Time object' do
+      subject.update_rates
+      subject.rates_timestamp.class.must_equal Time
+    end
+  end
+end

data/test/live.json

@@ -0,0 +1,177 @@
+{
+  "success":true,
+  "terms":"https:\/\/currencylayer.com\/terms",
+  "privacy":"https:\/\/currencylayer.com\/privacy",
+  "timestamp":1440755169,
+  "source":"USD",
+  "quotes":{
+    "USDAED":3.67315,
+    "USDAFN":65.059998,
+    "USDALL":124.204498,
+    "USDAMD":484.700012,
+    "USDANG":1.789762,
+    "USDAOA":125.800003,
+    "USDARS":9.289801,
+    "USDAUD":1.396775,
+    "USDAWG":1.79,
+    "USDAZN":1.05025,
+    "USDBAM":1.73215,
+    "USDBBD":2,
+    "USDBDT":78.16745,
+    "USDBGN":1.733895,
+    "USDBHD":0.37743,
+    "USDBIF":1558.050049,
+    "USDBMD":1,
+    "USDBND":1.403802,
+    "USDBOB":6.901852,
+    "USDBRL":3.55925,
+    "USDBSD":1,
+    "USDBTC":0.004416,
+    "USDBTN":66.165001,
+    "USDBWP":10.26445,
+    "USDBYR":17500,
+    "USDBZD":1.994978,
+    "USDCAD":1.321355,
+    "USDCDF":927.999825,
+    "USDCHF":0.962099,
+    "USDCLF":0.0246,
+    "USDCLP":694.494995,
+    "USDCNY":6.388203,
+    "USDCOP":3171.030029,
+    "USDCRC":532.380005,
+    "USDCUC":1,
+    "USDCUP":0.999558,
+    "USDCVE":98.070999,
+    "USDCZK":23.979502,
+    "USDDJF":177.669998,
+    "USDDKK":6.616496,
+    "USDDOP":44.889999,
+    "USDDZD":105.955002,
+    "USDEEK":13.850996,
+    "USDEGP":7.827797,
+    "USDERN":15.280041,
+    "USDETB":20.8335,
+    "USDEUR":0.886584,
+    "USDFJD":2.15655,
+    "USDFKP":0.648498,
+    "USDGBP":0.649287,
+    "USDGEL":2.344962,
+    "USDGGP":0.64902,
+    "USDGHS":4.117502,
+    "USDGIP":0.6485,
+    "USDGMD":39.630001,
+    "USDGNF":7277.700195,
+    "USDGTQ":7.672497,
+    "USDGYD":207.210007,
+    "USDHKD":7.75022,
+    "USDHNL":21.988899,
+    "USDHRK":6.7026,
+    "USDHTG":51.446201,
+    "USDHUF":279.019989,
+    "USDIDR":13995.5,
+    "USDILS":3.92785,
+    "USDIMP":0.64909,
+    "USDINR":66.160454,
+    "USDIQD":1149.349976,
+    "USDIRR":29929.999905,
+    "USDISK":129.264999,
+    "USDJEP":0.64908,
+    "USDJMD":117.410004,
+    "USDJOD":0.70905,
+    "USDJPY":120.879501,
+    "USDKES":103.844498,
+    "USDKGS":65.995598,
+    "USDKHR":4116.250384,
+    "USDKMF":435.697449,
+    "USDKPW":900.000329,
+    "USDKRW":1176.954956,
+    "USDKWD":0.30221,
+    "USDKYD":0.819677,
+    "USDKZT":241.599945,
+    "USDLAK":8196.599609,
+    "USDLBP":1506.501675,
+    "USDLKR":134.779999,
+    "USDLRD":84.660004,
+    "USDLSL":13.188027,
+    "USDLTL":3.048701,
+    "USDLVL":0.62055,
+    "USDLYD":1.37265,
+    "USDMAD":9.67355,
+    "USDMDL":19.049999,
+    "USDMGA":3322.699951,
+    "USDMKD":54.830002,
+    "USDMMK":1281.750421,
+    "USDMNT":1991.000101,
+    "USDMOP":7.98255,
+    "USDMRO":312.000071,
+    "USDMUR":35.150002,
+    "USDMVR":15.359568,
+    "USDMWK":555.734985,
+    "USDMXN":16.911249,
+    "USDMYR":4.187203,
+    "USDMZN":41.255001,
+    "USDNAD":13.18801,
+    "USDNGN":199.050003,
+    "USDNIO":27.4655,
+    "USDNOK":8.284018,
+    "USDNPR":105.863998,
+    "USDNZD":1.545237,
+    "USDOMR":0.38515,
+    "USDPAB":1,
+    "USDPEN":3.281097,
+    "USDPGK":2.8063,
+    "USDPHP":46.721501,
+    "USDPKR":103.904999,
+    "USDPLN":3.75175,
+    "USDPYG":5393.502337,
+    "USDQAR":3.64245,
+    "USDRON":3.92755,
+    "USDRSD":106.370003,
+    "USDRUB":66.537804,
+    "USDRWF":729.349976,
+    "USDSAR":3.75055,
+    "USDSBD":7.968634,
+    "USDSCR":13.03295,
+    "USDSDG":6.076982,
+    "USDSEK":8.44225,
+    "USDSGD":1.404397,
+    "USDSHP":0.6485,
+    "USDSLL":4638.000576,
+    "USDSOS":661.000153,
+    "USDSRD":3.296279,
+    "USDSTD":21789.5,
+    "USDSVC":8.734966,
+    "USDSYP":188.822006,
+    "USDSZL":13.187971,
+    "USDTHB":35.869999,
+    "USDTJS":6.319802,
+    "USDTMT":3.5,
+    "USDTND":1.95735,
+    "USDTOP":2.127081,
+    "USDTRY":2.91595,
+    "USDTTD":6.348697,
+    "USDTWD":32.221001,
+    "USDTZS":2153.300049,
+    "USDUAH":21.149933,
+    "USDUGX":3630.00047,
+    "USDUSD":1,
+    "USDUYU":28.52497,
+    "USDUZS":2595.520019,
+    "USDVEF":6.349652,
+    "USDVND":22462.5,
+    "USDVUV":111.910004,
+    "USDWST":2.620836,
+    "USDXAF":580.929871,
+    "USDXAG":0.069132,
+    "USDXAU":0.000887,
+    "USDXCD":2.700532,
+    "USDXDR":0.70995,
+    "USDXOF":580.929871,
+    "USDXPF":105.682747,
+    "USDYER":214.889999,
+    "USDZAR":13.17765,
+    "USDZMK":5156.098401,
+    "USDZMW":8.630369,
+    "USDZWL":322.355011
+  }
+}

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'minitest/autorun'
+require 'rr'
+require 'money/bank/currencylayer_historical_bank'
+require 'monetize'
+require 'timecop'
+require 'pry'
+
+TEST_ACCESS_KEY_PATH = File.join(File.dirname(__FILE__), 'TEST_ACCESS_KEY')
+TEST_ACCESS_KEY = ENV['TEST_ACCESS_KEY'] || File.read(TEST_ACCESS_KEY_PATH)
+
+if TEST_ACCESS_KEY.nil? || TEST_ACCESS_KEY.empty?
+  raise "Please add a valid access key to file #{TEST_ACCESS_KEY_PATH} or to " \
+    ' TEST_ACCESS_KEY environment'
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: currencylayer-historical-bank
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ildus Sadykov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.1
+- !ruby/object:Gem::Dependency
+  name: monetize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: A gem that calculates the historical exchange rate using published rates
+  from currencylayer.com. Compatible with the money gem.
+email: ildus@meyvndigital.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/money/bank/currencylayer_historical_bank.rb
+- lib/money/version.rb
+- test/TEST_ACCESS_KEY
+- test/currencylayer_bank_test.rb
+- test/live.json
+- test/test_helper.rb
+homepage: http://github.com/IldusSadykov/currencylayer-historical-bank
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem that calculates the historical exchange rate using published rates
+  from currencylayer.com.
+test_files:
+- test/currencylayer_bank_test.rb
+has_rdoc: