binance-ruby 0.5 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbd02bd36bb807895e727ed07261b63c4f8863862dd9016723b69e47d7033856
-  data.tar.gz: 64c57054923d757d07cbec602af8a6cc687a8646f65c8c62c63691e872a4e325
+  metadata.gz: e74c503800c58d470ef98deb95f32629f9954938dd64945dff998b50651d2733
+  data.tar.gz: 5a7977d1840a0a710bdbd825934b4fbb7ed991dba686f7c8aa4aa8251a0722aa
 SHA512:
-  metadata.gz: 01de466a3ba9a8811493029f1eef4ee059f0934ea165854b842c2d655e78fcc3677806ea6fd562142143b8af51afa338fd0f98c5875696f33b75c57efd25b288
-  data.tar.gz: cf17dfb48360a3a3ee089fb1461f50660f63344666dab63e3a2e42eb575a28a3bad121499795bae01f1e4d300deb385ed8c5128046a4be42cd3580ca0a8a37c5
+  metadata.gz: ea8fe1a34c96744a54e1e67aa589e336fb63ca843ce7e7b6c6d65e14e8a3142f9fdf523ff3df311c5ad1bd483ec26bb0dbb874abd5a2054af0dbafc970fce112
+  data.tar.gz: e39a5fe7430cd9055400eb4886a07e3ce679327af63ba2f03739c100fb9e00b29a344a2a06c7e7aaf357d84480c669072f923c30eb3c5d6c66d9aaa9d3856305

data/lib/binance-ruby.rb

@@ -7,6 +7,8 @@ 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"

data/lib/binance/api/configuration.rb

@@ -16,8 +16,7 @@ module Binance
 
         def tld
           tld = ENV["BINANCE_TLD"]&.downcase&.to_sym || :com
-          error_message = "Invalid tld (top-level-domain): #{tld}. Use one of: #{allowed_tlds.join(", ")}."
-          raise Error.new(message: error_message) unless allowed_tlds.include?(tld)
+          validate_tld!(tld)
           tld
         end
 
@@ -36,6 +35,11 @@ module Binance
           Time.now.utc.strftime("%s%3N")
         end
 
+        def validate_tld!(tld)
+          error_message = "Invalid tld (top-level-domain): #{tld}. Use one of: #{allowed_tlds.join(", ")}."
+          raise Error.new(message: error_message) unless allowed_tlds.include?(tld&.to_sym)
+        end
+
         private
 
         def allowed_tlds

data/lib/binance/api/error.rb

@@ -1,7 +1,7 @@
 module Binance
   module Api
     class Error < StandardError
-      attr_reader :code, :msg
+      attr_reader :code, :msg, :symbol
 
       class << self
         # https://github.com/binance-exchange/binance-official-api-docs/blob/master/errors.md
@@ -10,9 +10,10 @@ module Binance
         end
       end
 
-      def initialize(code: nil, json: {}, message: nil)
+      def initialize(code: nil, json: {}, message: nil, symbol: nil)
         @code = code || json[:code]
         @msg = message || json[:msg]
+        @symbol = message || json[:symbol]
       end
 
       def inspect

data/lib/binance/api/margin.rb

@@ -0,0 +1,43 @@
+module Binance
+  module Api
+    module Margin
+      class << self
+        # Your Margin Wallet balance determines the amount of funds you can borrow,
+        # following a fixed rate of 5:1 (5x).
+        def borrow!(asset: nil, amount: nil, recvWindow: nil)
+          timestamp = Configuration.timestamp
+          params = {
+            asset: asset, amount: amount, recvWindow: recvWindow, timestamp: timestamp,
+          }.delete_if { |_, value| value.nil? }
+          ensure_required_keys!(params: params)
+          path = "/sapi/v1/margin/loan"
+          Request.send!(api_key_type: :trading, method: :post, path: path,
+                        params: params, security_type: :margin, tld: Configuration.tld)
+        end
+
+        def repay!(asset: nil, isIsolated: nil, amount: nil, recvWindow: nil)
+          timestamp = Configuration.timestamp
+          params = {
+            asset: asset, amount: amount, recvWindow: recvWindow, timestamp: timestamp,
+          }.delete_if { |_, value| value.nil? }
+          ensure_required_keys!(params: params)
+          path = "/sapi/v1/margin/repay"
+          Request.send!(api_key_type: :trading, method: :post, path: path,
+                        params: params, security_type: :margin, tld: Configuration.tld)
+        end
+
+        private
+
+        def ensure_required_keys!(params:)
+          keys = required_margin_keys.dup
+          missing_keys = keys.select { |key| params[key].nil? }
+          raise Error.new(message: "required keys are missing: #{missing_keys.join(", ")}") unless missing_keys.empty?
+        end
+
+        def required_margin_keys
+          [:asset, :amount, :timestamp].freeze
+        end
+      end
+    end
+  end
+end

