binance-ruby 1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f8673071ace387d77172b21b9066e11ea6613cf72275ca1090cfb94e7d8f65
-  data.tar.gz: 860a8193bbb5c28877aa6e8ed6cac65c2680064a68be3bebc6913da1c74a51df
+  metadata.gz: 124f7e539a6f6e6003bf7c2619ba039a6a930037976815729398e34adb4686a1
+  data.tar.gz: a6dc10be4aa7629143663260ce33111b96b8a2f50b64ffef88bd219ed282ca12
 SHA512:
-  metadata.gz: 73c5b120484d13c814f621784b3d8e255255a96ad98cad8f68494af778412ef6518e7ea0aaac69a42a1336dd1de93d640e7a040005360c08f35d2392242fa25b
-  data.tar.gz: e1f8c8bc28eb9d12148fe3499842bf39a4d50d7b7a09bad69f740c20b040a912e71321eea4c9b08b8f5ffa1d66756e4ae0de4de4fe766a85432c36491f69503c
+  metadata.gz: 649dd4131cc420ae5b179616fdc4bc8d5b75e96ff864075c07ad47279b5a0819557f4f246a47a07e9367e1430fb8b48d063aa54ec7474397c065772be49d9481
+  data.tar.gz: 68c57f977409d0756df3a982c7a1c92a5b0af26b7c3c1fb3468bba855ac5057f9e0d925e5a81025edc1f78cdb27ac05df2b3d6a08d716e7f42d313014e5fb3db

data/lib/binance-ruby.rb

@@ -1,6 +1,7 @@
 require "active_support/core_ext/string"
 require "awrence"
 require "httparty"
+require "faye/websocket"
 
 require "binance/api"
 require "binance/api/account"
@@ -13,3 +14,4 @@ require "binance/api/margin/order"
 require "binance/api/order"
 require "binance/api/request"
 require "binance/api/version"
+require "binance/websocket"

data/lib/binance/api/error.rb

@@ -19,6 +19,7 @@ module Binance
           when 1003 then TooManyRequests
           when 1006 then UnexpectedResponse
           when 1007 then Timeout
+          when 1013 then InvalidQuantity
           when 1014 then UnknownOrderComposition
           when 1015 then TooManyOrders
           when 1016 then ServiceShuttingDown
@@ -84,6 +85,7 @@ module Binance
       class TooManyRequests < Error; end
       class UnexpectedResponse < Error; end
       class Timeout < Error; end
+      class InvalidQuantity < Error; end
       class UnknownOrderComposition < Error; end
       class TooManyOrders < Error; end
       class ServiceShuttingDown < Error; 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/order.rb

@@ -37,12 +37,12 @@ module Binance
         end
 
         def create!(icebergQuantity: nil, newClientOrderId: nil, newOrderResponseType: nil,
-                    price: nil, quantity: nil, recvWindow: nil, stopPrice: nil, symbol: nil,
+                    price: nil, quantity: nil, quoteOrderQty: nil, recvWindow: nil, stopPrice: nil, symbol: nil,
                     side: nil, type: nil, timeInForce: nil, test: false, api_key: nil, api_secret_key: nil)
           timestamp = Configuration.timestamp
           params = {
             icebergQty: icebergQuantity, newClientOrderId: newClientOrderId,
-            newOrderRespType: newOrderResponseType, price: price, quantity: quantity,
+            newOrderRespType: newOrderResponseType, price: price, quantity: quantity, quoteOrderQty: quoteOrderQty,
             recvWindow: recvWindow, stopPrice: stopPrice, symbol: symbol, side: side,
             type: type, timeInForce: timeInForce, timestamp: timestamp,
           }.delete_if { |key, value| value.nil? }
@@ -92,7 +92,7 @@ module Binance
         end
 
         def required_create_keys
-          [:symbol, :side, :type, :quantity, :timestamp].freeze
+          [:symbol, :side, :type, :timestamp].freeze
         end
       end
     end

data/lib/binance/api/request.rb

@@ -3,7 +3,7 @@ module Binance
     class Request
       include HTTParty
       class << self
-        def send!(api_key_type: :none, headers: {}, method: :get, path: "/", params: {}, security_type: :none, tld: :com, api_key: nil, api_secret_key: nil)
+        def send!(api_key_type: :none, headers: {}, method: :get, path: "/", params: {}, security_type: :none, tld: Configuration.tld, api_key: nil, api_secret_key: nil)
           Configuration.validate_tld!(tld)
           self.base_uri "https://api.binance.#{tld}"
 

data/lib/binance/api/version.rb

@@ -1,5 +1,5 @@
 module Binance
   module Api
-    VERSION = "1.0"
+    VERSION = "1.2.1"
   end
 end

data/lib/binance/websocket.rb

@@ -0,0 +1,89 @@
+module Binance
+  class WebSocket < Faye::WebSocket::Client
+    def initialize(on_open: nil, on_close: nil)
+      super "wss://stream.binance.com:9443/stream", nil, ping: 180
+
+      @request_id_inc = 0
+
+      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
+
+    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])
+        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
+
+    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.0'
+  version: 1.2.1
 platform: ruby
 authors:
 - Jake Peterson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -164,6 +164,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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'
 description: Ruby wrapper for the Binance API.
 email:
 - hello@jakenberg.io
@@ -180,9 +208,11 @@ files:
 - 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/version.rb
+- lib/binance/websocket.rb
 homepage: https://github.com/jakenberg/binance-ruby
 licenses:
 - MIT
@@ -206,5 +236,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: binance-ruby-1.0
+summary: binance-ruby-1.2.1
 test_files: []