money-open-exchange-rates 0.7.0 → 1.4.2

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
-require 'uri'
-require 'open-uri'
-require 'money'
+
 require 'json'
-require File.expand_path('../../../open_exchange_rates_bank/version', __FILE__)
+require 'money'
+require 'net/http'
+require 'time'
+require 'uri'
+require File.expand_path('../../open_exchange_rates_bank/version', __dir__)
 
 # Money gem class
-# rubocop:disable ClassLength
+# rubocop:disable Metrics/ClassLength
 class Money
   # https://github.com/RubyMoney/money#exchange-rate-stores
   module Bank
@@ -16,31 +18,30 @@ class Money
     # APP_ID not set error
     class NoAppId < StandardError; end
 
+    # Access restricted (e.g. usage/request limit exceeded for account)
+    class AccessRestricted < StandardError; end
+
+    # app_id_inactive
+    class AppIdInactive < StandardError; end
+
+    ERROR_MAP = {
+      access_restricted: AccessRestricted,
+      app_id_inactive: AppIdInactive
+    }.freeze
+
     # OpenExchangeRatesBank base class
     class OpenExchangeRatesBank < Money::Bank::VariableExchange
       VERSION = ::OpenExchangeRatesBank::VERSION
-      BASE_URL = 'http://openexchangerates.org/api/'.freeze
+      BASE_URL = 'https://openexchangerates.org/api/'
+
       # OpenExchangeRates urls
       OER_URL = URI.join(BASE_URL, 'latest.json')
       OER_HISTORICAL_URL = URI.join(BASE_URL, 'historical/')
-      # OpenExchangeRates secure url
-      SECURE_OER_URL = OER_URL.clone
-      SECURE_OER_URL.scheme = 'https'
-      SECURE_OER_HISTORICAL_URL = OER_HISTORICAL_URL.clone
-      SECURE_OER_HISTORICAL_URL.scheme = 'https'
 
       # Default base currency "base": "USD"
-      OE_SOURCE = 'USD'.freeze
-
-      # use https to fetch rates from Open Exchange Rates
-      # disabled by default to support free-tier users
-      #
-      # @example
-      #   oxr.secure_connection = true
-      #
-      # @param [Boolean] true for https, false for http
-      # @return [Boolean] true for https, false for http
-      attr_accessor :secure_connection
+      OE_SOURCE = 'USD'
+      RATES_KEY = 'rates'
+      TIMESTAMP_KEY = 'timestamp'
 
       # As of the end of August 2012 all requests to the Open Exchange Rates
       # API must have a valid app_id
@@ -72,6 +73,13 @@ class Money
       # @return [String] The requested date in YYYY-MM-DD format
       attr_accessor :date
 
+      # Force refresh rates cache and store on the fly when ttl is expired
+      # This will slow down request on get_rate, so use at your on risk, if you
+      # don't want to setup crontab/worker/scheduler for your application
+      #
+      # @param [Boolean]
+      attr_accessor :force_refresh_rate_on_expire
+
       # Rates expiration Time
       #
       # @return [Time] expiration time
@@ -82,11 +90,57 @@ class Money
       # @return [Hash] All rates as Hash
       attr_reader :oer_rates
 
+      # Unparsed OpenExchangeRates response as String
+      #
+      # @return [String] OpenExchangeRates json response
+      attr_reader :json_response
+
       # Seconds after than the current rates are automatically expired
       #
       # @return [Integer] Setted time to live in seconds
       attr_reader :ttl_in_seconds
 