data/lib/binance/api/margin/account.rb

@@ -0,0 +1,32 @@
+module Binance
+  module Api
+    module Margin
+      class Account
+        class << self
+          def transfer!(asset: nil, amount: nil, type: nil, recvWindow: nil)
+            timestamp = Configuration.timestamp
+            params = {
+              asset: asset, amount: amount, type: type, recvWindow: recvWindow, timestamp: timestamp,
+            }.delete_if { |_, value| value.nil? }
+            ensure_required_create_keys!(params: params)
+            path = "/sapi/v1/margin/transfer"
+            Request.send!(api_key_type: :trading, method: :post, path: path,
+                          params: params, security_type: :margin, tld: Configuration.tld)
+          end
+
+          private
+
+          def ensure_required_create_keys!(params:)
+            keys = required_create_keys.dup
+            missing_keys = keys.select { |key| params[key].nil? }
+            raise Error.new(message: "required keys are missing: #{missing_keys.join(", ")}") unless missing_keys.empty?
+          end
+
+          def required_create_keys
+            [:asset, :amount, :type, :timestamp].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/binance/api/margin/order.rb

@@ -3,6 +3,19 @@ module Binance
     module Margin
       class Order
         class << self
+          def cancel!(symbol: nil, isIsolated: false, orderId: nil, origClientOrderId: nil,
+                      newClientOrderId: nil, recvWindow: nil)
+            timestamp = Configuration.timestamp
+            params = {
+              symbol: symbol, isIsolated: isIsolated, orderId: orderId, origClientOrderId: origClientOrderId,
+              newClientOrderId: newClientOrderId, recvWindow: recvWindow, timestamp: timestamp,
+            }.delete_if { |_, value| value.nil? }
+            ensure_required_cancel_keys!(params: params)
+            path = "/sapi/v1/margin/order"
+            Request.send!(api_key_type: :trading, method: :delete, path: path,
+                          params: params, security_type: :margin, tld: Configuration.tld)
+          end
+
           def create!(symbol: nil, isIsolated: false, side: nil, type: nil, quantity: nil,
                       quoteOrderQty: nil, price: nil, stopPrice: nil, newClientOrderId: nil,
                       icebergQty: nil, newOrderRespType: nil, sideEffectType: nil, timeInForce: nil,
@@ -18,7 +31,7 @@ module Binance
             ensure_required_create_keys!(params: params)
             path = "/sapi/v1/margin/order"
             Request.send!(api_key_type: :trading, method: :post, path: path,
-                          params: params, security_type: :trade)
+                          params: params, security_type: :margin, tld: Configuration.tld)
           end
 
           private
@@ -47,6 +60,16 @@ module Binance
           def required_create_keys
             [:symbol, :side, :type, :timestamp].freeze
           end
+
+          def ensure_required_cancel_keys!(params:)
+            keys = required_cancel_keys.dup
+            missing_keys = keys.select { |key| params[key].nil? }
+            raise Error.new(message: "required keys are missing: #{missing_keys.join(", ")}") unless missing_keys.empty?
+          end
+
+          def required_cancel_keys
+            [:symbol, :timestamp].freeze
+          end
         end
       end
     end

data/lib/binance/api/order.rb

