omni_exchange 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d30d7e4e3e64ec5ad04a09977b9320fc3fa057b6467522f69e13f8b7449086d
-  data.tar.gz: ebfc182f603c08030550a23be4348f6126cfaa83cced86bd4af73fe7d2f485df
+  metadata.gz: f688c61226d02342f3c6e2730982b059d46cf6033fa61f822477d332bf21fc6b
+  data.tar.gz: 19d3020b4d6146634d6931e8ac72247e5d17072156bca230a75307c398b26c4c
 SHA512:
-  metadata.gz: 94df50122f3b0f827111c2b8ea5af33fafc4ef3c3202a80b1d8de0170113283f2bcbb2f8216de175bb2e3bb584231e68b5be3687be4185fb3faac73748dd7658
-  data.tar.gz: e2aaa25ab94143cf25fb3b86ee659df937f75f197e0d48c06d0bb561dd732d7d6eff79ada826dad10accb17589900a1cb74190a7167fb3a931f8ccc39f041e6a
+  metadata.gz: 44b9222aa670f9495d713b62b3a01115388c68e820cd24d699beab5b8df9a80a084a3f3613f9edac17c2e0e4e5fa642cd0bab6b466b87b56e25ee8b6ae88387e
+  data.tar.gz: 704c9d03570dec02e8115bf224a354e1bcea4a85574167b826cbb33b9d7dccce7c88c404d18d76d58291b4c74709624f6cd888353e05ca0b12e86c2dac6709b6

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-06-20 08:25:31 UTC using RuboCop version 0.93.1.
+# on 2022-06-24 08:14:59 UTC using RuboCop version 0.93.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,7 +9,7 @@
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 27
+  Max: 28
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
@@ -32,14 +32,22 @@ Style/Documentation:
     - 'lib/omni_exchange/providers/open_exchange_rates.rb'
     - 'lib/omni_exchange/providers/xe.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: scientific, engineering, integral
 Style/ExponentialNotation:
   Exclude:
     - 'spec/omni_exchange_spec.rb'
 
-# Offense count: 13
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/sandbox.rb'
+
+# Offense count: 16
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    omni_exchange (0.1.0)
-      faraday
+    omni_exchange (0.2.0)
+      faraday (= 0.17.4)
 
 GEM
   remote: https://rubygems.org/
@@ -11,11 +11,10 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.0)
     dotenv (2.7.6)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+    faraday (0.17.4)
+      multipart-post (>= 1.2, < 3)
     method_source (1.0.0)
+    multipart-post (2.2.3)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -51,7 +50,6 @@ GEM
     rubocop-ast (1.18.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)
 

data/README.md

@@ -1,6 +1,8 @@
 # OmniExchange
 
-OmniExchange converts currencies using up-to-the-minute foreign exchange rates data.
+OmniExchange converts currencies using up-to-the-minute foreign exchange rates.
+
+OmniExchange also supports fail-over logic and handles timeouts. In other words, if currency conversion isn't possible because an API data source cannot provide an exchange rate, OR if that data source times out, OmniExchange will retrieve exchange rate data from another API data source.
 
 ## Installation
 
@@ -73,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omni_exchange. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/omni_exchange/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/degica/omni_exchange. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/degica/omni_exchange/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -81,4 +83,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the OmniExchange project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/omni_exchange/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the OmniExchange project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/degica/omni_exchange/blob/master/CODE_OF_CONDUCT.md).

data/lib/omni_exchange/providers/open_exchange_rates.rb

@@ -19,9 +19,7 @@ module OmniExchange
       config = OmniExchange.configuration.provider_config[:open_exchange_rates]
       app_id = config[:app_id]
 
-      api = Faraday.new(ENDPOINT_URL) do |conn|
-        conn.response :json, parser_options: { symbolize_names: true }
-      end
+      api = Faraday.new(OmniExchange::OpenExchangeRates::ENDPOINT_URL)
 
       begin
         response = api.get do |req|
@@ -32,7 +30,8 @@ module OmniExchange
       rescue Faraday::Error, Faraday::ConnectionFailed => e
         raise e.class, 'Open Exchange Rates has timed out.'
       end
-      exchange_rate = response.body[:rates][target_currency.to_sym].to_d
+
+      exchange_rate = JSON.parse(response.body, symbolize_names: true)[:rates][target_currency.to_sym].to_d
 
       currency_unit = get_currency_unit(base_currency)
 

