binance-ruby 1.1.2 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b8a2d2b8699dd1ab11f5c4927f492f1083178f6c490b2f128bec3e17519142
-  data.tar.gz: d0f3a90df602d2218abb7a479ee239b25c45a3c556350cd1a044d0fff2e1d123
+  metadata.gz: ed932ba3687136b21bbf45ab2a104ebb89c8ad2073852c166c49bae172ee2693
+  data.tar.gz: f62479b21ed010c103f47f7cda6b1c64961389ce55667775e3099524fbca1490
 SHA512:
-  metadata.gz: 7e79efbfe09d9046dbec1de668d00e34811170eb5fa323f4b1999bc5586f960d9f7790093e753b861f6c2b7cf0af687cb3b12f3afa020a99d67426930dbec331
-  data.tar.gz: 16cfb386ab4ea3bfd87067b3cffbeca50145b7108453bff5edf95b84a1fe90a0f2a7caf21e8927b233624c86263f7fe8c6df3f691d10b4fffa628f20445d5089
+  metadata.gz: 6f2748f9c2124ff7615a23b8b73b3edbe3f88606395e9bc99ce864f6891803cbabe1fad881496a07441e1d518dd30dc1922b1e535752446513a91debb3f5001a
+  data.tar.gz: 6753fa662464ea79db5eb58f132c4f24ee94190279ce8de845389d40d4ae78e9232584caf71c330abd0d8e12e895d2a73afa94464a30c2d6ee6ec981bbbeffb7

data/lib/binance-ruby.rb

@@ -1,15 +1,18 @@
 require "active_support/core_ext/string"
 require "awrence"
 require "httparty"
+require "faye/websocket"
 
 require "binance/api"
 require "binance/api/account"
 require "binance/api/configuration"
-require "binance/api/data_stream"
 require "binance/api/error"
 require "binance/api/margin"
 require "binance/api/margin/account"
 require "binance/api/margin/order"
 require "binance/api/order"
 require "binance/api/request"
+require "binance/api/trade"
+require "binance/api/user_data_stream"
 require "binance/api/version"
+require "binance/websocket"

data/lib/binance/api/account.rb

@@ -27,6 +27,23 @@ module Binance
                         params: params.delete_if { |key, value| value.nil? },
                         security_type: :user_data, api_key: api_key, api_secret_key: api_secret_key)
         end
+
+        # @note have not tested this for binance.us yet.
+        def withdraw!(coin: nil, withdrawOrderId: nil, network: nil, address: nil, addressTag: nil, amount: nil,
+                      transactionFeeFlag: false, name: nil, recvWindow: nil, api_key: nil, api_secret_key: nil)
+          raise Error.new(message: "amount is required") if amount.nil?
+          raise Error.new(message: "coin is required") if coin.nil?
+          raise Error.new(message: "address is required") if address.nil?
+          timestamp = Configuration.timestamp
+          params = {
+            coin: coin, withdrawOrderId: withdrawOrderId, network: network, address: address, timestamp: timestamp,
+            addressTag: addressTag, amount: amount, transactionFeeFlag: transactionFeeFlag,
+            name: name, recvWindow: recvWindow,
+          }
+          Request.send!(api_key_type: :read_info, path: "/sapi/v1/capital/withdraw/apply",
+                        params: params.delete_if { |key, value| value.nil? }, method: :post,
+                        security_type: :user_data, api_key: api_key, api_secret_key: api_secret_key)
+        end
       end
     end
   end

data/lib/binance/api/market_stream.rb

@@ -0,0 +1,46 @@
+module Binance
+  module Api
+    class MarketStream
+      class << self
+        def connect(api_key: nil, api_secret_key: nil)
+          EM.run {
+            ws = Faye::WebSocket::Client.new("wss://stream.binance.com:9443/stream?streams=<streamName1>/<streamName2>/<streamName3>")
+
+            ws.on :open do |event|
+              p [:open]
+              ws.send("Hello, world!")
+            end
+
+            ws.on :message do |event|
+              p [:message, event.data]
+            end
+
+            ws.on :close do |event|
+              p [:close, event.code, event.reason]
+              ws = nil
+            end
+          }
+        end
+
+        # It's recommended to send a ping about every 30 minutes.
+        def keepalive!(listen_key: nil, api_key: nil, api_secret_key: nil)
+          raise Error.new(message: "listen_key is required") if listen_key.nil?
+          Request.send!(api_key_type: :none, method: :put, path: "/api/v1/userDataStream",
+                        params: { listenKey: listen_key }, security_type: :user_stream)
+        end
+
+        def start!(api_key: nil, api_secret_key: nil)
+          Request.send!(api_key_type: :none, method: :post, path: "/api/v1/userDataStream",
+                        security_type: :user_stream, api_key: api_key, api_secret_key: api_secret_key)
+        end
+
+        def stop!(listen_key: nil, api_key: nil, api_secret_key: nil)
+          raise Error.new(message: "listen_key is required") if listen_key.nil?
+          Request.send!(api_key_type: :none, method: :delete, path: "/api/v1/userDataStream",
+                        params: { listenKey: listen_key }, security_type: :user_stream,
+                        api_key: api_key, api_secret_key: api_secret_key)
+        end
+      end
+    end
+  end
+end

