omni_exchange 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c591dfb40110a465f93f0c714d6f26369ba9717592a8deb4da4f92e044a4f660
-  data.tar.gz: 91f086e1912b69998b55d6e76030dfdc8738388071c0405084fc6d8e8fa6174a
+  metadata.gz: a9e96486f0fec5e014b79827ca801fc70c717ad3f3c36a333fc2d1248ea7b3f6
+  data.tar.gz: f52a460e18ad19a5cfeefe507dbce77563faf8e81ad5c2b23701fa7fec058190
 SHA512:
-  metadata.gz: 813ec7f4ce3f0d18360a39cd864c39fcb62bb1dbacc36a4b089b7d970d32b9bfa6c334fd6d11921f99dcc0d4b48ec7e5a45fd169b11ae6e852969e0f6d768ee3
-  data.tar.gz: 75904791e0aaff4d160b5d11424c50ddfbd32450a5e0d52da2e4a246e5dde5aba81efe23f1bb9ed0ab656d4399eb3d48106f68c790c660fa50d76258265e3d55
+  metadata.gz: e948110df897320119664e7dadd069a9b32a74c9f683f21d9af48c4166eda64dfd6494fee2719c11c670088b91276de8f8659e7248aa324297219981ae18865f
+  data.tar.gz: 218e427ae203f24f0eeb4e74235b63fadaf47638061d6735f52d854b9413d5bfbcb08d5e541365cfcdeb9e4dfc481b2aedba145f6bfcf1f69b4a880a0e1451e9

data/.gitignore

@@ -14,11 +14,4 @@
 .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
-omni_exchange-1.4.0.gem
-omni_exchange-1.5.0.gem
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omni_exchange (1.4.0)
+    omni_exchange (1.7.0)
       faraday (< 2)
       money (~> 6.13.1)
 
@@ -13,7 +13,7 @@ GEM
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    faraday (1.10.1)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -41,7 +41,7 @@ GEM
     method_source (1.0.0)
     money (6.13.8)
       i18n (>= 0.6.4, <= 2)
-    multipart-post (2.2.3)
+    multipart-post (2.3.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -49,7 +49,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
-    rake (10.5.0)
+    rake (12.3.3)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -89,7 +89,7 @@ DEPENDENCIES
   dotenv
   omni_exchange!
   pry
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
   rubocop (~> 0.80)
   vcr

data/README.md

@@ -57,7 +57,8 @@ 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: (Symbol) the provider that supplied the exchange_rate (ie. :open_exchange_rates, :xe)
+3. non_subunit_fx_rate: (BigDecimal) an exchange rate that can be used to convert a formatted version of the base currency (ie. 100 USD being formatted as 1.00)
+4. 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 +68,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=>:open_exchange_rates }
+puts USD_to_JPY # => { :converted_amount=>0.13566633333e3, :exchange_rate=>0.13566633333e1, :non_subunit_fx_rate=>0.13566633333e3, :provider=>:open_exchange_rates }
 
 puts USD_to_JPY[:converted_amount] # => 0.13566633333e3
 puts USD_to_JPY[:converted_amount].to_f # => 135.66633333
@@ -75,6 +76,10 @@ puts USD_to_JPY[:converted_amount].to_f # => 135.66633333
 puts USD_to_JPY[:exchange_rate] # => 0.13566633333e1
 puts USD_to_JPY[:exchange_rate].to_f # => 1.3566633333
 
