xtb 0.1.0

data/lib/xtb/http/response.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    class Response
+      def initialize(raw_response, command)
+        @response = parse_json(raw_response)
+        @command = command
+      end
+
+      def self.parse(raw_response, command)
+        new(raw_response, command).parse
+      end
+
+      def parse
+        return data if success?
+
+        raise_error
+      end
+
+      private
+
+      attr_reader :response, :command
+
+      def parse_json(raw_response)
+        JSON.parse(raw_response).deep_transform_keys { |key| key.underscore.to_sym }
+      end
+
+      def success?
+        response[:status]
+      end
+
+      def data
+        return response if command == :login
+
+        response[:return_data]
+      end
+
+      def error_code
+        response[:error_code]
+      end
+
+      def error_description
+        response[:error_descr]
+      end
+
+      def error_string
+        "(#{error_code}) #{error_description}"
+      end
+
+      def raise_error
+        case error_code
+        when 'BE103'
+          raise NotLoggedInError, error_string
+        when 'BE118'
+          raise AlreadyLoggedInError, error_string
+        else
+          raise BrokerError, error_string
+        end
+      end
+    end
+  end
+end

data/lib/xtb/http/server_time.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getServerTime
+    class ServerTime < Command
+      ServerTimeResponse = Data.define(:time, :time_string)
+
+      def call
+        ServerTimeResponse.new(**super)
+      end
+
+      private
+
+      def command = :getServerTime
+    end
+  end
+end

data/lib/xtb/http/ssl_client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require_relative '../config'
+
+module Xtb
+  module Http
+    class SslClient
+      class << self
+        def request(payload)
+          ssl_socket.connect
+          ssl_socket.puts(payload)
+          next_line
+        end
+
+        private
+
+        def next_line
+          line = ssl_socket.gets.chomp
+          return line unless line.empty?
+
+          next_line
+        end
+
+        def ssl_context
+          @ssl_context ||= OpenSSL::SSL::SSLContext.new
+        end
+
+        def ssl_socket
+          @ssl_socket ||= OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context) do |socket|
+            socket.hostname = Config.https_host
+            socket.sync_close = true
+            socket
+          end
+        end
+
+        def tcp_socket
+          TCPSocket.new(Config.https_host, Config.https_port)
+        end
+      end
+    end
+  end
+end

data/lib/xtb/http/step_rules.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getStepRules
+    class StepRules < Command
+      StepRecord = Data.define(:from_value, :step)
+
+      def call
+        super.map { |record| StepRecord.new(**record) }
+      end
+
+      private
+
+      def command = :getStepRules
+    end
+  end
+end

