money-currencylayer-bank 0.5.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad15fc05b8e56c61e10554fd8574e0dbd358e3adc287c140ee11cb4b5c5747d8
-  data.tar.gz: 3ace2bd923ee971f5f6fca67f5ada19a0edf25687fbf0806b197f8876ee33146
+  metadata.gz: 468cd2adad236896e66ed821576b5bd5df64931909a85f41f48e171c8c3fd6b8
+  data.tar.gz: e09e3d6aff104763a6b069747e302dd7baa9d76d97d729d34dd186fc2a4eb8c9
 SHA512:
-  metadata.gz: 25849b05854111ab7ec51474fdbe9d02a5dd03d80719d46f0358a1c9c87b63e6296f2edcacd46e65e975e5510f16a456b4be50f1c92aa87c2b9af81504d5cf49
-  data.tar.gz: ce7667380baef8501825232ff7425b3a3121e85f0bfc4d8656d4c8b310e50d84ed787e6384d7da1bd692bf44233cccbaadee7dcf559232aece1ef83b28f258ec
+  metadata.gz: 29aed62e0d5e6eef896a2ce8136e42549fede2fe9c84dba9a0ba294dfc8d815fd8a93790cc6350463c40fbc243d5c80563d2fe02e51c04ed810e0a72978fa622
+  data.tar.gz: 971a319e510241c517480c2212ff5c9c938eb5eb67f234e9cd5545d76a12766e8f28ff2a967f161a123e1925e8ba7410d9960078620ea31e1521ffdd27822919

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

@@ -4,7 +4,7 @@
 [![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](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)
+[![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
@@ -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.
@@ -72,7 +79,7 @@ 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.
+# By default, they never expire, in this example 1 day.
 mclb.ttl_in_seconds = 86400
 
 # (optional)
@@ -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
@@ -155,6 +170,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
 
@@ -171,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
@@ -241,6 +259,7 @@ class Money
       # @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
@@ -268,15 +287,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.5.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2022-08-25 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