feat: get_converted_candles rest and websocket methods

Author: Insmael

lib/cryptomarket/client.rb

@@ -326,6 +326,31 @@ def get_candles_by_symbol(symbol:, period: nil, sort: nil, from: nil, till: nil,
       )
     end
 
+    # Gets OHLCV data regarding the last price converted to the target currency for all symbols or for the specified symbols
+    #
+    # Candles are used for the representation of a specific symbol as an OHLC chart
+    #
+    #  Conversion from the symbol quote currency to the target currency is the mean of "best" bid price and "best" ask price in the order book. If there is no "best" bid of ask price, the last price is returned.
+    #
+    # Requires no API key Access Rights
+    #
+    # https://api.exchange.cryptomkt.com/#candles
+    #
+    # +String+ +target_currency+:: Target currency for conversion
+    # +String+ +period+:: Optional. A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
+    # +Array[String]+ +symbols+:: Optional. A list of symbols
+    # +String+ +sort+:: Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
+    # +String+ +from+:: Optional. Initial value of the queried interval. As DateTime
+    # +String+ +till+:: Optional. Last value of the queried interval. As DateTime
+    # +Integer+ +limit+:: Optional. Prices per currency pair. Defaul is 100. Min is 1. Max is 1000
+
+    def get_converted_candles(target_currency:, period: nil, symbols: nil, sort: nil, from: nil, till: nil, limit: nil) # rubocop:disable Metrics/ParameterLists
+      public_get(
+        'public/converted/candles',
+        { target_currency: target_currency, symbols: symbols, period: period, sort: sort, from: from, till: till, limit: limit }
+      )
+    end
+
     ######################
     # Spot Trading calls #
     ######################

lib/cryptomarket/websocket/market_data_client.rb

@@ -60,6 +60,29 @@ def subscribe_to_candles(callback:, period:, symbols:, limit: nil, result_callba
                                   intercept_result_callback(result_callback), params)
       end
 
+      # Gets OHLCV data regarding the last price converted to the target currency for all symbols or for the specified symbols
+      #
+      # Candles are used for the representation of a specific symbol as an OHLC chart
+      #
+      #  Conversion from the symbol quote currency to the target currency is the mean of "best" bid price and "best" ask price in the order book. If there is no "best" bid of ask price, the last price is returned.
+      #
+      # Requires no API key Access Rights
+      #
+      # https://api.exchange.cryptomkt.com/#candles
+      #
+      # +String+ +target_currency+:: Target currency for conversion
+      # +String+ +period+:: A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
+      # +Array[String]+ +symbols+:: Optional. A list of symbols
+      # +String+ +from+:: Optional. Initial value of the queried interval. As DateTime
+      # +String+ +till+:: Optional. Last value of the queried interval. As DateTime
+      # +Integer+ +limit+:: Optional. Prices per currency pair. Defaul is 100. Min is 1. Max is 1000
+
+      def subscribe_to_converted_candles(callback:, target_currency:, period:, symbols:, limit: nil, result_callback: nil) # rubocop:disable Metrics/ParameterLists
+        params = { 'target_currency' => target_currency, 'symbols' => symbols, 'limit' => limit }
+        send_channel_subscription("converted/candles/#{period}", callback,
+                                  intercept_result_callback(result_callback), params)
+      end
+
       # subscribe to a feed of mini tickers
       #
       # subscription is for all symbols or for the specified symbols

tests/rest/market_data.rb

@@ -4,7 +4,7 @@
 require_relative '../../lib/cryptomarket/client'
 require_relative '../checks'
 
-class TestMarketDataMethods < Test::Unit::TestCase # rubocop:disable Style/Documentation
+class TestMarketDataMethods < Test::Unit::TestCase # rubocop:disable Style/Documentation,Metrics/ClassLength
   def setup
     @client = Cryptomarket::Client.new
   end
@@ -127,4 +127,13 @@ def test_get_candles_by_symbol
       assert(Check.good_candle(candle))
     end
   end
+
+  def test_get_converted_candles
+    symbols = %w[EOSETH BTCUSDT]
+    result = @client.get_converted_candles(symbols: symbols, limit: 2, target_currency: 'usdt')
+    result['data'].each do |symbol, candles|
+      assert(symbols.include?(symbol))
+      candles.each { |val| assert(Check.good_candle(val)) }
+    end
+  end
 end

tests/websocket/market_data_client.rb

@@ -45,6 +45,17 @@ def test_candles_subscriptions
     assert(veredict_checker.good_veredict?)
   end
 
+  def test_converted_candles_subscription
+    veredict_checker = VeredictChecker.new
+    @wsclient.subscribe_to_converted_candles(
+      period: 'M1', target_currency: 'usdt', symbols: %w[eoseth ethbtc], limit: 2,
+      callback: gen_check_notification_hash_list_callback(WSCheck.good_ws_public_candle, veredict_checker),
+      result_callback: gen_result_callback(veredict_checker)
+    )
+    sleep(10 * @@SECOND)
+    assert(veredict_checker.good_veredict?)
+  end
+
   def test_subscribe_to_mini_ticker
     veredict_checker = VeredictChecker.new
     @wsclient.subscribe_to_mini_ticker(