cryptomarket-sdk 1.0.0

data/lib/cryptomarket/websocket/publicClient.rb

@@ -0,0 +1,239 @@
+require "securerandom"
+
+require_relative "wsClientBase"
+require_relative"../utils"
+require_relative "methods"
+
+
+
+
+module Cryptomarket
+    module Websocket
+        # PublicClient connects via websocket to cryptomarket to get market information of the exchange.
+        #
+        # +Proc+ +callback+:: Optional. A +Proc+ to call with the client once the connection is established. if an error ocurrs is return as the fist parameter of the callback: callback(err, client)
+        
+        class PublicClient < ClientBase
+            include Utils
+            include Methods
+
+            def initialize()
+                @OBCache = OrderbookCache.new
+                super url:"wss://api.exchange.cryptomkt.com/api/2/ws/public"
+            end
+
+            def handleNotification(notification)
+                method = notification['method']
+                params = notification['params']
+                key = buildKey(method, params)
+                callback = @callbackCache.getSubscriptionCallback(key)
+                if callback.nil?
+                    return
+                end
+                if orderbookFeed(method)
+                    @OBCache.update(method, key, params)
+                    if @OBCache.orderbookBroken(key)
+                        storeAndSend('subscribeOrderbook', {'symbol' => params['symbol']}, nil)
+                        @OBCache.waitOrderbook(key)
+                        return
+                    end
+                    if @OBCache.orderbookWating(key)
+                        return
+                    end
+                    params = @OBCache.getOrderbook(key)
+                end
+                if candlesFeed(method) or tradesFeed(method)
+                    params = params["data"]
+                end
+                callback.call(params) 
+            end
+
+            def buildKey(method, params)
+                methodKey = mapping(method)
+
+                symbol =  ''
+                if params.has_key? 'symbol'
+                    symbol = params['symbol']
+                end
+                period = ''
+                if params.has_key? 'period'
+                    period = params['period']
+                end
+                key = methodKey + ':' + symbol + ':' + period
+                return key.upcase
+            end
+
+            # Get a list all available currencies on the exchange
+            # 
+            # https://api.exchange.cryptomkt.com/#get-currencies
+            # 
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getCurrencies(callback)
+                sendById("getCurrencies", callback)
+            end
+
+            # Get the data of a currency
+            # 
+            # https://api.exchange.cryptomkt.com/#get-currencies
+            # 
+            # +String+ +currency+:: A currency id
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getCurrency(currency, callback)
+                sendById('getCurrency', callback, {'currency' => currency})
+            end
+
+            # Get a list of the specified symbols or all of them if no symbols are specified
+            # 
+            # A symbol is the combination of the base currency (first one) and quote currency (second one)
+            # 
+            # https://api.exchange.cryptomkt.com/#get-symbols
+            # 
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getSymbols(callback)
+                sendById('getSymbols', callback)
+            end
+
+            # Get a symbol by its id
+            # 
+            # A symbol is the combination of the base currency (first one) and quote currency (second one)
+            # 
+            # https://api.exchange.cryptomkt.com/#get-symbols
+            # 
+            # 
+            # +String+ +symbol+:: A symbol id
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getSymbol(symbol, callback)
+                sendById('getSymbol', callback, {'symbol' => symbol})
+            end
+
+            # Subscribe to a ticker of a symbol
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-ticker
+            # 
+            # +String+ +symbol+:: A symbol to subscribe
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes one argument. The ticker feed
+            # +Proc+ +resultCallback+:: Optional. A function to call with the subscription result. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def subscribeToTicker(symbol, callback, resultCallback=nil)
+                sendSubscription('subscribeTicker', callback, {'symbol' => symbol}, resultCallback)
+            end
+
+            # Unsubscribe to a ticker of a symbol
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-ticker
+            # 
+            # 
+            # +String+ +symbol+:: The symbol to stop the ticker subscribption
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def unsubscribeToTicker(symbol, callback=nil)
+                sendUnsubscription('unsubscribeTicker', callback, {'symbol' => symbol})
+            end
+
+            # Subscribe to the order book of a symbol
+            # 
+            # An Order Book is an electronic list of buy and sell orders for a specific symbol, structured by price level
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-order-book
+            # 
+            # +String+ +symbol+:: The symbol of the orderbook
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes one argument. the order book feed
+            # +Proc+ +resultCallback+:: A function to call with the subscription result. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def subscribeToOrderbook(symbol, callback, resultCallback=nil)
+                sendSubscription('subscribeOrderbook', callback, {'symbol' => symbol}, resultCallback)
+            end
+
+            # Unsubscribe to an order book of a symbol
+            # 
+            # An Order Book is an electronic list of buy and sell orders for a specific symbol, structured by price level
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-order-book
+            # 
+            # +String+ +symbol+:: The symbol of the orderbook
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def unsubscribeToOrderbook(symbol, callback=nil)
+                sendUnsubscription('unsubscribeOrderbook', callback, {'symbol' => symbol})
+            end
+
+            # Subscribe to the trades of a symbol
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-trades
+            # 
+            # +String+ +symbol+:: The symbol of the trades
+            # +Integer+ [limit] Optional. Maximum number of trades in the first feed, the nexts feeds have one trade
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes one argument. the trades feed
+            # +Proc+ +resultCallback+:: Optional. A function to call with the subscription result. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def subscribeToTrades(symbol, callback, limit=nil, resultCallback=nil)
+                params = {'symbol' => symbol}
+                sendSubscription('subscribeTrades', callback, params, resultCallback)
+            end
+            
+            # Unsubscribe to a trades of a symbol
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-trades
+            # 
+            # +String+ +symbol+:: The symbol of the trades
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def unsubscribeToTrades(symbol, callback=nil)
+                sendUnsubscription('unsubscribeTrades', callback, {'symbol' => symbol})
+            end
+
+
+            # Get trades of the specified symbol
+            # 
+            # https://api.exchange.cryptomkt.com/#get-trades
+            # 
+            # +String+ +symbol+:: The symbol to get the trades
+            # +String+ +sort+:: Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
+            # +String+ +from+:: Optional. Initial value of the queried interval.
+            # +String+ +till+:: Optional. Last value of the queried interval.
+            # +Integer+ +limit+:: Optional. Trades per query. Defaul is 100. Max is 1000
+            # +Integer+ +offset+:: Optional. Default is 0. Max is 100000
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getTrades(symbol, callback, from:nil, till:nil, limit:nil, offset:nil)
+                params = {'symbol' => symbol}
+                extend_hash_with_pagination! params, from:from, till:till, limit:limit, offset:offset
+                sendById('getTrades', callback, params)
+            end
+            
+            # Subscribe to the candles of a symbol, at the given period
+            # 
+            # Candels are used for OHLC representation
+            # 
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-candles
+            # 
+            # +String+ +symbol+:: A symbol to recieve a candle feed
+            # +String+ period A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month)
+            # +Integer+ +limit+:: Optional. Maximum number of candles in the first feed. The rest of the feeds have one candle
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes one argument. recieves the candle feed
+            # +Proc+ +resultCallback+:: Optional. A callable to call with the subscription result. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def subscribeToCandles(symbol, period, limit, callback, resultCallback=nil)
+                params = {'symbol' => symbol, 'period' => period}
+                sendSubscription('subscribeCandles', callback, params, resultCallback)
+            end
+
+            # Unsubscribe to the candles of a symbol at a given period
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-candles
+            # 
+            # +String+ +symbol+:: The symbol of the candles
+            # +String+ period 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month)
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def unsubscribeToCandles(symbol, period, callback=nil)
+                sendUnsubscription('unsubscribeCandles', callback, {'symbol'=> symbol, 'period' => period})
+            end
+        end
+    end
+end

