binance_client 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8e52b3c3199ac128f970071e84b73cc25781a92f2206170b1513d523321631
-  data.tar.gz: 81f4c9e55772be4cb4ba350c764ebca822d66d541cb560a6477fe5e6ae0bd91e
+  metadata.gz: 16763512a190393e8a071e5e0840de77416ec615e91edf8f86cc1b897ca40c4b
+  data.tar.gz: e30373d8442ad67cd59a43bd5e4c1c97b8bf93724d2a1d0820d02363ae7387d1
 SHA512:
-  metadata.gz: bfb4049818b8846b1e2bcb1913ff473b9d9a9c782aab2a7dfc9b7b6cd262a2144aa17530fc2aeccccd4314df0a77f074c5b9ffa5afad615ab269b645edcb9e09
-  data.tar.gz: 55054e667ceb9219fdb4098dcbd14257126d8568a463eb8fbe28692d0b545587ce30a1d1372f30141b688b5ad06402e88469f6b484079f91c028b6884b958069
+  metadata.gz: a92884dc017a7a2ae3b868acd953eb7c89e95f08e537176e7298fff4112f5acb6c4582f73156fb7b4a99b9c7523b0e57a5219a423e4903ea38052f1a03ba8186
+  data.tar.gz: cf6a0272acc771014477ed8946a293c688a5a5679814f4f96d24cdf09fbd605843d0bfce113a2ae819f4d969f85e5331f758b72299fccbd08f32bb1c57f26672

data/CHANGELOG.md

@@ -4,6 +4,33 @@ 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.5.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)`
+- `#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

@@ -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,9 +1,9 @@
 PATH
   remote: .
   specs:
-    binance_client (1.1.0)
+    binance_client (2.0.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,14 @@ 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)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.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,13 +86,14 @@ 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
 
 DEPENDENCIES
   binance_client!
+  factory_bot
   pry-byebug
   rake (~> 12.0)
   rspec (~> 3.0)
@@ -99,4 +102,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.24
+   2.2.28

data/README.md

@@ -42,10 +42,35 @@ 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.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 DoSomethingAfterBinanceResponse
+
+  def self.call(request, 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
 
+## 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/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

@@ -2,20 +2,31 @@ 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 :book_ticker
     api_action :order_book_depth
+    api_action :sub_account_assets, args: [:email]
+    api_action :sub_account_deposit_address, args: [:email, :coin]
 
     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/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/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/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/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,39 @@
+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_and_recv_window.to_query,
+      )
+    end
+
+    def signature_hash
+      { signature: signature }
+    end
+
+    def timestamp
+      @timestamp ||= DateTime.now.strftime("%Q")
+    end
+
+    def params
+      params_without_signature_with_timestamp_and_recv_window.
+        merge(signature_hash).to_query
+    end
+
+    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
+      {}
+    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/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/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

@@ -2,12 +2,31 @@ module BinanceClient
   class BaseResponse
     include APIClientBase::Response.module
 
-    attribute :body, Object, default: :default_body
+    attribute :body, Object, lazy: true, default: :default_body
+
+    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
+      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/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/version.rb

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

data/lib/binance_client.rb

@@ -2,6 +2,7 @@ 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 "json"
 require "openssl"
 
@@ -10,19 +11,28 @@ 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/models/deposit_address"
 
 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/requests/sub_account_deposit_address_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/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/account_response"
 
 module BinanceClient
   class Error < StandardError; end
@@ -35,5 +45,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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - AJ Villalobos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-12-10 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,30 @@ 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_address.rb
 - lib/binance_client/models/order_book.rb
 - lib/binance_client/models/order_book_entry.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/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/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/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/system_status_response.rb
 - lib/binance_client/version.rb
 homepage: https://github.com/bloom-solutions/binance_client-ruby