omni_exchange 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e96486f0fec5e014b79827ca801fc70c717ad3f3c36a333fc2d1248ea7b3f6
-  data.tar.gz: f52a460e18ad19a5cfeefe507dbce77563faf8e81ad5c2b23701fa7fec058190
+  metadata.gz: 2b8b209ec25ddad7e22d1aecc9c8073e6e41ac9e6121e29fcb15c1a240a86a80
+  data.tar.gz: d31a7913b18dd4636d449e86f7bb059c2196026e360b2dbdc20e6376e91a96ae
 SHA512:
-  metadata.gz: e948110df897320119664e7dadd069a9b32a74c9f683f21d9af48c4166eda64dfd6494fee2719c11c670088b91276de8f8659e7248aa324297219981ae18865f
-  data.tar.gz: 218e427ae203f24f0eeb4e74235b63fadaf47638061d6735f52d854b9413d5bfbcb08d5e541365cfcdeb9e4dfc481b2aedba145f6bfcf1f69b4a880a0e1451e9
+  metadata.gz: 4e0c80da124045ae0ae12d4c874e464ba6084e399ca6b785bc8c23641a88169c9cb1548f90fd4c7e563a48d31f633568b4a0d3545f0d80e98494931e163f985f
+  data.tar.gz: '08705073d9dc0f158e67c067a021e122527e69851f7d62ce08cb494b30cc681399ef9567a820a9dcea2a1fae79f66d970ed0c3709c500a7fdf9114fcbc99abdc'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omni_exchange (1.7.0)
+    omni_exchange (1.9.0)
       faraday (< 2)
       money (~> 6.13.1)
 
@@ -10,7 +10,7 @@ GEM
   specs:
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
     faraday (1.10.3)
@@ -36,7 +36,7 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     money (6.13.8)

data/lib/omni_exchange/providers/open_exchange_rates.rb

@@ -23,10 +23,7 @@ module OmniExchange
           req.params['symbols'] = target_currency
         end
 
-        exchange_rate = body['rates'][target_currency].to_d
-        currency_unit = get_currency_unit(base_currency).to_d
-
-        (exchange_rate * currency_unit).to_d
+        body['rates'][target_currency].to_d
       end
 
       def get_historic_rate(base_currency:, target_currencies:, date:)
@@ -37,10 +34,7 @@ module OmniExchange
           req.params['symbols'] = target_currencies.join(',')
         end
 
-        currency_unit = get_currency_unit(base_currency).to_d
-        body['rates'].transform_values do |rate|
-          (rate * currency_unit).to_d
-        end
+        body['rates']
       end
 
       private

data/lib/omni_exchange/providers/xe.rb

@@ -17,14 +17,12 @@ module OmniExchange
       #   rate will be used to calculate an convert an exchange of currencies. However, an exception will be raised
       #   if there is a timeout while connecting to xe.com or a timeout while reading xe.com's API.
       def get_exchange_rate(base_currency:, target_currency:)
-        currency_unit = get_currency_unit(base_currency)
-
         body = api_get do |req|
           req.url 'v1/convert_from.json'
 
           req.params['from'] = base_currency
           req.params['to'] = target_currency
-          req.params['amount'] = currency_unit
+          req.params['amount'] = 1
         end
 
         body[:to][0][:mid].to_d
@@ -38,14 +36,12 @@ module OmniExchange
       #                                   exchanging to. ie. ["EUR", "KRW"]
       # @param date: [Date] the date for which you want the historic exchange rate.
       def get_historic_rate(base_currency:, target_currencies:, date:)
-        currency_unit = get_currency_unit(base_currency)
-
         body = api_get do |req|
           req.url 'v1/historic_rate.json'
 
           req.params['from'] = base_currency
           req.params['to'] = target_currencies.join(',')
-          req.params['amount'] = currency_unit
+          req.params['amount'] = 1
           req.params['date'] = date.strftime('%Y-%m-%d')
         end
 

data/lib/omni_exchange/version.rb

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

data/lib/omni_exchange.rb

@@ -98,5 +98,74 @@ module OmniExchange
     raise OmniExchange::HttpError, "Failed to load #{base_currency}->#{target_currency}:\n" \
                                    "#{error_messages.join("\n")}"
   end
+
+  # returns the latest foreign exchange rate from the base currency to the target currency.
+  #
+  # @param base_currency: [String] the ISO Currency Code of the currency that you're exchanging from.
+  #  ie. "USD", "JPY"
+  # @param target_currency: [String] the ISO Currency Code of the currency that you're exchanging to.
+  #  ie. "EUR", "KRW"
+  # @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 [BigDecimal] an exchange rate is returned as a BigDecimal for precise calculation since this exchange
+  #   rate will be used to calculate an convert an exchange of currencies.
+  def get_exchange_rate(base_currency:, target_currency:, providers:)
+    provider_classes = providers.map { |p| OmniExchange::Provider.load_provider(p) }
+
+    error_messages = []
+
+    provider_classes.each do |klass|
+      rate = klass.get_exchange_rate(base_currency: base_currency,
+                                     target_currency: target_currency)
+
+      return {
+        rate: rate,
+        provider: OmniExchange::Provider.all.key(klass)
+      }
+
+    rescue *EXCEPTIONS, OmniExchange::XeMonthlyLimit, JSON::ParserError => e
+      error_messages << e.inspect
+    end
+
+    raise OmniExchange::HttpError, "Failed to get exchange rate:\n" \
+                                   "#{error_messages.join("\n")}"
+  end
+
+  # returns the historic exchange rate from the base currency to the target currency at a certain date.
+  #
+  # @param base_currency: [String] the ISO Currency Code of the currency that you're exchanging from.
+  #  ie. "USD", "JPY"
+  # @param target_currency: [String] the ISO Currency Code of the currency that you're exchanging to.
+  #  ie. "EUR", "KRW"
+  # @param date: [Date] the specific date you want a historic exchange rate for.
+  # ie. Date.new(2018, 12, 25)
+  # @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]: A hash containing the exchange rates.
+  def get_historic_rate(base_currency:, target_currencies:, date:, providers:)
+    provider_classes = providers.map { |p| OmniExchange::Provider.load_provider(p) }
+
+    error_messages = []
+
+    provider_classes.each do |klass|
+      rates = klass.get_historic_rate(base_currency: base_currency,
+                                      target_currencies: target_currencies,
+                                      date: date)
+
+      return {
+        rates: rates,
+        provider: OmniExchange::Provider.all.key(klass)
+      }
+
+    rescue *EXCEPTIONS, OmniExchange::XeMonthlyLimit, JSON::ParserError => e
+      error_messages << e.inspect
+    end
+
+    raise OmniExchange::HttpError, "Failed to get historic rate:\n" \
+                                   "#{error_messages.join("\n")}"
+  end
 end
 # rubocop:enable Lint/Syntax

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omni_exchange
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: OmniExchange converts currencies using up-to-the-minute foreign exchange