data/lib/cryptomarket/websocket/tradingClient.rb

@@ -0,0 +1,123 @@
+require_relative "authClient"
+require_relative"../utils"
+
+module Cryptomarket
+    module Websocket
+            
+        # TradingClient connects via websocket to cryptomarket to enable the user to manage orders. uses SHA256 as auth method and authenticates automatically.
+        #
+        # +string+ +apiKey+:: the user api key
+        # +string+ +apiSecret+:: the user api secret
+        # +Proc+ +callback+:: Optional. A +Proc+ to call with the client once the connection is established and the authentication is successful. if an error ocurrs is return as the fist parameter of the callback: callback(err, client)
+        
+        class TradingClient < AuthClient
+            include Utils
+            # Creates a new client
+            def initialize(apiKey:, apiSecret:)
+                super(url:"wss://api.exchange.cryptomkt.com/api/2/ws/trading", apiKey:apiKey, apiSecret:apiSecret)
+            end
+
+            # Subscribe to a feed of trading events of the account
+            # 
+            # Requires authentication
+            # 
+            # https://api.exchange.cryptomkt.com/#subscribe-to-reports
+            # 
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes one argument. a feed of reports
+            # +Proc+ +resultCallback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def subscribeToReports(callback, resultCallback=nil)
+                sendSubscription('subscribeReports', callback, {}, resultCallback)
+            end
+
+            # Create a new order
+            # 
+            # Requires authentication
+            # 
+            # https://api.exchange.cryptomkt.com/#place-new-order
+            # 
+            # +String+ +clientOrderId+:: If given must be unique within the trading day, including all active orders. If not given, is generated by the server
+            # +String+ +symbol+:: Trading symbol
+            # +String+ +side+:: 'buy' or 'sell'
+            # +String+ +quantity+:: Order quantity
+            # +String+ +type+:: Optional. 'limit', 'market', 'stopLimit' or 'stopMarket'. Default is 'limit'
+            # +String+ +timeInForce+:: Optional. 'GTC', 'IOC', 'FOK', 'Day', 'GTD'
+            # +String+ +price+:: Required for 'limit' and 'stopLimit'. limit price of the order
+            # +String+ +stopPrice+:: Required for 'stopLimit' and 'stopMarket' orders. stop price of the order
+            # +String+ +expireTime+:: Required for orders with timeInForce = 'GDT'
+            # +bool+ +strictValidate+:: Optional. If False, the server rounds half down for tickerSize and quantityIncrement. Example of ETHBTC: tickSize = '0.000001', then price '0.046016' is valid, '0.0460165' is invalid
+            # +bool+ +postOnly+:: Optional. If True, your postOnly order causes a match with a pre-existing order as a taker, then the order will be cancelled
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def createOrder(clientOrderId:, symbol:, side:, quantity:, type:nil, timeInForce:nil, price:nil, stopPrice:nil, expireTime:nil, strictValidate:nil, postOnly:nil, callback:nil)
+                params = {'symbol' => symbol, 'side' => side, 'quantity' => quantity, 'clientOrderId' => clientOrderId}
+                extend_hash_with_order_params! params, type:type, timeInForce:timeInForce, price:price, stopPrice:stopPrice, expireTime:expireTime, strictValidate:strictValidate, postOnly:postOnly
+                sendById('newOrder', callback, params)
+            end
+
+            # Cancel the order with ClientOrderId
+            # 
+            # Requires authentication
+            # 
+            # https://api.exchange.cryptomkt.com/#cancel-order
+            # 
+            # +String+ +clientOrderId+:: The client order id of the order to cancel
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def cancelOrder(clientOrderId, callback:nil)
+                sendById('cancelOrder', callback, {'clientOrderId' => clientOrderId})
+            end
+
+            # Rewrites an order, canceling it or replacing it
+            # 
+            # The Cancel/Replace request is used to change the parameters of an existing order and to change the quantity or price attribute of an open order
+            # 
+            # Do not use this request to cancel the quantity remaining in an outstanding order. Use the cancel_order for this purpose
+            # 
+            # It is stipulated that a newly entered order cancels a prior order that has been entered, but not yet executed
+            # 
+            # Requires authentication
+            # 
+            # https://api.exchange.cryptomkt.com/#cancel-replace-order
+            # 
+            # +String+ +clientOrderId+:: The client id of the order to modify
+            # +String+ +requestClientId+:: The new id for the modified order
+            # +String+ +quantity+:: The new quantity of the order
+            # +String+ +price+:: The new price of the order
+            # +bool+ +strictValidate+:: Optional. If False, the server rounds half down for tickerSize and quantityIncrement. Example of ETHBTC: tickSize = '0.000001', then price '0.046016' is valid, '0.0460165' is invalid
+            # +Proc+ +callback+:: Optional. A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def replaceOrder(clientOrderId:, requestClientId:, quantity:, price:, strictValidate:nil, callback:nil)
+                params = {'clientOrderId' => clientOrderId, 'requestClientId' => requestClientId, 'quantity' => quantity, 'price' => price}
+                if not strictValidate.nil?
+                    params['strictValidate'] = strictValidate
+                end
+                sendById('cancelReplaceOrder', callback, params)
+            end
+
+            # Get the account active orders
+            # 
+            # Requires authentication
+            # 
+            # https://api.exchange.cryptomkt.com/#get-active-orders-2
+            # 
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getActiveOrders(callback)
+                sendById('getOrders', callback)
+            end
+
+            # Get the user trading balance
+            # 
+            # Requires authentication
+            # 
+            # https://api.exchange.cryptomkt.com/#get-trading-balance
+            # 
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes two arguments, err and result. err is None for successful calls, result is None for calls with error: Proc.new {|err, result| ...}
+            
+            def getTradingBalance(callback)
+                sendById('getTradingBalance', callback)
+            end
+        end
+    end
+end

