omni_exchange 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c591dfb40110a465f93f0c714d6f26369ba9717592a8deb4da4f92e044a4f660
-  data.tar.gz: 91f086e1912b69998b55d6e76030dfdc8738388071c0405084fc6d8e8fa6174a
+  metadata.gz: bf795bf43c3ede8973124f10ff3afa6190a4c6af4705ecc481bf2a1112477f33
+  data.tar.gz: 4b8fc48b43b3cbcb9e118d8e1ee5238c71c9ddfceca7aa1cf1034a78fa693691
 SHA512:
-  metadata.gz: 813ec7f4ce3f0d18360a39cd864c39fcb62bb1dbacc36a4b089b7d970d32b9bfa6c334fd6d11921f99dcc0d4b48ec7e5a45fd169b11ae6e852969e0f6d768ee3
-  data.tar.gz: 75904791e0aaff4d160b5d11424c50ddfbd32450a5e0d52da2e4a246e5dde5aba81efe23f1bb9ed0ab656d4399eb3d48106f68c790c660fa50d76258265e3d55
+  metadata.gz: a42a179b5435a78d4aacd65c04e4c26223c1115c53b3160963ace5c8175dce8252a1ae7fc2272e758d16c0264c99294ac3a84763f0fa1f4cf5a51d08746327c3
+  data.tar.gz: 58186c5c5697ef71566e41ad717b4c76362e2650edc1bd72da11ff0964bc76e7e5936f656969b58e37f69f6f34e640c1f09cba2041eeeb25a73ad27fae037ef3

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.6.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.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)

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/version.rb

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

data/lib/omni_exchange.rb

@@ -53,6 +53,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,10 +72,11 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omni_exchange
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday