okcoin-ruby 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 830387957a835f4427a3c83b5b9a51b540147328
-  data.tar.gz: 7716a827c6d2fa7d61ac8ad47cd9a9a1028d6cb4
+  metadata.gz: b23eec84532c011d040c6fa7728ab5efa39b8c18
+  data.tar.gz: f8783b2a32993bc2233aceffff7dfd3c127d65e9
 SHA512:
-  metadata.gz: 07fbdae8dfb02cea01f431ce8f115cda92e5a445abb847eaa166ef5790f8fdf139d80cac712f5691d7fccd7ed9927580950171db6b41ce4d9d3f4c9b84982f5f
-  data.tar.gz: cccbd09133e4ccc261f76bb6abf459db736062540b5aa0050574b57414606c61cf48df42fcd869bee316aebb54d70d2eeb97579296f61a98b6d5a147e3bbf6fb
+  metadata.gz: 27a39fe575d4fb49380fb79df027636dfef5c15d89bd56ddf681fa2fb195ed0094fd7e206102710ca63d7beaf18a0995c8342f64e681e9e5e533716bd3eefff5
+  data.tar.gz: 346ca36c63f846445c6dfba035ca206ce469900a0674a018904a4bfaa900504dbb84123078916c0d1d94e430f919893e124e1308f4ed5da290f1d98964d3f0e5

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.gem

data/README.md

@@ -12,7 +12,7 @@ BTC 15y2a3FKLW89qoDniDMRwsdhrZeHJA1Det
 Add these gems into your Gemfile:
 
 ```ruby
-gem 'okcoin-ruby'
+gem 'okcoin-ruby', '~> 0.0.6'
 gem 'celluloid-websocket-client',  :github => 'ilyacherevkov/celluloid-websocket-client'
 ```
 
@@ -30,6 +30,8 @@ okcoin = Okcoin::Rest.new api_key: ENV['OKCOIN_APIKEY'], secret_key: ENV['OKCOIN
 
 Make requests
 
+[See OKCoin REST API reference](https://www.okcoin.com/about/rest_api.do)
+
 Spot Price
 ```ruby
 okcoin.spot_ticker(pair: "btc_usd")
@@ -43,11 +45,26 @@ Spot Trade
 ```ruby
 okcoin.spot_userinfo
 okcoin.spot_trade(pair: "btc_usd", type: "buy", price:240, amount:1)
+# max 5 orders in spot_batch_trade per request
+okcoin.batch_spot_trade(pair: "btc_usd", type: "buy", orders_data: [{price:3,amount:5,type:'sell'},{price:3,amount:3,type:'buy'},{price:3,amount:3}])
+# max 3 order_ids in spot_cancel per request 
+okcoin.spot_cancel(pair: "btc_usd", order_id: "1234, 2345, 3456")
+# -1 returns all unfilled orders, otherwise return the order specified
+okcoin.spot_order_info(pair: "btc_usd", order_id: -1)
+# max 50 orders per request
+spot_orders_info(pair: "btc_usd", type: 0, order_id: "12345, 2345, 3456")
 ```
 
 Futures Price
 ```ruby
-okcoin.futures_orderbook(pair: "btc_usd", contract: "this_week", items_no: 50)
+okcoin.futures_orderbook(pair: "btc_usd", contract_type: "this_week", items_no: 50, merge: 0)
+okcoin.futures_trades(pair: "btc_usd", contract_type: "this_week")
+okcoin.futures_index(pair: "btc_usd")
+okcoin.exchange_rate
+okcoin.futures_estimated_price(pair: "btc_usd")
+okcoin.futures_trades_history(pair: "btc_usd", date: nil, since: nil)
+okcoin.futures_kandlestick(pair: "btc_usd", type: "30min", contract_type: "this_week", size: 50, since: nil)
+okcoin.futures_hold_amount(pair: "btc_usd", contract_type: "this_week")
 ```
 
 Futures Trade
@@ -57,10 +74,12 @@ okcoin.futures_trade(pair: "btc_usd", amount: 1, type: 1, contract_type: "this_w
 okcoin.futures_cancel(pair: "btc_usd", contract_type: "this_week", order_id: 12345)
 okcoin.futures_order_info(order_id: 12345, symbol: "btc_usd", contract_type: "this_week", status: nil, current_page: nil, page_length: nil)
 okcoin.futures_position(pair: "btc_usd", contract_type: "this_week")
+okcoin.futures_explosive(pair: "btc_usd", contract_type: "this_week", status: 0, current_page: 1, page_length: 50)
+# status - 0: open liquidation orders of last 7 days; 1: filled liquidation orders of last 7 days
 ```
 
 ### 2. WebSocket Example
-
+[See OKCoin WebSocket API reference](https://www.okcoin.com/about/ws_api.do)
 ```ruby
   okcoin = Okcoin::WS.new api_key: ENV['OKCOIN_APIKEY'], secret_key: ENV['OKCOIN_SECRET']
   okcoin.userinfo

data/lib/okcoin-ruby.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'curb'
 require 'celluloid/websocket/client'
 require 'okcoin/rest'

data/lib/okcoin/rest.rb

@@ -9,7 +9,9 @@ class Okcoin
     end
 
     public
+
       # Spot Price API
+
       def spot_ticker(pair: "btc_usd")
         query = { "symbol" => pair }
         get_request(url: "/v1/ticker.do", query: query)
@@ -44,7 +46,7 @@ class Okcoin
 
       def spot_trade(pair:, type:, price:, amount:)
         post_data = initial_post_data
-        
+
         post_data["symbol"] = pair
         post_data["type"] = type
         post_data["amount"] = amount
@@ -53,13 +55,131 @@ class Okcoin
         post_request post_data: post_data, action: "/v1/trade.do"
       end
 
+      def spot_batch_trade(pair:, type:, orders_data:)
+        post_data = initial_post_data
+
+        post_data["symbol"] = pair
+        post_data["type"] = type
+        post_data["orders_data"] = orders_data
+
+        post_request post_data: post_data, action: "/v1/batch_trade.do"
+      end
+
+      def spot_cancel(pair:, order_id:)
+        post_data = initial_post_data
+
+        post_data["symbol"] = pair
+        post_data["order_id"] = order_id
+
+        post_request post_data: post_data, action: "/v1/cancel_order.do"
+      end
+
+      def spot_order_info(pair:, order_id:)
+        post_data = initial_post_data
+
+        post_data["symbol"] = pair
+        post_data["order_id"] = order_id
+
+        post_request post_data: post_data, action: "/v1/order_info.do"
+      end
+
+      def spot_orders_info(pair:, type:, order_id:)
+        post_data = initial_post_data
+
+        post_data["symbol"] = pair
+        post_data["order_id"] = order_id
+        post_data["type"] = type
+
+        post_request post_data: post_data, action: "/v1/orders_info.do"
+      end
+
+      def spot_withdraw(pair: 'btc_usd', trade_pwd:, withdraw_address:, withdraw_amount:, chargefee: 0.0001)
+        post_data = initial_post_data
+
+        post_data['symbol'] = pair
+        post_data['chargefee'] = chargefee
+        post_data['trade_pwd'] = trade_pwd
+        post_data['withdraw_address'] = withdraw_address
+        post_data['withdraw_amount'] = withdraw_amount
+        post_request post_data: post_data, action: "/v1/withdraw.do"
+      end
+
+      def spot_cancel_withdraw(pair: 'btc_usd', withdraw_id:)
+        post_data = initial_post_data
+
+        post_data['symbol'] = pair
+        post_data['withdraw_id'] = withdraw_id
+        post_request post_data: post_data, action: "/v1/cancel_withdraw.do"
+      end
+
+      def spot_withdraw_info(pair: 'btc_usd', withdraw_id:)
+        post_data = initial_post_data
+
+        post_data['symbol'] = pair
+        post_data['withdraw_id'] = withdraw_id
+        post_request post_data: post_data, action: "/v1/withdraw_info.do"
+      end
+
+      # type 0：deposits 1 ：withdraw
+      def spot_account_records(pair: 'btc_usd', type: 1, current_page: 1, page_length: 50)
+        post_data = initial_post_data
+
+        post_data['symbol'] = pair
+        post_data['type'] = type
+        post_data['current_page'] = current_page
+        post_data['page_length'] = page_length
+
+        post_request post_data: post_data, action: "/v1/account_records.do"
+      end
+
       # Futures Price API
-      def futures_orderbook(pair:, contract:, items_no: 50)
-        query = { "symbol" => pair, "contractType" => contract, "size" => items_no }
+
+      def futures_ticker(pair: "btc_usd", contract_type: "this_week")
+        query = { "symbol" => pair, "contract_type" => contract_type }
+        get_request(url: "/v1/future_ticker.do", query: query)
+      end
+
+      def futures_orderbook(pair: "btc_usd", contract_type: "this_week", items_no: 50, merge: 0)
+        query = { "symbol" => pair, "contract_type" => contract_type, "size" => items_no, "merge" => merge }
         get_request(url: "/future_depth.do", query: query)
       end
 
+      def futures_trades(pair: "btc_usd", contract_type: "this_week")
+        query = { "symbol" => pair, "contract_type" => since }
+        get_request(url: "/v1/trades.do", query: query)
+      end
+
+      def futures_index(pair: "btc_usd")
+        query = { "symbol" => pair }
+        get_request(url: "/v1/future_index.do", query: query)
+      end
+
+      def exchange_rate
+        get_request(url: "/v1/exchange_rate.do")
+      end
+
+      def futures_estimated_price(pair: "btc_usd")
+        query = { "symbol" => pair }
+        get_request(url: "/v1/future_estimated_price.do", query: query)
+      end
+
+      def futures_trades_history(pair: "btc_usd", date:, since:)
+        query = { "symbol" => pair, "date" => date, "since" => since }
+        get_request(url: "/v1/future_trades_history.do", query: query)
+      end
+
+      def futures_kandlestick(pair: "btc_usd", type: "30min", contract_type: "this_week", size: 50, since: nil)
+        query = { "symbol" => pair, "type" => type, "contract_type" => contract_type, "size" => size, "since" => since }
+        get_request(url: "/v1/future_kline.do", query: query)
+      end
+
+      def futures_hold_amount(pair: "btc_usd", contract_type: "this_week")
+        query = { "symbol" => pair, "contract_type" => contract_type }
+        get_request(url: "/v1/future_hold_amount.do", query: query)
+      end
+
       # Futures Trading API
+
       def futures_userinfo
         post_data = initial_post_data
         post_request post_data: post_data, action: "/v1/future_userinfo.do"
@@ -109,13 +229,28 @@ class Okcoin
         post_request post_data: post_data, action: "/v1/future_position.do"
       end
 
+      def futures_explosive(pair:, contract_type:, status:, current_page:, page_length:)
+        post_data = initial_post_data
+        post_data["symbol"] = pair
+        post_data["contract_type"] = contract_type
+        post_data["status"] = status
+        post_data["current_page"] = current_page
+        post_data["page_length"] = page_length
+
+        post_request post_data: post_data, action: "/v1/future_explosive.do"
+      end
+
     private 
 
+      def logger
+        @logger ||= Object.const_defined?(:Rails) ? Rails.logger : Logger.new(STDOUT)
+      end
+
       def handle_timeouts
         begin
           yield
         rescue => ex
-          Rails.logger.info "Okcoin: An error of type #{ex.class} happened, message is #{ex.message}. Retrying..."
+          logger.info("Okcoin: An error of type #{ex.class} happened, message is #{ex.message}. Retrying...")
           sleep TIMEOUT
           retry
         end

data/lib/okcoin/version.rb

@@ -1,3 +1,3 @@
 class Okcoin
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okcoin-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ilya Cherevkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-24 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A ruby library for okcoin.com