xtb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c368d7138b3a90d013565212661d39e0dd339c57c8a4c235eaa30ad786e4601
+  data.tar.gz: c1613af477c8de260af049d7fc1ac42df8ead3d327967ecc2b575c8599cdbe19
+SHA512:
+  metadata.gz: 98a5f73fb940d41c98f338c14bbb7a11f5b546214d1b9a7249bc3594797f4968216fbc449118a39a7cb5ba5bf8a0837560334521cf758d8eb50cc52ad3678e9a
+  data.tar.gz: '046729d8d9a8efad3203bfef09ce870fbb2086b196343460114232f052b8ef194a5063e56d119324595d7ed53db27f3bd9a3217b0ce161c44ec5efe16728ffba'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/spec/**/*'

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 jacekmaciag
+
+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,49 @@
+# XTB API client for Ruby
+
+Xtb is a Ruby implementation of the [XTB broker API (xAPI) version 2.5.0](http://developers.xstore.pro/documentation/2.5.0).
+At the time of writing this it's the latest version of the API.
+This gem allows you to connect to the XTB broker and execute trades, get account information, and more.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+### Configuration
+
+Before you can connect to the XTB API, you need to configure the connection. 
+You can do this by creating a configuration object and passing it to the client.
+    
+```ruby
+
+```
+
+### Connect to the XTB API
+
+```ruby
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jacekmaciag/xtb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/xtb/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Xtb
+  # Configuration mapping for XTB API.
+  class Config
+    class << self
+      def https_host
+        ENV.fetch('XTB__HTTPS_HOST', 'xapi.xtb.com')
+      end
+
+      def https_port
+        ENV.fetch('XTB__HTTPS_PORT', 5124).to_i
+      end
+
+      def wss_host
+        ENV.fetch('XTB__WSS_HOST', 'ws.xtb.com')
+      end
+
+      def wss_path
+        ENV.fetch('XTB__WSS_PATH', 'demo')
+      end
+
+      def wss_port
+        ENV.fetch('XTB__WSS_PORT', 5125).to_i
+      end
+
+      def user_id
+        ENV.fetch('XTB__USER_ID') { raise 'XTB__USER_ID is required' }
+      end
+
+      def password
+        ENV.fetch('XTB__PASSWORD') { raise 'XTB__PASSWORD is required' }
+      end
+
+      def min_request_interval
+        ENV.fetch('XTB__MIN_REQUEST_INTERVAL', 0.2).to_f
+      end
+    end
+  end
+end

data/lib/xtb/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Xtb
+  class Error < StandardError; end
+
+  class NotLoggedInError < Error; end
+  class AlreadyLoggedInError < Error; end
+end

data/lib/xtb/http/all_symbols.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getAllSymbols
+    class AllSymbols < Command
+      def call
+        super.map { |symbol| Xtb::SymbolRecord.new(**symbol) }
+      end
+
+      private
+
+      def command = :getAllSymbols
+    end
+  end
+end

data/lib/xtb/http/calendar.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getCalendar
+    class Calendar < Command
+      IMPACT = {
+        1 => 'low',
+        2 => 'medium',
+        3 => 'high'
+      }.freeze
+
+      CalendarRecord = Data.define(:country, :current, :forecast, :impact, :period, :previous, :time, :title) do
+        def initialize(country:, current:, forecast:, impact:, period:, previous:, time:, title:)
+          super(country:, current:, forecast:, impact: IMPACT[impact.to_i], period:, previous:, time:, title:)
+        end
+      end
+
+      def call
+        super.map { |record| CalendarRecord.new(**record) }
+      end
+
+      private
+
+      def command = :getCalendar
+    end
+  end
+end

data/lib/xtb/http/chart_last_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getChartLastRequest
+    class ChartLastRequest < Command
+      RateInfoRecord = Data.define(:close, :ctm, :ctm_string, :high, :low, :open, :vol)
+      ChartLastRequestResponse = Data.define(:digits, :rate_infos)
+
+      # @param period [Xtb::PERIODS]
+      # @param start [Time]
+      # @param symbol [String|Symbol]
+      def initialize(period, start, symbol)
+        @period = period
+        @start = start
+        @symbol = symbol
+      end
+
+      def call
+        digits, rate_infos = super.values_at(:digits, :rate_infos)
+        rate_infos = rate_infos.map { |record| RateInfoRecord.new(**record) }
+        ChartLastRequestResponse.new(digits:, rate_infos:)
+      end
+
+      private
+
+      attr_reader :period, :start, :symbol
+
+      def command = :getChartLastRequest
+
+      def arguments
+        {
+          info:
+          {
+            period:,
+            start:,
+            symbol:
+          }
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/chart_range_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getChartRangeRequest
+    class ChartRangeRequest < Command
+      RateInfoRecord = Data.define(:close, :ctm, :ctm_string, :high, :low, :open, :vol)
+      ChartLastRequestResponse = Data.define(:digits, :rate_infos)
+
+      # @param end_time [Time] End of chart block
+      # @param period [Xtb::PERIODS] Period code
+      # @param start_time [Time] Start of chart block
+      # @param symbol [String|Symbol] Symbol
+      # @param ticks [Integer] (Optional) Number of ticks needed
+      def initialize(end_time, period, start_time, symbol, ticks: nil)
+        @end_time = end_time
+        @period = period
+        @start_time = start_time
+        @symbol = symbol
+        @ticks = ticks
+      end
+
+      def call
+        digits, rate_infos = super.values_at(:digits, :rate_infos)
+        rate_infos = rate_infos.map { |record| RateInfoRecord.new(**record) }
+        ChartLastRequestResponse.new(digits:, rate_infos:)
+      end
+
+      private
+
+      attr_reader :end_time, :period, :start_time, :symbol, :ticks
+
+      def command = :getChartRangeRequest
+
+      def arguments
+        {
+          info:
+            {
+              end: end_time,
+              period:,
+              start: start_time,
+              symbol:,
+              ticks:
+            }.compact
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'ssl_client'
+require_relative '../errors'
+require_relative '../request_queue'
+
+module Xtb
+  module Http
+    class Client
+      include RequestQueue
+
+      class << self
+        def post(payload)
+          with_request_queue do
+            Xtb::Http::SslClient.request(payload)
+          end
+          # rescue NotLoggedInError => e
+          #   return if command == :logout
+          #
+          #   Rails.logger.debug(e)
+          #
+          #   BrokerClients::Xtb::Login.call
+          #   retry
+          # rescue AlreadyLoggedInError => _e
+          #   # noop
+        end
+
+        def stream_session_id
+          @stream_session_id ||= BrokerClients::Xtb::Login.call.stream_session_id
+        end
+
+        private
+
+        def ssl_client
+          @ssl_client ||= Xtb::Http::SslClient.new
+        end
+      end
+    end
+  end
+end

data/lib/xtb/http/command.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'active_support/inflector'
+require_relative '../errors'
+
+module Xtb
+  module Http
+    # Base class for all commands.
+    class Command
+      Request = Struct.new(:command, :arguments) do
+        def to_json(*_args)
+          arguments = transform_keys(self.arguments) if self.arguments
+          JSON.dump({ command:, arguments: }.compact)
+        end
+
+        private
+
+        def transform_keys(hash)
+          hash.transform_keys! do |key|
+            key.to_s.camelize(:lower)
+          end
+
+          hash.transform_values do |value|
+            transform_keys(value) if value.is_a?(Hash)
+            value
+          end
+        end
+      end
+
+      Response = Struct.new(:command, :raw_response) do
+        def initialize(**args)
+          super
+
+          @response = parse
+        end
+
+        def success?
+          response[:status]
+        end
+
+        def return_data
+          response[:return_data]
+        end
+
+        def error_code
+          response[:error_code]
+        end
+
+        def error_description
+          response[:error_descr]
+        end
+
+        private
+
+        attr_reader :response
+
+        def parse
+          response = JSON.parse(raw_response)
+          transform_keys(response)
+        end
+
+        def transform_keys(hash)
+          hash.transform_keys! do |key|
+            key.underscore.to_sym
+          end
+
+          hash.transform_values do |value|
+            transform_keys(value) if value.is_a?(Hash)
+            value.each { |item| transform_keys(item) } if value.is_a?(Array)
+            value
+          end
+        end
+      end
+
+      def initialize(**args); end
+
+      def self.call(**args)
+        new(**args).call
+      end
+
+      def call
+        request_data = Request.new(command:, arguments:).to_json
+        raw_response = Client.post(request_data)
+        response = Response.new(command:, raw_response:)
+        raise_error(response.error_code, response.error_description) unless response.success?
+
+        response.return_data
+      end
+
+      private
+
+      def command
+        raise NotImplementedError
+      end
+
+      def arguments
+        nil
+      end
+
+      def raise_error(error_code, error_description)
+        case error_code
+        when 'BE103'
+          raise NotLoggedInError, "(#{error_code}) #{error_description}"
+        when 'BE118'
+          raise AlreadyLoggedInError, "(#{error_code}) #{error_description}"
+        else
+          raise "(#{error_code}) #{error_description}"
+        end
+      end
+    end
+  end
+end

data/lib/xtb/http/commission_def.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getCommissionDef
+    class CommissionDef < Command
+      CommissionDefResponse = Data.define(:commission, :rate_of_exchange)
+
+      # @param symbol [String|Symbol]
+      # @param volume [Float]
+      def initialize(symbol, volume)
+        @symbol = symbol
+        @volume = volume
+      end
+
+      def call
+        CommissionDefResponse.new(**super)
+      end
+
+      private
+
+      attr_reader :symbol, :volume
+
+      def command = :getCommissionDef
+
+      def arguments
+        {
+          symbol:,
+          volume:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/current_user_data.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getCurrentUserData
+    class CurrentUserData < Command
+      CurrentUserDataResponse = Data.define(:company_unit, :currency, :group, :ib_account, :leverage,
+                                            :leverage_multiplier, :spread_type, :trailing_stop)
+
+      def call
+        CurrentUserDataResponse.new(**super)
+      end
+
+      private
+
+      def command = :getCurrentUserData
+    end
+  end
+end

data/lib/xtb/http/margin_level.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getMarginLevel
+    class MarginLevel < Command
+      MarginLevelResponse = Data.define(:balance, :credit, :currency, :equity, :margin, :margin_free, :margin_level)
+
+      def call
+        MarginLevelResponse.new(**super)
+      end
+
+      private
+
+      def command = :getMarginLevel
+    end
+  end
+end

data/lib/xtb/http/margin_trade.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getMarginTrade
+    class MarginTrade < Command
+      MarginTradeResponse = Data.define(:margin)
+
+      # @param symbol [String|Symbol]
+      # @param volume [Float]
+      def initialize(symbol, volume)
+        @symbol = symbol
+        @volume = volume
+      end
+
+      def call
+        MarginTradeResponse.new(**super)
+      end
+
+      private
+
+      attr_reader :symbol, :volume
+
+      def command = :getMarginTrade
+
+      def arguments
+        {
+          symbol:,
+          volume:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/news.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getNews
+    class News < Command
+      NewsTopicRecord = Data.define(:body, :bodylen, :key, :time, :time_string, :title)
+
+      # @param end_time [Time]
+      # @param start_time [Time]
+      def initialize(end_time, start_time)
+        @end_time = end_time
+        @start_time = start_time
+      end
+
+      def call
+        super.map { |record| NewsTopicRecord.new(**record) }
+      end
+
+      private
+
+      attr_reader :end_time, :start_time
+
+      def command = :getNews
+
+      def arguments
+        {
+          end_time:,
+          start_time:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/profit_calculation.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getProfitCalculation
+    class ProfitCalculation < Command
+      ProfitCalculationResponse = Data.define(:profit)
+
+      # @param close_price [Float]
+      # @param cmd [Xtb::OPERATIONS]
+      # @param open_price [Float]
+      # @param symbol [String|Symbol]
+      # @param volume [Float]
+      def initialize(close_price, cmd, open_price, symbol, volume)
+        @close_price = close_price
+        @cmd = cmd
+        @open_price = open_price
+        @symbol = symbol
+        @volume = volume
+      end
+
+      def call
+        ProfitCalculationResponse.new(**super)
+      end
+
+      private
+
+      attr_reader :close_price, :cmd, :open_price, :symbol, :volume
+
+      def command = :getProfitCalculation
+
+      def arguments
+        {
+          close_price:,
+          cmd: Xtb::OPERATIONS[cmd],
+          open_price:,
+          symbol:,
+          volume:
+        }
+      end
+    end
+  end
+end