omni_exchange 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ebf805bee18ff582b11e816572b9bab09208e042c16a00d4c74b933a842104
-  data.tar.gz: 9decd4210cdcfd4e41a92e59e17f1a1e44addb6618c13db4d0765750d711b6dc
+  metadata.gz: e498fc09556edce13c2f54ef7de9451e38546eaae859a38b2c0378d9011d8c2b
+  data.tar.gz: 8ef08385d9b929689e825ed4ac9b1f19756105e0f4d393279fe8e7482d85a281
 SHA512:
-  metadata.gz: bd89c93e6e044e0bebb387f369e312760ac782e97da28a12bb0ed635c92696cedb4ea41e3c75cdc7d999d5b69853686a2a71cea6e706c79c263b046e96ff5c55
-  data.tar.gz: 07ac0fcb122d03643889b01380d97f5dada0ea9b34951b8f88bb7c0a236a82b4244a491ae28f75e82a82c408624606462ebbf3eab08d93f0ea7f73a8e24a85e9
+  metadata.gz: a2dd2e4413a7c0f061d70f605d55395d924e48341a6f44b292c997ce58b6264d090d90d605fc4304e5afd36981797c4c49965684154c3a7b8b9719d4cb89dcc5
+  data.tar.gz: '048bb4224fd6c1b61d6ef89daa5eb2a38fc3527b9428c892e11786bf621205be39795b7876cf5b1832faa2811b733a5fca0dc45a01e77f2240bbe7fd914adf8b'

data/.gitignore

@@ -14,3 +14,9 @@
 .env
 
 sandbox.rb
+omni_exchange-0.1.0.gem
+omni_exchange-0.2.0.gem
+omni_exchange-1.1.0.gem
+omni_exchange-1.1.1.gem
+omni_exchange-1.2.0.gem
+omni_exchange-1.3.0.gem

data/.rubocop_todo.yml

@@ -1,15 +1,20 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-06-30 01:49:03 UTC using RuboCop version 0.93.1.
+# on 2022-07-12 04:26:20 UTC using RuboCop version 0.93.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/sandbox.rb'
+
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 28
+  Max: 33
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
@@ -39,7 +44,7 @@ Style/ExponentialNotation:
   Exclude:
     - 'spec/omni_exchange_spec.rb'
 
-# Offense count: 3
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -47,9 +52,17 @@ Style/StringLiterals:
   Exclude:
     - 'lib/sandbox.rb'
 
-# Offense count: 16
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: .
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: percent
+  MinSize: 3
+
+# Offense count: 19
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 226
+  Max: 220

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omni_exchange (1.1.0)
+    omni_exchange (1.3.0)
       faraday (= 0.17.4)
       money (~> 6.13.1)
 

data/README.md

@@ -57,7 +57,7 @@ To convert currency and/or get an exchange rate, all you have to do is call `Omn
 What you get back is a hash containing:
 1. converted_amount: (BigDecimal) the amount of money exchanged from the base currency to the target currency
 2. exchange_rate: (BigDecimal) the rate used to calculate the converted_amount
-3. provider_class: (Class) the name of the provider class that supplied the exchange_rate (ie. OmniExchange::OpenExhangeRates)
+3. provider: (Symbol) the provider that supplied the exchange_rate (ie. :open_exchange_rates, :xe)
 
 [For the sake of precise calculation](https://www.bigbinary.com/blog/handling-money-in-ruby), converted_amount and exchange_rate are BigDecimal. Simply call `.to_f` to the results if you'd like to see a number that is easier to read.
 
@@ -67,7 +67,7 @@ Here is an example. Lets say I want to convert $1.00 US Dollar to Japanese Yen,
 ```ruby
 USD_to_JPY = OmniExchange.get_fx_data(amount: 100, base_currency: 'USD', target_currency: 'JPY', providers: [:open_exchange_rates, :xe])
 
-puts USD_to_JPY # => { :converted_amount=>0.13566633333e3, :exchange_rate=>0.13566633333e1, :provider_class=>OmniExchange::OpenExchangeRates }
+puts USD_to_JPY # => { :converted_amount=>0.13566633333e3, :exchange_rate=>0.13566633333e1, :provider=>:open_exchange_rates }
 
 puts USD_to_JPY[:converted_amount] # => 0.13566633333e3
 puts USD_to_JPY[:converted_amount].to_f # => 135.66633333

data/bin/console

@@ -6,6 +6,7 @@ require 'omni_exchange'
 require 'dotenv/load'
 require 'faraday'
 require 'money'
+require 'net/http'
 require_relative '../lib/omni_exchange/provider'
 require_relative '../lib/omni_exchange/configuration'
 require_relative '../lib/omni_exchange/error'

data/lib/omni_exchange/error.rb

@@ -8,4 +8,8 @@ module OmniExchange
   # A custom error for failure to get data from a provider
   class HttpError < StandardError
   end
+
+  # A custom error for exceeding the monthly request limit for xe.com
+  class XeMonthlyLimit < StandardError
+  end
 end

data/lib/omni_exchange/providers/open_exchange_rates.rb

@@ -27,15 +27,19 @@ module OmniExchange
           req.options.timeout = config[:read_timeout] || OmniExchange::Configuration::DEFAULT_READ_TIMEOUT
           req.options.open_timeout = config[:connect_timeout] || OmniExchange::Configuration::DEFAULT_CONNECTION_TIMEOUT
         end
