add balance subscription

redo subscription logic

Author: Insmael

lib/cryptomarket/websocket/accountClient.rb

@@ -3,7 +3,7 @@
 
 module Cryptomarket
     module Websocket
-            
+
         # AccountClient connects via websocket to cryptomarket to get account information of the user. uses SHA256 as auth method and authenticates automatically.
         #
         # +string+ +apiKey+:: the user api key
@@ -12,9 +12,24 @@ module Websocket
 
         class AccountClient < AuthClient
             include Utils
+            
             # Creates a new client and authenticates it to the server
             def initialize(apiKey:, apiSecret:)
-                super(url:"wss://api.exchange.cryptomkt.com/api/2/ws/account", apiKey:apiKey, apiSecret:apiSecret)
+                transaction = "transaction"
+                balance = "balance"
+                super(
+                    url:"wss://api.exchange.cryptomkt.com/api/2/ws/account", 
+                    apiKey:apiKey, 
+                    apiSecret:apiSecret, 
+                    subscriptionKeys:{
+                        "unsubscribeTransactions" => transaction,
+                        "subscribeTransactions" => transaction,
+                        "updateTransaction" => transaction,
+        
+                        "unsubscribeBalance" => balance,
+                        "subscribeBalance" => balance,
+                        "balance" => balance,
+                    })
             end
 
             # get the account balance as a list of balances. non-zero balances only
@@ -105,6 +120,31 @@ def subscribeToTransactions(callback, resultCallback:nil)
             def unsubscribeToTransactions(callback:nil)
                 sendUnsubscription('unsubscribeTransactions', callback, {})
             end
+
+            # subscribes to a feed of balances
+            #
+            # This subscription aims to provide an easy way to be informed of the current balance state. 
+            # If the state has been changed or potentially changed the "balance" event will come with the actual state. 
+            # Please be aware that only non-zero values present.
+            #
+            # https://api.exchange.cryptomkt.com/#subscription-to-the-balance
+            #
+            # +Proc+ +callback+:: A +Proc+ to call with the result data. It takes one argument. a feed of balances
+            # +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 subscribeToBalance(callback, resultCallback:nil)
+                sendSubscription('subscribeBalance', callback, {}, resultCallback)
+            end
+
+            # unsubscribe to the balance feed.
+            #
+            # https://api.exchange.cryptomkt.com/#subscription-to-the-balance
+            #
+            # +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 unsubscribeToBalance(callback:nil)
+                sendUnsubscription('unsubscribeBalance', callback, {})
+            end
         end
     end
 end

lib/cryptomarket/websocket/authClient.rb

@@ -5,10 +5,10 @@ module Cryptomarket
     module Websocket
         class AuthClient < ClientBase
             # Creates a new client
-            def initialize(url:, apiKey:, apiSecret:)
+            def initialize(url:, apiKey:, apiSecret:, subscriptionKeys:)
                 @apiKey = apiKey
                 @apiSecret = apiSecret
-                super url:url
+                super url:url, subscriptionKeys:subscriptionKeys
                 @authed = false
             end
 

lib/cryptomarket/websocket/publicClient.rb

@@ -2,7 +2,6 @@
 
 require_relative "wsClientBase"
 require_relative"../utils"
-require_relative "methods"
 
 
 
@@ -15,11 +14,35 @@ module Websocket
 
         class PublicClient < ClientBase
             include Utils
-            include Methods
 
             def initialize()
+                orderbook = "orderbook"
+                tickers = "tickers"
+                trades = "trades"
+                candles = "candles"
+                super(
+                    url:"wss://api.exchange.cryptomkt.com/api/2/ws/public", 
+                    subscriptionKeys:{
+                        "subscribeTicker" => tickers,
+                        "unsubscribeTicker" => tickers,
+                        "ticker" => tickers,
+    
+                        "subscribeOrderbook" => orderbook,
+                        "unsubscribeOrderbook" => orderbook,
+                        "snapshotOrderbook" => orderbook,
+                        "updateOrderbook" => orderbook,
+    
+                        "subscribeTrades" => trades,
+                        "unsubscribeTrades" => trades,
+                        "snapshotTrades" => trades,
+                        "updateTrades" => trades,
+                        
+                        "subscribeCandles" => candles,
+                        "unsubscribeCandles" => candles,
+                        "snapshotCandles" => candles,
+                        "updateCandles" => candles
+                    })
                 @OBCache = OrderbookCache.new
