vexapion 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13b088be62d4de49b5f471088077d2c0142e0fa8
-  data.tar.gz: 130e8e80c10272e6ff2a48c18c84f3a4516e7211
+  metadata.gz: 28b59cf177eae960a829717727624d49714484b6
+  data.tar.gz: 3b1cf4c5bda2c08090f1fd7ce20ad843f74f36e5
 SHA512:
-  metadata.gz: 3433e525af5857b92594d294fdb6e44c7dcd134f44ffaa718dddf6be58bfe0d16e22bfa9a2705d052c0344e66bac6e291cf2283e1aaff82902412739b6dbaf06
-  data.tar.gz: a42752f44c429d38b3bcf3428132f41cff7d7673c6096ad0dc602ce475c0b65b78410e4595446b948027b566512b9609978a4035d050d457d696bc2cfb2d0c8f
+  metadata.gz: c2b11378b807f020baf1fba42a87739dba44d59e427f61983da8cf8952381d758c2f835dcb366ae92ee5015f913985ab501e93dbcfc6ae5592eec030d409aa84
+  data.tar.gz: 7b13dbbe0b911625c777b65ae9d7e8eb51d57858587aa301ce3b5beee1e87011833fb6bf101f353786b6f018386fced3b2fe4ffc46e874def80df87a126cae95

data/lib/vexapion/bitflyer.rb

@@ -23,18 +23,27 @@ module Vexapion
 
 # Public API
 		#板情報
+		# @param [String] pair product_codeを指定します。
+		# @return [Hash]
 		def board(pair)
 			public_get('board', product_code: pair.upcase)
 		end
 		alias get_board board
 
 		#Ticker
