binance 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/lib/binance/client/rest.rb +12 -9
  3. data/lib/binance/client/rest/account_api.rb +67 -40
  4. data/lib/binance/client/rest/public_api.rb +18 -18
  5. data/lib/binance/client/rest/withdraw_api.rb +18 -18
  6. data/lib/binance/client/websocket.rb +17 -16
  7. data/lib/binance/version.rb +1 -1
  8. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a44f0ee9e6501f2e0cd830429766dc93e53d24e3
4
- data.tar.gz: d71bb3d006b04582e8b3bbe0c63ae1b2e178781b
3
+ metadata.gz: 17ceeaf8ec5393a0d116114d857bdea05c6e626b
4
+ data.tar.gz: 69fe61ac677f70dbe01f4b253fde3fe5e135d6ca
5
5
  SHA512:
6
- metadata.gz: 953a41c328bb44d5af13b0b21bacd246409285e77e2d5da345cc2d786c4abe3bceaa197eecd91e1821944e75bc9023301669e40763869fe5f51ccf58181d429d
7
- data.tar.gz: 6caf04faa96a0d4b20d12d6ef0135b7ef93c6ad6ba70be0bd88bd3a459e6e0c3193fbf3ae1872af5a0f07193848168abda9edae3f52d8505065584ff446fb9ea
6
+ metadata.gz: a0b708aeacc91c3155701f518cff5223a97c1ec4c6732b82de4df5016bbd6288cbe9fac58f6afcdacbdb4320df71bd05cac96b452c7beed158ab76c4655bf7fe
7
+ data.tar.gz: e6719b7cb44ceb107a32ad6b92095425239f96f8efadc0edc63ad5816ed7c7be1a3820fd9087da9bdab3fc631aee2c835bebe61d0a0bbb696470125561f736ca
data/lib/binance/client/rest.rb CHANGED
@@ -23,11 +23,12 @@ module Binance
23
23
 
24
24
  # Public: Initialize a REST Client
25
25
  #
26
- # :api_key - The String API key to authenticate (Default = '')
26
+ # :api_key - The String API key to authenticate (Default = '').
27
27
  #
28
- # :secret_key - The String secret key to authenticate (Default = '')
28
+ # :secret_key - The String secret key to authenticate (Default = '').
29
29
  #
30
30
  # :adapter - The Faraday::Adapter to be used for the client
31
+ # (Default = Faraday.default_adapter).
31
32
  def initialize(api_key: '', secret_key: '',
32
33
  adapter: Faraday.default_adapter)
33
34
  @api_key = api_key
@@ -43,14 +44,16 @@ module Binance
43
44
 
44
45
  # Internal: Create a request that hits one of the REST APIs
45
46
  #
46
- # qpi - The Symbol that represents which API to use
47
+ # api - The Symbol that represents which API to use.
47
48
  #
48
- # method - The Symbol that represents which HTTP method to use
49
+ # method - The Symbol that represents which HTTP method to use.
49
50
  #
50
- # endpoint - The String that represents which API endpoint to request from
51
+ # endpoint - The String that represents which API endpoint to request
52
+ # from.
51
53
  #
52
54
  # options - The Hash which hosts various REST query params. (Default = {})
53
- # Each endpoint will have their own required and optional params.
55
+ # Each endpoint will have their own required and optional
56
+ # params.
54
57
  def request(api, method, endpoint, options = {})
55
58
  conn = REST.api[api].call
56
59
  response = conn.send(method) do |req|
@@ -63,11 +66,11 @@ module Binance
63
66
 
64
67
  # Internal: Append key-value pair to REST query string
65
68
  #
66
- # query - The String of the existing request query url
69
+ # query - The String of the existing request query url.
67
70
  #
68
- # key - The String that represents the param type
71
+ # key - The String that represents the param type.
69
72
  #
70
- # value - The String that represents the param value
73
+ # value - The String that represents the param value.
71
74
  def self.add_query_param(query, key, value)
72
75
  query = query.to_s