-                super url:"wss://api.exchange.cryptomkt.com/api/2/ws/public"
             end
 
             def handleNotification(notification)
@@ -49,7 +72,7 @@ def handleNotification(notification)
             end
 
             def buildKey(method, params)
-                methodKey = mapping(method)
+                methodKey = @subscriptionKeys[method]
 
                 symbol =  ''
                 if params.has_key? 'symbol'
@@ -63,6 +86,19 @@ def buildKey(method, params)
                 return key.upcase
             end
 
+            def orderbookFeed(method)
+                return @subscriptionKeys[method] == "orderbook"
+            end
+
+            def tradesFeed(method)
+                return @subscriptionKeys[method] == "trades"
+            end
+
+            def candlesFeed(method)
+                return @subscriptionKeys[method] == "candles"
+            end
+
+
             # Get a list all available currencies on the exchange
             # 
             # https://api.exchange.cryptomkt.com/#get-currencies

lib/cryptomarket/websocket/tradingClient.rb

@@ -13,8 +13,19 @@ module Websocket
         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)
+                reports = "reports"
+                super(
+                    url:"wss://api.exchange.cryptomkt.com/api/2/ws/trading", 
+                    apiKey:apiKey, 
+                    apiSecret:apiSecret, 
+                    subscriptionKeys:{
+                        "subscribeReports" => reports,
+                        "unsubscribeReports" => reports,
+                        "activeOrders" => reports,
+                        "report" => reports,
+                    })
             end
 
             # Subscribe to a feed of trading events of the account

lib/cryptomarket/websocket/wsClientBase.rb

@@ -1,15 +1,13 @@
 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:)
+            def initialize(url:, subscriptionKeys:)
+                @subscriptionKeys = subscriptionKeys
                 @callbackCache = CallbackCache.new
                 @wsmanager = WSManager.new self, url:url
                 @onconnect = ->{}
@@ -98,7 +96,7 @@ def handle(message)
             end
 
             def handleNotification(notification)
-                key = "subscription"
+                key = buildKey(notification["method"])
                 callback = @callbackCache.getSubscriptionCallback(key)
                 if callback.nil?
                     return
@@ -107,6 +105,9 @@ def handleNotification(notification)
             end
 
             def buildKey(method=nil, params=nil)
+                if @subscriptionKeys.key? method
+                    return @subscriptionKeys[method]
+                end
                 return "subscription"
             end
 

tests/websocket/accountSubs.rb

@@ -19,6 +19,7 @@ def teardown
     def test_transaction_subscription
         msg = ""
         callback = Proc.new {|feed|
+            print feed
             if not goodTransaction(feed)
                 msg = "bad transaction"
                 return
@@ -29,8 +30,28 @@ def test_transaction_subscription
         sleep(3)
         @restclient.transferMoneyFromExchangeToBank("EOS", "0.1")
         sleep(3)
+        @wsclient.subscribeToBalance(Proc.new {|feed|
+            print feed
+        })
+        sleep(3)
         @restclient.transferMoneyFromBankToExchange("EOS", "0.1")
         sleep(3)
+        @wsclient.unsubscribeToTransactions()
         assert(msg == "", msg)
     end 
+
+    def test_balance_subscription
+        msg = ""
+        callback = Proc.new {|feed|
+            print feed
+            # if not goodBalances(feed)
+            #     msg = "bad balances"
+            #     return
+            # print feed
+            # end 
+        }
+        @wsclient.subscribeToBalance(callback)
+        sleep(3)
+        @wsclient.unsubscribeToBalance()
+    end
 end