ecb_exchange_rates_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb5c9800e1d65a7b7d83ec1d75ef044ee75a236ef44ac79a2234deeca7f8f67
-  data.tar.gz: 29e3c2959768e8fed2a5d8c0e54cb8444b59c0d9f5392d70bc93c3b2114f5787
+  metadata.gz: cd746f263ae1db257c0ea6ef795be4461128902969eede9dbb3a700a662e6770
+  data.tar.gz: 745564a9cde6f767458d347abb4cb4d4b6e2a9d51241c195c97a6288cb778808
 SHA512:
-  metadata.gz: 3adbc5cc561c3c56f3ace910af8e1383726b568a1088c0d12f9993b57bf418bcfb6211a5b4416a17947c5bc9fd939d9ddd4123e87610b30c4ca436078c7f1032
-  data.tar.gz: dc05cf1e7b8882efc8fd503686cd5f51a8eec450c28f01924a389679575196cc52e29b0df102fe6bddae77f47ec78deeed55ecdda8a3fab6d10f72e6d02ede91
+  metadata.gz: f7175a63d08cc539fc69313b5dc64b608b8091b4862112ea899f45d74f7e414be34a0b843bc7dbc690d05ed3bd4eaee9cb5c75fa7fa23eeb594c88c707dc4bb8
+  data.tar.gz: 5e140841b9363eede405c3e694b5ea933a2afad36a5b661f9f592512603b2665e234d355074468e668675c07acfffd4545318bcc1776723800a32659b2abf191

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable
 
 Metrics/BlockLength:
   Exclude:

data/Gemfile.lock

@@ -1,29 +1,30 @@
 PATH
   remote: .
   specs:
