fxdatapi 0.1.2

data/README.md

@@ -0,0 +1,57 @@
+## Currency API Ruby Gem
+
+[![Gem](https://img.shields.io/gem/v/fxdatapi)](https://rubygems.org/gems/fxdatapi)
+[![Build Status](https://github.com/moatsystems/fxdatapi-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/moatsystems/fxdatapi-rb/actions/workflows/ci.yml)
+
+A Ruby Gem to interact with the [Currency API](https://moatsystems.com/currency-api/).
+
+[Moat Systems](https://moatsystems.com) provides customers with accurate and up-to-date currency data for making informed decisions in the global financial market, including Gold, Silver and Special Drawing Rights. Our reliable exchange rate data assist businesses in confidently managing foreign transactions, investments and risks. Accounting, E-commerce, CRM, and ERP software companies will find it helpful to integrate with us instead of developing a custom in-house solution.
+
+### Requirements
+
+- Ruby: MRI > 2.6+
+
+### Installation
+
+You can install the gem manually:
+
+```shell
+gem install fxdatapi
+```
+
+Or use Bundler and define it as a dependency in your Gemfile:
+
+```ruby
+gem 'fxdatapi', '~> 0.1.1'
+```
+
+### Documentation
+
+#### Relevant links
+
+- [Currency API product page](https://moatsystems.com/currency-api/)
+- [Currency API support documentation](https://docs.fxdatapi.com/)
+
+### Usage Example
+
+Remember to update your `username` and `password` inside `usage_example.rb` before executing the command below.
+
+```ruby
+ruby usage_example.rb
+```
+
+### Setting up Currency API Account
+
+Subscribe [here](https://moatsystems.com/currency-api/) for a user account.
+
+### Using the Currency API
+
+You can read the [API documentation](https://docs.fxdatapi.com/) to understand what's possible with the Currency API. If you need further assistance, don't hesitate to [contact us](https://moatsystems.com/contact/).
+
+### License
+
+This project is licensed under the [BSD 3-Clause License](./LICENSE).
+
+### Copyright
+
+(c) 2020 - 2023 [Moat Systems Limited](https://moatsystems.com).

data/Rakefile

@@ -0,0 +1,37 @@
+require 'bundler/gem_tasks'
+
+# By default, run tests and linter.
+task default: [:spec, :rubocop]
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = !ENV["VERBOSE"].nil?
+end
+
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:yardoc) do |y|
+  y.options = ["--output-dir", "yardoc"]
+end
+
+namespace :yardoc do
+  task :clobber do
+    rm_r "yardoc" rescue nil
+  end
+end
+
+task :clobber => "yardoc:clobber"
+
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -r rubygems -I lib -r fxdatapi.rb"
+end

data/fxdatapi.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/fxdatapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fxdatapi"
+  spec.version = Fxdatapi::VERSION
+  spec.authors = ["Finbarrs Oketunji"]
+  spec.email = ["f@finbarrs.eu"]
+  spec.summary = "A Ruby Gem to interact with the Currency API"
+  spec.description = "A Ruby Gem to interact with the Currency API."
+  spec.homepage = "https://github.com/moatsystems/fxdatapi-rb"
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.licenses = ['Nonstandard']
+  spec.extra_rdoc_files = %w(LICENSE)
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/moatsystems/fxdatapi-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/moatsystems/fxdatapi-rb/CHANGLOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/currensees.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "fxdatapi/version"
+require_relative "fxdatapi/auth"
+require_relative "fxdatapi/currencies"
+require_relative "fxdatapi/historical"
+require_relative "fxdatapi/margins_spreads"
+require_relative "fxdatapi/performances"
+require_relative "fxdatapi/signals"
+require_relative "fxdatapi/daily_average"
+require_relative "fxdatapi/weekly_average"
+require_relative "fxdatapi/monthly_average"
+require_relative "fxdatapi/convert"
+require_relative "fxdatapi/convert_all"
+
+module Fxdatapi
+end

data/lib/fxdatapi/auth.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Fxdatapi
+  class Authentication
+    def self.login(username, password)
+      uri = URI('https://fxdatapi.com/v1/login')
+      request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json')
+
+      request.body = {
+        username: username,
+        password: password,
+      }.to_json
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Login failed: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/convert.rb

@@ -0,0 +1,37 @@
+# lib/fxdatapi/convert.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class Convert
+    BASE_URL = 'https://fxdatapi.com/v1/convert'
+
+    def self.convert_currency(username, password, date, base_currency, target_currency, amount)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI(BASE_URL)
+      request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+      request.body = {
+        username: username,
+        date: date,
+        base_currency: base_currency,
+        target_currency: target_currency,
+        amount: amount,
+      }.to_json
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to convert currency: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/convert_all.rb

@@ -0,0 +1,37 @@
+# lib/fxdatapi/convert_all.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class ConvertAll
+    BASE_URL = 'https://fxdatapi.com/v1/convert_all'
+
+    def self.convert_all(username, password, base_currency, amount, date)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI(BASE_URL)
+      request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      request.body = {
+        username: username,
+        base_currency: base_currency,
+        amount: amount,
+        date: date,
+      }.to_json
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch conversion for all currencies: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/currencies.rb

@@ -0,0 +1,47 @@
+# lib/fxdatapi/currencies.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class Currencies
+    BASE_URL = 'https://fxdatapi.com/v1/currencies'
+
+    def self.get_currencies(username, password, day, month, year)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}?username=#{username}&day=#{day}&month=#{month}&year=#{year}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch currencies: #{response.code} #{response.message}"
+      end
+    end
+
+    def self.get_currency_by_uuid(username, password, uuid, day, month, year)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{uuid}?username=#{username}&day=#{day}&month=#{month}&year=#{year}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch currency by uuid: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/daily_average.rb

@@ -0,0 +1,30 @@
+# lib/fxdatapi/daily_average.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class DailyAverage
+    BASE_URL = 'https://fxdatapi.com/v1/daily_average'
+
+    def self.get_daily_average(username, password, date)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{date}")
+      request = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch daily average: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/historical.rb

@@ -0,0 +1,47 @@
+# lib/fxdatapi/historical.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class Historical
+    BASE_URL = 'https://fxdatapi.com/v1/historical'
+
+    def self.get_historical_data(username, password, date, day, month, year)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}?username=#{username}&date=#{date}&day=#{day}&month=#{month}&year=#{year}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch historical data: #{response.code} #{response.message}"
+      end
+    end
+
+    def self.get_historical_data_by_id(username, password, data_id, date_string, day, month, year)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{data_id}?username=#{username}&date_string=#{date_string}&day=#{day}&month=#{month}&year=#{year}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch historical data by ID: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/margins_spreads.rb

@@ -0,0 +1,47 @@
+# lib/fxdatapi/margins_spreads.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class MarginsSpreads
+    BASE_URL = 'https://fxdatapi.com/v1/margins_spreads'
+
+    def self.get_margins_spreads(username, password, day, month, year)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}?username=#{username}&day=#{day}&month=#{month}&year=#{year}")
+      request = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch margins and spreads: #{response.code} #{response.message}"
+      end
+    end
+
+    def self.get_margin_spread_by_uuid(username, password, uuid, day, month, year)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{uuid}?username=#{username}&day=#{day}&month=#{month}&year=#{year}")
+      request = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch margin and spread by uuid: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/monthly_average.rb

@@ -0,0 +1,30 @@
+# lib/fxdatapi/monthly_average.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class MonthlyAverage
+    BASE_URL = 'https://fxdatapi.com/v1/monthly_average'
+
+    def self.get_monthly_average(username, password, year, month)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{year}/#{month}")
+      request = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch monthly average data: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/performances.rb

@@ -0,0 +1,47 @@
+# lib/fxdatapi/performances.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class Performances
+    BASE_URL = 'https://fxdatapi.com/v1/performances'
+
+    def self.get_performances(username, password)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}?username=#{username}")
+      request = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch performances: #{response.code} #{response.message}"
+      end
+    end
+
+    def self.get_performance_by_id(username, password, performance_id)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{performance_id}?username=#{username}")
+      request = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch performance by ID: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/signals.rb

@@ -0,0 +1,47 @@
+# lib/fxdatapi/signals.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class Signals
+    BASE_URL = 'https://fxdatapi.com/v1/signals'
+
+    def self.get_signals(username, password)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}?username=#{username}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch signals: #{response.code} #{response.message}"
+      end
+    end
+
+    def self.get_signal_by_id(username, password, signal_id)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{signal_id}?username=#{username}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch signal by id: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/fxdatapi/version.rb

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

data/lib/fxdatapi/weekly_average.rb

@@ -0,0 +1,30 @@
+# lib/fxdatapi/weekly_average.rb
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'auth'
+
+module Fxdatapi
+  class WeeklyAverage
+    BASE_URL = 'https://fxdatapi.com/v1/weekly_average'
+
+    def self.get_weekly_average(username, password, from_date, to_date)
+      login_result = Authentication.login(username, password)
+      cookie = "user_type=#{login_result['user_type']}; username=#{username}"
+
+      uri = URI("#{BASE_URL}/#{from_date}/#{to_date}")
+      request = Net::HTTP::Get.new(uri, 'Accept' => 'application/json', 'Cookie' => cookie)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise "Failed to fetch weekly average data: #{response.code} #{response.message}"
+      end
+    end
+  end
+end