omni_exchange 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e498fc09556edce13c2f54ef7de9451e38546eaae859a38b2c0378d9011d8c2b
-  data.tar.gz: 8ef08385d9b929689e825ed4ac9b1f19756105e0f4d393279fe8e7482d85a281
+  metadata.gz: bf795bf43c3ede8973124f10ff3afa6190a4c6af4705ecc481bf2a1112477f33
+  data.tar.gz: 4b8fc48b43b3cbcb9e118d8e1ee5238c71c9ddfceca7aa1cf1034a78fa693691
 SHA512:
-  metadata.gz: a2dd2e4413a7c0f061d70f605d55395d924e48341a6f44b292c997ce58b6264d090d90d605fc4304e5afd36981797c4c49965684154c3a7b8b9719d4cb89dcc5
-  data.tar.gz: '048bb4224fd6c1b61d6ef89daa5eb2a38fc3527b9428c892e11786bf621205be39795b7876cf5b1832faa2811b733a5fca0dc45a01e77f2240bbe7fd914adf8b'
+  metadata.gz: a42a179b5435a78d4aacd65c04e4c26223c1115c53b3160963ace5c8175dce8252a1ae7fc2272e758d16c0264c99294ac3a84763f0fa1f4cf5a51d08746327c3
+  data.tar.gz: 58186c5c5697ef71566e41ad717b4c76362e2650edc1bd72da11ff0964bc76e7e5936f656969b58e37f69f6f34e640c1f09cba2041eeeb25a73ad27fae037ef3

data/.gitignore

@@ -14,9 +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
+*.gem

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    omni_exchange (1.3.0)
-      faraday (= 0.17.4)
+    omni_exchange (1.6.0)
+      faraday (< 2)
       money (~> 6.13.1)
 
 GEM
@@ -12,17 +12,38 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    dotenv (2.7.6)
-    faraday (0.17.4)
-      multipart-post (>= 1.2, < 3)
-    i18n (1.10.0)
+    dotenv (2.8.1)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     money (6.13.8)
       i18n (>= 0.6.4, <= 2)
     multipart-post (2.2.3)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -53,14 +74,16 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     unicode-display_width (1.8.0)
     vcr (6.1.0)
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   dotenv

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.3.0'
+  VERSION = '1.6.0'
 end

data/lib/omni_exchange.rb

@@ -34,7 +34,7 @@ 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, 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 +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

data/omni_exchange.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '0.17.4'
+  spec.add_dependency 'faraday', '< 2'
   spec.add_dependency 'money', '~> 6.13.1'
 
   spec.add_development_dependency 'dotenv'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: omni_exchange
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.17.4
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.17.4
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: money
   requirement: !ruby/object:Gem::Requirement