+		# @param [String] pair product_codeを指定します。
+		# @return [Hash]
 		def ticker(pair)
 			public_get('ticker', product_code: pair.upcase)
 		end
 		alias get_ticker ticker
 
 		#約定履歴
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
 		def executions(pair, count='', before='', after='')
 			params = {
 			  product_code: pair.upcase
@@ -48,37 +57,48 @@ module Vexapion
 		alias get_public_executions executions
 
 		#チャット
+		# @params [???] 日付を指定するようです。形式不明。省略すると5日前からのデータを取得します。
+		# @return [Hash]
 		def get_chats(date)
 			public_get('getchats', from_date: date)
 		end
 
 		#取引所の状態
+		# @return [Hash]
 		def get_health
 			public_get('gethealth')
 		end
 
 # Private API
 		#APIキーの権限を取得
+		# @return [Hash]
 		def get_permissions
 			get('getpermissions')
 		end
 
 		#資産残高を取得
+		# @return [Hash]
 		def get_balance
 			get('getbalance')
 		end
 
 		#証拠金の状態を取得
+		# @return [Hash]
 		def get_collateral
 			get('getcollateral')
 		end
 
 		#預入用BTC/ETHアドレス取得
+		# @return [Hash]
 		def get_addresses
 			get('getaddresses')
 		end
 		
 	#BTC/ETH預入履歴
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
 		def get_coin_ins(count='', before='', after='')
 		  params = Hash.new
 			params[:count]  = count  if count  != ''
@@ -88,6 +108,12 @@ module Vexapion
 		end
 
 		#BTC/ETH外部送付
+		# @param [String] currency 送付する通貨名を指定します。~BTC" または "ETH"を指定します。
+		# @param [Float] amount 送付する数量を数値で指定します。
+		# @param [String] address 送付先アドレスを指定します。
+		# @param [Float] fee 追加の手数料を指定します。上限は0.0005です。
+		# @param [String] code 二段階認証の確認コードです。コイン外部送付時の二段階認証を設定している場合のみ必要。
+		# @return [Hash]
 		def sendcoin(currency, amount, address, fee='', code='')
 			params = {
 				currency_code: currency.upcase,
@@ -98,12 +124,16 @@ module Vexapion
 				fee = 0.0005 < fee.to_f ? 0.0005 : fee.to_f
 				params[:additional_fee]  = fee
 			end
-			params[:code]            = code.to_i  if code != ''
+			params[:code] = code.to_i  if code != ''
 
 			post('sendcoin', params)
 		end
 
 		#BTC/ETH送付履歴
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
 		def get_coin_outs(count='', before='', after='')
 		  params = Hash.new
 			#params[:message_id] = id if id     != ''
@@ -115,7 +145,7 @@ module Vexapion
 		end
 
 		#BTC/ETH送付状況確認
-		# @params [String] message_id sendcoinAPIの戻り値を指定
+		# @param [String]	message_id	sendcoinAPIの戻り値を指定
 		# @return [hash]
 		def get_coin_outs_id(message_id)
 			params = { message_id: message_id }
@@ -124,11 +154,16 @@ module Vexapion
 		end
 
 		#銀行口座一覧取得
+		# @return [Hash]
 		def get_bank_accounts
 			get('getbankaccounts')
 		end
 
 		#デポジット入金履歴
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
 		def get_deposits(count='', before='', after='')
 		  params = Hash.new
 			params[:count]  = count  if count  != ''
@@ -139,6 +174,11 @@ module Vexapion
 		end
 
 		#デポジット解約(出金)
+		# @param [String] currency 送付する通貨名を指定します。現在は"JPY"のみ対応しています。
+		# @param [Integer] id 出金先口座のidを指定します。
+		# @param [Integer] amount 解約する数量を指定します。
+		# @param [String] code 二段階認証の確認コードです。出金時の二段階認証を設定している場合のみ必要。
+		# @return [Hash]
 		def withdraw(currency, id, amount, code='')
 			params = {
 				currency_code:    currency.upcase,
@@ -151,6 +191,10 @@ module Vexapion
 		end
 
 		#デポジット解約履歴(出金)
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
 		def get_withdrawals(count='', before='', after='')
 		  params = Hash.new
 			params[:count]  = count  if count  != ''
@@ -161,11 +205,18 @@ module Vexapion
 		end
 
 
-		#新規注文を出す
-		def send_child_order(pair, type, side, price, size, expire='', force='')
+		#指値で新規注文を出す
+		# @param [String] pair product_codeを指定します。
+		# @param [String] side 買い注文の場合は"BUY"、売り注文の場合は"SELL"を指定します。
+		# @param [Float] price 価格を指定します。 ただしJPYの場合はInteger
+		# @param [Float] size  注文数量を指定します。
+		# @param [Integer] expire 期限切れまでの時間を分で指定します。省略した場合の値は525600(365日間)です。
+		# @param [String] force 執行数量条件を"GTC"、"IOC"、"FOK"のいずれかで指定します。省略した場合は"GTC"です。
+		# @return [Hash]
+		def send_child_order(pair, side, price, size, expire='', force='')
 			params = {
 				product_code:      pair.upcase,
-				child_order_type:  type.upcase,
+				child_order_type:  'LIMIT',
 				side:              side.upcase,
 				price:             price,
 				size:              size.to_f
@@ -176,7 +227,30 @@ module Vexapion
 			post('sendchildorder', params)
 		end
 			
+		#成行で新規注文を出す
+		# @param [String] pair product_codeを指定します。
+		# @param [String] side 買い注文の場合は"BUY"、売り注文の場合は"SELL"を指定します。
+		# @param [Float] size  注文数量を指定します。
+		# @param [Integer] expire 期限切れまでの時間を分で指定します。省略した場合の値は525600(365日間)です。
+		# @param [String] force 執行数量条件を"GTC"、"IOC"、"FOK"のいずれかで指定します。省略した場合は"GTC"です。
+		# @return [Hash]
+		def send_child_order_market(pair, side, size, expire='', force='')
+			params = {
+				product_code:      pair.upcase,
+				child_order_type:  'MARKET',
+				side:              side.upcase,
+				size:              size.to_f
+			}
+			params[:minute_to_expire]  = expire  if expire != ''
+			params[:time_in_force]     = force   if force  != ''
+
+			post('sendchildorder', params)
+		end
+			
 		#child_order_idを指定して、注文をキャンセルする
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] order_id child_order_idを指定します。
+		# @return [Hash]
 		def cancel_child_order(pair, order_id)
 			params = {
 				product_code:   pair.upcase,
@@ -187,6 +261,9 @@ module Vexapion
 		end
 
 		#child_order_acceptance_idを指定して、注文をキャンセルする
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] child_order_acceptance_id child_order_acceptance_idを指定します。
+		# @return [Hash]
 		def cancel_child_order_specify_acceptance_id(pair, acceptance_id)
 			params = {
 				product_code:              pair.upcase,
@@ -199,11 +276,14 @@ module Vexapion
 		#新規の親注文を出す(特殊注文)
 		#https://lightning.bitflyer.jp/docs/specialorder を熟読して使用のこと
 		#とても自由度が高いため、ユーザーがパラメータを組み立ててそれを引数にする
+		# @return [Hash]
 		#def send_parent_order(params)
 		#	post('sendparentorder', params)
 		#end
 
 		#parent_order_idを指定して、親注文をキャンセルする
+		# @param [String] pair product_codeを指定します。
+		# @return [Hash]
 		#def cancel_parent_order(pair, order_id)
 		#  params = {
 		#	  product_code: pair.upcase,
@@ -214,6 +294,8 @@ module Vexapion
 		#end
 
 		#parent_order_acceptance_idを指定して、親注文をキャンセルする
+		# @param [String] pair product_codeを指定します。
+		# @return [Hash]
 		#def cancel_parent_order_specify_acceptance_id(pair, acceptance_id)
 		#  params = {
 		#	  product_code: pair.upcase,
@@ -223,17 +305,25 @@ module Vexapion
 		#end
 
 		#すべての注文をキャンセルする
+		# @param [String] pair product_codeを指定します。
+		# @return [Hash]
 		def cancel_all_child_order(pair)
 			post('cancelallchildorders', product_code: pair.upcase)
 		end
 
 		#注文の一覧を取得
-		def get_child_orders(pair, state='', pid='', count='', before='', after='')
+		#stateが指定されない場合、ACTIVE, COMPLETED, CANCELED, RXPIRED, REJECTEDのすべてが返されます。
+		# @param [String] pair product_codeを指定します。
+		# @param [String] state ACTIVE, COMPLETED, CANCELED, RXPIRED, REJECTEDのいずれかを指定します。省略可。
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
+		def get_child_orders(pair, state='', count='', before='', after='')
 			params = {
 				product_code: pair.upcase
 			}
 			params[:child_order_state]  = state  if state != ''
-			params[:parent_order_id]    = pid    if pid != ''
 			params[:count]  = count  if count  != ''
 			params[:before] = before if before != ''
 			params[:after]  = after  if after  != ''
@@ -241,7 +331,26 @@ module Vexapion
 			get('getchildorders', params)
 		end
 
+		#parent_order_idに関連した注文の一覧を取得
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] parent_order_id parent_order_idを指定します。
+		# @return [Hash]
+		def get_child_orders_parent_order_id(pair, parent_order_id)
+			params = {
+				product_code: pair.upcase,
+				parent_order_id: parent_order_id
+			}
+
+			get('getchildorders', params)
+		end
+
 		#親注文の一覧を取得
+		# @param [String] pair product_codeを指定します。
+		# @param [String] state ACTIVE, COMPLETED, CANCELED, RXPIRED, REJECTEDのいずれかを指定します。省略可。
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
 		#def get_parent_orders(pair, state='', count='', before='', after='')
 		#	params = {
 		#		product_code: pair.upcase
@@ -255,25 +364,30 @@ module Vexapion
 		#end
 
 		#parent_order_idを指定して、親注文の詳細を取得
+		# @param [Integer] parent_order_id parent_order_idを指定します。
+		# @return [Hash]
 		#def get_parent_order(parent_order_id)
 		#	get('getparentorder', parent_order_id: parent_order_id)
 		#end
 
 		#parent_order_acceptance_idを指定して、親注文の詳細を取得
+		# @param [Integer] parent_order_acceptance_id parent_order_acceptance_idを指定します。
+		# @return [Hash]
 		#def get_parent_order_specify_acceptance_id(acceptance_id)
 		#	get('getparentorder', parent_order_acceptance_id: acceptance_id)
 		#end
 
 		#約定の一覧を取得
-		def get_executions(pair, coid='', child_order_acceptance_id='',
-			  count='', before='', after='')
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] count 結果の個数を指定します。
+		# @param [Integer] before このパラメータに指定した値より小さいidを持つデータを取得します。
+		# @param [Integer] after このパラメータに指定した値より大きいidを持つデータを取得します。
+		# @return [Hash]
+		def get_executions(pair, count='', before='', after='')
+			#必須パラメータ
 			params = {
 				product_code: pair.upcase
 			}
-			params['child_order_id'] = coid if coid != ''
-			if child_order_acceptance_id != ''
-				params['child_order_acceptance_id']  = child_order_acceptance_id  
-			end
 			params[:count]  = count  if count  != ''
 			params[:before] = before if before != ''
 			params[:after]  = after  if after  != ''
@@ -281,9 +395,42 @@ module Vexapion
 			get('getexecutions', params)
 		end
 
-		#建玉の一覧を取得
-		def get_positions(pair='FX_BTC_JPY')
-			get('getpositions', product_code: pair.upcase)
+		#child_order_idに関連した約定の一覧を取得
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] child_order_id child_order_idを指定します。
+		# @return [Hash]
+		def get_executions_child_order_id(pair, child_order_id)
+			#必須パラメータ
+			params = {
+				product_code: pair.upcase,
+				child_order_id: child_order_id
+			}
+
+			get('getexecutions', params)
+		end
+
+		#child_order_acceptance_idに関連した約定の一覧を取得
+		# @param [String] pair product_codeを指定します。
+		# @param [Integer] child_order_acceptance_id child_order_acceptance_idを指定します。
+		# @return [Hash]
+		def get_executions_acceptance_id(pair, child_order_acceptance_id='')
+			params = {
+				product_code: pair.upcase,
+				child_order_acceptance_id: child_order_acceptance_id  
+			}
+
+			get('getexecutions', params)
+		end
+
+		# 建玉の一覧を取得
+		# @param [String] pair product_codeを指定します。 "FX_BTC_JPY"を指定します。
+		# @return [Hash]
+		def get_positions(pair)
+			params = {
+				product_code: pair.upcase
+			}
+
+			get('getpositions', params)
 		end
 
 
@@ -331,7 +478,7 @@ module Vexapion
 			request.body = body
 
 			res = do_command(uri, request)
-			error_check(res)
+			#error_check(res)
 			res
 		end
 

data/lib/vexapion/template.rb

@@ -0,0 +1,121 @@
+# coding: utf-8
+
+# 新しい取引所を追加するときに利用するテンプレート
+
+require 'vexapion'
+
+module Vexapion
+
+	# ....のAPIラッパークラスです。
+	# 各メソッドの戻り値は下記URLを参照してください。
+	# @see http://....
+
+	class NewExchangesName < BaseExchanges
+
+		def initialize(key = nil, secret = nil)
+			super(key,secret)
+
+			@public_url = 'https://...'
+			@private_url = 'https://...'
+		end
+
+		def available_pair
+		end
+
+# Public API
+
+		# @raise RequestFailed APIリクエストの失敗
+		# @raise SocketError ソケットエラー
+		# @raise RetryException  リクエストの結果が確認できないとき 408, 500, 503
+		# @raise Warning 何かがおかしいと時(200 && response.body == nil), 509
+		# @raise Error  クライアントエラー 400, 401, 403
+		# @raise Fatal APIラッパーの修正が必要と思われるエラー, 404
+
+
+
+		# 例:ティッカー
+		# @param [String] pair 取得したい通貨ペア
+		# @return [Hash]
+		def ticker(pair)
+			get('ticker', pair)
+		end
+
+# Private API
+
+
+		# 未約定の注文一覧を取得します
+		#  @param [String]    pair    トレードしたい通貨ペア
+		#  @param [String]    action  注文の種類 ask(売)/bid(買)
+		#  @param [Float]    price    注文価格(ただしBTC_JPYの時はInteger)
+		#  @param [Float]    amount  注文量
+		#  @param [Float]    limit    リミット注文価格(ただしBTC_JPYの時はInteger)
+		# @return [Hash]
+		def trade(pair, action, price, amount, limit = '')
+			params = {
+				currency_pair: pair,
+				action:        action,
+				price:         price,
+				amount:        amount
+			}
+			params['limit'] = limit if limit != ''
+
+			post('trade', params)
+		end
+
+
+#  Create request header & body
+
+		private 
+		
+		def get(method, pair)
+			url = "#{@public_url}#{method.downcase}/#{pair.downcase}"
+			uri = URI.parse url
+			request = Net::HTTP::Get.new(uri.request_uri)
+
+			do_command(uri, request)
+		end
+
+		def post(method, params = {})
+			uri = URI.parse @private_url
+			params['method'] = method
+			params['nonce'] = get_nonce
+
+			request = Net::HTTP::Post.new(uri)
+			request.set_form_data(params)  #クエリをURLエンコード (p1=v1&p2=v2...)
+			request['Key']  = @key
+			request['Sign'] = signature(request)
+
+			res = do_command(uri, request)
+			error_check(res)
+			res
+		end
+
+		def delete(method)
+			nonce = get_nonce.to_s
+			uri = URI.parse "#{@private_url}#{method}"
+			message = "#{nonce}#{uri.to_s}"
+			sig = signature(message)
+			header = headers(nonce, sig)
+			request = Net::HTTP::Delete.new(uri.request_uri, headers)
+
+			res = do_command(uri, request)
+			error_check(res) #TODO check require
+			res
+		end
+
+		def signature(req)
+			algo = OpenSSL::Digest.new('sha512')
+			OpenSSL::HMAC.hexdigest(algo, @secret, req.body)
+		end
+
+		def header(nonce, signature)
+			{
+				'Content-Type'	=> 'application/json',
+				'ACCESS-KEY'		=> '@key,
+				'ACCESS-NONCE'	=> nonce,
+				'ACCESS-SIGNATURE'	=> signature
+			}
+		end
+
+	end #of class
+end #of Vexapion module

data/lib/vexapion/version.rb

@@ -1,3 +1,3 @@
 module Vexapion
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
 end

data/lib/vexapion/zaif.rb

@@ -244,7 +244,7 @@ module Vexapion
 			request['Sign'] = signature(request)
 
 			res = do_command(uri, request)
-			error_check(res)
+			#error_check(res)
 			res
 		end
 

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vexapion
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - fuyuton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bigdecimal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.6
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +53,7 @@ files:
 - lib/vexapion/errors/http_errors.rb
 - lib/vexapion/errors/vexapion_errors.rb
 - lib/vexapion/poloniex.rb
+- lib/vexapion/template.rb
 - lib/vexapion/version.rb
 - lib/vexapion/zaif.rb
 homepage: https://github.com/fuyuton/vexapion