money-currencylayer-bank 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd0e712f363b756776096cd7cb5ff5b3fbb473147f5659a524f6cd3a4d675d9
-  data.tar.gz: 415066f35b6dd18c2f86d9259003c26559a73a042c52c4192ab97247c0b23856
+  metadata.gz: c3f50af5ecdfe22212d99381d062f3db9bec09415f0734b54db59b64a8f42d47
+  data.tar.gz: 60aebccb74c462df8a0a8d7c48a73e86f8bb75f52c6520c7478792475416087c
 SHA512:
-  metadata.gz: cac0709ae73bbc1efac414dde9b770793905a3e9a5c50abc4fa1ddab7040c0626b776c5c46be46b6ca234bfed8a220c11089f62a705009f1f08dbc214bda08e5
-  data.tar.gz: 34e550142270e65d075183ebe528306d749f8ceaa115bd5ad3e09d1193bcc415183443f81f1ed2d2354392c4dda8616dc205fc9f5d16b4b8b30b1507793980a6
+  metadata.gz: e0dd0f1cf80928b7b293ae220bdd684701aa5a03eee129520505940baef899225f27a360ff13a04798f51607a8802a551376eb0e025942266389788b1ddb93fb
+  data.tar.gz: 41fce81a38a14709b7439751d7ab3d1c944fb901eb9749a68cfbbc02b623d2809838a3849cb35e6679a71eeaef85d171fe008f7cba7a0d5a491fc88369c6a17f

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Phlegx Systems OG
+Copyright (c) 2022 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

@@ -63,7 +63,14 @@ Or install it yourself as:
 # Minimal requirements.
 require 'money/bank/currencylayer_bank'
 mclb = Money::Bank::CurrencylayerBank.new
-mclb.access_key = 'your access_key from https://currencylayer.com/product'
+
+# New endpoint: https://apilayer.com/marketplace/currency_data-api or
+# old endpoint: https://currencylayer.com/product
+mclb.access_key = 'your access_key'
+
+# (optional)
+# Use the old endpoint api.currencylayer.com. By default, the new endpoint is used.
+mclb.currencylayer = true
 
 # (optional)
 # Set the base currency for all rates. By default, USD is used.
@@ -80,6 +87,10 @@ mclb.ttl_in_seconds = 86400
 # CurrencylayerBank only allows http as connection for the free plan users.
 mclb.secure_connection = true
 
+# (optional)
+# Rescue with rates from the cache instead of reporting an error when the endpoint fails.
+mclb.rescue_with_cache = true
+
 # Define cache (string or pathname).
 mclb.cache = 'path/to/file/cache'
 
@@ -103,9 +114,15 @@ Money.default_bank = mclb
 ~~~ ruby
 mclb = Money::Bank::CurrencylayerBank.new
 
+# Returns true if configured to use the old endpoint.
+mclb.currencylayer
+
 # Returns the base currency set for all rates.
 mclb.source
 
+# Returns true if configured to rescue rates from the cache.
+mclb.rescue_with_cache
+
 # Expires rates if the expiration time is reached.
 mclb.expire_rates!
 

data/lib/money/bank/currencylayer_bank.rb

@@ -30,12 +30,20 @@ class Money
 
     # CurrencylayerBank base class
     class CurrencylayerBank < Money::Bank::VariableExchange
+      # Apilayer url
+      URL_AL = 'http://api.apilayer.com/currency_data/live'.freeze
       # CurrencylayerBank url
-      CL_URL = 'http://api.currencylayer.com/live'.freeze
-      # CurrencylayerBank secure url
-      CL_SECURE_URL = CL_URL.sub('http:', 'https:')
+      URL_CL = 'http://api.currencylayer.com/live'.freeze
       # Default base currency
-      CL_SOURCE = 'USD'.freeze
+      SOURCE = 'USD'.freeze
+
+      # Use new or old endpoint.
+      # new: api.apilayer.com
+      # old: api.currencylayer.com
+      #
+      # @param value [Boolean] true for old endpoint
+      # @return [Boolean] chosen old endpoint if true
+      attr_accessor :currencylayer
 
       # Use https to fetch rates from CurrencylayerBank
       # CurrencylayerBank only allows http as connection
@@ -51,6 +59,13 @@ class Money
       # @return [String] chosen API access key
       attr_accessor :access_key
 
+      # Rescue with rates from the cache instead of reporting an
+      # error when the endpoint fails.
+      #
+      # @param value [Boolean] true for rescue error with cache rates
+      # @return [Boolean] chosen rescue with cache rates
+      attr_accessor :rescue_with_cache
+
       # Cache accessor, can be a String or a Proc
       #
       # @param value [String,Pathname,Proc] cache system
@@ -84,13 +99,13 @@ class Money
       # @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
+        @source = Money::Currency.find(value.to_s).try(:iso_code) || SOURCE
       end
 
       # Get the base currency for all rates. By default, USD is used.
       # @return [String] base currency
       def source
-        @source ||= CL_SOURCE
+        @source ||= SOURCE
       end
 
       # Get the seconds after than the current rates are automatically expired
@@ -173,9 +188,10 @@ class Money
       # @return [String] the remote API url
       def source_url
         raise NoAccessKey if access_key.nil? || access_key.empty?
