money-currencylayer-bank 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3c0fb9028cd1aeffa15e39f1ac11611a98ebc98c4388b3d7e15c3926f186ae2
-  data.tar.gz: 4cd0872bd7ddf5957a80b344a781656532b98c77b4eaf69f1d5b36eb6b4b4a48
+  metadata.gz: 2cd0e712f363b756776096cd7cb5ff5b3fbb473147f5659a524f6cd3a4d675d9
+  data.tar.gz: 415066f35b6dd18c2f86d9259003c26559a73a042c52c4192ab97247c0b23856
 SHA512:
-  metadata.gz: cddb985e9d2f028674acff2e4f5605ff9d504396abbcec1e63cadadc3ea7a9620517e9af28d622fccf4729a70e0500918b6f9d218e38d01d42dd1fb91cc00581
-  data.tar.gz: b138d9a8d0ca0fa1ece3d4c576088ad7fe6e023b96fd3d21537e048764df887c871e9eebc2cfe8c425bca682aa20e63d2e1a38ebc0259611ee2a57f8bfb9e7a3
+  metadata.gz: cac0709ae73bbc1efac414dde9b770793905a3e9a5c50abc4fa1ddab7040c0626b776c5c46be46b6ca234bfed8a220c11089f62a705009f1f08dbc214bda08e5
+  data.tar.gz: 34e550142270e65d075183ebe528306d749f8ceaa115bd5ad3e09d1193bcc415183443f81f1ed2d2354392c4dda8616dc205fc9f5d16b4b8b30b1507793980a6

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)
-[![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)
+[![Code Climate](https://codeclimate.com/github/phlegx/money-currencylayer-bank.svg)](https://codeclimate.com/github/phlegx/money-currencylayer-bank)
+[![Inline Docs](https://inch-ci.org/github/phlegx/money-currencylayer-bank.svg?branch=master)](http://inch-ci.org/github/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
@@ -61,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
-# by default, they never expire, in this example 1 day.
+# 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
 ~~~
 
@@ -212,4 +216,4 @@ bundle exec rake
 
 The MIT License
 
-Copyright (c) 2017 Phlegx Systems OG
+Copyright (c) 2022 Phlegx Systems OG

data/lib/money/bank/currencylayer_bank.rb

@@ -31,7 +31,7 @@ class Money
     # CurrencylayerBank base class
     class CurrencylayerBank < Money::Bank::VariableExchange
       # CurrencylayerBank url
-      CL_URL = 'http://apilayer.net/api/live'.freeze
+      CL_URL = 'http://api.currencylayer.com/live'.freeze
       # CurrencylayerBank secure url
       CL_SECURE_URL = CL_URL.sub('http:', 'https:')
       # Default base currency
@@ -155,6 +155,8 @@ class Money
       # Check if rates are expired
       # @return [Boolean] true if rates are expired
       def expired?
+        return false if ttl_in_seconds.zero?
+
         Time.now > rates_expiration
       end
 
@@ -240,7 +242,7 @@ class Money
       # Opens an url and reads the content
       # @return [String] unparsed JSON content
       def open_url
-        ::OpenURI.open_uri(source_url).read
+        URI.open(source_url).read
       rescue OpenURI::HTTPError
         ''
       end
@@ -268,11 +270,18 @@ 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

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.7
+  version: 0.6.0
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.24
 signing_key: 
 specification_version: 4
 summary: A gem that calculates the exchange rate using published rates from currencylayer.com.