+      # Set support for the black market and alternative digital currencies
+      # see https://docs.openexchangerates.org/docs/alternative-currencies
+      # @example
+      #   oxr.show_alternative = true
+      #
+      # @param [Boolean] if true show alternative
+      # @return [Boolean] Setted show alternative
+      attr_writer :show_alternative
+
+      # Filter response to a list of symbols
+      # see https://docs.openexchangerates.org/docs/get-specific-currencies
+      # @example
+      #   oxr.symbols = [:usd, :cad]
+      #
+      # @param [Array] list of symbols
+      # @return [Array] Setted list of symbols
+      attr_writer :symbols
+
+      # Minified Response ('prettyprint')
+      # see https://docs.openexchangerates.org/docs/prettyprint
+      # @example
+      #   oxr.prettyprint = false
+      #
+      # @param [Boolean] Set to false to receive minified (default: true)
+      # @return [Boolean]
+      attr_writer :prettyprint
+
+      # Set current rates timestamp
+      #
+      # @return [Time]
+      def rates_timestamp=(at)
+        @rates_timestamp = Time.at(at)
+      end
+
+      # Current rates timestamp
+      #
+      # @return [Time]
+      def rates_timestamp
+        @rates_timestamp || Time.now
+      end
+
       # Set the seconds after than the current rates are automatically expired
       # by default, they never expire.
       #
@@ -99,7 +153,7 @@ class Money
       def ttl_in_seconds=(value)
         @ttl_in_seconds = value
         refresh_rates_expiration if ttl_in_seconds
-        @ttl_in_seconds
+        ttl_in_seconds
       end
 
       # Set the base currency for all rates. By default, USD is used.
@@ -113,9 +167,12 @@ class Money
       #
       # @return [String] chosen base currency
       def source=(value)
-        @source = Money::Currency.find(value.to_s).iso_code
-      rescue
-        @source = OE_SOURCE
+        scurrency = Money::Currency.find(value.to_s)
+        @source = if scurrency
+                    scurrency.iso_code
+                  else
+                    OE_SOURCE
+                  end
       end
 
       # Get the base currency for all rates. By default, USD is used.
@@ -129,27 +186,19 @@ class Money
       #
       # @return [Array] Array of exchange rates
       def update_rates
-        exchange_rates.each do |exchange_rate|
-          rate = exchange_rate.last
-          currency = exchange_rate.first
-          next unless Money::Currency.find(currency)
-          set_rate(source, currency, rate)
-          set_rate(currency, source, 1.0 / rate)
+        store.transaction do
+          clear_rates!
+          exchange_rates.each do |exchange_rate|
+            rate = exchange_rate.last
+            currency = exchange_rate.first
+            next unless Money::Currency.find(currency)
+
+            set_rate(source, currency, rate)
+            set_rate(currency, source, 1.0 / rate)
+          end
         end
       end
 
-      # Save rates on cache
-      # Can raise InvalidCache
-      #
-      # @return [Proc,File]
-      def save_rates
-        raise InvalidCache unless cache
-        text = read_from_url
-        store_in_cache(text) if valid_rates?(text)
-      rescue Errno::ENOENT
-        raise InvalidCache
-      end
-
       # Alias super method
       alias super_get_rate get_rate
 
@@ -166,30 +215,77 @@ class Money
         rate || calc_pair_rate_using_base(from_currency, to_currency, opts)
       end
 
+      # Fetch from url and save cache
+      #
+      # @return [Array] Array of exchange rates
+      def refresh_rates
+        read_from_url
+      end
+
+      # Alias refresh_rates method
+      alias save_rates refresh_rates
+
       # Expire rates when expired
       #
       # @return [NilClass, Time] nil if not expired or new expiration time
       def expire_rates
         return unless ttl_in_seconds
         return if rates_expiration > Time.now
+
+        refresh_rates if force_refresh_rate_on_expire
         update_rates
         refresh_rates_expiration
       end
 
+      # Get show alternative
+      #
+      # @return [Boolean] if true show alternative
+      def show_alternative
+        @show_alternative ||= false
+      end
+
+      # Get prettyprint option
+      #
+      # @return [Boolean]
+      def prettyprint
+        return true unless defined? @prettyprint
+        return true if @prettyprint.nil?
+
+        @prettyprint
+      end
+
+      # Get symbols
+      #
+      # @return [Array] list of symbols to filter by
+      def symbols
+        @symbols ||= nil
+      end
+
       # Source url of openexchangerates