73
76
  query << '&' unless query.empty?
data/lib/binance/client/rest/account_api.rb CHANGED
@@ -10,8 +10,8 @@ module Binance
10
10
  # Public: A module containing all of the Account API endpoints
11
11
  module Account_API
12
12
  # Internal: Create Lambda that returns a new Faraday client instance
13
- # and add it to the REST class instance variable @api. This is called
14
- # while a new instance of the REST class is created.
13
+ # and add it to the REST class instance variable @api. This is called
14
+ # while a new instance of the REST class is created.
15
15
  #
16
16
  # base - The base class that is being extended into
17
17
  def self.extended(base)
@@ -28,53 +28,80 @@ module Binance
28
28
  end
29
29
 
30
30
  # Public: Create a new order on the specified symbol for the
31
- # authenticated account
31
+ # authenticated account
32
32
  #
33
- # options - The Hash which hosts various REST query params
33
+ # options - The Hash which hosts various REST query params.
34
34
  # :symbol - The String of which trading pair to create the
35
- # order on.
35
+ # order on.
36
36
  # :side - The String determining which side to create the
37
- # order on.
37
+ # order on.
38
38
  # :type - The String determining what type of order it is.
39
39
  # :timeInForce - The String determining what the time in force is
40
- # (optional).
40
+ # (optional).
41
41
  # :quantity - The String determining the amount of assets to
42
- # purchase.
42
+ # purchase.
43
43
  # :price - The String determining what price to purchase at
44
- # (optional).
44
+ # (optional).
45
45
  # :newClientOrderId - The String which uniquely identifies this order
46
- # (optional).
46
+ # (optional).
47
47
  # :stopPrice - The String determining which price to stop at
48
- # (optional).
48
+ # (optional).
49
49
  # :icebergQty - The String determining the amount of assets to
50
- # show on the order book (optional).
50
+ # show on the order book (optional).
51
51
  # :newOrderRespType - The String which sets the type of response to
52
- # receive (optional).
52
+ # receive (optional).
53
53
  # :recvWindow - The Number of how long a request is valid for
54
- # in milliseconds (optional).
54
+ # in milliseconds (optional).
55
55
  #
56
56
  # Returns a Hash of the request response
57
57
  def create_order(options)
58
58
  request :account, :post, 'order', options
59
59
  end
60
60
 
61
+ # Public: Create a test order on the specified symbol for the
62
+ # authenticated account
63
+ #
64
+ # options - The Hash which hosts various REST query params.
65
+ # :symbol - The String of which trading pair to create the
66
+ # order on.
67
+ # :side - The String determining which side to create the
68
+ # order on.
69
+ # :type - The String determining what type of order it is.
70
+ # :timeInForce - The String determining what the time in force is
71
+ # (optional).
72
+ # :quantity - The String determining the amount of assets to
73
+ # purchase.
74
+ # :price - The String determining what price to purchase at
75
+ # (optional).
76
+ # :newClientOrderId - The String which uniquely identifies this order
77
+ # (optional).
78
+ # :stopPrice - The String determining which price to stop at
79
+ # (optional).
80
+ # :icebergQty - The String determining the amount of assets to
81
+ # show on the order book (optional).
82
+ # :newOrderRespType - The String which sets the type of response to
83
+ # receive (optional).
84
+ # :recvWindow - The Number of how long a request is valid for
85
+ # in milliseconds (optional).
86
+ #
87
+ # Returns a Hash of the request response
61
88
  def create_test_order(options)
62
89
  request :account, :post, 'order/test', options
63
90
  end
64
91
 
65
92
  # Public: Query an orders status on the specified symbol for the
66
- # authenticated account. One must send either an :orderId or
67
- # :origOrderId, but not both.
93
+ # authenticated account. One must send either an :orderId or
94
+ # :origOrderId, but not both.
68
95
  #
69
- # options - The Hash which hosts various REST query params
96
+ # options - The Hash which hosts various REST query params.
70
97
  # :symbol - The String of which trading pair to query from
