binance_client 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65dba4f920f7c9e017d74cee2c972ae54af6f731faa17c6eb15c9602061e0bb7
-  data.tar.gz: 0aa2e07fac3321d91513d0ab3904e80f09351b538507d7b915cf20145166f13f
+  metadata.gz: 92d03cdb49a0580cae0efce1cbcaf3f908994f2959473801eccfcabb46cd8c1d
+  data.tar.gz: 8eadce8b6bdb99dad54e1e58724c65595f79a843006e13cc0c4618ee5d62bf88
 SHA512:
-  metadata.gz: e72bc48d33af094253cbbe395f9bf8f6d67343a7bcc8cf912e69740e4733c4161f7a1d06fc4755f1ff236f214b8026c1f896b360b99204e9338b18c02e95b906
-  data.tar.gz: 43f1d01d8a1ac0ab5fd540f13933e4d5cd17d34f063ab1dc924372a0a94e74599c4672fbeb411e6378c97f86182eb61a46a8ee3285c1838f98ce11d17b3706cd
+  metadata.gz: f31e20576e0c83a044f2f59a3e4a5a8bddb0dfce7eab0a73494ef101dbfce4cefee7c3404b004bd3b1d1438f1accd155d151d819d4028405d9c36c2c10a4ab11
+  data.tar.gz: 7f24cd955d6a8e2ca3ab560b0f45900c514f12001e49e5cfcbfd206b49b24ad7a105111dbc1f673b8831f4091d01486fe6a97922ca0ce12c9dd8116cf6635c7d

data/CHANGELOG.md

@@ -4,6 +4,31 @@ 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).
 
+## [2.1.0]
+### Added
+- `exchange_info` endpoint
+- `sub_account_deposit_history` endpoint
+
+## [2.0.0]
+### Changed
+- Remove `used_weight` from responses
+
+### Added
+- `recv_window` configuration to set `recvWindow`
+- `#account` call to get the `/api/v3/account` info
+
+### Added
+- `used_weights` to responses
+
+## [1.4.0] - 2021-12-09
+### Added
+- Add factories for use in app development
+- Add `#sub_account_deposit_address`
+
+## [1.3.0] - 2021-11-29
+### Added
+- Add proxy support
+
 ## [1.2.0] - 2021-11-26
 ### Added
 - Allow easy access to the `used_weight` header in a response by calling `#used_weight(interval)`

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in binance_client.gemspec
 gemspec
 
+gem "factory_bot"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "pry-byebug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binance_client (1.2.0)
+    binance_client (2.1.0)
       activesupport
       api_client_base (~> 1.11)
       typhoeus
@@ -37,6 +37,8 @@ GEM
     diff-lcs (1.4.4)
     ethon (0.15.0)
       ffi (>= 1.15.0)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
     ffi (1.15.4)
     gem_config (0.3.2)
     hashdiff (1.0.1)
@@ -91,6 +93,7 @@ PLATFORMS
 
 DEPENDENCIES
   binance_client!
+  factory_bot
   pry-byebug
   rake (~> 12.0)
   rspec (~> 3.0)

data/README.md