@@ -9,7 +9,7 @@ module Binance
           params = { limit: limit, orderId: orderId, recvWindow: recvWindow, symbol: symbol, timestamp: timestamp }
           Request.send!(api_key_type: :read_info, path: "/api/v3/allOrders",
                         params: params.delete_if { |key, value| value.nil? },
-                        security_type: :user_data)
+                        security_type: :user_data, tld: Configuration.tld)
         end
 
         # Be careful when accessing without a symbol!
@@ -17,7 +17,7 @@ module Binance
           timestamp = Configuration.timestamp
           params = { recvWindow: recvWindow, symbol: symbol, timestamp: timestamp }
           Request.send!(api_key_type: :read_info, path: "/api/v3/openOrders",
-                        params: params, security_type: :user_data)
+                        params: params, security_type: :user_data, tld: Configuration.tld)
         end
 
         def cancel!(orderId: nil, originalClientOrderId: nil, newClientOrderId: nil, recvWindow: nil, symbol: nil)
@@ -29,7 +29,7 @@ module Binance
                      newClientOrderId: newClientOrderId, recvWindow: recvWindow,
                      symbol: symbol, timestamp: timestamp }.delete_if { |key, value| value.nil? }
           Request.send!(api_key_type: :trading, method: :delete, path: "/api/v3/order",
-                        params: params, security_type: :trade)
+                        params: params, security_type: :trade, tld: Configuration.tld)
         end
 
         def create!(icebergQuantity: nil, newClientOrderId: nil, newOrderResponseType: nil,
@@ -45,7 +45,7 @@ module Binance
           ensure_required_create_keys!(params: params)
           path = "/api/v3/order#{"/test" if test}"
           Request.send!(api_key_type: :trading, method: :post, path: path,
-                        params: params, security_type: :trade)
+                        params: params, security_type: :trade, tld: Configuration.tld)
         end
 
         def status!(orderId: nil, originalClientOrderId: nil, recvWindow: nil, symbol: nil)
@@ -58,7 +58,7 @@ module Binance
             symbol: symbol, timestamp: timestamp,
           }.delete_if { |key, value| value.nil? }
           Request.send!(api_key_type: :trading, path: "/api/v3/order",
-                        params: params, security_type: :user_data)
+                        params: params, security_type: :user_data, tld: Configuration.tld)
         end
 
         private

data/lib/binance/api/request.rb

@@ -3,8 +3,9 @@ module Binance
     class Request
       include HTTParty
       class << self
-        def send!(api_key_type: :none, headers: {}, method: :get, path: "/", params: {}, security_type: :none)
-          self.base_uri "https://api.binance.#{Configuration.tld}"
+        def send!(api_key_type: :none, headers: {}, method: :get, path: "/", params: {}, security_type: :none, tld: :com)
+          Configuration.validate_tld!(tld)
+          self.base_uri "https://api.binance.#{tld}"
 
           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)
@@ -36,13 +37,18 @@ module Binance
         end
 
         def process!(response:)
-          json = JSON.parse(response.body, symbolize_names: true)
+          json = begin
+              JSON.parse(response.body, symbolize_names: true)
+            rescue JSON::ParserError => error
+              # binance 500 errors are html format
+              raise Error.new(message: error)
+            end
           raise Error.new(json: json) if Error.is_error_response?(response: response)
           json
         end
 
         def security_types
-          [:none, :trade, :user_data, :user_stream, :market_data].freeze
+          [:none, :trade, :user_data, :user_stream, :market_data, :margin].freeze
         end
 
         def signed_request_signature(params:)

data/lib/binance/api/version.rb

@@ -1,5 +1,5 @@
 module Binance
   module Api
-    VERSION = "0.5"
+    VERSION = "0.6.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-ruby
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.6.4
 platform: ruby
 authors:
 - Jake Peterson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -129,9 +129,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,9 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: awrence
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +177,8 @@ files:
 - 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/order.rb
 - lib/binance/api/request.rb
@@ -210,5 +206,5 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
-summary: binance-ruby-0.5
+summary: binance-ruby-0.6.4
 test_files: []