71
- # (optional).
98
+ # (optional).
72
99
  # :orderId - The String determining which order to query
73
- # (optional).
100
+ # (optional).
74
101
  # :origClientOrderId - The String determining which order to cancel
75
- # (optional).
102
+ # (optional).
76
103
  # :recvWindow - The Number of how long a request is valid for
77
- # in milliseconds (optional).
104
+ # in milliseconds (optional).
78
105
  #
79
106
  # Returns a Hash of the request response
80
107
  def query_order(options)
@@ -82,19 +109,19 @@ module Binance
82
109
  end
83
110
 
84
111
  # Public: Cancel the order specified for the authenticated account.
85
- # One must send either an :orderId or :origOrderId, but not both.
112
+ # One must send either an :orderId or :origOrderId, but not both.
86
113
  #
87
- # options - The Hash which hosts various REST query params
114
+ # options - The Hash which hosts various REST query params.
88
115
  # :symbol - The String of which trading pair to delete from
89
- # (optional).
116
+ # (optional).
90
117
  # :orderId - The String determining which order to cancel
91
- # (optional).
118
+ # (optional).
92
119
  # :origClientOrderId - The String determining which order to cancel
93
- # (optional).
120
+ # (optional).
94
121
  # :newClientOrderId - The String used in uniquely identifying the
95
- # cancel order (optional).
122
+ # cancel order (optional).
96
123
  # :recvWindow - The Number of how long a request is valid for
97
- # in milliseconds (optional).
124
+ # in milliseconds (optional).
98
125
  #
99
126
  # Returns a Hash with the request response
100
127
  def cancel_order(options)
@@ -103,11 +130,11 @@ module Binance
103
130
 
104
131
  # Public: Retrieve open orders for the authenticated account
105
132
  #
106
- # options - The Hash which hosts various REST query params
133
+ # options - The Hash which hosts various REST query params.
107
134
  # :symbol - The String of which trading pair to retrieve
108
- # (optional).
135
+ # (optional).
109
136
  # :recvWindow - The Number of how long a request is valid for in
110
- # milliseconds (optional).
137
+ # milliseconds (optional).
111
138
  #
112
139
  # Returns a Hash with the request response
113
140
  def open_orders(options)
@@ -115,15 +142,15 @@ module Binance
115
142
  end
116
143
 
117
144
  # Public: Retrieve all orders of the specified symbol for the
118
- # authenticated account
145
+ # authenticated account
119
146
  #
120
- # options - The Hash which hosts various REST query params
147
+ # options - The Hash which hosts various REST query params.
121
148
  # :symbol - The String of which trading pair to retrieve.
122
149
  # :orderId - The String determining which order to start the data
123
- # from (optional).
150
+ # from (optional).
124
151
  # :limit - The Number of how many trades to request (optional).
125
152
  # :recvWindow - The Number of how long a request is valid for in
126
- # milliseconds (optional).
153
+ # milliseconds (optional).
127
154
  #
128
155
  # Returns a Hash with the request response
129
156
  def all_orders(options)
@@ -132,9 +159,9 @@ module Binance
132
159
 
133
160
  # Public: Retrieve account information for the authenticated account
134
161
  #
135
- # options - The Hash which hosts various REST query params
162
+ # options - The Hash which hosts various REST query params.
136
163
  # :recvWindow - The Number of how long a request is valid for in
137
- # milliseconds (optional).
164
+ # milliseconds (optional).
138
165
  #
139
166
  # Returns a Hash with the request response
140
167
  def account_info(options = {})
@@ -142,14 +169,14 @@ module Binance
142
169
  end
143
170
 
144
171
  # Public: Retrieve trade data of the specified symbol for the
145
- # authenticated account
172
+ # authenticated account
146
173
  #
147
- # options - The Hash which hosts various REST query params
174
+ # options - The Hash which hosts various REST query params.
148
175
  # :symbol - The String of which trading pair to retrieve.
149
176
  # :limit - The Number of how many trades to request (optional).
