fxdatapi 0.1.2

data/usage_example.rb

@@ -0,0 +1,115 @@
+# usage_example.rb
+
+# frozen_string_literal: true
+
+require 'fxdatapi'
+
+# Authentication
+username = "your_username"
+password = "your_password"
+
+# Currencies data parameters
+day = 19
+month = 4
+year = 2024
+currency_uuid = '594bffc4-d095-11ed-9e30-acde48001122'
+
+# Historical data parameters
+date = '2023_04_02'
+data_id = 'fe1ee1c4-d162-11ed-a2dc-acde48001122'
+date_string = '2023_04_02'
+
+# Margins and spreads parameters
+margin_spread_uuid = '02775b82-e3c1-11ed-9eab-acde48001122'
+
+# Performances parameters
+performance_id = '9010e700-e3c2-11ed-b5bd-acde48001122'
+
+# Signals parameters
+signal_id = '8e694050-e3c2-11ed-b5bd-acde48001122'
+
+# Weekly Average data parameters
+from_date = '2023_04_03'
+to_date = '2023_04_07'
+
+# Convert currency parameters
+convert_date = '2023_04_19'
+base_currency = 'GBP'
+target_currency = 'EUR'
+convert_amount = 500
+amount = 120
+
+# Using Authentication
+result = Fxdatapi::Authentication.login(username, password)
+puts "Authentication result:"
+puts result.inspect
+
+# Using Currencies
+currencies = Fxdatapi::Currencies.get_currencies(username, password, day, month, year)
+puts "Currencies result:"
+puts currencies.inspect
+
+currency_by_uuid = Fxdatapi::Currencies.get_currency_by_uuid(username, password, currency_uuid, day, month, year)
+puts "Currency by UUID result:"
+puts currency_by_uuid.inspect
+
+# Using Historical
+historical_data = Fxdatapi::Historical.get_historical_data(username, password, date, day, month, year)
+puts "Historical data result:"
+puts historical_data.inspect
+
+historical_data_by_id = Fxdatapi::Historical.get_historical_data_by_id(username, password, data_id, date_string, day, month, year)
+puts "Historical data by ID result:"
+puts historical_data_by_id.inspect
+
+# Using MarginsSpreads
+margins_spreads = Fxdatapi::MarginsSpreads.get_margins_spreads(username, password, day, month, year)
+puts "Margins and spreads result:"
+puts margins_spreads.inspect
+
+margin_spread_by_uuid = Fxdatapi::MarginsSpreads.get_margin_spread_by_uuid(username, password, margin_spread_uuid, day, month, year)
+puts "Margin and spread by UUID result:"
+puts margin_spread_by_uuid.inspect
+
+# Using Performances
+performances = Fxdatapi::Performances.get_performances(username, password)
+puts "Performances result:"
+puts performances.inspect
+
+performance_by_id = Fxdatapi::Performances.get_performance_by_id(username, password, performance_id)
+puts "Performance by ID result:"
+puts performance_by_id.inspect
+
+# Using Signals
+signals = Fxdatapi::Signals.get_signals(username, password)
+puts "Signals result:"
+puts signals.inspect
+
+signal_by_id = Fxdatapi::Signals.get_signal_by_id(username, password, signal_id)
+puts "Signal by ID result:"
+puts signal_by_id.inspect
+
+# Using DailyAverage
+daily_average_data = Fxdatapi::DailyAverage.get_daily_average(username, password, date)
+puts "Daily average data result:"
+puts daily_average_data.inspect
+
+# Using WeeklyAverage
+weekly_average = Fxdatapi::WeeklyAverage.get_weekly_average(username, password, from_date, to_date)
+puts "Weekly Average result:"
+puts weekly_average.inspect
+
+# Using MonthlyAverage
+monthly_average = Fxdatapi::MonthlyAverage.get_monthly_average(username, password, year, month)
+puts "Monthly Average result:"
+puts monthly_average.inspect
+
+# Using Convert
+converted_currency = Fxdatapi::Convert.convert_currency(username, password, convert_date, base_currency, target_currency, convert_amount)
+puts "Converted currency result:"
+puts converted_currency.inspect
+
+# Using ConvertAll
+convert_all_result = Fxdatapi::ConvertAll.convert_all(username, password, base_currency, amount, date)
+puts "Conversion for all currencies result:"
+puts convert_all_result.inspect

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: fxdatapi
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Finbarrs Oketunji
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-10 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby Gem to interact with the Currency API.
+email:
+- f@finbarrs.eu
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_currensees.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- CONTRIBUTORS
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fxdatapi.gemspec
+- lib/currensees.rb
+- lib/fxdatapi/auth.rb
+- lib/fxdatapi/convert.rb
+- lib/fxdatapi/convert_all.rb
+- lib/fxdatapi/currencies.rb
+- lib/fxdatapi/daily_average.rb
+- lib/fxdatapi/historical.rb
+- lib/fxdatapi/margins_spreads.rb
+- lib/fxdatapi/monthly_average.rb
+- lib/fxdatapi/performances.rb
+- lib/fxdatapi/signals.rb
+- lib/fxdatapi/version.rb
+- lib/fxdatapi/weekly_average.rb
+- usage_example.rb
+homepage: https://github.com/moatsystems/fxdatapi-rb
+licenses:
+- Nonstandard
+metadata:
+  homepage_uri: https://github.com/moatsystems/fxdatapi-rb
+  source_code_uri: https://github.com/moatsystems/fxdatapi-rb
+  changelog_uri: https://github.com/moatsystems/fxdatapi-rb/CHANGLOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A Ruby Gem to interact with the Currency API
+test_files: []