data/lib/binance/api/request.rb

@@ -10,13 +10,16 @@ module Binance
           raise Error.new(message: "invalid security type #{security_type}") unless security_types.include?(security_type)
           all_headers = default_headers(api_key_type: api_key_type, security_type: security_type, api_key: api_key)
           params.delete_if { |k, v| v.nil? }
-          signature = signed_request_signature(params: params, api_secret_key: api_secret_key)
-          params.merge!(signature: signature) if [:trade, :user_data].include?(security_type)
+          if %w(trade user_data).include?(security_type&.to_s)
+            signature = signed_request_signature(params: params, api_secret_key: api_secret_key)
+            params.merge!(signature: signature)
+          end
           # send() is insecure so don't use it.
           case method
           when :get
             response = get(path, headers: all_headers, query: params)
           when :post
+            byebug
             response = post(path, body: params, headers: all_headers)
           when :put
             response = put(path, body: params, headers: all_headers)

data/lib/binance/api/trade.rb

@@ -0,0 +1,27 @@
+module Binance
+  module Api
+    class Trade
+      class << self
+        def get_bnb_burn_status!(recvWindow: nil, api_key: nil, api_secret_key: nil)
+          timestamp = Configuration.timestamp
+          params = { recvWindow: recvWindow, timestamp: timestamp }
+          Request.send!(api_key_type: :read_info, path: "/sapi/v1/bnbBurn",
+                        params: params.delete_if { |key, value| value.nil? },
+                        security_type: :user_data, tld: Configuration.tld, api_key: api_key,
+                        api_secret_key: api_secret_key)
+        end
+
+        def toggle_bnb_burn!(spot_bnb_burn: true, interest_bnb_burn: false, recvWindow: nil, api_key: nil,
+                             api_secret_key: nil)
+          timestamp = Configuration.timestamp
+          params = { spotBNBBurn: spot_bnb_burn, interestBNBBurn: interest_bnb_burn,
+                     recvWindow: recvWindow, timestamp: timestamp }
+          Request.send!(api_key_type: :read_info, path: "/sapi/v1/bnbBurn", method: :post,
+                        params: params.delete_if { |key, value| value.nil? },
+                        security_type: :user_data, tld: Configuration.tld, api_key: api_key,
+                        api_secret_key: api_secret_key)
+        end
+      end
+    end
+  end
+end

data/lib/binance/api/{data_stream.rb → user_data_stream.rb}

@@ -1,17 +1,18 @@
 module Binance
   module Api
-    class DataStream
+    class UserDataStream
       class << self
         # It's recommended to send a ping about every 30 minutes.
         def keepalive!(listen_key: nil, api_key: nil, api_secret_key: nil)
           raise Error.new(message: "listen_key is required") if listen_key.nil?
           Request.send!(api_key_type: :none, method: :put, path: "/api/v1/userDataStream",
-                        params: { listenKey: listen_key }, security_type: :user_stream)
+                        params: { listenKey: listen_key }, security_type: :user_stream,
+                        api_key: api_key, api_secret_key: api_secret_key)
         end
 
         def start!(api_key: nil, api_secret_key: nil)
           Request.send!(api_key_type: :none, method: :post, path: "/api/v1/userDataStream",
-                        security_type: :user_stream, api_key: api_key, api_secret_key: api_secret_key)
+                        security_type: :user_stream, api_key: api_key, api_secret_key: api_secret_key)[:listenKey]
         end
 
         def stop!(listen_key: nil, api_key: nil, api_secret_key: nil)

data/lib/binance/api/version.rb

@@ -1,5 +1,5 @@
 module Binance
   module Api
-    VERSION = "1.1.2"
+    VERSION = "1.2.7"
   end
 end

data/lib/binance/websocket.rb