150
177
  # :fromId - The String of which trade ID to fetch from (optional).
151
178
  # :recvWindow - The Number of how long a request is valid for in
152
- # milliseconds (optional).
179
+ # milliseconds (optional).
153
180
  #
154
181
  # Returns a Hash with the request response
155
182
  def account_trade_list(options)
data/lib/binance/client/rest/public_api.rb CHANGED
@@ -8,10 +8,10 @@ module Binance
8
8
  # Public: A Module containing all of the Public API endpoints
9
9
  module Public_API
10
10
  # Internal: Create Lambda that returns a new Faraday client instance
11
- # and add it to the REST class instance variable @api. This is called
12
- # while a new instance of the REST class is created.
11
+ # and add it to the REST class instance variable @api. This is called
12
+ # while a new instance of the REST class is created.
13
13
  #
14
- # base - The base class that is being extended into
14
+ # base - The base class that is being extended into.
15
15
  def self.extended(base)
16
16
  REST.api[:public] = lambda do
17
17
  Faraday.new(url: "#{BASE_URL}/api") do |conn|
@@ -44,7 +44,7 @@ module Binance
44
44
  end
45
45
 
46
46
  # Public: Retrieve current exchange asset information. This is an
47
- # undocumented endpoint.
47
+ # undocumented endpoint.
48
48
  #
49
49
  # Returns a Hash with the request response
50
50
  def products
@@ -53,7 +53,7 @@ module Binance
53
53
 
54
54
  # Public: Retrieve depth information for the specified symbol
55
55
  #
56
- # options - The Hash which hosts various REST query params
56
+ # options - The Hash which hosts various REST query params.
57
57
  # :symbol - The String of which trading pair to retrieve.
58
58
  # :limit - The Number of how many updates to request (optional).
59
59
  #
@@ -64,7 +64,7 @@ module Binance
64
64
 
65
65
  # Public: Retrieve recent trades for the specified symbol
66
66
  #
67
- # options - The Hash which hosts various REST query params
67
+ # options - The Hash which hosts various REST query params.
68
68
  # :symbol - The String of which trading pair to retrieve.
69
69
  # :limit - The Number of how many trades to request (optional).
70
70
  #
@@ -75,7 +75,7 @@ module Binance
75
75
 
76
76
  # Public: Retrieve old trade data for the specified symbol
77
77
  #
78
- # options - The Hash which hosts various REST query params
78
+ # options - The Hash which hosts various REST query params.
79
79
  # :symbol - The String of which trading pair to retrieve.
80
80
  # :limit - The Number of how many trades to request (optional).
81
81
  # :fromId - The String of which trade ID to fetch from.
@@ -87,13 +87,13 @@ module Binance
87
87
 
88
88
  # Public: Retrieve aggregate trade data for the specified symbol
89
89
  #
90
- # options - The Hash which hosts various REST query params
90
+ # options - The Hash which hosts various REST query params.
91
91
  # :symbol - The String of which trading pair to retrieve.
92
92
  # :fromId - The String of which trade ID to fetch from (optional).
93
93
  # :startTime - The Timestamp of when to get trades from in
94
- # milliseconds (optional).
94
+ # milliseconds (optional).
95
95
  # :endTime - The Timestamp of when to get trades until in
96
- # milliseconds (optional).
96
+ # milliseconds (optional).
97
97
  # :limit - The Number of how many trades to request (optional).
98
98
  #
99
99
  # Returns a Hash with the request response
@@ -103,14 +103,14 @@ module Binance
103
103
 
104
104
  # Public: Retrieve kline data for the specified symbol
105
105
  #
106
- # options - The Hash which hosts various REST query params
106
+ # options - The Hash which hosts various REST query params.
107
107
  # :symbol - The String of which trading pair to retrieve.
108
- # :interval -
109
- # :fromId - The String of which trade ID to fetch from (optional).
108
+ # :interval - The String of which interval to retrieve (optional).
109
+ # :fromId - The String of which trade ID to fetch from (optional).
110
110
  # :startTime - The Timestamp of when to get trades from in