data/lib/cryptomarket/websocket/wsClientBase.rb

@@ -0,0 +1,157 @@
+require_relative "callbackCache"
+require_relative "methods"
+require_relative "orderbookCache"
+require_relative "wsManager"
+require_relative '../exceptions'
+
+module Cryptomarket
+    module Websocket
+        class ClientBase
+            include Methods
+
+            def initialize(url:)
+                @callbackCache = CallbackCache.new
+                @wsmanager = WSManager.new self, url:url
+                @onconnect = ->{}
+                @onerror = ->(error){}
+                @onclose = ->{}
+            end
+
+            def connected?
+                return @wsmanager.connected?
+            end
+
+            def close()
+                @wsmanager.close()
+            end
+
+            # connects via websocket to the exchange, it blocks until the connection is stablished
+            def connect()
+                @wsmanager.connect()
+                while (not @wsmanager.connected?)
+                    sleep(1)
+                end
+            end
+
+            def on_open()
+                @onconnect.call()
+            end
+
+            def onconnect=(callback=nil, &block)
+                callback = callback || block
+                @onconnect = callback
+            end
+
+            def onconnect()
+                @onconnect.call()
+            end
+
+            def onerror=(callback=nil, &block)
+                callback = callback || block
+                @onerror = callback
+            end
+
+            def onerror(error)
+                @onerror.call(error)
+            end
+
+            def onclose=(callback=nil, &block)
+                callback = callback || block
+                @onclose = callback
+            end
+
+            def onclose()
+                @onclose.call()
+            end
+
+            def sendSubscription(method, callback, params, resultCallback)
+                key = buildKey(method, params)
+                @callbackCache.storeSubscriptionCallback(key, callback)
+                storeAndSend(method, params, resultCallback)
+            end
+
+            def sendUnsubscription(method, callback, params)
+                key = buildKey(method, params)
+                @callbackCache.deleteSubscriptionCallback(key)
+                storeAndSend(method, params, callback)
+            end
+            
+            def sendById(method, callback, params={})
+                storeAndSend(method, params, callback)
+            end
+            
+            def storeAndSend(method, params, callbackToStore=nil)
+                payload = {'method' => method, 'params' => params}
+                if not callbackToStore.nil?
+                    id = @callbackCache.storeCallback(callbackToStore)
+                    payload['id'] = id
+                end
+                @wsmanager.send(payload)
+            end
+
+            def handle(message)
+                if message.has_key? 'method'
+                    handleNotification(message)
+                elsif message.has_key? 'id'
+                    handleResponse(message)
+                end
+            end
+
+            def handleNotification(notification)
+                key = "subscription"
+                callback = @callbackCache.getSubscriptionCallback(key)
+                if callback.nil?
+                    return
+                end
+                callback.call(notification["params"]) 
+            end
+            
+            def buildKey(method=nil, params=nil)
+                return "subscription"
+            end
+
+            def handleResponse(response)
+                id = response['id']
+                if id.nil? 
+                    return 
+                end
+                callback = @callbackCache.popCallback(id)
+                if callback.nil?
+                    return
+                end
+                if response.has_key? 'error'
+                    callback.call(Cryptomarket::APIException.new(response['error']), nil)
+                    return
+                elsif
+                    result = response['result']
+                    if result.is_a?(Hash) and result.has_key? 'data'
+                        callback.call(nil, result['data'])
+                    else
+                        callback.call(nil, result)
+                    end
+                end
+            end
+
+            def handleNotification(notification)
+                key = "subscription"
+                callback = @callbackCache.getSubscriptionCallback(key)
+                if callback.nil?
+                    return
+                end
+                if notification["params"].kind_of?(Array)
+                    notification["params"].each{|feed| callback.call(feed)}
+                else
+                    callback.call(notification["params"]) 
+                end
+            end
+
+            def buildKey(method=nil, params=nil)
+                return "subscription"
+            end
+
+            def close()
+                @wsmanager.close()
+            end
+        end
+    end
+end