-      # defined with app_id and secure_connection
+      # defined with app_id
       #
       # @return [String] URL
       def source_url
-        if source == OE_SOURCE
-          "#{oer_url}?app_id=#{app_id}"
-        else
-          "#{oer_url}?app_id=#{app_id}&base=#{source}"
-        end
+        str = "#{oer_url}?app_id=#{app_id}"
+        str = "#{str}&base=#{source}" unless source == OE_SOURCE
+        str = "#{str}&show_alternative=#{show_alternative}"
+        str = "#{str}&prettyprint=#{prettyprint}"
+        str = "#{str}&symbols=#{symbols.join(',')}" if symbols&.is_a?(Array)
+        str
       end
 
       protected
 
+      # Save rates on cache
+      # Can raise InvalidCache
+      #
+      # @return [Proc,File]
+      def save_cache
+        store_in_cache(@json_response) if valid_rates?(@json_response)
+      rescue Errno::ENOENT
+        raise InvalidCache
+      end
+
       # Latest url if no date given
       #
       # @return [String] URL
@@ -205,21 +301,19 @@ class Money
       #
       # @return [String] URL
       def historical_url
-        url = OER_HISTORICAL_URL
-        url = SECURE_OER_HISTORICAL_URL if secure_connection
-        URI.join(url, "#{date}.json")
+        URI.join(OER_HISTORICAL_URL, "#{date}.json")
       end
 
       # Latest url
       #
       # @return [String] URL
       def latest_url
-        return SECURE_OER_URL if secure_connection
         OER_URL
       end
 
       # Store the provided text data by calling the proc method provided
       # for the cache, or write to the cache file.
+      # Can raise InvalidCache
       #
       # @example
       #   oxr.store_in_cache("{\"rates\": {\"AED\": 3.67304}}")
@@ -229,10 +323,12 @@ class Money
       def store_in_cache(text)
         if cache.is_a?(Proc)
           cache.call(text)
-        elsif cache.is_a?(String)
-          open(cache, 'w') do |f|
+        elsif cache.is_a?(String) || cache.is_a?(Pathname)
+          File.open(cache.to_s, 'w') do |f|
             f.write(text)
           end
+        else
+          raise InvalidCache
         end
       end
 
@@ -240,11 +336,19 @@ class Money
       #
       # @return [String] Raw string from file or cache proc
       def read_from_cache
-        if cache.is_a?(Proc)
-          cache.call(nil)
-        elsif cache.is_a?(String) && File.exist?(cache)
-          open(cache).read
-        end
+        result = if cache.is_a?(Proc)
+                   cache.call(nil)
+                 elsif File.exist?(cache.to_s)
+                   File.read(cache)
+                 end
+        result if valid_rates?(result)
+      end
+
+      # Read API
+      #
+      # @return [String]
+      def api_response
+        Net::HTTP.get(URI(source_url))
       end
 
       # Read from url
@@ -252,7 +356,10 @@ class Money
       # @return [String] JSON content
       def read_from_url
         raise NoAppId if app_id.nil? || app_id.empty?
-        open(source_url).read
+
+        @json_response = api_response
+        save_cache if cache
+        @json_response
       end
 
       # Check validity of rates response only for store in cache
@@ -263,8 +370,10 @@ class Money
       # @param [String] text is JSON content
       # @return [Boolean] valid or not
       def valid_rates?(text)
+        return false unless text
+
         parsed = JSON.parse(text)
-        parsed && parsed.key?('rates')
+        parsed&.key?(RATES_KEY) && parsed&.key?(TIMESTAMP_KEY)
       rescue JSON::ParserError
         false
       end
@@ -274,14 +383,19 @@ class Money
       # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
       def exchange_rates
         doc = JSON.parse(read_from_cache || read_from_url)