@@ -39,6 +39,8 @@ client.book_ticker(symbol: "BTCETH")
 client.order_book_depth(symbol: "BTCUSDT", limit: 100)
 ```
 
+See `spec/acceptance` for all calls.
+
 ## Responses
 The default representation of response data is a JSON hash
 
@@ -46,19 +48,16 @@ The default representation of response data is a JSON hash
 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
+BinanceClient.configuration.after_response = DoSomethingAfterBinanceResponse
 ```
 
 What you assign can be a proc -- it just needs to respond to `call` and accept the `BinanceClient` response object:
 
 ```ruby
-class DoSomethingAfterBinanceRequest
+class DoSomethingAfterBinanceResponse
 
-  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
+  def self.call(request, response)
+    response.used_weights # Ruby hash of the headers of all the possible used weights
   end
 
 end
@@ -67,6 +66,10 @@ end
 ## Development
 Edit the `config.yml.sample` with your own credentials for testing
 
+## Factories
+
+To make testing easier in your app, `require "binance_client/factories"` to get access to factories of the models.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bloom-solutions/binance_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bloom-solutions/binance_client/blob/master/CODE_OF_CONDUCT.md).

data/lib/binance_client/client.rb

@@ -2,21 +2,33 @@ module BinanceClient
   class Client
     include APIClientBase::Client.module(default_opts: :default_opts)
 
+    api_action :account
     api_action :system_status
     api_action :account_snapshot
     api_action :get_all
+    api_action :exchange_info
     api_action :book_ticker
     api_action :order_book_depth
     api_action :sub_account_assets, args: [:email]
+    api_action :sub_account_deposit_address, args: [:email, :coin]
+    api_action :sub_account_deposit_history
 
     attribute :host
     attribute :api_key
     attribute :api_secret
+    attribute :proxy
+    attribute :recv_window
 
     private
 
     def default_opts
-      {host: host, api_key: api_key, api_secret: api_secret}
+      {
+        host: host,
+        api_key: api_key,
+        api_secret: api_secret,
+        proxy: proxy,
+        recv_window: recv_window,
+      }
     end
   end
 end

data/lib/binance_client/factories.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+
+  factory :binance_client_asset_balance, class: "BinanceClient::AssetBalance" do
+    sequence(:asset) { |n| "ASSET#{n}" }
+    free { rand(10_000) }
+    locked { rand(1_000) }
+
+    initialize_with do
+      new(asset: asset, free: free, locked: locked)
+    end
+  end
+
+end

data/lib/binance_client/models/deposit.rb

@@ -0,0 +1,31 @@
+module BinanceClient
+  class Deposit
+
+    METHODS = %i[
+      sub_account_id
+      address
+      address_tag
+      amount
+      coin
+      insert_time
+      network
+      status
+      tx_id
+      source_address
+      confirm_times
+    ].freeze
+
+    attr_reader :raw_hash
+
+    def initialize(raw_hash:)
+      @raw_hash = raw_hash
+    end
+
+    METHODS.each do |method_name|
+      define_method method_name do
+        raw_hash[method_name.to_s.camelcase(:lower)]
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/deposit_address.rb

@@ -0,0 +1,28 @@
+module BinanceClient
+  class DepositAddress
+
+    def self.new_from_raw(raw_hash)
+      args = raw_hash.each_with_object({}) do |(k, v), h|
+        h[k.underscore] = v
+      end
+
+      self.new(**args)
+    end
+
+    ATTRS = [
+      :address,
+      :coin,
+      :tag,
+      :url,
+    ]
+
+    attr_accessor(*ATTRS)
+
+    def initialize(**kwargs)
+      kwargs.each do |attr, value|
+        self.send("#{attr}=", value)
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/market.rb

@@ -0,0 +1,53 @@
+module BinanceClient
+  class Market < BaseModel
+
+    METHODS = %i[
+      symbol
+      status
+      base_asset
+      base_asset_precision
+      quote_asset
+      quote_precision
+      quote_asset_precision
+      base_commission_precision
+      quote_commission_precision
+      order_types
+      iceberg_allowed
+      oco_allowed
+      quote_order_qty_market_allowed
+      is_spot_trading_allowed
+      is_margin_trading_allowed
+    ].freeze
+
+    BOOL_MAP = {
+      iceberg_allowed: :iceberg_allowed?,
+      oco_allowed: :oco_allowed?,
+      quote_order_qty_market_allowed: :quote_order_qty_market_allowed?,
+      is_spot_trading_allowed: :spot_trading_allowed?,
+      is_margin_trading_allowed: :margin_trading_allowed?,
+    }.freeze
+
+    attr_reader :raw_hash
+
+    def initialize(raw_hash:)
+      @raw_hash = raw_hash
+    end
+
+    METHODS.each do |method_name|
+      define_method method_name do
+        raw_hash[method_name.to_s.camelcase(:lower)]
+      end
+    end
+
+    BOOL_MAP.each do |original_method_name, alias_method_name|
+      alias_method alias_method_name, original_method_name
+    end
+
+    def filters
+      @filters ||= raw_hash["filters"].map do |filter_hash|
+        MarketFilter.new(raw_hash: filter_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/market_filter.rb

@@ -0,0 +1,25 @@
+module BinanceClient
+  class MarketFilter
+
+    attr_reader :raw_hash
+
+    def initialize(raw_hash:)
+      @raw_hash = raw_hash
+    end
+
+    def method_missing(method_name, *args)
+      key = method_name.to_s.camelcase(:lower)
+      super if raw_hash[key].nil?
+
+      self.class.define_method method_name do
+        value = raw_hash[method_name.to_s.camelcase(:lower)]
+
+        value = value.to_d if value =~ /^[\d\.]+$/
+
+        value
+      end
+      send(method_name)
+    end
+
+  end
+end

data/lib/binance_client/models/rate_limit.rb

@@ -0,0 +1,24 @@
+module BinanceClient
+  class RateLimit
+
+    METHODS = %i[
+      rate_limit_type
+      interval
+      interval_num
+      limit
+    ].freeze
+
+    attr_reader :raw_hash
+
+    def initialize(raw_hash:)
+      @raw_hash = raw_hash
+    end
+
+    METHODS.each do |method_name|
+      define_method method_name do
+        raw_hash[method_name.to_s.camelcase(:lower)]
+      end
+    end
+
+  end
+end

data/lib/binance_client/requests/account_request.rb

@@ -0,0 +1,10 @@
+module BinanceClient
+  class AccountRequest < AuthenticatedBaseRequest
+    private
+
+    def path
+      "/api/v3/account"
+    end
+
+  end
+end

data/lib/binance_client/requests/authenticated_base_request.rb

@@ -2,11 +2,13 @@ module BinanceClient
   class AuthenticatedBaseRequest < BaseRequest
     include APIClientBase::Request.module
 
+    attribute :recv_window, Integer
+
     def signature
       OpenSSL::HMAC.hexdigest(
         OpenSSL::Digest.new("sha256"),
         api_secret,
-        params_without_signature_with_timestamp.to_query,
+        params_without_signature_with_timestamp_and_recv_window.to_query,
       )
     end
 
@@ -19,11 +21,14 @@ module BinanceClient
     end
 
     def params
-      params_without_signature_with_timestamp.merge(signature_hash).to_query
+      params_without_signature_with_timestamp_and_recv_window.
+        merge(signature_hash).to_query
     end
 
-    def params_without_signature_with_timestamp
-      params_without_signature.merge(timestamp: timestamp)
+    def params_without_signature_with_timestamp_and_recv_window
+      attrs_to_merge = { timestamp: timestamp }
+      attrs_to_merge[:recvWindow] = recv_window if recv_window.present?
+      params_without_signature.merge(attrs_to_merge)
     end
 
     def params_without_signature

data/lib/binance_client/requests/exchange_info_request.rb

@@ -0,0 +1,10 @@
+module BinanceClient
+  class ExchangeInfoRequest < BaseRequest
+    private
+
+    def path
+      "api/v1/exchangeInfo"
+    end
+
+  end
+end

data/lib/binance_client/requests/sub_account_deposit_address_request.rb

@@ -0,0 +1,25 @@
+module BinanceClient
+  class SubAccountDepositAddressRequest < AuthenticatedBaseRequest
+
+    attribute :email, String
+    attribute :coin, String
+    attribute :network, String
+
+    private
+
+    def path
+      "/sapi/v1/capital/deposit/subAddress"
+    end
+
+    def params_without_signature
+      {
+        email: email,
+        coin: coin,
+        network: network,
+      }.reject do |key, value|
+        value.nil?
+      end
+    end
+
+  end
+end

data/lib/binance_client/requests/sub_account_deposit_history_request.rb

@@ -0,0 +1,36 @@
+module BinanceClient
+  class SubAccountDepositHistoryRequest < AuthenticatedBaseRequest
+    attribute :sub_account_id, String
+    attribute :start_time, DateTime
+    attribute :end_time, DateTime
+    attribute :coin, String
+    attribute :status, Integer
+    attribute :limit, Integer
+    attribute :offset, Integer
+
+    PARAMS = [
+      :sub_account_id,
+      :start_time,
+      :end_time,
+      :coin,
+      :status,
+      :limit,
+      :offset,
+    ].freeze
+
+    private
+
+    def path
+      "/sapi/v1/broker/subAccount/depositHist"
+    end
+
+    def params_without_signature
+      PARAMS.each_with_object({}) do |param, hash|
+        key = param.to_s.camelcase(:lower)
+        value = send(param)
+        value = value.to_i * 1_000 if value.is_a?(DateTime)
+        hash[key] = value
+      end
+    end
+  end
+end

data/lib/binance_client/responses/account_response.rb

@@ -0,0 +1,29 @@
+module BinanceClient
+  class AccountResponse < BaseResponse
+
+    [
+      :maker_commission,
+      :taker_commission,
+      :buyer_commission,
+      :seller_commission,
+      :can_trade,
+      :can_withdraw,
+      :can_deposit,
+      :update_time,
+      :account_type,
+      :permissions,
+    ].each do |method_name|
+      define_method method_name do
+        key = method_name.to_s.camelcase(:lower)
+        body[key]
+      end
+    end
+
+    def balances
+      body["balances"].map do |balance_hash|
+        AssetBalance.new(**balance_hash.symbolize_keys)
+      end
+    end
+
+  end
+end

data/lib/binance_client/responses/base_response.rb

@@ -4,10 +4,12 @@ module BinanceClient
 
     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
+    def used_weights
+      @used_weights ||= headers.each_with_object({}) do |(key, value), hash|
+        next if not key.include?("USED")
+        next if not key.include?("WEIGHT")
+        hash[key] = value
+      end
     end
 
     def message

data/lib/binance_client/responses/exchange_info_response.rb

@@ -0,0 +1,30 @@
+module BinanceClient
+  class ExchangeInfoResponse < BaseResponse
+
+    def timezone
+      body["timezone"]
+    end
+
+    def timezone
+      body["timezone"]
+    end
+
+    def server_time
+      body["serverTime"]
+    end
+
+    def markets
+      @markets ||= body["symbols"].map do |market_hash|
+        Market.new(raw_hash: market_hash)
+      end
+    end
+    alias_method :symbols, :markets
+
+    def rate_limits
+      @rate_limits ||= body["rateLimits"].map do |rate_limit_hash|
+        RateLimit.new(raw_hash: rate_limit_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/responses/sub_account_deposit_address_response.rb

@@ -0,0 +1,14 @@
+module BinanceClient
+  class SubAccountDepositAddressResponse < BaseResponse
+
+    def deposit_address
+      DepositAddress.new(
+        address: body["address"],
+        coin: body["coin"],
+        tag: body["tag"],
+        url: body["url"],
+      )
+    end
+
+  end
+end

data/lib/binance_client/responses/sub_account_deposit_history_response.rb

@@ -0,0 +1,11 @@
+module BinanceClient
+  class SubAccountDepositHistoryResponse < BaseResponse
+
+    def deposits
+      body.map do |deposit_hash|
+        Deposit.new(raw_hash: deposit_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/version.rb

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

data/lib/binance_client.rb

@@ -2,6 +2,9 @@ require "binance_client/version"
 require "api_client_base"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/date_time"
+require "active_support/core_ext/integer"
 require "json"
 require "openssl"
 
@@ -11,22 +14,35 @@ 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/models/deposit_address"
+require "binance_client/models/market"
+require "binance_client/models/market_filter"
+require "binance_client/models/rate_limit"
+require "binance_client/models/deposit"
 
 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/exchange_info_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/requests/sub_account_deposit_address_request"
+require "binance_client/requests/sub_account_deposit_history_request"
+require "binance_client/requests/account_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/exchange_info_response"
 require "binance_client/responses/book_ticker_response"
 require "binance_client/responses/order_book_depth_response"
 require "binance_client/responses/sub_account_assets_response"
+require "binance_client/responses/sub_account_deposit_address_response"
+require "binance_client/responses/sub_account_deposit_history_response"
+require "binance_client/responses/account_response"
 
 module BinanceClient
   class Error < StandardError; end
@@ -39,5 +55,7 @@ module BinanceClient
     has :host, classes: String, default: DEFAULT_HOST
     has :api_key, classes: String
     has :api_secret, classes: String
+    has :recv_window, classes: [NilClass, Integer]
+    has :proxy
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - AJ Villalobos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-26 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -116,24 +116,38 @@ files:
 - binance_client.gemspec
 - lib/binance_client.rb
 - lib/binance_client/client.rb
+- lib/binance_client/factories.rb
 - lib/binance_client/models/asset_balance.rb
 - lib/binance_client/models/base_model.rb
+- lib/binance_client/models/deposit.rb
+- lib/binance_client/models/deposit_address.rb
+- lib/binance_client/models/market.rb
+- lib/binance_client/models/market_filter.rb
 - lib/binance_client/models/order_book.rb
 - lib/binance_client/models/order_book_entry.rb
+- lib/binance_client/models/rate_limit.rb
+- lib/binance_client/requests/account_request.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/exchange_info_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/sub_account_deposit_address_request.rb
+- lib/binance_client/requests/sub_account_deposit_history_request.rb
 - lib/binance_client/requests/system_status_request.rb
+- lib/binance_client/responses/account_response.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/exchange_info_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/sub_account_deposit_address_response.rb
+- lib/binance_client/responses/sub_account_deposit_history_response.rb
 - lib/binance_client/responses/system_status_response.rb
 - lib/binance_client/version.rb
 homepage: https://github.com/bloom-solutions/binance_client-ruby