omni_exchange 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e96486f0fec5e014b79827ca801fc70c717ad3f3c36a333fc2d1248ea7b3f6
-  data.tar.gz: f52a460e18ad19a5cfeefe507dbce77563faf8e81ad5c2b23701fa7fec058190
+  metadata.gz: c10147e9b33c5288fe9d59249c2d51ff23e5fbf2be87f352fa59e6244b2949f8
+  data.tar.gz: beff303239c412ff7e4d2691319be4fce1cf7c1424d2589397900f5c45184c21
 SHA512:
-  metadata.gz: e948110df897320119664e7dadd069a9b32a74c9f683f21d9af48c4166eda64dfd6494fee2719c11c670088b91276de8f8659e7248aa324297219981ae18865f
-  data.tar.gz: 218e427ae203f24f0eeb4e74235b63fadaf47638061d6735f52d854b9413d5bfbcb08d5e541365cfcdeb9e4dfc481b2aedba145f6bfcf1f69b4a880a0e1451e9
+  metadata.gz: cdb12eb02901081566e65046c780f02eea5691689b9d4fd7fa646f6acee57686d2eab1138a0c289ae893930076ba099235ed46fb3e1a95ca64815122502c8ee5
+  data.tar.gz: c049ff4bc1946d7c87018f308beb7cffca268bae4601c3796447c22acef34118e5e50cb5aa004b012e690e15714c0b10342b0226bafb6c6a3a51d53266dd2365

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omni_exchange (1.7.0)
+    omni_exchange (1.8.0)
       faraday (< 2)
       money (~> 6.13.1)
 

data/lib/omni_exchange/version.rb

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

data/lib/omni_exchange.rb

@@ -98,5 +98,64 @@ 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|
+      return klass.get_exchange_rate(base_currency: base_currency,
+                                     target_currency: target_currency)
+
+    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
+
+  # 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|
+      return klass.get_historic_rate(base_currency: base_currency,
+                                    target_currencies: target_currencies,
+                                    date: date)
+
+    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.8.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday