initial commit

Author: forexrateapi

.gitignore

@@ -0,0 +1,7 @@
+.env
+pkg
+Gemfile.lock
+.DS_Store
+.bundle
+.idea
+*.gem

Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 ForexRateAPI
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,119 @@
+# 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.
+
+## Installation
+Add to Gemfile.
+
+```
+gem 'forexrateapi'
+```
+
+## Usage
+
+```ruby
+
+api_key = 'SET_YOUR_API_KEY_HERE'
+client = ForexRateAPI::Client.new(api_key: api_key)
+```
+---
+## Documentation
+
+#### fetchSymbols()
+```ruby
+client.fetchSymbols()
+```
+
+[Link](https://forexrateapi.com/documentation#api_symbol)
+
+---
+#### fetchLive(base, currencies)
+
+- `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.
+
+```ruby
+client.fetchLive(base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+```
+
+[Link](https://forexrateapi.com/documentation#api_realtime)
+
+---
+#### fetchHistorical(date, base, currencies)
+
+- `date` <[string]> Required. Pass in a string with 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.
+
+```ruby
+client.fetchHistorical(date='2021-04-05', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+```
+
+[Link](https://forexrateapi.com/documentation#api_historical)
+
+---
+#### convert(from_currency, to_currency, amount, date)
+
+- `from_currency` <[string]> Optional. Pass in a base currency, defaults to USD.
+- `to_currency` <[string]> Required. Specify currency you would like to convert to.
+- `amount` <[number]> Required. The amount to convert.
+- `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')
+```
+
+[Link](https://forexrateapi.com/documentation#api_convert)
+
+---
+#### timeframe(start_date, end_date, base, currencies)
+
+- `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.
+
+```ruby
+client.timeframe(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+```
+
+[Link](https://forexrateapi.com/documentation#api_timeframe)
+
+---
+#### change(start_date, end_date, base, currencies)
+
+- `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.
+
+```ruby
+client.change(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
+```
+
+[Link](https://forexrateapi.com/documentation#api_change)
+
+---
+**[Official documentation](https://forexrateapi.com/documentation)**
+
+
+---
+## FAQ
+
+- How do I get an API Key?
+
+    Free API Keys are available [here](https://forexrateapi.com).
+
+- I want more information
+
+    Checkout our FAQs [here](https://forexrateapi.com/faq).
+
+
+## Support
+
+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'

Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development

example/index.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/forexrateapi'
+
+API_KEY = 'REPLACE_ME'
+
+ForexRateAPI::VERSION
+
+client = ForexRateAPI::Client.new(
+  api_key: API_KEY
+)
+
+data = client.fetchSymbols()
+puts data
+
+data = client.fetchLive()
+puts data
+
+data = client.fetchHistorical('2021-04-05', 'USD', ['AUD', 'CAD', 'GBP', 'JPY'])
+puts data
+
+data = client.convert('USD', 'EUR', 100, '2021-04-05')
+puts data
+
+data = client.timeframe('2021-04-05', '2021-04-06', 'USD', ['AUD', 'CAD', 'GBP', 'JPY'])
+puts data
+
+data = client.change('2021-04-05', '2021-04-06', 'USD', ['AUD', 'CAD', 'GBP', 'JPY'])
+puts data

forexrateapi.gemspec

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'forexrateapi/version'
+
+Gem::Specification.new do |s|
+  s.name = 'forexrateapi'
+  s.version = ForexRateAPI::VERSION
+  s.authors = ['ForexRateAPI']
+  s.email = 'contact@forexrateapi.com'
+  s.files = Dir['{bin,lib}/**/*'] + ['README.md', 'LICENSE.md']
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/forexrateapi/forexrateapi-ruby'
+  s.licenses = ['MIT']
+  s.summary = 'Official ForexRateAPI Ruby client.'
+  s.add_dependency 'faraday', '>= 1.0.0'
+  s.add_dependency 'faraday_middleware'
+end

lib/forexrateapi.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+
+require_relative 'forexrateapi/version'
+require_relative 'forexrateapi/logger'
+
+require_relative 'forexrateapi/errors/fault'
+
+require_relative 'forexrateapi/raise_error'
+require_relative 'forexrateapi/connection'
+require_relative 'forexrateapi/request'
+require_relative 'forexrateapi/config'
+require_relative 'forexrateapi/errors'
+require_relative 'forexrateapi/endpoints'
+require_relative 'forexrateapi/client'

lib/forexrateapi/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ForexRateAPI
+  class Client
+    include Connection
+    include Request
+    include Endpoints
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def initialize(options = {})
+      ForexRateAPI::Config::ATTRIBUTES.each do |key|
+        send("#{key}=", options[key] || ForexRateAPI.config.send(key))
+      end
+      @logger ||= ForexRateAPI::Logger.logger
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

lib/forexrateapi/config.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ForexRateAPI
+  module Config
+    extend self
+
+    ATTRIBUTES = %i[
+      endpoint
+      api_key
+      proxy
+      user_agent
+      ca_path
+      ca_file
+      logger
+      timeout
+      open_timeout
+    ].freeze
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def reset
+      self.endpoint = 'https://api.forexrateapi.com/v1'
+      self.api_key = nil
+      self.user_agent = "ForexRateAPI Ruby Client/#{ForexRateAPI::VERSION}"
+      self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
+      self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
+      self.proxy = nil
+      self.logger = nil
+      self.timeout = nil
+      self.open_timeout = nil
+    end
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end
+
+ForexRateAPI::Config.reset