data/lib/omni_exchange/providers/xe.rb

@@ -21,9 +21,9 @@ module OmniExchange
       api_key = config[:api_key]
       currency_unit = get_currency_unit(base_currency)
 
-      api = Faraday.new(ENDPOINT_URL) do |conn|
-        conn.request :authorization, :basic, api_id, api_key
-        conn.response :json, parser_options: { symbolize_names: true }
+      api = Faraday.new(OmniExchange::Xe::ENDPOINT_URL) do |f|
+        f.request :basic_auth, api_id, api_key
+        f.adapter :net_http
       end
 
       begin
@@ -36,7 +36,7 @@ module OmniExchange
         raise e.class, 'xe.com has timed out.'
       end
 
-      response.body[:to][0][:mid].to_d
+      JSON.parse(response.body, symbolize_names: true)[:to][0][:mid].to_d
     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 = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/omni_exchange.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# requires all of the provider files in the providers folder
-#   which then allows the providers to be registered
-Dir['omni_exchange/providers/*.rb'].each do |file|
-  require_relative file
-end
+require 'omni_exchange/provider'
+# in order to make sure that all API data providers are registered correctly,
+#   all of the provider files in the providers folder must be required
+require 'omni_exchange/providers/open_exchange_rates'
+require 'omni_exchange/providers/xe'
 require 'omni_exchange/version'
 require 'omni_exchange/configuration'
 require 'faraday'
@@ -54,7 +54,7 @@ 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)
-      
+    
       return rate * amount.to_d
     rescue Faraday::Error, Faraday::ConnectionFailed => e
       error_messages << e.inspect
@@ -62,5 +62,35 @@ module OmniExchange
     
     raise "Failed to load #{base_currency}->#{target_currency}:\n#{exception_messages.join("\n")}"
   end
+
+  # 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 API providers 
+  #
+  # @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] the amount of the base currency exchanged to the target currency using an exchange rate
+  #   provided by one of the data providers in the providers hash. The final amount is returned as a BigDecimal
+  #   for precise calculation. If all of the providers in the providers hash fail to retrieve data,
+  #   an exception is raised.
+  def get_exchange_rate(base_currency:, target_currency:, providers:)
+    error_messages = []
+
+    # Make sure all providers passed exist. If not, a LoadError is raise and not rescued
+    provider_classes = providers.map { |p| OmniExchange::Provider.load_provider(p) }
+
+    # 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)
+    
+      return rate
+    rescue Faraday::Error, Faraday::ConnectionFailed => e
+      error_messages << e.inspect
+    end
+    
+    raise "Failed to load #{base_currency}->#{target_currency}:\n#{exception_messages.join("\n")}"
+  end
 end
 # rubocop:enable Lint/Syntax

data/omni_exchange.gemspec

@@ -8,17 +8,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Yun Chung']
   spec.email         = ['yunseok_chung@degica.com']
 
-  spec.summary       = 'Write a short summary, because RubyGems requires one.'
-  spec.description   = 'Write a longer description or delete this line.'
+  spec.summary       = 'OmniExchange converts currencies using up-to-the-minute foreign exchange rates.'
+  spec.description   = 'OmniExchange converts currencies using up-to-the-minute foreign exchange rates.'
   spec.homepage      = 'https://degica.com'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://degica.com'
-  spec.metadata['changelog_uri'] = 'https://degica.com'
+  spec.metadata['homepage_uri'] = 'https://degica.com'
+  spec.metadata['source_code_uri'] = 'https://github.com/degica/omni_exchange'
+  spec.metadata['changelog_uri'] = 'https://github.com/degica/omni_exchange'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
@@ -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'
+  spec.add_dependency 'faraday', '0.17.4'
 
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'pry'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: omni_exchange
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yun Chung
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.4
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a longer description or delete this line.
+description: OmniExchange converts currencies using up-to-the-minute foreign exchange
+  rates.
 email:
 - yunseok_chung@degica.com
 executables: []
@@ -143,8 +144,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://degica.com
-  source_code_uri: https://degica.com
-  changelog_uri: https://degica.com
+  source_code_uri: https://github.com/degica/omni_exchange
+  changelog_uri: https://github.com/degica/omni_exchange
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -160,8 +161,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: OmniExchange converts currencies using up-to-the-minute foreign exchange
+  rates.
 test_files: []