111
- # milliseconds (optional).
111
+ # milliseconds (optional).
112
112
  # :endTime - The Timestamp of when to get trades until in
113
- # milliseconds (optional).
113
+ # milliseconds (optional).
114
114
  # :limit - The Number of how many trades to request (optional).
115
115
  #
116
116
  # Returns a Hash with the request response
@@ -120,7 +120,7 @@ module Binance
120
120
 
121
121
  # Public: Retrieve 24 hour ticker price data
122
122
  #
123
- # options - The Hash which hosts various REST query params
123
+ # options - The Hash which hosts various REST query params.
124
124
  # :symbol - The String of which trading pair to retrieve (optional).
125
125
  #
126
126
  # Returns a Hash with the request response
@@ -130,7 +130,7 @@ module Binance
130
130
 
131
131
  # Public: Retrieve price ticker data for the specified symbol
132
132
  #
133
- # options - The Hash which hosts various REST query params
133
+ # options - The Hash which hosts various REST query params.
134
134
  # :symbol - The String of which trading pair to retrieve (optional).
135
135
  #
136
136
  # Returns a Hash with the request response
@@ -147,7 +147,7 @@ module Binance
147
147
 
148
148
  # Public: Retrieve best price per quantity on the order book
149
149
  #
150
- # options - The Hash which hosts various REST query params
150
+ # options - The Hash which hosts various REST query params.
151
151
  # :symbol - The String of which trading pair to retrieve (optional).
152
152
  #
153
153
  # Returns a Hash with the request response
data/lib/binance/client/rest/withdraw_api.rb CHANGED
@@ -10,10 +10,10 @@ module Binance
10
10
  # Public: A Module containing all of the Withdraw API endpoints
11
11
  module Withdraw_API
12
12
  # Internal: Create Lambda that returns a new Faraday client instance
13
- # and add it to the REST class instance variable @api. This is called
14
- # while a new instance of the REST class is created.
13
+ # and add it to the REST class instance variable @api. This is called
14
+ # while a new instance of the REST class is created.
15
15
  #
16
- # base - The base class that is being extended into
16
+ # base - The base class that is being extended into.
17
17
  def self.extended(base)
18
18
  REST.api[:withdraw] = lambda do
19
19
  Faraday.new(url: "#{BASE_URL}/wapi") do |conn|
@@ -28,16 +28,16 @@ module Binance
28
28
  end
29
29
 
30
30
  # Public: Withdraw the specified asset to the given address using
31
- # the authenticated account
31
+ # the authenticated account
32
32
  #
33
- # options - The Hash which hosts various REST query params
33
+ # options - The Hash which hosts various REST query params.
34
34
  # :asset - The String of which asset to withdraw.
35
35
  # :address - The String of where to send the asset to.
36
36
  # :addressTag - The String secondary address identifier (optional).
37
37
  # :amount - The String decimal value of how much to withdraw.
38
38
  # :name - The String description of the address
39
39
  # :recvWindow - The Number of how long a request is valid for in
40
- # milliseconds (optional).
40
+ # milliseconds (optional).
41
41
  #
42
42
  # Returns a Hash with the request response
43
43
  def withdraw(options)
@@ -46,15 +46,15 @@ module Binance
46
46
 
47
47
  # Public: Retrieve the deposit history for the authenticated account
48
48
  #
49
- # options - The Hash which hosts various REST query params
49
+ # options - The Hash which hosts various REST query params.
50
50
  # :asset - The String of which asset to retrieve (optional).
51
51
  # :status - The Number of which status to retrieve (optional).
52
52
  # :startTime - The Timestamp of when to start the history in
53
- # milliseconds (optional).
53
+ # milliseconds (optional).
54
54
  # :endTime - The Timestamp of when to end the history in
55
- # milliseconds (optional).
55
+ # milliseconds (optional).
56
56
  # :recvWindow - The Number of how long a request is valid for in
57
- # milliseconds (optional).
57
+ # milliseconds (optional).
58
58
  #