-        @oer_rates = doc['rates']
+        if doc['error'] && ERROR_MAP.key?(doc['message'].to_sym)
+          raise ERROR_MAP[doc['message'].to_sym]
+        end
+
+        self.rates_timestamp = doc[TIMESTAMP_KEY]
+        @oer_rates = doc[RATES_KEY]
       end
 
       # Refresh expiration from now
       #
       # @return [Time] new expiration time
       def refresh_rates_expiration
-        @rates_expiration = Time.now + ttl_in_seconds
+        @rates_expiration = rates_timestamp + ttl_in_seconds
       end
 
       # Get rate or calculate it as inverse rate
@@ -312,13 +426,23 @@ class Money
       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.to_f / from_base_rate
-          add_rate(from_currency, to_currency, rate)
-          return rate
+        return unless to_base_rate
+        return unless from_base_rate
+
+        rate = BigDecimal(to_base_rate.to_s) / from_base_rate
+        add_rate(from_currency, to_currency, rate)
+        rate
+      end
+
+      # Clears cached rates in store
+      #
+      # @return [Hash] All rates from store as Hash
+      def clear_rates!
+        store.each_rate do |iso_from, iso_to|
+          add_rate(iso_from, iso_to, nil)
         end
-        nil
       end
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/open_exchange_rates_bank/version.rb

@@ -2,5 +2,5 @@
 
 # Module for version constant
 module OpenExchangeRatesBank
-  VERSION = '0.7.0'.freeze
+  VERSION = '1.4.2'
 end

data/test/data/access_restricted_error.json

@@ -0,0 +1,6 @@
+{
+  "error": true,
+  "status": 429,
+  "message": "access_restricted",
+  "description": "Access restricted until 2050-01-01 (reason: too_many_requests). If there has been a mistake, please contact support@openexchangerates.org."
+}

data/test/data/app_id_inactive.json

@@ -0,0 +1 @@
+{"error": true, "status": 401, "message": "app_id_inactive", "description": "This App ID has been deactivated. Please use another or contact support@openexchangerates.org for assistance."}

data/test/integration/Gemfile

@@ -1,2 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
 gem 'money', '~> 6.7'
 gem 'money-open-exchange-rates', path: '../../'

data/test/integration/Gemfile.lock

@@ -1,26 +1,24 @@
 PATH
-  remote: ../../
+  remote: ../..
   specs:
-    money-open-exchange-rates (0.6.1)
-      monetize (~> 1.4)
-      money (~> 6.7)
+    money-open-exchange-rates (1.4.1)
+      money (~> 6.12)
 
 GEM
+  remote: https://rubygems.org/
   specs:
-    i18n (0.7.0)
-    monetize (1.4.0)
-      money (~> 6.7)
-    money (6.7.1)
-      i18n (>= 0.6.4, <= 0.7.0)
-      sixarm_ruby_unaccent (>= 1.1.1, < 2)
-    sixarm_ruby_unaccent (1.1.1)
+    concurrent-ruby (1.2.2)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    money (6.16.0)
+      i18n (>= 0.6.4, <= 2)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   money (~> 6.7)
   money-open-exchange-rates!
 
 BUNDLED WITH
-   1.13.1
+   2.4.12

data/test/integration/api.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'money/bank/open_exchange_rates_bank'
 
-ERROR_MSG = 'Integration test failed!'.freeze
+ERROR_MSG = 'Integration test failed!'
 cache_path = '/tmp/latest.json'
 to_currency = 'CAD'
 app_id = ENV['OXR_APP_ID']
@@ -29,6 +31,9 @@ begin
   puts 'Money to_currency', cad_rate
   # rubocop:disable Style/AndOr
   json_to_currency == cad_rate or raise ERROR_MSG
+  # rubocop:enable Style/AndOr
+  # rubocop:disable Style/RescueStandardError
 rescue
+  # rubocop:enable Style/RescueStandardError
   raise ERROR_MSG
 end