-      rescue Faraday::Error, Faraday::ConnectionFailed => e
+      rescue *EXCEPTIONS => e
         raise e.class, 'Open Exchange Rates has timed out.'
       end
 
-      exchange_rate = JSON.parse(response.body, symbolize_names: true)[:rates][target_currency.to_sym].to_d
+      begin
+        exchange_rate = JSON.parse(response.body, symbolize_names: true)[:rates][target_currency.to_sym].to_d
+      rescue JSON::ParserError => e
+        raise e.class, 'JSON::ParserError in OmniExchange::OpenExchangeRates'
+      end
 
-      currency_unit = get_currency_unit(base_currency)
+      currency_unit = get_currency_unit(base_currency).to_d
 
-      exchange_rate * currency_unit
+      (exchange_rate * currency_unit).to_d
     end
 
     # when this file is required at the top of lib/omni_exchange.rb, this method call is run and allows

data/lib/omni_exchange/providers/xe.rb

@@ -32,11 +32,19 @@ module OmniExchange
           req.options.timeout = config[:read_timeout] || OmniExchange::Configuration::DEFAULT_READ_TIMEOUT
           req.options.open_timeout = config[:connect_timeout] || OmniExchange::Configuration::DEFAULT_CONNECTION_TIMEOUT
         end
-      rescue Faraday::Error, Faraday::ConnectionFailed => e
+      rescue *EXCEPTIONS => e
         raise e.class, 'xe.com has timed out.'
       end
 
-      JSON.parse(response.body, symbolize_names: true)[:to][0][:mid].to_d
+      begin
+        body = JSON.parse(response.body, symbolize_names: true)
+      rescue JSON::ParserError => e
+        raise e.class, 'JSON::ParserError in OmniExchange::Xe'
+      end
+
+      raise OmniExchange::XeMonthlyLimit, 'Xe.com monthly limit has been exceeded' if body[:code] == 3
+
+      body[:to][0][:mid].to_d
     end
 
     # when this file is required at the top of lib/omni_exchange.rb, this method call is run and allows

data/lib/omni_exchange/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniExchange
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/lib/omni_exchange.rb

@@ -12,6 +12,7 @@ require 'faraday'
 require 'money'
 require 'json'
 require 'bigdecimal/util'
+require 'net/http'
 
 # rubocop:disable Lint/Syntax
 module OmniExchange
@@ -32,6 +33,9 @@ module OmniExchange
     yield(configuration)
   end
 
+  # if a provider raises one of these exceptions, OmniExchange will gracefully attempt to use another provider
+  EXCEPTIONS = [Faraday::Error, Faraday::ConnectionFailed, Faraday::TimeoutError, Net::OpenTimeout, Net::WriteTimeout, Net::ReadTimeout, OpenSSL::SSL::SSLError]
+
   module_function
 
   # returns foreign exchange data including the amount of money in one country's currency when exchanged from an
@@ -44,15 +48,12 @@ module OmniExchange
   # @param providers: [Array] an array of symbols of the providers that will be used to get exchange rates API
   #   data. The symbols must be found in the @providers hash in the Provider class (lib/omni_exchange/provider.rb).
   #   ie. xe:, :open_exchange_rates
-  # @return [Hash] If all of the providers in the providers hash fail to retrieve data, or if one of the currencies
-  #   is not valid, an exception is raised.
+  # @return [Hash] If none of the providers in the providers hash are able to retrieve data, or if one of the
+  #   currencies is not valid, an exception is raised.
   #   * :converted_amount [BigDecimal] the amount of money exchanged from the base currency to the target
   #       currency as a BigDecimal for precice calculation. ie. 1, 10, 100
   #   * :exchange_rate [BigDecimal] the rate used to calculate the converted_amount as a BigDecimal. ie. 0.95211e1
-  #   * :provider_class [Class] the provider class that supplied the exchange_rate data. ie. OmniExchange::Xe
-  #the amount of the base currency exchanged to the target currency using an exchange rate
-  #   provided by one of the data providers in the providers hash. The final amount is returned as a BigDecimal
-  #   for precise calculation. If all of the providers in the providers hash fail to retrieve data, an exception is raised.
+  #   * :provider [Symbol] the provider that supplied the exchange_rate data. ie. :xe, :open_exchange_rates
   def get_fx_data(amount:, base_currency:, target_currency:, providers:)
     # if one of the currencies is not valid (ie. 'fake_crypto'), an exception is raised.
     begin
@@ -71,10 +72,10 @@ module OmniExchange
     provider_classes.each do |klass|
       rate = klass.get_exchange_rate(base_currency: base_currency, target_currency: target_currency)
 
-      exchanged_amount = rate * amount.to_d
+      exchanged_amount = rate.to_d * amount.to_d
 
-      return { converted_amount: exchanged_amount, exchange_rate: rate, provider_class: klass }
-    rescue Faraday::Error, Faraday::ConnectionFailed => e
+      return { converted_amount: exchanged_amount, exchange_rate: rate, provider: OmniExchange::Provider.all.key(klass) }
+    rescue *EXCEPTIONS, OmniExchange::XeMonthlyLimit, JSON::ParserError => e
       error_messages << e.inspect
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omni_exchange
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday