kucoin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06881a46d3828d1c9ab08cdba0362e3b4ba9468c0b60ca202147ba179ad19acb'
-  data.tar.gz: 4f8446da98f48191191156883dbbfccff95fbe69dc491090ebae2169b7cd4f46
+  metadata.gz: 8eeeda2d6f7015e9dc44aaa40a8848c1672bdc9e16c83eaf70fbb1871bf4e64c
+  data.tar.gz: 0d249646f09eb52cd1136ae0e1823da00726d5e63f6cf081904bba1b1b22eec6
 SHA512:
-  metadata.gz: 39360039bfdccae95c1707c739fc046bea43bde9b636fb6c5b555a840d4215d326de8f650054130d5da3404ea55895ff6958fcce38e7a97e08da1611216f4ed4
-  data.tar.gz: 4628d521bac0895dbb9b4727875e64fda92ab0e7998eaf7b9e0406906012f0d1a341eeae62de18fecc487cc5ebffd16162c3aa4c821283bf8299c6e3b21e0b5e
+  metadata.gz: babd57f307e67dfecb44562a434c6cca0ae02554345aae8773ce16335f5c35f2f24d013b7ca9b59b4d3941a40c1eed6caa92fb7e945befab9e54b5e02cc8d479
+  data.tar.gz: 1c5a8fdaca76c44eac278d36f018595dadd284f41f572833a5b1d89c05eb1219656ef1ec981f403f4452d9276d7cfab329036b9838a6fec8a858c7d2d1b082b3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kucoin (0.1.0)
+    kucoin (0.1.1)
       addressable (>= 2.5.2)
       faraday (>= 0.13)
       faraday_middleware (>= 0.12.2)

data/README.md

@@ -42,6 +42,9 @@ client = Kucoin::Rest::Client.new
 client.ticker("HPB-ETH")
 ```
 
+## Status
+
+Full rspec coverage suit will be added shortly. Almost all API endpoints have been implemented. Feel free to fork the repo and submit PRs for any missing endpoints!
 
 ## Development
 

data/lib/kucoin.rb

@@ -27,6 +27,7 @@ require "kucoin/models/coin"
 require "kucoin/models/coin_address"
 require "kucoin/models/balance"
 require "kucoin/models/deal"
+require "kucoin/models/order"
 require "kucoin/models/user"
 
 require "kucoin/rest/public/currencies"
@@ -43,6 +44,7 @@ require "kucoin/rest/private/invitations"
 require "kucoin/rest/private/transfers"
 require "kucoin/rest/private/balances"
 require "kucoin/rest/private/trading"
+require "kucoin/rest/private/markets"
 
 require "kucoin/rest/errors"
 require "kucoin/rest/authentication"

data/lib/kucoin/models/deal.rb

@@ -6,8 +6,8 @@ module Kucoin
         order_oid:        :string,
         coin_type:        :string,
         coin_type_pair:   :string,
-        deal_direction:   :string,
-        direction:        :string,
+        deal_direction:   :symbol,
+        direction:        :symbol,
         deal_price:       :float,
         amount:           :float,
         deal_value:       :float,

data/lib/kucoin/models/order.rb

@@ -0,0 +1,72 @@
+module Kucoin
+  module Models
+    class Order < Base
+      attr_accessor :deals
+      
+      MAPPING  =   {
+        id:                   :string,
+        type:                 :symbol,
+        direction:            :symbol,
+        created_at:           :time,
+        updated_at:           :time,
+        price:                :float,
+        pending_amount:       :float,
+        deal_amount:          :float,
+        deal_value_total:     :float,
+        coin_type:            :string,
+        fee_total:            :float,
+        user_oid:             :string,
+        coin_type_pair:       :string,
+        deal_price_average:   :float
+      }
+      
+      INDEX_MAPPING = {
+        0 => :created_at,
+        1 => :type,
+        2 => :price,
+        3 => :pending_amount,
+        4 => :deal_amount,
+        5 => :id
+      }
+      
+      def initialize(hash)
+        super(hash)
+        
+        self.id       =   ::Kucoin::Utilities::Parsing.convert_value(hash.fetch("oid", hash.fetch("orderOid", nil)), :string)    if self.id.to_s.empty?
+        self.price    =   ::Kucoin::Utilities::Parsing.convert_value(hash.fetch("price", hash.fetch("orderPrice", nil)), :float) if self.price.nil?
+        
+        dealt         =   hash.dig("dealOrders", "datas")
+        self.deals    =   ::Kucoin::Models::Trade.parse(response) if dealt && dealt.is_a?(Array) && dealt.any?
+      end
+      
+      def self.parse(response)
+        orders              =   []
+        
+        response&.each do |item|
+          data              =   {}
+          
+          item.each_with_index do |value, index|
+            data[INDEX_MAPPING[index]] = value
+          end
+          
+          orders << ::Kucoin::Models::Order.new(data)
+        end
+        
+        return orders
+      end
+      
+      def self.parse_map(response)
+        orders        =     []
+        
+        response&.each do |type, collection|
+          collection.each do |item|
+            orders << ::Kucoin::Models::Order.new(item)
+          end
+        end
+        
+        return orders
+      end
+      
+    end
+  end
+end

data/lib/kucoin/models/order_book.rb

@@ -3,7 +3,7 @@ module Kucoin
     class OrderBook
       attr_accessor :symbol, :timestamp, :asks, :bids
       
-      ARRAY_MAPPING         =   {
+      INDEX_MAPPING         =   {
         0 => :price,
         1 => :amount,
         2 => :volume
@@ -36,7 +36,7 @@ module Kucoin
           data              =   {}
           
           item.each_with_index do |value, index|
-            data[ARRAY_MAPPING[index]] = value
+            data[INDEX_MAPPING[index]] = value
           end
           
           case type

data/lib/kucoin/models/ticker.rb

@@ -17,7 +17,9 @@ module Kucoin
         datetime:         :time,
         vol:              :float,
         low:              :float,
-        change_rate:      :float
+        change_rate:      :float,
+        stick:            :boolean,
+        fav:              :boolean
       }
     end
   end

data/lib/kucoin/models/trade.rb

@@ -1,7 +1,7 @@
 module Kucoin
   module Models
     class Trade < Base
-      ARRAY_MAPPING     =   {
+      INDEX_MAPPING     =   {
         0 => "timestamp",
         1 => "order_type",
         2 => "price",
@@ -24,7 +24,7 @@ module Kucoin
           data              =   {}
           
           item.each_with_index do |value, index|
-            data[ARRAY_MAPPING[index]] = value
+            data[INDEX_MAPPING[index]] = value
           end
           
           trades << ::Kucoin::Models::Trade.new(data)

data/lib/kucoin/rest/client.rb

@@ -25,6 +25,7 @@ module Kucoin
       include ::Kucoin::Rest::Private::Transfers
       include ::Kucoin::Rest::Private::Balances
       include ::Kucoin::Rest::Private::Trading
+      include ::Kucoin::Rest::Private::Markets
             
       def configured?
         !self.configuration.key.to_s.empty? && !self.configuration.secret.to_s.empty?
@@ -81,7 +82,7 @@ module Kucoin
           builder.adapter self.configuration.faraday.fetch(:adapter, :net_http)
         end
     
-        case method
+        response = case method
           when :get
             connection.get do |request|
               request.params  =   params if params && !params.empty?
@@ -92,6 +93,8 @@ module Kucoin
               request.params  =   params if params && !params.empty?
             end&.body
         end
+        
+        parse(response)
       end
             
     end

data/lib/kucoin/rest/private/balances.rb

@@ -12,19 +12,19 @@ module Kucoin
           params    =   {type: type, status: status, limit: limit, page: page}
           params.delete_if { |key, value| value.nil? }
           
-          parse(get("/account/#{coin}/wallet/records", params: params, options: options))&.fetch("data", {})
+          get("/account/#{coin}/wallet/records", params: params, options: options)&.fetch("data", {})
         end
         
         def coin_balance(coin, options: {})
           options.merge!(authenticate: true)          
           
-          response  =   parse(get("/account/#{coin}/balance", options: options))&.fetch("data", {})
+          response  =   get("/account/#{coin}/balance", options: options)&.fetch("data", {})
           ::Kucoin::Models::Balance.new(response) if response
         end
         
         def balance(options: {})
           options.merge!(authenticate: true)          
-          response  =   parse(get("/account/balance", options: options))&.fetch("data", {})
+          response  =   get("/account/balance", options: options)&.fetch("data", {})
           ::Kucoin::Models::Balance.parse(response) if response
         end
       

data/lib/kucoin/rest/private/invitations.rb

@@ -5,17 +5,17 @@ module Kucoin
         
         def invitation_count(options: {})
           options.merge!(authenticate: true)
-          parse(get("/referrer/descendant/count", options: options))&.fetch("data", {})
+          get("/referrer/descendant/count", options: options)&.fetch("data", {})
         end
         
         def promotion_reward(options: {})
           options.merge!(authenticate: true)
-          parse(get("/account/promotion/info", options: options))&.fetch("data", {})
+          get("/account/promotion/info", options: options)&.fetch("data", {})
         end
         
         def promotion_summary(options: {})
           options.merge!(authenticate: true)
-          parse(get("/account/promotion/sum", options: options))&.fetch("data", {})
+          get("/account/promotion/sum", options: options)&.fetch("data", {})
         end
       
       end

data/lib/kucoin/rest/private/markets.rb

@@ -0,0 +1,38 @@
+module Kucoin
+  module Rest
+    module Private
+      module Markets
+        
+        # Market: BTC, ETH, etc.
+        # Symbol: HPB-ETH, ITC-ETH etc.
+        # Filter: FAVOURITE / STICK
+        
+        def user_market_symbols(market: nil, symbol: nil, filter: nil, options: {})
+          options.merge!(authenticate: true)
+          
+          params      =   {
+            market: market.to_s.upcase,
+            symbol: symbol.to_s.upcase,
+            filter: filter.to_s.upcase
+          }
+          
+          params.delete_if { |key, value| value.nil? || value.to_s.empty? }
+          
+          response    =   get("/market/symbols", params: params, options: options)&.fetch("data", {})
+          ::Kucoin::Models::Ticker.parse(response) if response
+        end
+        
+        def stick_symbols(options: {})
+          options.merge!(authenticate: true)
+          response    =   get("/market/stick-symbols", params: {}, options: options)&.fetch("data", {})
+        end
+        
+        def favorite_symbols(options: {})
+          options.merge!(authenticate: true)
+          response    =   get("/market/fav-symbols", params: {}, options: options)&.fetch("data", {})
+        end
+      
+      end
+    end
+  end
+end

data/lib/kucoin/rest/private/trading.rb

@@ -14,14 +14,16 @@ module Kucoin
         def create_order(symbol, type: :buy, price:, amount:, options: {})
           options.merge!(authenticate: true)
 
-          payload   =     {
+          payload   =   {
             symbol: symbol.to_s.upcase,
             type:   type.to_s.upcase,
             price:  price,
             amount: amount
           }
           
-          parse(post("/order", data: payload, options: options))
+          response  =   post("/order", data: payload, options: options)
+
+          return {success: response&.fetch("success", false), id: response&.dig("data", "orderOid")}
         end
         
         def cancel_order(symbol, type: :buy, order_id:, options: {})
@@ -32,10 +34,10 @@ module Kucoin
             type:     type.to_s.upcase
           }
           
-          response  =   parse(post("/#{symbol}/cancel-order", data: payload, options: options))
+          post("/#{symbol}/cancel-order", data: payload, options: options)&.fetch("success", false)
         end
         
-        def cancel_all_orders(symbol, type: :buy, options: {})
+        def cancel_all_orders(symbol, type: nil, options: {})
           options.merge!(authenticate: true)
           
           payload   =     {
@@ -43,7 +45,9 @@ module Kucoin
             type:     type.to_s.upcase
           }
           
-          response  =   parse(post("/order/cancel-all", data: payload, options: options))
+          payload.delete_if { |key, value| value.nil? || value.to_s.empty? }
+          
+          post("/order/cancel-all", data: payload, options: options)&.fetch("success", false)
         end
         
         def active_orders(symbol, type: :buy, options: {})
@@ -54,10 +58,23 @@ module Kucoin
             type:   type.to_s.upcase
           }
           
-          response  =   parse(get("/order/active", params: params, options: options))
+          response  =   get("/order/active", params: params, options: options)&.fetch("data", [])
+          ::Kucoin::Models::Order.parse(response) if response
+        end
+        
+        def active_orders_map(symbol, type: :buy, options: {})
+          options.merge!(authenticate: true)
+          
+          params    =   {
+            symbol: symbol.to_s.upcase,
+            type:   type.to_s.upcase
+          }
+          
+          response  =   get("/order/active-map", params: params, options: options)&.fetch("data", {})
+          ::Kucoin::Models::Order.parse_map(response) if response
         end
         
-        def dealt_orders(symbol: nil, type: nil, before: nil, since: nil, limit: nil, page: nil, options: {})
+        def dealt_orders(symbol, type: nil, before: nil, since: nil, limit: nil, page: nil, options: {})
           options.merge!(authenticate: true)
           
           params    =   {
@@ -71,7 +88,7 @@ module Kucoin
           
           params.delete_if { |key, value| value.nil? }
           
-          response  =   parse(get("/order/dealt", params: params, options: options))&.dig("data", "datas")
+          response  =   get("/order/dealt", params: params, options: options)&.dig("data", "datas")
           ::Kucoin::Models::Deal.parse(response) if response
         end
         
@@ -87,7 +104,7 @@ module Kucoin
           
           params.delete_if { |key, value| value.nil? }
           
-          response  =   parse(get("/deal-orders", params: params, options: options))&.dig("data", "datas")
+          response  =   get("/deal-orders", params: params, options: options)&.dig("data", "datas")
           ::Kucoin::Models::Deal.parse(response) if response
         end
         
@@ -104,7 +121,8 @@ module Kucoin
           
           params.delete_if { |key, value| value.nil? }
           
-          response  =   parse(get("/order/detail", params: params, options: options))&.fetch("data", {})
+          response  =   get("/order/detail", params: params, options: options)&.fetch("data", {})
+          ::Kucoin::Models::Order.new(response) if response
         end
       
       end

data/lib/kucoin/rest/private/transfers.rb

@@ -5,18 +5,18 @@ module Kucoin
         
         def get_coin_address(coin, options: {})
           options.merge!(authenticate: true)
-          response = parse(get("/account/#{coin}/wallet/address", options: options))&.fetch("data", {})
+          response = get("/account/#{coin}/wallet/address", options: options)&.fetch("data", {})
           ::Kucoin::Models::CoinAddress.new(response) if response
         end
         
         def create_withdrawal(coin, amount:, address:, options: {})
           options.merge!(authenticate: true)
-          parse(post("/account/#{coin}/withdraw/apply", data: {coin: coin, amount: amount, address: address}, options: options))
+          post("/account/#{coin}/withdraw/apply", data: {coin: coin, amount: amount, address: address}, options: options)
         end
         
         def cancel_withdrawal(coin, transaction_id:, options: {})
           options.merge!(authenticate: true)
-          parse(post("/account/#{coin}/withdraw/cancel", data: {txOid: transaction_id}, options: options))
+          post("/account/#{coin}/withdraw/cancel", data: {txOid: transaction_id}, options: options)
         end
       
       end

data/lib/kucoin/rest/private/user.rb

@@ -5,7 +5,7 @@ module Kucoin
         
         def user_info(options: {})
           options.merge!(authenticate: true)
-          response = parse(get("/user/info", options: options))&.fetch("data", {})
+          response = get("/user/info", options: options)&.fetch("data", {})
           ::Kucoin::Models::User.new(response) if response
         end
       

data/lib/kucoin/rest/public/currencies.rb

@@ -4,7 +4,7 @@ module Kucoin
       module Currencies
         
         def exchange_rates(options: {})
-          parse(get("/open/currencies", options: options))&.dig("data", "rates")
+          get("/open/currencies", options: options)&.dig("data", "rates")
         end
       
       end

data/lib/kucoin/rest/public/klines.rb

@@ -22,18 +22,18 @@ module Kucoin
           
           params.delete_if { |key, value| value.nil? }
           
-          response  = parse(get("/open/kline", params: params, options: options))&.fetch("data", {})
+          response  = get("/open/kline", params: params, options: options)&.fetch("data", {})
         end
         
         #
         # TradingView related endpoints: 
         # 
         def kline_config(options: {})
-          parse(get("/open/chart/config", options: options))
+          get("/open/chart/config", options: options)
         end
         
         def chart_symbol(symbol, options: {})
-          response    =   parse(get("/open/chart/symbols", params: {symbol: symbol}, options: options))
+          response    =   get("/open/chart/symbols", params: {symbol: symbol}, options: options)
         end
         
         def chart_kline_data(symbol, resolution: :one_hour, from: nil, to: nil, options: {})
@@ -53,7 +53,7 @@ module Kucoin
           
           params.delete_if { |key, value| value.nil? }
           
-          response    =   parse(get("/open/chart/history", params: params, options: options))
+          response    =   get("/open/chart/history", params: params, options: options)
           ::Kucoin::Models::OHLCV.parse(response) if response
         end
         

data/lib/kucoin/rest/public/languages.rb

@@ -4,7 +4,7 @@ module Kucoin
       module Languages
         
         def languages(options: {})
-          parse(get("/open/lang-list", options: options))&.fetch("data", [])
+          get("/open/lang-list", options: options)&.fetch("data", [])
         end
       
       end

data/lib/kucoin/rest/public/markets.rb

@@ -4,26 +4,37 @@ module Kucoin
       module Markets
         
         def markets(options: {})
-          parse(get("/open/markets", options: options))&.fetch("data", {})
+          get("/open/markets", options: options)&.fetch("data", {})
         end
         
-        # /market/open/symbols is also available, seems to be the same endpoint
-        def market_symbols(market, options: {})
-          response    =   parse(get("/open/symbols", params: {market: market}, options: options))&.fetch("data", {})
+        def market_symbols(market: nil, options: {})
+          params      =   {
+            market: market.to_s.upcase,
+          }
+          
+          params.delete_if { |key, value| value.nil? || value.to_s.empty? }
+          
+          response    =   get("/market/open/symbols", params: params, options: options)&.fetch("data", {})
           ::Kucoin::Models::Ticker.parse(response) if response
         end
         
-        def trending_symbols(market, options: {})
-          response    =   parse(get("/market/open/coins-trending", params: {market: market}, options: options))&.fetch("data", {})
+        def trending_symbols(market: nil, options: {})
+          params      =   {
+            market: market.to_s.upcase,
+          }
+          
+          params.delete_if { |key, value| value.nil? || value.to_s.empty? }
+          
+          response    =   get("/market/open/coins-trending", params: params, options: options)&.fetch("data", {})
         end
         
         def coins(options: {})
-          response    =   parse(get("/market/open/coins", options: options))&.fetch("data", {})
+          response    =   get("/market/open/coins", options: options)&.fetch("data", {})
           ::Kucoin::Models::Coin.parse(response) if response
         end
         
         def coin_info(coin, options: {})
-          response    =   parse(get("/market/open/coin-info", params: {coin: coin}, options: options))&.fetch("data", {})
+          response    =   get("/market/open/coin-info", params: {coin: coin}, options: options)&.fetch("data", {})
           ::Kucoin::Models::Coin.new(response) if response
         end
       

data/lib/kucoin/rest/public/orders.rb

@@ -17,7 +17,7 @@ module Kucoin
         
         private
           def get_orders(symbol:, endpoint:, params: {}, type: nil, options: {})
-            response = parse(get(endpoint, params: params, options: options))&.merge("symbol" => symbol)
+            response = get(endpoint, params: params, options: options)&.merge("symbol" => symbol)
             ::Kucoin::Models::OrderBook.new(response, type: type) if response
           end
           

data/lib/kucoin/rest/public/ticker.rb

@@ -4,7 +4,7 @@ module Kucoin
       module Ticker
         
         def ticker(symbol, options: {})
-          response  = parse(get("/open/tick", params: {symbol: symbol}, options: options))&.fetch("data", {})
+          response  = get("/open/tick", params: {symbol: symbol}, options: options)&.fetch("data", {})
           ::Kucoin::Models::Ticker.new(response) if response
         end
       

data/lib/kucoin/rest/public/trades.rb

@@ -12,7 +12,7 @@ module Kucoin
           
           params.delete_if { |key, value| value.nil? }
           
-          response  = parse(get("/open/deal-orders", params: params, options: options))&.fetch("data", {})
+          response  = get("/open/deal-orders", params: params, options: options)&.fetch("data", {})
           ::Kucoin::Models::Trade.parse(response) if response
         end
       

data/lib/kucoin/utilities/parsing.rb

@@ -8,6 +8,8 @@ module Kucoin
             return case type
               when :string
                 value.to_s
+              when :symbol
+                value.to_s.underscore.downcase.to_sym
               when :integer
                 value.to_i
               when :float

data/lib/kucoin/version.rb

@@ -1,3 +1,3 @@
 module Kucoin
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kucoin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sebastian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -168,6 +168,7 @@ files:
 - lib/kucoin/models/coin_address.rb
 - lib/kucoin/models/deal.rb
 - lib/kucoin/models/ohlcv.rb
+- lib/kucoin/models/order.rb
 - lib/kucoin/models/order_book.rb
 - lib/kucoin/models/ticker.rb
 - lib/kucoin/models/trade.rb
@@ -178,6 +179,7 @@ files:
 - lib/kucoin/rest/private/balances.rb
 - lib/kucoin/rest/private/invitations.rb
 - lib/kucoin/rest/private/languages.rb
+- lib/kucoin/rest/private/markets.rb
 - lib/kucoin/rest/private/trading.rb
 - lib/kucoin/rest/private/transfers.rb
 - lib/kucoin/rest/private/user.rb