binance_client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8e52b3c3199ac128f970071e84b73cc25781a92f2206170b1513d523321631
-  data.tar.gz: 81f4c9e55772be4cb4ba350c764ebca822d66d541cb560a6477fe5e6ae0bd91e
+  metadata.gz: 65dba4f920f7c9e017d74cee2c972ae54af6f731faa17c6eb15c9602061e0bb7
+  data.tar.gz: 0aa2e07fac3321d91513d0ab3904e80f09351b538507d7b915cf20145166f13f
 SHA512:
-  metadata.gz: bfb4049818b8846b1e2bcb1913ff473b9d9a9c782aab2a7dfc9b7b6cd262a2144aa17530fc2aeccccd4314df0a77f074c5b9ffa5afad615ab269b645edcb9e09
-  data.tar.gz: 55054e667ceb9219fdb4098dcbd14257126d8568a463eb8fbe28692d0b545587ce30a1d1372f30141b688b5ad06402e88469f6b484079f91c028b6884b958069
+  metadata.gz: e72bc48d33af094253cbbe395f9bf8f6d67343a7bcc8cf912e69740e4733c4161f7a1d06fc4755f1ff236f214b8026c1f896b360b99204e9338b18c02e95b906
+  data.tar.gz: 43f1d01d8a1ac0ab5fd540f13933e4d5cd17d34f063ab1dc924372a0a94e74599c4672fbeb411e6378c97f86182eb61a46a8ee3285c1838f98ce11d17b3706cd

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2021-11-26
+### Added
+- Allow easy access to the `used_weight` header in a response by calling `#used_weight(interval)`
+- `#sub_account_assets` to get the assets of a sub-account
+- `#body_code` to return the value of "code" in the body, if it exists
+- `#message` to return the value of "message" in the body, if it exists
+
 ## [1.1.0]
 ### Added
 - `order_book_depth` (`/api/v3/depth`) to get a snapshot of the order book

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    binance_client (1.1.0)
+    binance_client (1.2.0)
       activesupport
-      api_client_base
+      api_client_base (~> 1.11)
       typhoeus
 
 GEM
@@ -17,7 +17,7 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    api_client_base (1.10.0)
+    api_client_base (1.11.0)
       activesupport (>= 3.0)
       gem_config (>= 0.3.1)
       virtus (>= 1.0)
@@ -35,12 +35,12 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.4.4)
-    ethon (0.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
     ffi (1.15.4)
     gem_config (0.3.2)
     hashdiff (1.0.1)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     method_source (1.0.0)
@@ -84,7 +84,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -99,4 +99,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.24
+   2.2.28

data/README.md

@@ -42,6 +42,27 @@ client.order_book_depth(symbol: "BTCUSDT", limit: 100)
 ## Responses
 The default representation of response data is a JSON hash
 
+## Hooks
+You can set a hook to do application-specific things per request. This is useful when monitoring the rate limits:
+
+```ruby
+BinanceClient.after_request = DoSomethingAfterBinanceRequest
+```
+
+What you assign can be a proc -- it just needs to respond to `call` and accept the `BinanceClient` response object:
+
+```ruby
+class DoSomethingAfterBinanceRequest
+
+  def self.call(response)
+    one_minute_weight = response.used_weight("1m")
+    if one_minute_weight > 1200
+      Rails.logger.info "Looks like we've hit the request limit!"
+    end
+  end
+
+end
+```
 
 ## Development
 Edit the `config.yml.sample` with your own credentials for testing

data/binance_client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "api_client_base"
+  spec.add_dependency "api_client_base", "~> 1.11"
   spec.add_dependency "activesupport"
   spec.add_dependency "typhoeus"
 

data/lib/binance_client/client.rb

@@ -7,6 +7,7 @@ module BinanceClient
     api_action :get_all
     api_action :book_ticker
     api_action :order_book_depth
+    api_action :sub_account_assets, args: [:email]
 
     attribute :host
     attribute :api_key

data/lib/binance_client/models/asset_balance.rb

@@ -0,0 +1,21 @@
+module BinanceClient
+  class AssetBalance
+
+    attr_reader :asset
+
+    def initialize(asset:, free:, locked:)
+      @asset = asset
+      @free = free
+      @locked = locked
+    end
+
+    def free
+      @free.to_d
+    end
+
+    def locked
+      @locked.to_d
+    end
+
+  end
+end

data/lib/binance_client/requests/account_snapshot_request.rb

@@ -1,28 +1,14 @@
 module BinanceClient
-  class AccountSnapshotRequest < BaseRequest
+  class AccountSnapshotRequest < AuthenticatedBaseRequest
     private
 
     def path
       "/sapi/v1/accountSnapshot"
     end
 
-    def params
-      type = "SPOT"
-      limit = 30
-      query = query(type: type, limit: limit)
-
-      [
-        query,
-        "signature=#{signature(query)}"
-      ].join("&")
+    def params_without_signature
+      { type: "SPOT", limit: 30 }
     end
 
-    def query(options={})
-      [
-        "type=#{options[:type]}",
-        "timestamp=#{timestamp}",
-        "limit=#{options[:limit]}",
-      ].join("&")
-    end
   end
 end

data/lib/binance_client/requests/authenticated_base_request.rb

@@ -0,0 +1,34 @@
+module BinanceClient
+  class AuthenticatedBaseRequest < BaseRequest
+    include APIClientBase::Request.module
+
+    def signature
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new("sha256"),
+        api_secret,
+        params_without_signature_with_timestamp.to_query,
+      )
+    end
+
+    def signature_hash
+      { signature: signature }
+    end
+
+    def timestamp
+      @timestamp ||= DateTime.now.strftime("%Q")
+    end
+
+    def params
+      params_without_signature_with_timestamp.merge(signature_hash).to_query
+    end
+
+    def params_without_signature_with_timestamp
+      params_without_signature.merge(timestamp: timestamp)
+    end
+
+    def params_without_signature
+      {}
+    end
+
+  end
+end

