cryptomarket-sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56104f24b0cf0227d1b07b004a96a0c7bb12f6c0144683fe5286ecf605e229e9
-  data.tar.gz: 1bdebf110497fc4c99fa768ad5f01c4d5d7811f48b90c739b677e84b90d720fd
+  metadata.gz: 62756eac34a0cac0bff07eb60b27f57d35688de29c77db8b9c395bb00d48af2b
+  data.tar.gz: c6326c7df54dbc1069fec07be675f06fc95e8aafa71ac5ed47b6e9a1b97236f4
 SHA512:
-  metadata.gz: b8db890022384ea30bfaf012af54b37e06eb2951874246aa7b363c603a3672a5d35f5a44b2ad6d02f006247818f04283b1327db62573c7374c3e7f6fdf054af5
-  data.tar.gz: 467cd155cee84cb5e67dd57859eb3c1b5227f9549420d4c7e073e815355ce0842fd5b56d5dfb983f16f4c944b4adcc69aea302f923be3c4dc29126fa43681691
+  metadata.gz: d64312e26d144291661b081b8dfde90ea2d65d909392bafc310a4fc3720e8f21a356f47521a70e274ad515558a2c41b75f8a2bcad86d4540f2bb163ece8fb016
+  data.tar.gz: cf5e559cdf9bd29fc578c04387ae837a4fb3f46c15eb5bf502ded24f2f2c41461ee7beceeda536ba03dc9a4a92737147106a717df319da1cb8fd5375c470b164

data/README.md

@@ -5,14 +5,12 @@
 [sign up in CryptoMarket](https://www.cryptomkt.com/account/register).
 
 # Installation
-To install Cryptomarket use pip
+To install Cryptomarket use gem
 ```
-gem install cryptomarket
+gem install cryptomarket-sdk
 ```
 # Documentation
-
-[The api documentation](https://api.exchange.cryptomkt.com/)
-
+This sdk makes use of the [api version 2](https://api.exchange.cryptomkt.com/v2) of cryptomarket
 
 # Quick Start
 
@@ -166,12 +164,11 @@ wsclient.connect
 
 ```
 # Checkout our other SDKs
-<!-- agregar links -->
 
-python sdk
+[node sdk](https://github.com/cryptomkt/cryptomkt-node)
 
-node sdk
+[java sdk](https://github.com/cryptomkt/cryptomkt-java)
 
-java sdk
+[go sdk](https://github.com/cryptomkt/cryptomkt-go)
 
-go sdk
+[python sdk](https://github.com/cryptomkt/cryptomkt-python)

data/lib/cryptomarket/HttpManager.rb

@@ -3,6 +3,7 @@ require 'uri'
 require 'json'
 require 'base64'
 require 'rest-client'
+require_relative 'exceptions'
 
 module Cryptomarket
     class HttpManager
@@ -19,7 +20,7 @@ module Cryptomarket
             timestamp = Time.now.to_i.to_s
             msg = httpMethod + timestamp + @@apiVersion + method
             if not params.nil? and params.keys.any?
-                if httpMethod == 'GET'
+                if httpMethod.upcase == 'GET' or httpMethod.upcase == 'PUT'
                     msg += '?'
                 end
                 msg += URI.encode_www_form params
@@ -32,11 +33,14 @@ module Cryptomarket
         
         def makeRequest(method:, endpoint:, params:nil, public:false)
             uri = URI(@@apiUrl + @@apiVersion + endpoint)
+            if not params.nil?
+                params = Hash[params.sort_by {|key, val| key.to_s }]
+            end
             headers = Hash.new
             if not public
                 headers['Authorization'] = getCredential(method.upcase, endpoint, params)
             end
-            if method.upcase == 'GET' and not params.nil?
+            if (method.upcase == 'GET' or method.upcase =='PUT') and not params.nil?
                 uri.query = URI.encode_www_form params
                 params = nil
             end
@@ -68,4 +72,4 @@ module Cryptomarket
             return parsed_result
         end
     end
-end
+end

data/lib/cryptomarket/client.rb

@@ -630,8 +630,8 @@ module Cryptomarket
         # +String+ +currency+:: the currency code for withdraw
         # +Integer+ +amount+:: the expected withdraw amount
         
-        def getEstimatesWithdrawFee(currency, amount)
-            params = {currency:currency, amount:amount}
+        def getEstimateWithdrawFee(currency, amount)
+            params = {amount:amount, currency:currency}
             return get('account/crypto/estimate-withdraw', params)
         end
 

data/lib/cryptomarket/websocket/accountClient.rb

@@ -3,7 +3,7 @@ require_relative"../utils"
 
 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 Cryptomarket
 
         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 @@ module Cryptomarket
             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

data/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
 

data/lib/cryptomarket/websocket/publicClient.rb

@@ -2,7 +2,6 @@ require "securerandom"
 
 require_relative "wsClientBase"
 require_relative"../utils"
-require_relative "methods"
 
 
 
@@ -15,11 +14,35 @@ module Cryptomarket
         
         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 @@ module Cryptomarket
             end
 
             def buildKey(method, params)
-                methodKey = mapping(method)
+                methodKey = @subscriptionKeys[method]
 
                 symbol =  ''
                 if params.has_key? 'symbol'
@@ -63,6 +86,19 @@ module Cryptomarket
                 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

data/lib/cryptomarket/websocket/tradingClient.rb

@@ -13,8 +13,19 @@ module Cryptomarket
         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

data/lib/cryptomarket/websocket/wsClientBase.rb

@@ -1,5 +1,4 @@
 require_relative "callbackCache"
-require_relative "methods"
 require_relative "orderbookCache"
 require_relative "wsManager"
 require_relative '../exceptions'
@@ -7,9 +6,8 @@ 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 @@ module Cryptomarket
             end
 
             def handleNotification(notification)
-                key = "subscription"
+                key = buildKey(notification["method"])
                 callback = @callbackCache.getSubscriptionCallback(key)
                 if callback.nil?
                     return
@@ -107,6 +105,9 @@ module Cryptomarket
             end
             
             def buildKey(method=nil, params=nil)
+                if @subscriptionKeys.key? method
+                    return @subscriptionKeys[method]
+                end
                 return "subscription"
             end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptomarket-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - T. Ismael Verdugo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client