59
59
  # Returns a Hash with the request response
60
60
  def deposit_history(options = {})
@@ -63,15 +63,15 @@ module Binance
63
63
 
64
64
  # Public: Retrieve the withdraw history for the authenticated account
65
65
  #
66
- # options - The Hash which hosts various REST query params
66
+ # options - The Hash which hosts various REST query params.
67
67
  # :asset - The String of which asset to retrieve (optional).
68
68
  # :status - The Number of which status to retrieve (optional).
69
69
  # :startTime - The Timestamp of when to start the history in
70
- # milliseconds (optional).
70
+ # milliseconds (optional).
71
71
  # :endTime - The Timestamp of when to end the history in
72
- # milliseconds (optional).
72
+ # milliseconds (optional).
73
73
  # :recvWindow - The Number of how long a request is valid for in
74
- # milliseconds (optional).
74
+ # milliseconds (optional).
75
75
  #
76
76
  # Returns a Hash with the request response
77
77
  def withdraw_history(options = {})
@@ -80,10 +80,10 @@ module Binance
80
80
 
81
81
  # Public: Retrieve the deposit address for a specific asset
82
82
  #
83
- # options - The Hash which hosts various REST query params
83
+ # options - The Hash which hosts various REST query params.
84
84
  # :asset - The String of which asset to retrieve (optional).
85
85
  # :recvWindow - The Number of how long a request is valid for in
86
- # milliseconds (optional).
86
+ # milliseconds (optional).
87
87
  #
88
88
  # Returns a Hash with the request response
89
89
  def deposit_address(options)
@@ -92,9 +92,9 @@ module Binance
92
92
 
93
93
  # Public: Retrieve current account status
94
94
  #
95
- # options - The Hash which hosts various REST query params
95
+ # options - The Hash which hosts various REST query params.
96
96
  # :recvWindow - The Number of how long a request is valid for in
97
- # milliseconds (optional).
97
+ # milliseconds (optional).
98
98
  #
99
99
  # Returns a Hash with the request response
100
100
  def account_status(options)
data/lib/binance/client/websocket.rb CHANGED
@@ -17,7 +17,7 @@ module Binance
17
17
  # :interval - The String interval to use for the kline stream (optional)
18
18
  #
19
19
  # :methods - The Hash which contains the event handler methods to pass to
20
- # the WebSocket client
20
+ # the WebSocket client
21
21
  # :open - The Proc called when a stream is opened (optional)
22
22
  # :message - The Proc called when a stream receives a message
23
23
  # :error - The Proc called when a stream receives an error (optional)
@@ -29,15 +29,15 @@ module Binance
29
29
 
30
30
  # Public: Create multiple WebSocket streams
31
31
  #
32
- # :streams - The Array of Hashes used to define the stream.
33
- # Each Hash can have the following keys
32
+ # :streams - The Array of Hashes used to define the stream. Each Hash can
33
+ # have the following keys:
34
34
  # :symbol - The String symbol the stream will listen to
35
35
  # :type - The String type of stream to listen to
36
36
  # :level - The String level to use for the depth stream (optional)
37
37
  # :interval - The String interval to use for the kline stream (optional)
38
38
  #
39
39
  # :methods - The Hash which contains the event handler methods to pass to
40
- # the WebSocket client
40
+ # the WebSocket client
41
41
  # :open - The Proc called when a stream is opened (optional)
42
42
  # :message - The Proc called when a stream receives a message
43
43
  # :error - The Proc called when a stream receives an error (optional)
@@ -53,7 +53,7 @@ module Binance
53
53
  # :symbol - The String symbol the stream will listen to
54
54
  #
55
55
  # :methods - The Hash which contains the event handler methods to pass to
56
- # the WebSocket client
56
+ # the WebSocket client
57
57
  # :open - The Proc called when a stream is opened (optional)
58
58
  # :message - The Proc called when a stream receives a message
59
59
  # :error - The Proc called when a stream receives an error (optional)
