binance_client 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3905cb869b611e99b318cb5066477236ed55a9fc206681b7991c91c6bdaad3
-  data.tar.gz: a0f67542cf08ebaa538c4a740cf6ca4186ab619bc92a6b842ae3f3a5e1e039ef
+  metadata.gz: 4b4624eac956c44c052169d1c6598f527ac24dbee062321dd23525d33cc5fea0
+  data.tar.gz: 3cc4c5a13eedf200f51a218daf89aeb2ad4a8b49607149db8397af47b5c45c02
 SHA512:
-  metadata.gz: e57ec0318a7ed587a32154bd2c8de4c7ec5499137a33c46bb4cf166f1c89846c83cb8872037b87723a74c94c5c6ebef9aea0c72983b6a18cd4e4dae486400b18
-  data.tar.gz: e9a67ecd796b0a7baa21c8fc48e3b2e49ede84b3271f816a014bf007c0950d5255937242c8910af7d42c98659944cf1484ed59cc49977f4786f9fccd37cbc647
+  metadata.gz: 416797926140c8928d4db9eb322db9187d3744af4d8c0a9f5090ce1bbedc85edabd4ea2f26b9249591d329d6da01445f38a98f881d12a91d88d3f76349c3cc0f
+  data.tar.gz: 49cec6ad29790c32623484f23ca6986f79d635d738d18da4b3fec3b8a0495696d146380fea9a77f9011930ca2c8bdb7ab2d871f4ea7e1a7efdf7ded25d6b3037

data/CHANGELOG.md

@@ -4,6 +4,26 @@ 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.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
+
 ## [1.0.0]
 ### Fixed
 - Avoid "Signature for this request is not valid" errors by using the same timestamp

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,23 +1,23 @@
 PATH
   remote: .
   specs:
-    binance_client (1.0.0)
+    binance_client (1.4.0)
       activesupport
-      api_client_base
+      api_client_base (~> 1.11)
       typhoeus
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    api_client_base (1.9.0)
+    api_client_base (1.11.0)
       activesupport (>= 3.0)
       gem_config (>= 0.3.1)
       virtus (>= 1.0)
@@ -29,23 +29,24 @@ GEM
     coderay (1.1.3)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.4.4)
-    equalizer (0.0.11)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    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.5)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     method_source (1.0.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -63,6 +64,9 @@ GEM
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
@@ -71,30 +75,31 @@ GEM
     thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     vcr (6.0.0)
-    virtus (1.0.5)
+    virtus (2.0.0)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
     webmock (3.9.1)
       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)
+  rspec-its
   vcr
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.28

data/README.md

@@ -21,8 +21,8 @@ Or install it yourself as:
 ## Authenticate
 ```
 client = BinanceClient.new(
-    api_key: "your-api-key",
-    api_secret: "your-api-secret"
+  api_key: "your-api-key",
+  api_secret: "your-api-secret"
 )
 ```
 
@@ -36,15 +36,41 @@ client.system_status
 client.account_snapshot
 client.get_all
 client.book_ticker(symbol: "BTCETH")
+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,10 +25,11 @@ 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"
 
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rspec-its"
 end

data/lib/binance_client/client.rb

@@ -6,15 +6,19 @@ module BinanceClient
     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
 
     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}
     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/base_model.rb

@@ -0,0 +1,7 @@
+module BinanceClient
+  class BaseModel
+
+    include Virtus.model
+
+  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/order_book.rb

@@ -0,0 +1,40 @@
+module BinanceClient
+  class OrderBook < BaseModel
+
+    attribute :body, Hash
+    attribute(:last_update_id, Integer, {
+      lazy: true,
+      default: :default_last_update_id,
+    })
+    attribute(:bids, Array[BinanceClient::OrderBookEntry], {
+      lazy: true,
+      default: :default_bids,
+    })
+    attribute(:asks, Array[BinanceClient::OrderBookEntry], {
+      lazy: true,
+      default: :default_asks,
+    })
+
+    def default_last_update_id
+      body["lastUpdateId"]
+    end
+
+    def default_bids
+      _entries_from body["bids"]
+    end
+
+    def default_asks
+      _entries_from body["asks"]
+    end
+
+    private
+
+    def _entries_from(array)
+      array.map do |raw_entry|
+        price, quantity = raw_entry
+        OrderBookEntry.new(price: price, quantity: quantity)
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/order_book_entry.rb

@@ -0,0 +1,8 @@
+module BinanceClient
+  class OrderBookEntry < BaseModel
+
+    attribute :price, BigDecimal
+    attribute :quantity, BigDecimal
+
+  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/order_book_depth_request.rb

@@ -0,0 +1,18 @@
+module BinanceClient
+  class OrderBookDepthRequest < BaseRequest
+
+    attribute :symbol, String
+    attribute :limit, Integer
+
+    def path
+      "/api/v3/depth"
+    end
+
+    def params
+      h = {symbol: symbol}
+      h[:limit] = limit if not limit.nil?
+      h.to_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/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/order_book_depth_response.rb

@@ -0,0 +1,14 @@
+module BinanceClient
+  class OrderBookDepthResponse < BaseResponse
+
+    attribute(:order_book, BinanceClient::OrderBook, {
+      lazy: true,
+      default: :default_order_book,
+    })
+
+    def default_order_book
+      OrderBook.new(body: 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.0.0"
+  VERSION = "1.4.0"
 end

data/lib/binance_client.rb

@@ -7,16 +7,29 @@ require "openssl"
 
 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/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"
 
 module BinanceClient
   class Error < StandardError; end
@@ -29,5 +42,6 @@ module BinanceClient
     has :host, classes: String, default: DEFAULT_HOST
     has :api_key, classes: String
     has :api_secret, classes: String
+    has :proxy
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - AJ Villalobos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-12-09 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
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for Binance API
 email:
 - hi@ajvillalobos.com
@@ -102,15 +116,28 @@ 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_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_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
@@ -135,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for Binance API