-        cl_url = CL_URL
-        cl_url = CL_SECURE_URL if secure_connection
-        "#{cl_url}?source=#{source}&access_key=#{access_key}"
+        url = "#{currencylayer ? URL_CL : URL_AL}?source=#{source}"
+        url = url.sub('http:', 'https:') if secure_connection
+        url = "#{url}&access_key=#{access_key}" if currencylayer
+        url
       end
 
       # Get rates expiration time based on ttl
@@ -242,7 +258,7 @@ class Money
       # Opens an url and reads the content
       # @return [String] unparsed JSON content
       def open_url
-        URI.open(source_url).read
+        currencylayer ? URI.open(source_url).read : URI.open(source_url, apikey: access_key).read
       rescue OpenURI::HTTPError
         ''
       end
@@ -270,15 +286,14 @@ 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
-                else
-                  raw_rates_careful
-                end
+        rates = straight ? raw_rates_straight : raw_rates_careful
         if rates.key?('quotes')
           @rates = rates['quotes']
         elsif rates.key?('error')
-          raise Error, rates.dig('error', 'info')
+          raise Error, rates.dig('error', 'info') unless rescue_with_cache
+
+          rates = raw_rates_careful(false)
+          @rates = rates.key?('quotes') ? rates['quotes'] : { 'quotes' => {} }
         else
           raise Error, 'Unknown rates situation!'
         end

data/test/TEST_ACCESS_KEY

@@ -1 +1 @@
-your access_key from https://currencylayer.com/product
+your access_key from https://currencylayer.com/product or https://apilayer.com/marketplace/currency_data-api

data/test/currencylayer_bank_test.rb

@@ -6,9 +6,11 @@ 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 }
-  let(:source) { Money::Bank::CurrencylayerBank::CL_SOURCE }
+  let(:url_al) { Money::Bank::CurrencylayerBank::URL_AL }
+  let(:url_cl) { Money::Bank::CurrencylayerBank::URL_CL }
+  let(:secure_url_al) { Money::Bank::CurrencylayerBank::URL_AL.sub('http:', 'https:') }
+  let(:secure_url_cl) { Money::Bank::CurrencylayerBank::URL_CL.sub('http:', 'https:') }
+  let(:source) { Money::Bank::CurrencylayerBank::SOURCE }
   let(:temp_cache_path) do
     File.expand_path(File.join(File.dirname(__FILE__), 'temp.json'))
   end
@@ -161,24 +163,46 @@ describe Money::Bank::CurrencylayerBank do
   end
 
   describe '#secure_connection' do
-    it "should use the non-secure http url if secure_connection isn't set" do
+    it "should use the non-secure http apilayer.com 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_al}?source=#{source}"
+    end
+
+    it 'should use the non-secure http apilayer.com url if secure_connection is false' do
+      subject.secure_connection = false
+      subject.access_key = TEST_ACCESS_KEY
+      _(subject.source_url).must_equal "#{url_al}?source=#{source}"
+    end
+
+    it 'should use the secure https apilayer.com 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_al}?source=#{source}"
+      _(subject.source_url).must_include 'https://'
+    end
+
+    it "should use the non-secure http currencylayer.com url if secure_connection isn't set" do
+      subject.secure_connection = nil
+      subject.currencylayer = true
+      subject.access_key = TEST_ACCESS_KEY
+      _(subject.source_url).must_equal "#{url_cl}?source=#{source}&"\
                                     "access_key=#{TEST_ACCESS_KEY}"
     end
 
-    it 'should use the non-secure http url if secure_connection is false' do
+    it 'should use the non-secure http currencylayer.com url if secure_connection is false' do
       subject.secure_connection = false
+      subject.currencylayer = true
       subject.access_key = TEST_ACCESS_KEY
-      _(subject.source_url).must_equal "#{url}?source=#{source}&"\
+      _(subject.source_url).must_equal "#{url_cl}?source=#{source}&"\
                                     "access_key=#{TEST_ACCESS_KEY}"
     end
 
-    it 'should use the secure https url if secure_connection is set to true' do
+    it 'should use the secure https currencylayer.com url if secure_connection is set to true' do
       subject.secure_connection = true
+      subject.currencylayer = true
       subject.access_key = TEST_ACCESS_KEY
-      _(subject.source_url).must_equal "#{secure_url}?source=#{source}&"\
+      _(subject.source_url).must_equal "#{secure_url_cl}?source=#{source}&"\
                                     "access_key=#{TEST_ACCESS_KEY}"
       _(subject.source_url).must_include 'https://'
     end
@@ -223,7 +247,7 @@ describe Money::Bank::CurrencylayerBank do
   describe '#access_key' do
     before do
       subject.cache = temp_cache_path
-      stub(OpenURI::OpenRead).open(url) { File.read data_path }
+      stub(OpenURI::OpenRead).open(url_al) { File.read data_path }
     end
 
     it 'should raise an error if no access key is set' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -150,8 +150,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-description: A gem that calculates the exchange rate using published rates from currencylayer.com.
-  Compatible with the money gem.
+description: A gem that calculates the exchange rate using published rates from currencylayer.com
+  and apilayer.com. Compatible with the money gem.
 email: office@phlegx.com
 executables: []
 extensions: []
@@ -188,6 +188,7 @@ requirements: []
 rubygems_version: 3.2.24
 signing_key: 
 specification_version: 4
-summary: A gem that calculates the exchange rate using published rates from currencylayer.com.
+summary: A gem that calculates the exchange rate using published rates from currencylayer.com
+  and apilayer.com.
 test_files:
 - test/currencylayer_bank_test.rb