forexrateapi 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09786c38fab46aa7cc8a8d4563d5d19557843ed5487ab87fced0467f08b367bd'
-  data.tar.gz: da6ec735343f79837df80ab761df8eebad9b380b798086dfbfa08ac25bb3bb0c
+  metadata.gz: 1b95736b9d870b217de0a86b67ba39d66e188e3f98c2fcbc14b26510751c99a0
+  data.tar.gz: e592a8251ac179ed60bb3341b074e1c3ecd8ef336804e3aea3b7f5a8143023d6
 SHA512:
-  metadata.gz: 5dd1698e4512b742a5a7fc68a66a62776d45af15c283fd0716f47c88a36eeca50b0761cb1aa5c29ce15b908f3b59ebbd4d3154504adef47693c88e095584fbf7
-  data.tar.gz: 6e77fd48b33cdb459d05a06b6a5b41eabe281128066317acd483e9e305af89302a91e84c0ff1e0847a837e3f19e1cd6c69c86511623df2883ff1ffed58caab31
+  metadata.gz: f168941bd8dc7f4c8dd9009968c34b4e5fd47c9c7a21336cc40c5630c605df7ef80a3e71864adc4b7a7f2993c4788be39b421418f2d577bc259ed99114e749a7
+  data.tar.gz: e3aa765aa0cb5ee99d4233768168198c267dee0d46dbbfa718e98fc4aa423193da665537b36ae72977296416d4c8f48d5056bfb141139e36bfc27e65c5456ead

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ForexRateAPI
+Copyright (c) 2025 ForexRateAPI
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,6 @@
 # ForexRateAPI
 
-forexrateapi is the official Node.js wrapper for ForexRateAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://forexrateapi.com documentation for more information.
+forexrateapi is the official Ruby wrapper for ForexRateAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://forexrateapi.com documentation for more information.
 
 ## Installation
 Add to Gemfile.
@@ -15,7 +15,28 @@ gem 'forexrateapi'
 
 api_key = 'SET_YOUR_API_KEY_HERE'
 client = ForexRateAPI::Client.new(api_key: api_key)
+
+# Or use EU server:
+# client = ForexRateAPI::Client.new(api_key: api_key, server: 'eu')
+```
+---
+## Server Regions
+
+ForexRateAPI provides two regional endpoints. Choose the one closest to your servers for optimal performance.
+
+| Region | Base URL |
+|--------|----------|
+| United States (default) | `https://api.forexrateapi.com/v1` |
+| Europe | `https://api-eu.forexrateapi.com/v1` |
+
+```ruby
+# Default (US)
+client = ForexRateAPI::Client.new(api_key: 'SET_YOUR_API_KEY_HERE')
+
+# Europe
+client = ForexRateAPI::Client.new(api_key: 'SET_YOUR_API_KEY_HERE', server: 'eu')
 ```
+
 ---
 ## Documentation
 