@@ -67,7 +67,7 @@ module Binance
67
67
  # :symbol - The String symbol the stream will listen to
68
68
  #
69
69
  # :methods - The Hash which contains the event handler methods to pass to
70
- # the WebSocket client
70
+ # the WebSocket client
71
71
  # :open - The Proc called when a stream is opened (optional)
72
72
  # :message - The Proc called when a stream receives a message
73
73
  # :error - The Proc called when a stream receives an error (optional)
@@ -80,11 +80,12 @@ module Binance
80
80
  #
81
81
  # :symbol - The String symbol the stream will listen to
82
82
  #
83
- # :interval - The String interval the stream will update with.
84
- # The intervals that may be used can be found in the Binance API docs.
83
+ # :interval - The String interval the stream will update with. The
84
+ # intervals that may be used can be found in the Binance API
85
+ # docs.
85
86
  #
86
87
  # :methods - The Hash which contains the event handler methods to pass to
87
- # the WebSocket client
88
+ # the WebSocket client
88
89
  # :open - The Proc called when a stream is opened (optional)
89
90
  # :message - The Proc called when a stream receives a message
90
91
  # :error - The Proc called when a stream receives an error (optional)
@@ -99,7 +100,7 @@ module Binance
99
100
  # :symbol - The String symbol the stream will listen to
100
101
  #
101
102
  # :methods - The Hash which contains the event handler methods to pass to
102
- # the WebSocket client
103
+ # the WebSocket client
103
104
  # :open - The Proc called when a stream is opened (optional)
104
105
  # :message - The Proc called when a stream receives a message
105
106
  # :error - The Proc called when a stream receives an error (optional)
@@ -111,7 +112,7 @@ module Binance
111
112
  # Public: Create a Ticker stream for all symbols
112
113
  #
113
114
  # :methods - The Hash which contains the event handler methods to pass to
114
- # the WebSocket client
115
+ # the WebSocket client
115
116
  # :open - The Proc called when a stream is opened (optional)
116
117
  # :message - The Proc called when a stream receives a message
117
118
  # :error - The Proc called when a stream receives an error (optional)
@@ -124,11 +125,11 @@ module Binance
124
125
  #
125
126
  # :symbol - The String symbol the stream will listen to
126
127
  #
127
- # :level - The String interval the stream will update with.
128
- # The intervals that may be used can be found in the Binance API docs.
128
+ # :level - The String interval the stream will update with. The intervals
129
+ # that may be used can be found in the Binance API docs.
129
130
  #
130
131
  # :methods - The Hash which contains the event handler methods to pass to
131
- # the WebSocket client
132
+ # the WebSocket client
132
133
  # :open - The Proc called when a stream is opened (optional)
133
134
  # :message - The Proc called when a stream receives a message
134
135
  # :error - The Proc called when a stream receives an error (optional)
@@ -143,7 +144,7 @@ module Binance
143
144
  # :symbol - The String symbol the stream will listen to
144
145
  #
145
146
  # :methods - The Hash which contains the event handler methods to pass to
146
- # the WebSocket client
147
+ # the WebSocket client
147
148
  # :open - The Proc called when a stream is opened (optional)
148
149
  # :message - The Proc called when a stream receives a message
149
150
  # :error - The Proc called when a stream receives an error (optional)
@@ -172,7 +173,7 @@ module Binance
172
173
  # url - The String url that the WebSocket should try to connect to
173
174
  #
174
175
  # :methods - The Hash which contains the event handler methods to pass to
175
- # the WebSocket client
176
+ # the WebSocket client
176
177
  # :open - The Proc called when a stream is opened (optional)
177
178
  # :message - The Proc called when a stream receives a message
178
179
  # :error - The Proc called when a stream receives an error (optional)
data/lib/binance/version.rb CHANGED
@@ -1,4 +1,4 @@
1
1
 
2
2
  module Binance
3
- VERSION = '0.3.0'.freeze
3
+ VERSION = '0.3.1'.freeze
4
4
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: binance
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Charles Ray Shisler III