+# :fx_rate can be used when 100 USD is written as 1.00 instead of 100. In other words, you can do 1.00 * USD_to_JPY[:non_subunit_fx_rate] and get 135.66633333
+puts USD_to_JPY[:non_subunit_fx_rate] # => 0.13566633333e3
+puts USD_to_JPY[:non_subunit_fx_rate].to_f # => 135.66633333
+
 ```
 
 ## Development

data/lib/omni_exchange/provider.rb

@@ -36,7 +36,7 @@ module OmniExchange
 
     # Each provider class should inherit from Provider and have a .get_exchange_rates method. If a provider class
     #   doesn't have a .get_exchange_rates method, the method below will be called and an error will be raised.
-    def self.get_exchange_rate
+    def self.get_exchange_rate(base_currency:, target_currency:) # rubocop:disable Lint/UnusedMethodArgument
       raise 'method not implemented...'
     end
 

data/lib/omni_exchange/providers/open_exchange_rates.rb

@@ -4,42 +4,67 @@ require 'omni_exchange'
 
 module OmniExchange
   class OpenExchangeRates < Provider
-    ENDPOINT_URL = 'https://openexchangerates.org/api/latest.json'
-
-    # This method returns the exchange rate, the rate at which the smallest unit of one currency (the base currency)
-    #   will be exchanged for another currency (the target currency), from Open Exchange Rate's API.
-    #   This method is called in the OmniExchange.exchange_currency method.
-    #
-    # @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"
-    # @ 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. However, an exception will be raised
-    #   if there is a timeout while connecting to xe.com or a timeout while reading Open Exchange Rate's API.
-    def self.get_exchange_rate(base_currency:, target_currency:)
-      config = OmniExchange.configuration.provider_config[:open_exchange_rates]
-      app_id = config[:app_id]
-
-      api = Faraday.new(OmniExchange::OpenExchangeRates::ENDPOINT_URL)
-
-      begin
-        response = api.get do |req|
-          req.url "?app_id=#{app_id}&base=#{base_currency}"
-          req.options.timeout = config[:read_timeout] || OmniExchange::Configuration::DEFAULT_READ_TIMEOUT
-          req.options.open_timeout = config[:connect_timeout] || OmniExchange::Configuration::DEFAULT_CONNECTION_TIMEOUT
+    ENDPOINT_URL = 'https://openexchangerates.org/api/'
+
+    class << self
+      # This method returns the exchange rate, the rate at which the smallest unit of one currency (the base currency)
+      #   will be exchanged for another currency (the target currency), from Open Exchange Rate's API.
+      #   This method is called in the OmniExchange.exchange_currency method.
+      #
+      # @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"
+      # @ 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. However, an exception will be raised
+      #   if there is a timeout while connecting to xe.com or a timeout while reading Open Exchange Rate's API.
+      def get_exchange_rate(base_currency:, target_currency:)
+        body = api_get do |req|
+          req.url 'latest.json'
+          req.params['base'] = base_currency
+          req.params['symbols'] = target_currency
         end
-      rescue *EXCEPTIONS => e
-        raise e.class, 'Open Exchange Rates has timed out.'
+
+        exchange_rate = body['rates'][target_currency].to_d
+        currency_unit = get_currency_unit(base_currency).to_d
+
+        (exchange_rate * currency_unit).to_d
       end
 
-      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'
+      def get_historic_rate(base_currency:, target_currencies:, date:)
+        body = api_get do |req|
+          req.url "historical/#{date.strftime('%Y-%m-%d')}.json"
+
+          req.params['base'] = base_currency
+          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
       end
 
-      currency_unit = get_currency_unit(base_currency).to_d
+      private
+
+      def api_get(&blk)
+        api = Faraday.new(OmniExchange::OpenExchangeRates::ENDPOINT_URL)
 
-      (exchange_rate * currency_unit).to_d
+        response = api.get do |req|
+          blk.call(req)
+
+          req.params['app_id'] = config[:app_id]
+
+          req.options.timeout = config[:read_timeout] ||
+                                OmniExchange::Configuration::DEFAULT_READ_TIMEOUT
+          req.options.open_timeout = config[:connect_timeout] ||
+                                     OmniExchange::Configuration::DEFAULT_CONNECTION_TIMEOUT
+        end
+
+        JSON.parse(response.body)
+      end
+
+      def config
+        OmniExchange.configuration.provider_config[:open_exchange_rates]
+      end
     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

@@ -6,45 +6,89 @@ module OmniExchange
   class Xe < Provider
     ENDPOINT_URL = 'https://xecdapi.xe.com/'
 
-    # This method returns the exchange rate, the rate at which the smallest unit of one currency (the base currency)
-    #   will be exchanged for another currency (the target currency), from xe.com's API.
-    #   This method is called in the OmniExchange.exchange_currency method.
-    #
-    # @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"
-    # @ 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. 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 self.get_exchange_rate(base_currency:, target_currency:)
-      config = OmniExchange.configuration.provider_config[:xe]
-      api_id = config[:api_id]
-      api_key = config[:api_key]
-      currency_unit = get_currency_unit(base_currency)
-
-      api = Faraday.new(OmniExchange::Xe::ENDPOINT_URL) do |f|
-        f.request :basic_auth, api_id, api_key
-        f.adapter :net_http
+    class << self
+      # This method returns the exchange rate, the rate at which the smallest unit of one currency (the base currency)
+      #   will be exchanged for another currency (the target currency), from xe.com's API.
+      #   This method is called in the OmniExchange.exchange_currency method.
+      #
+      # @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"
+      # @ 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. 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
+        end
+
+        body[:to][0][:mid].to_d
       end
 
-      begin
-        response = api.get do |req|
-          req.url "v1/convert_from.json/?from=#{base_currency}&to=#{target_currency}&amount=#{currency_unit}"
-          req.options.timeout = config[:read_timeout] || OmniExchange::Configuration::DEFAULT_READ_TIMEOUT
-          req.options.open_timeout = config[:connect_timeout] || OmniExchange::Configuration::DEFAULT_CONNECTION_TIMEOUT
+      # This method returns the historic exchange rate for multiple currencies for a given date.
+      #
+      # @param base_currency: [String] the ISO Currency Code of the currency that you're exchanging from.
+      #                                ie. "USD", "JPY"
+      # @param target_currencies: [Array] an array of ISO Currency Codes of the currencies that you're
+      #                                   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['date'] = date.strftime('%Y-%m-%d')
+        end
+
+        rates = {}
+        body[:to].each do |rate|
+          rates[rate[:quotecurrency]] = rate[:mid].to_d
         end
-      rescue *EXCEPTIONS => e
-        raise e.class, 'xe.com has timed out.'
+
+        rates
       end
 
-      begin
+      private
+
+      def api_get(&blk)
+        response = api.get do |req|
+          blk.call(req)
+
+          req.options.timeout = config[:read_timeout] ||
+                                OmniExchange::Configuration::DEFAULT_READ_TIMEOUT
+          req.options.open_timeout = config[:connect_timeout] ||
+                                     OmniExchange::Configuration::DEFAULT_CONNECTION_TIMEOUT
+        end
+
         body = JSON.parse(response.body, symbolize_names: true)
-      rescue JSON::ParserError => e
-        raise e.class, 'JSON::ParserError in OmniExchange::Xe'
+
+        raise OmniExchange::XeMonthlyLimit, 'Xe.com monthly limit has been exceeded' if body[:code] == 3
+
+        body
       end
 
-      raise OmniExchange::XeMonthlyLimit, 'Xe.com monthly limit has been exceeded' if body[:code] == 3
+      def api
+        api_id = config[:api_id]
+        api_key = config[:api_key]
 
-      body[:to][0][:mid].to_d
+        Faraday.new(OmniExchange::Xe::ENDPOINT_URL) do |f|
+          f.request :basic_auth, api_id, api_key
+          f.adapter :net_http
+        end
+      end
+
+      def config
+        OmniExchange.configuration.provider_config[:xe]
+      end
     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.5.0'
+  VERSION = '1.7.0'
 end

data/lib/omni_exchange.rb

@@ -34,7 +34,16 @@ module OmniExchange
   end
 
   # if a provider raises one of these exceptions, OmniExchange will gracefully attempt to use another provider
-  EXCEPTIONS = [Faraday::Error, Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::SSLError, Net::OpenTimeout, Net::WriteTimeout, Net::ReadTimeout, OpenSSL::SSL::SSLError]
+  EXCEPTIONS = [
+    Faraday::Error,
+    Faraday::ConnectionFailed,
+    Faraday::TimeoutError,
+    Faraday::SSLError,
+    Net::OpenTimeout,
+    Net::WriteTimeout,
+    Net::ReadTimeout,
+    OpenSSL::SSL::SSLError
+  ]
 
   module_function
 
@@ -53,6 +62,7 @@ module OmniExchange
   #   * :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
+  #   * :non_subunit_fx_rate [BigDecimal] a rate that can be used when a currency with subunits is not in cents . ie. 0.95211e3
   #   * :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.
@@ -71,15 +81,22 @@ module OmniExchange
     # Gracefully hit each provider and fail-over to the next one
     provider_classes.each do |klass|
       rate = klass.get_exchange_rate(base_currency: base_currency, target_currency: target_currency)
+      plain_format_rate = (rate * Money::Currency.wrap(base_currency).subunit_to_unit).to_d
 
       exchanged_amount = rate.to_d * amount.to_d
 
-      return { converted_amount: exchanged_amount, exchange_rate: rate, provider: OmniExchange::Provider.all.key(klass) }
+      return {
+        converted_amount: exchanged_amount,
+        exchange_rate: rate,
+        non_subunit_fx_rate: plain_format_rate,
+        provider: OmniExchange::Provider.all.key(klass)
+      }
     rescue *EXCEPTIONS, OmniExchange::XeMonthlyLimit, JSON::ParserError => e
       error_messages << e.inspect
     end
-    
-    raise OmniExchange::HttpError, "Failed to load #{base_currency}->#{target_currency}:\n#{error_messages.join("\n")}"
+
+    raise OmniExchange::HttpError, "Failed to load #{base_currency}->#{target_currency}:\n" \
+                                   "#{error_messages.join("\n")}"
   end
 end
 # rubocop:enable Lint/Syntax

data/omni_exchange.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.80'
   spec.add_development_dependency 'vcr'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omni_exchange
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: OmniExchange converts currencies using up-to-the-minute foreign exchange