@@ -27,13 +48,23 @@ client.fetchSymbols()
 [Link](https://forexrateapi.com/documentation#api_symbol)
 
 ---
-#### fetchLive(base, currencies)
+#### setServer(server)
+
+- `server` <[string]> Pass `'eu'` to use the EU server (`api-eu.forexrateapi.com`), or `'us'` for the US server. Defaults to US if not specified.
+
+```ruby
+client.setServer('eu')
+```
+
+---
+#### fetchLive(base, currencies, math)
 
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
+- `math` <[string]> Optional. Pass in a math expression to apply to the rates.
 
 ```ruby
-client.fetchLive(base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+client.fetchLive('USD', ['AUD', 'CAD', 'GBP', 'JPY'])
 ```
 
 [Link](https://forexrateapi.com/documentation#api_realtime)
@@ -46,11 +77,41 @@ client.fetchLive(base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
 
 ```ruby
-client.fetchHistorical(date='2021-04-05', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+client.fetchHistorical('2024-02-05', 'USD', ['AUD', 'CAD', 'GBP', 'JPY'])
 ```
 
 [Link](https://forexrateapi.com/documentation#api_historical)
 
+---
+#### hourly(base, currency, start_date, end_date, math, date_type)
+
+- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
+- `currency` <[string]> Required. Specify currency you would like to get hourly rates for.
+- `start_date` <[string]> Required. Specify the start date using the format `YYYY-MM-DD`.
+- `end_date` <[string]> Required. Specify the end date using the format `YYYY-MM-DD`.
+- `math` <[string]> Optional. Pass in a math expression to apply to the rates.
+- `date_type` <[string]> Optional. Pass in a date type, overrides date parameters if passed in.
+
+```ruby
+client.hourly('USD', 'EUR', '2024-02-05', '2024-02-05')
+```
+
+[Link](https://forexrateapi.com/documentation#api_hourly)
+
+---
+#### ohlc(base, currency, date, date_type)
+
+- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
+- `currency` <[string]> Required. Specify currency you would like to get OHLC for.
+- `date` <[string]> Required. Specify date to get OHLC for specific date using format `YYYY-MM-DD`.
+- `date_type` <[string]> Optional. Pass in a date type, overrides date parameter if passed in.
+
+```ruby
+client.ohlc('USD', 'EUR', '2024-02-05', nil)
+```
+
+[Link](https://forexrateapi.com/documentation#api_ohlc)
+
 ---
 #### convert(from_currency, to_currency, amount, date)
 
@@ -60,7 +121,7 @@ client.fetchHistorical(date='2021-04-05', base='USD', currencies=['AUD', 'CAD',
 - `date` <[string]> Optional. Specify date to use historical midpoint value for conversion with format `YYYY-MM-DD`. Otherwise, it will use live exchange rate date if value not passed in.
 
 ```ruby
-client.convert(from_currency='USD', to_currency='EUR', amount=100, date='2021-04-05')
+client.convert('USD', 'EUR', 100, '2024-02-05')
 ```
 
 [Link](https://forexrateapi.com/documentation#api_convert)
@@ -74,29 +135,37 @@ client.convert(from_currency='USD', to_currency='EUR', amount=100, date='2021-04
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
 
 ```ruby
-client.timeframe(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+client.timeframe('2024-02-05', '2024-02-06', 'USD', ['AUD', 'CAD', 'GBP', 'JPY'])
 ```
 
 [Link](https://forexrateapi.com/documentation#api_timeframe)
 
 ---
-#### change(start_date, end_date, base, currencies)
+#### change(start_date, end_date, base, currencies, date_type)
 
 - `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.
 - `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
+- `date_type` <[string]> Optional. Pass in a date type, overrides date parameters if passed in.
 
 ```ruby
-client.change(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+client.change('2024-02-05', '2024-02-06', 'USD', ['AUD', 'CAD', 'GBP', 'JPY'])
 ```
 
 [Link](https://forexrateapi.com/documentation#api_change)
 
 ---
-**[Official documentation](https://forexrateapi.com/documentation)**
+#### usage()
 
+```ruby
+client.usage()
+```
+
+[Link](https://forexrateapi.com/documentation#api_usage)
 
+---
+**[Official documentation](https://forexrateapi.com/documentation)**
 ---
 ## FAQ
 
@@ -116,4 +185,4 @@ For support, get in touch using [this form](https://forexrateapi.com/contact).
 
 [Array]: https://www.geeksforgeeks.org/ruby-data-types/ 'Array'
 [number]: https://www.geeksforgeeks.org/ruby-data-types/ 'Number'
-[string]: https://apidock.com/ruby/String 'String'
+[string]: https://apidock.com/ruby/String 'String'

data/lib/forexrateapi/client.rb

@@ -12,9 +12,17 @@ module ForexRateAPI
       ForexRateAPI::Config::ATTRIBUTES.each do |key|
         send("#{key}=", options[key] || ForexRateAPI.config.send(key))
       end
+      if options[:server]
+        self.endpoint = Config::SERVERS[options[:server]] || Config::SERVERS['us']
+      end
       @logger ||= ForexRateAPI::Logger.logger
     end
 
+    def setServer(server)
+      self.endpoint = Config::SERVERS[server] || Config::SERVERS['us']
+      @connection = nil
+    end
+
     class << self
       def configure
         block_given? ? yield(Config) : Config

data/lib/forexrateapi/config.rb

@@ -4,6 +4,11 @@ module ForexRateAPI
   module Config
     extend self
 
+    SERVERS = {
+      'us' => 'https://api.forexrateapi.com/v1',
+      'eu' => 'https://api-eu.forexrateapi.com/v1'
+    }.freeze
+
     ATTRIBUTES = %i[
       endpoint
       api_key
@@ -19,7 +24,7 @@ module ForexRateAPI
     attr_accessor(*Config::ATTRIBUTES)
 
     def reset
-      self.endpoint = 'https://api.forexrateapi.com/v1'
+      self.endpoint = SERVERS['us']
       self.api_key = nil
       self.user_agent = "ForexRateAPI Ruby Client/#{ForexRateAPI::VERSION}"
       self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil

data/lib/forexrateapi/endpoints/index.rb

@@ -6,10 +6,11 @@ module ForexRateAPI
       get('symbols')
     end
 
-    def fetchLive(base = nil, currencies = nil)
+    def fetchLive(base = nil, currencies = nil, math = nil)
       options = removeEmpty({
         base: base,
-        currencies: (currencies || []).join(',')
+        currencies: (currencies || []).join(','),
+        math: math
       })
       get('latest', options)
     end
@@ -22,6 +23,28 @@ module ForexRateAPI
       get(date, options)
     end
 
+    def hourly(base = nil, currency = nil, start_date = nil, end_date = nil, math = nil, date_type = nil)
+      options = removeEmpty({
+        base: base,
+        currency: currency,
+        start_date: start_date,
+        end_date: end_date,
+        math: math,
+        date_type: date_type
+      })
+      get('hourly', options)
+    end
+
+    def ohlc(base = nil, currency = nil, date = nil, date_type = nil)
+      options = removeEmpty({
+        base: base,
+        currency: currency,
+        date: date,
+        date_type: date_type
+      })
+      get('ohlc', options)
+    end
+
     def convert(from_currency = nil, to_currency = nil, amount = nil, date = nil)
       options = removeEmpty({
           'from': from_currency,
@@ -42,21 +65,26 @@ module ForexRateAPI
       get('timeframe', options)
     end
 
-    def change(start_date, end_date, base = '', currencies = nil)
+    def change(start_date, end_date, base = nil, currencies = nil, date_type = nil)
       options = removeEmpty({
           'start_date': start_date,
           'end_date': end_date,
           'base': base,
-          'currencies': (currencies || []).join(',')
+          'currencies': (currencies || []).join(','),
+          'date_type': date_type
       })
       get('change', options)
     end
 
+    def usage
+      get('usage')
+    end
+
     private
 
     def removeEmpty(options)
       options.each do |key, value|
-        if (!value || value == '')
+        if (value.nil? || value == '')
           options.delete(key)
         end
       end

data/lib/forexrateapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForexRateAPI
-  VERSION = '1.0.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: forexrateapi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - ForexRateAPI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -28,16 +34,16 @@ dependencies:
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description:
 email: contact@forexrateapi.com
 executables: []
@@ -70,14 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Official ForexRateAPI Ruby client.