data/lib/xtb/http/symbol.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getSymbol
+    class Symbol < Command
+      # @param symbol [String|Symbol]
+      def initialize(symbol)
+        @symbol = symbol
+      end
+
+      def call
+        Xtb::SymbolRecord.new(**super)
+      end
+
+      private
+
+      attr_reader :symbol
+
+      def command = :getSymbol
+
+      def arguments
+        {
+          symbol:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/tick_prices.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getTickPrices
+    class TickPrices < Command
+      TickRecord = Data.define(:ask, :ask_volume, :bid, :bid_volume, :high, :level, :low, :spread_raw, :spread_table,
+                               :symbol, :timestamp)
+
+      def initialize(level, symbols, timestamp)
+        @level = level
+        @symbols = symbols
+        @timestamp = timestamp
+      end
+
+      def call
+        super[:quotations].map { |record| TickRecord.new(**record) }
+      end
+
+      private
+
+      attr_reader :level, :symbols, :timestamp
+
+      def command = :getTickPrices
+
+      def arguments
+        {
+          level:,
+          symbols:,
+          timestamp:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/trade_records.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getTradeRecords
+    class TradeRecords < Command
+      # @param orders [Array<Integer>] list of order ids
+      def initialize(orders)
+        @orders = orders
+      end
+
+      def call
+        super.map { |record| Xtb::TradeRecord.new(**record) }
+      end
+
+      private
+
+      attr_reader :orders
+
+      def command = :getTradeRecords
+
+      def arguments
+        {
+          orders:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/trade_transaction.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#tradeTransaction
+    class TradeTransaction < Command
+      TradeTransactionResponse = Data.define(:order)
+
+      # @param cmd [Symbol]
+      # @param custom_comment [String]
+      # @param expiration [Integer]
+      # @param offset [Integer]
+      # @param order [Integer]
+      # @param price [Float]
+      # @param stop_loss [Float]
+      # @param symbol [String]
+      # @param take_profit [Float]
+      # @param type [Symbol]
+      # @param volume [Float]
+      def initialize(cmd:, custom_comment:, expiration:, offset:, order:, price:, stop_loss:, symbol:, take_profit:,
+                     type:, volume:)
+        @cmd = cmd
+        @custom_comment = custom_comment
+        @expiration = expiration
+        @offset = offset
+        @order = order
+        @price = price
+        @stop_loss = stop_loss
+        @symbol = symbol
+        @take_profit = take_profit
+        @type = type
+        @volume = volume
+      end
+
+      def call
+        TradeTransactionResponse.new(**super)
+      end
+
+      private
+
+      attr_reader :cmd, :custom_comment, :expiration, :offset, :order, :price, :stop_loss, :symbol, :take_profit,
+                  :type, :volume
+
+      def command = :tradeTransaction
+
+      def arguments
+        {
+          trade_trans_info: {
+            cmd: Xtb::OPERATIONS[cmd],
+            custom_comment:,
+            expiration:,
+            offset:,
+            order:,
+            price:,
+            sl: stop_loss,
+            symbol:,
+            tp: take_profit,
+            type: Xtb::TRADE_TRANSACTION_TYPES[type],
+            volume:
+          }
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/trades.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getTrades
+    class Trades < Command
+      # @param opened_only [Boolean]
+      def initialize(opened_only)
+        @opened_only = opened_only
+      end
+
+      def call
+        super.map { |record| Xtb::TradeRecord.new(**record) }
+      end
+
+      private
+
+      attr_reader :opened_only
+
+      def command = :getTrades
+
+      def arguments
+        {
+          opened_only:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/trades_history.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getTrades
+    class TradesHistory < Command
+      # @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| Xtb::TradeRecord.new(**record) }
+      end
+
+      private
+
+      attr_reader :end_time, :start_time
+
+      def command = :getTradesHistory
+
+      def arguments
+        {
+          end: end_time,
+          start: start_time
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/trading_hours.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getTradingHours
+    class TradingHours < Command
+      TradingHoursRecord = Data.define(:quotes, :symbol, :trading) do
+        # Represents both quotes and trading times records.
+        TimesRecord = Data.define(:day, :from_t, :to_t)
+
+        def initialize(symbol:, quotes: TimesRecord.new, trading: TimesRecord.new)
+          super(quotes:, symbol:, trading:)
+        end
+      end
+
+      # @param symbols [Array<String|Symbol>]
+      def initialize(symbols)
+        @symbols = symbols
+      end
+
+      def call
+        super.map { |record| TradingHoursRecord.new(**record) }
+      end
+
+      private
+
+      attr_reader :symbols
+
+      def command = :getTradingHours
+
+      def arguments
+        {
+          symbols:
+        }
+      end
+    end
+  end
+end

data/lib/xtb/http/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Xtb
+  module Http
+    # http://developers.xstore.pro/documentation/2.5.0#getVersion
+    class Version < Command
+      VersionResponse = Data.define(:version)
+
+      def call
+        VersionResponse.new(**super)
+      end
+
+      private
+
+      def command = :getVersion
+    end
+  end
+end

data/lib/xtb/http.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'http/client'
+
+# commands
+require_relative 'http/command'
+require_relative 'http/all_symbols'
+require_relative 'http/calendar'
+require_relative 'http/chart_last_request'
+require_relative 'http/chart_range_request'
+require_relative 'http/commission_def'
+require_relative 'http/current_user_data'
+require_relative 'http/margin_level'
+require_relative 'http/margin_trade'
+require_relative 'http/news'
+require_relative 'http/profit_calculation'
+require_relative 'http/server_time'
+require_relative 'http/step_rules'
+require_relative 'http/symbol'
+require_relative 'http/tick_prices'
+require_relative 'http/trade_records'
+require_relative 'http/trades'
+require_relative 'http/trades_history'
+require_relative 'http/trading_hours'
+require_relative 'http/version'
+
+module Xtb
+  module Http # :nodoc:
+  end
+end

data/lib/xtb/request_queue.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require_relative 'config'
+
+module Xtb
+  # Module provides a mechanism to limit the number of requests to the broker server.
+  module RequestQueue
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      private
+
+      def with_request_queue(&block)
+        queue << block
+        queue << wait_proc
+
+        result = queue.pop.call
+        queue.pop.call
+
+        result
+      end
+
+      def queue
+        @queue ||= Queue.new
+      end
+
+      def wait_proc
+        proc { sleep(min_request_interval) }
+      end
+
+      def min_request_interval
+        Config.min_request_interval
+      end
+    end
+  end
+end

data/lib/xtb/version.rb

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

data/lib/xtb/web_socket/client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Xtb
+  module WebSocket
+    class Client
+      include RequestQueue
+
+      def initialize() end
+    end
+  end
+end

data/lib/xtb/web_socket.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Xtb
+  module WebSocket
+  end
+end

data/lib/xtb.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'xtb/version'
+require_relative 'xtb/http'
+require_relative 'xtb/web_socket'
+require_relative 'xtb/config'
+
+module Xtb
+  # Periods in minutes.
+  PERIODS = {
+    m1: 1,
+    m5: 5,
+    m15: 15,
+    m30: 30,
+    h1: 60,
+    h4: 240,
+    d1: 1440,
+    w1: 10_080,
+    mn1: 43_200
+  }.freeze
+
+  # Operations with XTB broker codes.
+  OPERATIONS = {
+    buy: 0,
+    sell: 1,
+    buy_limit: 2,
+    sell_limit: 3,
+    buy_stop: 4,
+    sell_stop: 5,
+    balance: 6,
+    credit: 7
+  }.freeze
+
+  # Trade transaction type with XTB broker codes.
+  TRADE_TRANSACTION_TYPES = {
+    open: 0,
+    pending: 1,
+    close: 2,
+    modify: 3,
+    delete: 4
+  }.freeze
+
+  SymbolRecord = Data.define(:ask, :bid, :category_name, :contract_size, :currency, :currency_pair, :currency_profit,
+                             :description, :exemode, :expiration, :group_name, :high, :initial_margin,
+                             :instant_max_volume, :leverage, :long_only, :lot_max, :lot_min, :lot_step, :low,
+                             :margin_hedged, :margin_hedged_strong, :margin_maintenance, :margin_mode, :percentage,
+                             :pips_precision, :precision, :profit_mode, :quote_id, :quote_id_cross, :short_selling,
+                             :spread_raw, :spread_table, :starting, :step_rule_id, :stops_level, :swap_rollover3days,
+                             :swap_enable, :swap_long, :swap_short, :swap_type, :symbol, :tick_size, :tick_value,
+                             :time, :time_string, :trailing_enabled, :type)
+
+  TradeRecord = Data.define(:close_price, :close_time, :close_time_string, :closed, :cmd, :comment, :commission,
+                            :custom_comment, :digits, :expiration, :expiration_string, :margin_rate, :offset,
+                            :open_price, :open_time, :open_time_string, :order, :order2, :position, :profit, :sl,
+                            :storage, :symbol, :timestamp, :tp, :volume)
+end

data/sig/xtb.rbs

@@ -0,0 +1,4 @@
+module Xtb
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: xtb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jacekmaciag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-12 00:00:00.000000000 Z
+dependencies: []
+description: 'The XTB API (xAPI) client for Ruby provides a simple and easy to use
+  interface to interact with XTB API.
+
+  '
+email:
+- jacek.maciag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xtb.rb
+- lib/xtb/config.rb
+- lib/xtb/errors.rb
+- lib/xtb/http.rb
+- lib/xtb/http/all_symbols.rb
+- lib/xtb/http/calendar.rb
+- lib/xtb/http/chart_last_request.rb
+- lib/xtb/http/chart_range_request.rb
+- lib/xtb/http/client.rb
+- lib/xtb/http/command.rb
+- lib/xtb/http/commission_def.rb
+- lib/xtb/http/current_user_data.rb
+- lib/xtb/http/margin_level.rb
+- lib/xtb/http/margin_trade.rb
+- lib/xtb/http/news.rb
+- lib/xtb/http/profit_calculation.rb
+- lib/xtb/http/response.rb
+- lib/xtb/http/server_time.rb
+- lib/xtb/http/ssl_client.rb
+- lib/xtb/http/step_rules.rb
+- lib/xtb/http/symbol.rb
+- lib/xtb/http/tick_prices.rb
+- lib/xtb/http/trade_records.rb
+- lib/xtb/http/trade_transaction.rb
+- lib/xtb/http/trades.rb
+- lib/xtb/http/trades_history.rb
+- lib/xtb/http/trading_hours.rb
+- lib/xtb/http/version.rb
+- lib/xtb/request_queue.rb
+- lib/xtb/version.rb
+- lib/xtb/web_socket.rb
+- lib/xtb/web_socket/client.rb
+- sig/xtb.rbs
+homepage: https://github.com/jacekmaciag/xtb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jacekmaciag/xtb
+  source_code_uri: https://github.com/jacekmaciag/xtb
+  changelog_uri: https://github.com/jacekmaciag/xtb/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: XTB API client for Ruby.
+test_files: []