data/lib/binance_client/requests/base_request.rb

@@ -4,7 +4,6 @@ module BinanceClient
 
     attribute :api_key, String
     attribute :api_secret, String
-    attribute :timestamp, Integer, lazy: true, default: :default_timestamp
 
     def headers
       {
@@ -13,16 +12,5 @@ module BinanceClient
       }
     end
 
-    def signature(query)
-      OpenSSL::HMAC.hexdigest(
-        OpenSSL::Digest.new("sha256"),
-        api_secret,
-        query,
-      )
-    end
-
-    def default_timestamp
-      DateTime.now.strftime("%Q")
-    end
   end
 end

data/lib/binance_client/requests/get_all_request.rb

@@ -1,25 +1,10 @@
 module BinanceClient
-  class GetAllRequest < BaseRequest
+  class GetAllRequest < AuthenticatedBaseRequest
     private
 
     def path
       "/sapi/v1/capital/config/getall"
     end
 
-    def query
-      uri = Addressable::URI.new(query_values: {
-        timestamp: timestamp,
-      })
-      uri.normalized_query
-    end
-
-    def params
-      uri = Addressable::URI.new(query: query)
-      uri.query_values = [
-        uri.query,
-        ["signature", signature(query)],
-      ]
-      uri.normalized_query
-    end
   end
 end

data/lib/binance_client/requests/sub_account_assets_request.rb

@@ -0,0 +1,15 @@
+module BinanceClient
+  class SubAccountAssetsRequest < AuthenticatedBaseRequest
+    attribute :email
+
+    private
+
+    def path
+      "/sapi/v3/sub-account/assets"
+    end
+
+    def params_without_signature
+      {email: email}
+    end
+  end
+end

data/lib/binance_client/responses/base_response.rb

@@ -2,12 +2,29 @@ module BinanceClient
   class BaseResponse
     include APIClientBase::Response.module
 
-    attribute :body, Object, default: :default_body
+    attribute :body, Object, lazy: true, default: :default_body
+
+    def used_weight(interval)
+      val = header("X-MBX-USED-WEIGHT-#{interval}")
+      return nil if val.nil?
+      val.to_i
+    end
+
+    def message
+      body["message"]
+    end
+
+    def body_code
+      val = body["code"]
+      return nil if val.nil?
+      val.to_i
+    end
 
     private
 
     def default_body
       JSON.parse(raw_response.body)
     end
+
   end
 end

data/lib/binance_client/responses/sub_account_assets_response.rb

@@ -0,0 +1,16 @@
+module BinanceClient
+  class SubAccountAssetsResponse < BaseResponse
+
+    attribute(:balances, Array[BinanceClient::AssetBalance], {
+      lazy: true,
+      default: :default_balances,
+    })
+
+    def default_balances
+      body["balances"].map do |balance_hash|
+        AssetBalance.new(**balance_hash.symbolize_keys)
+      end
+    end
+
+  end
+end

data/lib/binance_client/version.rb

@@ -1,3 +1,3 @@
 module BinanceClient
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/binance_client.rb

@@ -10,19 +10,23 @@ require "binance_client/client"
 require "binance_client/models/base_model"
 require "binance_client/models/order_book_entry"
 require "binance_client/models/order_book"
+require "binance_client/models/asset_balance"
 
 require "binance_client/requests/base_request"
+require "binance_client/requests/authenticated_base_request"
 require "binance_client/responses/base_response"
 require "binance_client/requests/system_status_request"
 require "binance_client/requests/account_snapshot_request"
 require "binance_client/requests/get_all_request"
 require "binance_client/requests/book_ticker_request"
 require "binance_client/requests/order_book_depth_request"
+require "binance_client/requests/sub_account_assets_request"
 require "binance_client/responses/system_status_response"
 require "binance_client/responses/account_snapshot_response"
 require "binance_client/responses/get_all_response"
 require "binance_client/responses/book_ticker_response"
 require "binance_client/responses/order_book_depth_response"
+require "binance_client/responses/sub_account_assets_response"
 
 module BinanceClient
   class Error < StandardError; end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - AJ Villalobos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -116,20 +116,24 @@ files:
 - binance_client.gemspec
 - lib/binance_client.rb
 - lib/binance_client/client.rb
+- lib/binance_client/models/asset_balance.rb
 - lib/binance_client/models/base_model.rb
 - lib/binance_client/models/order_book.rb
 - lib/binance_client/models/order_book_entry.rb
 - lib/binance_client/requests/account_snapshot_request.rb
+- lib/binance_client/requests/authenticated_base_request.rb
 - lib/binance_client/requests/base_request.rb
 - lib/binance_client/requests/book_ticker_request.rb
 - lib/binance_client/requests/get_all_request.rb
 - lib/binance_client/requests/order_book_depth_request.rb
+- lib/binance_client/requests/sub_account_assets_request.rb
 - lib/binance_client/requests/system_status_request.rb
 - lib/binance_client/responses/account_snapshot_response.rb
 - lib/binance_client/responses/base_response.rb
 - lib/binance_client/responses/book_ticker_response.rb
 - lib/binance_client/responses/get_all_response.rb
 - lib/binance_client/responses/order_book_depth_response.rb
+- lib/binance_client/responses/sub_account_assets_response.rb
 - lib/binance_client/responses/system_status_response.rb
 - lib/binance_client/version.rb
 homepage: https://github.com/bloom-solutions/binance_client-ruby