@@ -0,0 +1,105 @@
+module Binance
+  class WebSocket < Faye::WebSocket::Client
+    class Error < StandardError; end
+
+    def initialize(on_open: nil, on_close: nil)
+      super "wss://stream.binance.com:9443/stream", nil, ping: 180
+
+      @request_id_inc = 0
+      @user_stream_handlers = {}
+
+      on :open do |event|
+        on_open&.call(event)
+      end
+
+      on :message do |event|
+        process_data(event.data)
+      end
+
+      on :close do |event|
+        on_close&.call(event)
+      end
+    end
+
+    # stream name: <symbol>@kline_<interval>
+    #
+    # {
+    #   "e": "kline",     // Event type
+    #   "E": 123456789,   // Event time
+    #   "s": "BNBBTC",    // Symbol
+    #   "k": {
+    #     "t": 123400000, // Kline start time
+    #     "T": 123460000, // Kline close time
+    #     "s": "BNBBTC",  // Symbol
+    #     "i": "1m",      // Interval
+    #     "f": 100,       // First trade ID
+    #     "L": 200,       // Last trade ID
+    #     "o": "0.0010",  // Open price
+    #     "c": "0.0020",  // Close price
+    #     "h": "0.0025",  // High price
+    #     "l": "0.0015",  // Low price
+    #     "v": "1000",    // Base asset volume
+    #     "n": 100,       // Number of trades
+    #     "x": false,     // Is this kline closed?
+    #     "q": "1.0000",  // Quote asset volume
+    #     "V": "500",     // Taker buy base asset volume
+    #     "Q": "0.500",   // Taker buy quote asset volume
+    #     "B": "123456"   // Ignore
+    #   }
+    # }
+    def candlesticks!(symbols, interval, &on_receive)
+      symbols_fmt = symbols.is_a?(String) ? [symbols] : symbols
+      @candlesticks_handler = on_receive
+      subscribe(symbols_fmt.map { |s| "#{s.downcase}@kline_#{interval}" })
+    end
+
+    def user_data_stream!(listen_key, &on_receive)
+      @user_stream_handlers[listen_key] = on_receive
+      subscribe([listen_key])
+    end
+
+    private
+
+    def process_data(data)
+      json = JSON.parse(data, symbolize_names: true)
+      if json[:error]
+        raise Error.new("(#{json[:code]}) #{json[:msg]}")
+      elsif json.key?(:result)
+        #  Binance stream connected successfully
+      else
+        case json[:data][:e]&.to_sym
+        when :kline
+          @candlesticks_handler&.call(json[:stream], json[:data])
+        when :outboundAccountPosition
+        when :balanceUpdate
+        when :executionReport # order update
+          listen_key = json[:stream]
+          @user_stream_handlers[listen_key]&.call(listen_key, json[:data])
+        end
+      end
+    end
+
+    def request_id
+      @request_id_inc += 1
+    end
+
+    def subscribe(streams)
+      send({
+        method: "SUBSCRIBE",
+        params: streams,
+        id: request_id,
+      }.to_json)
+    end
+
+    # Terminating socket connection achieves the same result.
+    # If you have a use-case for this, please create a GitHub issue.
+    #
+    # def unsubscribe(streams)
+    #   send({
+    #     method: "UNSUBSCRIBE",
+    #     params: streams,
+    #     id: request_id,
+    #   }.to_json)
+    # end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.7
 platform: ruby
 authors:
 - Jake Peterson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 11.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 11.1.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,47 +123,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.20.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: awrence
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: awrence
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
 description: Ruby wrapper for the Binance API.
 email:
 - hello@jakenberg.io
@@ -175,14 +203,17 @@ files:
 - lib/binance/api.rb
 - lib/binance/api/account.rb
 - lib/binance/api/configuration.rb
-- lib/binance/api/data_stream.rb
 - lib/binance/api/error.rb
 - lib/binance/api/margin.rb
 - lib/binance/api/margin/account.rb
 - lib/binance/api/margin/order.rb
+- lib/binance/api/market_stream.rb
 - lib/binance/api/order.rb
 - lib/binance/api/request.rb
+- lib/binance/api/trade.rb
+- lib/binance/api/user_data_stream.rb
 - lib/binance/api/version.rb
+- lib/binance/websocket.rb
 homepage: https://github.com/jakenberg/binance-ruby
 licenses:
 - MIT
@@ -206,5 +237,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: binance-ruby-1.1.2
+summary: binance-ruby-1.2.7
 test_files: []