forexrateapi 1.0.1

checksums.yaml

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

data/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.

data/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'

data/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

data/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

data/lib/forexrateapi/connection.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ForexRateAPI
+  module Connection
+    private
+
+    def headers
+      {}
+    end
+
+    def connection
+      @connection ||= begin
+        options = {
+          headers: headers.merge(
+            'Accept' => 'application/json; charset=utf-8',
+            'Content-Type' => 'application/json'
+          )
+        }
+
+        options[:headers]['User-Agent'] = user_agent if user_agent
+        options[:proxy] = proxy if proxy
+        options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
+
+        request_options = {}
+        request_options[:timeout] = timeout if timeout
+        request_options[:open_timeout] = open_timeout if open_timeout
+        options[:request] = request_options if request_options.any?
+
+        ::Faraday::Connection.new(endpoint, options) do |connection|
+          connection.use ::Faraday::Request::Multipart
+          connection.use ::Faraday::Request::UrlEncoded
+          connection.use ::ForexRateAPI::Response::RaiseError
+          connection.use ::FaradayMiddleware::ParseJson, content_type: /\bjson$/
+          connection.response :logger, logger if logger
+          connection.adapter ::Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/forexrateapi/endpoints/index.rb

@@ -0,0 +1,66 @@
+# # frozen_string_literal: true
+
+module ForexRateAPI
+  module Endpoints
+    def fetchSymbols
+      get('symbols')
+    end
+
+    def fetchLive(base = nil, currencies = nil)
+      options = removeEmpty({
+        base: base,
+        currencies: (currencies || []).join(',')
+      })
+      get('latest', options)
+    end
+
+    def fetchHistorical(date, base = nil, currencies = nil)
+      options = removeEmpty({
+        base: base,
+        currencies: (currencies || []).join(',')
+      })
+      get(date, options)
+    end
+
+    def convert(from_currency = nil, to_currency = nil, amount = nil, date = nil)
+      options = removeEmpty({
+          'from': from_currency,
+          'to': to_currency,
+          'amount': amount,
+          'date': date
+      })
+      get('convert', options)
+    end
+
+    def timeframe(start_date, end_date, base = nil, currencies = nil)
+      options = removeEmpty({
+          'start_date': start_date,
+          'end_date': end_date,
+          'base': base,
+          'currencies': (currencies || []).join(',')
+      })
+      get('timeframe', options)
+    end
+
+    def change(start_date, end_date, base = '', currencies = nil)
+      options = removeEmpty({
+          'start_date': start_date,
+          'end_date': end_date,
+          'base': base,
+          'currencies': (currencies || []).join(',')
+      })
+      get('change', options)
+    end
+
+    private
+
+    def removeEmpty(options)
+      options.each do |key, value|
+        if (!value || value == '')
+          options.delete(key)
+        end
+      end
+      options
+    end
+  end
+end

data/lib/forexrateapi/endpoints.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'endpoints/index'

data/lib/forexrateapi/errors/fault.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ForexRateAPI
+  module Errors
+    class Fault < ::Faraday::ClientError
+      def message
+        response[:body]['message'] || super
+      end
+
+      def headers
+        response[:headers]
+      end
+    end
+  end
+end

data/lib/forexrateapi/errors.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'errors/fault'

data/lib/forexrateapi/logger.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module ForexRateAPI
+  class Logger < ::Logger
+    def self.logger
+      @logger ||= begin
+        logger = new STDOUT
+        logger.level = Logger::WARN
+        logger
+      end
+    end
+  end
+end

data/lib/forexrateapi/raise_error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ForexRateAPI
+  module Response
+    class RaiseError < ::Faraday::Response::Middleware
+      def on_complete(env)
+        case env[:status]
+        when 404
+          raise Faraday::ResourceNotFound, response_values(env)
+        when 407
+          # mimic the behavior that we get with proxy requests with HTTPS
+          raise Faraday::ConnectionFailed, %(407 "Proxy Authentication Required ")
+        when (400...600).freeze
+          raise ForexRateAPI::Errors::Fault, response_values(env)
+        end
+      end
+
+      def response_values(env)
+        {
+          status: env.status,
+          headers: env.response_headers,
+          body: env.body
+        }
+      end
+    end
+  end
+end

data/lib/forexrateapi/request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ForexRateAPI
+  module Request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    private
+
+    #
+    # @param [Symbol] method - Faraday HTTP method.
+    # @param [String] path - URL to send.
+    # @param [Hash] options - :appid, :lang, :units, :endpoint, :body keys will configure the request.
+    #   The rest will be converted to query params for GET/DELETE, or jsonified for POST/PUT.
+    #
+    # @return [Object] - the Faraday::Response#body.
+    #
+    def request(method, path, options)
+      options = options.dup
+      options[:api_key] ||= api_key if !api_key.nil?
+      root = options.delete(:endpoint) || endpoint
+      path = [root, path].join('/')
+      response = connection.send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.params = { appid: options.delete(:appid) }
+          if options.key?(:body)
+            request.body = options.delete(:body).to_json
+          elsif !options.empty?
+            request.body = options.to_json
+          end
+        end
+        request.options.merge!(options.delete(:request)) if options.key?(:request)
+      end
+      response.body
+    end
+  end
+end

data/lib/forexrateapi/version.rb

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

data/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'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: forexrateapi
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- ForexRateAPI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-19 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: contact@forexrateapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/forexrateapi.rb
+- lib/forexrateapi/client.rb
+- lib/forexrateapi/config.rb
+- lib/forexrateapi/connection.rb
+- lib/forexrateapi/endpoints.rb
+- lib/forexrateapi/endpoints/index.rb
+- lib/forexrateapi/errors.rb
+- lib/forexrateapi/errors/fault.rb
+- lib/forexrateapi/logger.rb
+- lib/forexrateapi/raise_error.rb
+- lib/forexrateapi/request.rb
+- lib/forexrateapi/version.rb
+homepage: http://github.com/forexrateapi/forexrateapi-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Official ForexRateAPI Ruby client.
+test_files: []