-    ecb_exchange_rates_api (0.1.1)
-      activesupport
-      httparty
+    ecb_exchange_rates_api (0.1.3)
+      activesupport (~> 6.1.1)
+      httparty (~> 0.18.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    ffi (1.11.3)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    ffi (1.14.2)
     formatador (0.2.5)
-    guard (2.16.1)
+    guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -37,82 +38,86 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (1.0.0)
-    httparty (0.17.3)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.1)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    listen (3.2.1)
+    listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.1.1)
-    method_source (0.9.2)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    minitest (5.13.0)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.3)
     multi_xml (0.6.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rb-fsevent (0.10.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.9.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     shellany (0.0.1)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    vcr (5.0.0)
-    webmock (3.7.6)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    vcr (6.0.0)
+    webmock (3.11.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   ecb_exchange_rates_api!
-  guard-rspec
-  rspec
-  rubocop
-  vcr
-  webmock
+  guard-rspec (~> 4.7.3)
+  rspec (>= 2.99.0)
+  rubocop (~> 1.9.1)
+  vcr (~> 6.0.0)
+  webmock (~> 3.11.2)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/Guardfile

@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'

data/README.md

@@ -29,8 +29,8 @@ Since the CurrencyExchangeAPI does not require API keys or authentication in ord
 Fetch the latest exchange rates from the European Central Bank:
 
 ```ruby
-query = ECBExchangeRatesApi::Client.new 
-query.fetch
+client = ECBExchangeRatesApi::Client.new 
+client.fetch
 ```
 
 ### Historical data:
@@ -38,13 +38,13 @@ query.fetch
 Get historical rates for any day since 1999:
 
 ```ruby
-query.at("2010-09-21").fetch
+client.at("2010-09-21").fetch
 ```
 
 or specify some date range:
 
 ```ruby
-query.from("2010-09-21").to("2010-10-21").fetch
+client.from("2010-09-21").to("2010-10-21").fetch
 ```
 
 ### Set the base currency:
@@ -52,16 +52,31 @@ query.from("2010-09-21").to("2010-10-21").fetch
 By default, the base currency is set to Euro (EUR), but it can be changed:
 
 ```ruby
-query.with_base("USD").fetch
+client.with_base("USD").fetch
 ```
 
 currency code should be passed as an ISO 4217 code.
 
 ### Fetch specific rates:
-If you do not want all current rates, it's possible to specify only the currencies you want using `for_rate(symbol)` or `for_rates(array_of_symbols)`. The following code fetches only the exchange rate between GBP and EUR:
+If you do not want all current rates, it's possible to specify only the currencies you want using with `for_rate(symbol)` or `for_rates(array_of_symbols)`. The following code fetches only the exchange rate between GBP and EUR:
 
 ```ruby
-query.with_base("GBP").for_rate("EUR").fetch
+client.with_base("GBP").for_rate("EUR").fetch
+```
+
+### Convert
+
+It is useful not just to check the exchange rates but also to calculate the amount of money for them. This is the case where the `convert` method comes into play. You can specify options with the method arguments `convert(amount, base, symbols, specific_data)` or use the preconfigured client as follow:
+
+```ruby
+client.convert(100, "USD", %w(EUR SEK), "2018-02-01")
+#or
+base_client = ECBExchangeRatesApi::Client.new do |c|
+  c.with_base "USD"
+  c.for_rates %w(EUR SEK)
+  c.at "2018-02-01"
+end
+base_client.convert(100)
 ```
 
 Please refer to the [API website](https://exchangeratesapi.io/) for further information and full API docs.

data/ecb_exchange_rates_api.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.homepage      = "https://github.com/overchind/ECBExchangeRatesApi"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.1")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -31,12 +31,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "httparty"
+  spec.add_dependency "activesupport", "~> 6.1.1"
+  spec.add_dependency "httparty", "~> 0.18.1"
 
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_development_dependency "rspec", "~> 3.10.1"
+  spec.add_development_dependency "rubocop", "~> 1.9.1"
+  spec.add_development_dependency "vcr", "~> 6.0.0"
+  spec.add_development_dependency "webmock", "~> 3.11.2"
 end

data/lib/ecb_exchange_rates_api/client.rb

@@ -25,7 +25,7 @@ module ECBExchangeRatesApi
 
     def fetch
       response = self.class.get(path, query: options.to_params)
-      ECBExchangeRatesApi::Result.new(response.parsed_response, status: response.code)
+      create_result(response.parsed_response, response.code)
     end
 
     def from(date)
@@ -58,6 +58,17 @@ module ECBExchangeRatesApi
       self
     end
 
+    def convert(amount, base_code = nil, codes = nil, date = nil)
+      response = self.class.new do |client|
+        client.with_base presented_base(base_code)
+        client.for_rates presented_symbols(codes)
+        client.at presented_date(date)
+      end.fetch
+
+      response.rates.transform_values! { |v| v * amount }
+      response
+    end
+
     def currency_is_supported?(code)
       supported_currency?(validated_currency_code(code))
     end
@@ -77,5 +88,21 @@ module ECBExchangeRatesApi
 
       "/latest"
     end
+
+    def create_result(response, status)
+      ECBExchangeRatesApi::Result.new(response, status: status)
+    end
+
+    def presented_base(base_from_params)
+      base_from_params || base || default_base
+    end
+
+    def presented_symbols(codes)
+      (codes && Array.wrap(codes)) || symbols || []
+    end
+
+    def presented_date(date)
+      date || specific_date || current_date
+    end
   end
 end

data/lib/ecb_exchange_rates_api/constants.rb

@@ -2,6 +2,7 @@
 
 module ECBExchangeRatesApi
   module Constants
+    DEFAULT_BASE = "EUR"
     CURRENCIES = %w[USD GBP EUR JPY BGN CZK DKK HUF PLN RON
                     SEK CHF ISK NOK HRK RUB TRY AUD BRL CAD
                     CNY HKD IDR ILS INR KRW MXN MYR NZD PHP

data/lib/ecb_exchange_rates_api/options.rb

@@ -8,6 +8,7 @@ module ECBExchangeRatesApi
     include SharedMethods
 
     attr_reader :start_at, :end_at, :specific_date, :base, :symbols
+
     date_attr_writer :start_at, :end_at, :specific_date
     code_attr_writer :base
 
@@ -31,7 +32,7 @@ module ECBExchangeRatesApi
 
     def options_params
       instance_variables.each_with_object({}) do |var, hash|
-        key = var.to_s[1..-1].to_sym
+        key = var.to_s[1..].to_sym
         variable = instance_variable_get(var)
         value = key == :symbols ? variable&.join(",") : variable
         hash[key] = value

data/lib/ecb_exchange_rates_api/shared_methods.rb

@@ -15,6 +15,14 @@ module ECBExchangeRatesApi
 
     private
 
+    def default_base
+      ECBExchangeRatesApi::Constants::DEFAULT_BASE
+    end
+
+    def current_date
+      represent_date(Time.now)
+    end
+
     def represent_date(date)
       return date.strftime("%Y-%m-%d") if time_or_date_instance?(date)
 

data/lib/ecb_exchange_rates_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ECBExchangeRatesApi
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: ecb_exchange_rates_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Roman Ovcharov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.1
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.2
 description: |2
       This is an unofficial wrapper for the awesome, free ExchangeRatesAPI,
       which provides exchange rate lookups courtesy of the Central European Bank."
@@ -153,15 +153,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Client library for ExchangeRates API