money-currencylayer-bank 0.5.4 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc97450bce8ac6e02fc906a21ca0c10860428557
-  data.tar.gz: 371c75e3794e3a7c2be6babd222845eda7cb1ac6
+SHA256:
+  metadata.gz: ad15fc05b8e56c61e10554fd8574e0dbd358e3adc287c140ee11cb4b5c5747d8
+  data.tar.gz: 3ace2bd923ee971f5f6fca67f5ada19a0edf25687fbf0806b197f8876ee33146
 SHA512:
-  metadata.gz: f69464174caabd8f18da9077f579d252f77b5b751bf4032117fbc575efd04a4740f84cf1be1fdb39e1f42791dc1540d5911b168324938108a339facef6bcdce0
-  data.tar.gz: e81c35792af291b86f106ed2c2f1efacc78ffcf035ffa01f70d4e030bb9de77de6f41983ccd0052dc61bf105cf4fde668256c1b5b87566bea6cb7e0017ec122e
+  metadata.gz: 25849b05854111ab7ec51474fdbe9d02a5dd03d80719d46f0358a1c9c87b63e6296f2edcacd46e65e975e5510f16a456b4be50f1c92aa87c2b9af81504d5cf49
+  data.tar.gz: ce7667380baef8501825232ff7425b3a3121e85f0bfc4d8656d4c8b310e50d84ed787e6384d7da1bd692bf44233cccbaadee7dcf559232aece1ef83b28f258ec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Phlegx Systems OG
+Copyright (c) 2017 Phlegx Systems OG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,9 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/money-currencylayer-bank.svg)](https://rubygems.org/gems/money-currencylayer-bank)
 [![Gem](https://img.shields.io/gem/dt/money-currencylayer-bank.svg?maxAge=2592000)](https://rubygems.org/gems/money-currencylayer-bank)
 [![Build Status](https://secure.travis-ci.org/phlegx/money-currencylayer-bank.svg?branch=master)](https://travis-ci.org/phlegx/money-currencylayer-bank)
-[![Code Climate](http://img.shields.io/codeclimate/github/phlegx/money-currencylayer-bank.svg)](https://codeclimate.com/github/phlegx/money-currencylayer-bank)
+[![Code Climate](https://codeclimate.com/github/phlegx/money-currencylayer-bank.svg)](https://codeclimate.com/github/phlegx/money-currencylayer-bank)
 [![Inline Docs](http://inch-ci.org/github/phlegx/money-currencylayer-bank.svg?branch=master)](http://inch-ci.org/github/phlegx/money-currencylayer-bank)
-[![Dependency Status](https://gemnasium.com/phlegx/money-currencylayer-bank.svg)](https://gemnasium.com/phlegx/money-currencylayer-bank)
 [![License](https://img.shields.io/github/license/phlegx/money-currencylayer-bank.svg)](http://opensource.org/licenses/MIT)
 
 A gem that calculates the exchange rate using published rates from
@@ -40,6 +39,7 @@ See more about Currencylayer product plans on https://currencylayer.com/product.
 * average response time < 20ms
 * supports caching currency rates
 * calculates every pair rate calculating inverse rate or using base currency rate
+* supports multiple server instances, thread safe
 
 ## Installation
 
@@ -60,36 +60,41 @@ Or install it yourself as:
 ## Usage
 
 ~~~ ruby
-# Minimal requirements
+# Minimal requirements.
 require 'money/bank/currencylayer_bank'
 mclb = Money::Bank::CurrencylayerBank.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.
 # CurrencylayerBank 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
+# 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 CurrencylayerBank
+# Use https to fetch rates from CurrencylayerBank.
 # CurrencylayerBank only allows http as connection for the free plan users.
 mclb.secure_connection = true
 
-# Define cache (string or pathname)
+# Define cache (string or pathname).
 mclb.cache = 'path/to/file/cache'
 
-# Set money default bank to currencylayer bank
+# Update rates (get new rates from remote if expired or access rates from cache).
+# Be sure to define the cache first before updating the rates.
+mclb.update_rates
+
+# Force update rates from remote and store in cache.
+# Be sure to define the cache first before updating the rates.
+# mclb.update_rates(true)
+
+# Set money rounding mode.
+Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
+
+# Set money default bank to Currencylayer bank.
 Money.default_bank = mclb
 ~~~
 
@@ -104,7 +109,7 @@ mclb.source
 # Expires rates if the expiration time is reached.
 mclb.expire_rates!
 
-# Return true if the expiration time is reached.
+# Returns true if the expiration time is reached.
 mclb.expired?
 
 # Get the API source url.
@@ -112,6 +117,9 @@ mclb.source_url
 
 # Get the rates timestamp of the last API request.
 mclb.rates_timestamp
+
+# Get the rates timestamp of loaded rates in memory.
+moxb.rates_mem_timestamp
 ~~~
 
 ### How to exchange
@@ -184,6 +192,7 @@ bundle exec rake
 ## Other Implementations
 
 * Gem [currencylayer](https://github.com/askuratovsky/currencylayer)
+* Gem [money-openexchangerates-bank](https://github.com/phlegx/money-openexchangerates-bank)
 * 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)
@@ -207,4 +216,4 @@ bundle exec rake
 
 The MIT License
 
-Copyright (c) 2015 Phlegx Systems OG
+Copyright (c) 2022 Phlegx Systems OG

data/lib/money/bank/currencylayer_bank.rb

@@ -13,7 +13,6 @@ class Money
     class Memory
       # Add method to reset the build in memory store
       # @param [Hash] rt Optional initial exchange rate data.
-      #
       # @return [Object] store.
       def reset!(rt = {})
         transaction { @index = rt }
@@ -32,32 +31,29 @@ class Money
     # CurrencylayerBank base class
     class CurrencylayerBank < Money::Bank::VariableExchange
       # CurrencylayerBank url
-      CL_URL = 'http://apilayer.net/api/live'
+      CL_URL = 'http://api.currencylayer.com/live'.freeze
       # CurrencylayerBank secure url
-      CL_SECURE_URL = CL_URL.gsub('http:', 'https:')
+      CL_SECURE_URL = CL_URL.sub('http:', 'https:')
       # Default base currency
-      CL_SOURCE = 'USD'
+      CL_SOURCE = 'USD'.freeze
 
       # Use https to fetch rates from CurrencylayerBank
       # CurrencylayerBank only allows http as connection
       # for the free plan users.
       #
       # @param value [Boolean] true for secure connection
-      #
       # @return [Boolean] chosen secure connection
       attr_accessor :secure_connection
 
       # API must have a valid access_key
       #
       # @param value [String] API access key
-      #
       # @return [String] chosen API access key
       attr_accessor :access_key
 
       # Cache accessor, can be a String or a Proc
       #
       # @param value [String,Pathname,Proc] cache system
-      #
       # @return [String,Pathname,Proc] chosen cache system
       attr_accessor :cache
 
@@ -75,7 +71,6 @@ class Money
       #   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
       attr_writer :ttl_in_seconds
 
@@ -87,7 +82,6 @@ class Money
       #   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
@@ -110,7 +104,7 @@ class Money
       # @return [Array] array of exchange rates
       def update_rates(straight = false)
         store.reset!
-        exchange_rates(straight).each do |exchange_rate|
+        rates = exchange_rates(straight).each do |exchange_rate|
           currency = exchange_rate.first[3..-1]
           rate = exchange_rate.last
           next unless Money::Currency.find(currency)
@@ -118,53 +112,30 @@ class Money
           add_rate(currency, source, 1.0 / rate)
         end
         @rates_mem_timestamp = rates_timestamp
+        rates
       end
 
       # Override Money `add_rate` method for caching
       # @param [String] from_currency Currency ISO code. ex. 'USD'
       # @param [String] to_currency Currency ISO code. ex. 'CAD'
       # @param [Numeric] rate Rate to use when exchanging currencies.
-      #
       # @return [Numeric] rate.
       def add_rate(from_currency, to_currency, rate)
         super
       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'
       # @param [Hash] opts Options hash to set special parameters.
-      #
       # @return [Numeric] rate.
-      def get_rate(from_currency, to_currency, opts = {}) # rubocop:disable all
+      def get_rate(from_currency, to_currency, opts = {})
         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
+        rate = get_rate_or_calc_inverse(from_currency, to_currency, opts)
+        rate || calc_pair_rate_using_base(from_currency, to_currency, opts)
       end
 
       # Fetch new rates if cached rates are expired or stale
@@ -269,7 +240,7 @@ class Money
       # Opens an url and reads the content
       # @return [String] unparsed JSON content
       def open_url
-        open(source_url).read
+        URI.open(source_url).read
       rescue OpenURI::HTTPError
         ''
       end
@@ -297,14 +268,22 @@ class Money
       # @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
+        rates = if straight
+                  raw_rates_straight
+                else
+                  raw_rates_careful
+                end
+        if rates.key?('quotes')
+          @rates = rates['quotes']
+        elsif rates.key?('error')
+          raise Error, rates.dig('error', 'info')
+        else
+          raise Error, 'Unknown rates situation!'
+        end
       end
 
       # Get raw exchange rates from cache and then from url
+      # @param rescue_straight [Boolean] true for rescue straight, default true
       # @return [String] JSON content
       def raw_rates_careful(rescue_straight = true)
         JSON.parse(read_from_cache.to_s)
@@ -319,6 +298,38 @@ class Money
       rescue JSON::ParserError
         raw_rates_careful(false)
       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 / from_base_rate
+          add_rate(from_currency, to_currency, rate)
+          return rate
+        end
+        nil
+      end
     end
   end
 end

data/test/currencylayer_bank_test.rb

@@ -4,6 +4,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 
 describe Money::Bank::CurrencylayerBank do
+  Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
   subject { Money::Bank::CurrencylayerBank.new }
   let(:url) { Money::Bank::CurrencylayerBank::CL_URL }
   let(:secure_url) { Money::Bank::CurrencylayerBank::CL_SECURE_URL }
@@ -30,12 +31,12 @@ describe Money::Bank::CurrencylayerBank do
     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
+        _(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') }
+        _(proc { subject.exchange_with(money, 'SSP') })
           .must_raise Money::Bank::UnknownRate
       end
     end
@@ -47,17 +48,17 @@ describe Money::Bank::CurrencylayerBank do
 
       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')
+        _(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')
+        _(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') }
+        _(proc { subject.exchange_with(money, 'SSP') })
           .must_raise Money::Bank::UnknownRate
       end
     end
@@ -87,21 +88,21 @@ describe Money::Bank::CurrencylayerBank 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
+      _(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
+      _(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
+      _(File.read(temp_cache_path).size).must_equal initial_size
     end
   end
 
@@ -114,7 +115,7 @@ describe Money::Bank::CurrencylayerBank do
 
     it 'should get from url' do
       subject.update_rates
-      subject.rates.wont_be_empty
+      _(subject.rates).wont_be_empty
     end
   end
 
@@ -126,7 +127,7 @@ describe Money::Bank::CurrencylayerBank do
     end
 
     it 'should raise an error if invalid path is given' do
-      proc { subject.update_rates }.must_raise Money::Bank::InvalidCache
+      _(proc { subject.update_rates }).must_raise Money::Bank::InvalidCache
     end
   end
 
@@ -146,16 +147,16 @@ describe Money::Bank::CurrencylayerBank do
     it 'should get from url normally' do
       stub(subject).source_url { data_path }
       subject.update_rates
-      subject.rates.wont_be_empty
+      _(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
+      _(@global_rates).wont_be_empty
       dont_allow(subject).source_url
       subject.update_rates
-      subject.rates.wont_be_empty
+      _(subject.rates).wont_be_empty
     end
   end
 
@@ -163,23 +164,23 @@ describe Money::Bank::CurrencylayerBank 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}&"\
+      _(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}&"\
+      _(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}&"\
+      _(subject.source_url).must_equal "#{secure_url}?source=#{source}&"\
                                     "access_key=#{TEST_ACCESS_KEY}"
-      subject.source_url.must_include 'https://'
+      _(subject.source_url).must_include 'https://'
     end
   end
 
@@ -214,7 +215,7 @@ describe Money::Bank::CurrencylayerBank do
         subject.add_rate('USD', 'WTF', 2)
         subject.add_rate('WTF', 'USD', 2)
         subject.exchange_with(5000.to_money('WTF'), 'USD').cents
-        subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
+        _(subject.exchange_with(5000.to_money('WTF'), 'USD').cents).wont_equal 0
       end
     end
   end
@@ -226,7 +227,7 @@ describe Money::Bank::CurrencylayerBank do
     end
 
     it 'should raise an error if no access key is set' do
-      proc { subject.update_rates }.must_raise Money::Bank::NoAccessKey
+      _(proc { subject.update_rates }).must_raise Money::Bank::NoAccessKey
     end
   end
 
@@ -250,11 +251,11 @@ describe Money::Bank::CurrencylayerBank do
     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
+          _(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
+          _(subject.get_rate('USD', 'EUR')).wont_equal @old_usd_eur_rate
+          _(subject.get_rate('USD', 'EUR')).must_equal @new_usd_eur_rate
         end
       end
 
@@ -262,7 +263,7 @@ describe Money::Bank::CurrencylayerBank do
         Timecop.freeze(subject.rates_timestamp + 1001) do
           exp_time = subject.rates_timestamp + 1000
           subject.expire_rates!
-          subject.rates_expiration.must_equal exp_time
+          _(subject.rates_expiration).must_equal exp_time
         end
       end
     end
@@ -272,7 +273,7 @@ describe Money::Bank::CurrencylayerBank do
         subject.update_rates
         exp_time = subject.rates_expiration
         subject.expire_rates!
-        subject.rates_expiration.must_equal exp_time
+        _(subject.rates_expiration).must_equal exp_time
       end
     end
   end
@@ -291,12 +292,12 @@ describe Money::Bank::CurrencylayerBank do
     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)
+      _(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
+      _(subject.rates_timestamp.class).must_equal Time
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.8
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.49.1
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
@@ -185,11 +185,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.2.24
 signing_key: 
 specification_version: 4
 summary: A gem that calculates the exchange rate using published rates from currencylayer.com.
 test_files:
 - test/currencylayer_bank_test.rb
-has_rdoc: