binance_client 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d03cdb49a0580cae0efce1cbcaf3f908994f2959473801eccfcabb46cd8c1d
-  data.tar.gz: 8eadce8b6bdb99dad54e1e58724c65595f79a843006e13cc0c4618ee5d62bf88
+  metadata.gz: d0ffbedc335b6922f76dc12d791c2e362e012408ec15d89ccbc9a601277874d2
+  data.tar.gz: d260ca781537671f0efa3cbefad3543f681b5d8c8616d52ceaa8f411dda02d02
 SHA512:
-  metadata.gz: f31e20576e0c83a044f2f59a3e4a5a8bddb0dfce7eab0a73494ef101dbfce4cefee7c3404b004bd3b1d1438f1accd155d151d819d4028405d9c36c2c10a4ab11
-  data.tar.gz: 7f24cd955d6a8e2ca3ab560b0f45900c514f12001e49e5cfcbfd206b49b24ad7a105111dbc1f673b8831f4091d01486fe6a97922ca0ce12c9dd8116cf6635c7d
+  metadata.gz: ae418449f912f5acab8efea9cb2369d221ff25477254f973e4dc87e44b54d1a4eb9b4835cb2e926af9b725a3187a974a105d1c815dd704f4b03d78e2eb61871a
+  data.tar.gz: 81b69e1a4cbb64e0a22459a98909f605421a6fbf9286a94a448868cf951d4004cd468e2a08a2ab2d47843b2e18d774dd1284ac6acb242ded188182799a0629a1

data/CHANGELOG.md

@@ -4,6 +4,25 @@ 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).
 
+## [3.0.1]
+### Fixed
+- `Coin#network_list` is initialized properly
+- Return decimal for the following methods of `Network`:
+  - `#withdraw_fee`
+  - `#withdraw_integer_multiple`
+  - `#withdraw_max`
+  - `#withdraw_min`
+
+## [3.0.0]
+### Changed
+- Rename `#get_all` to `#coins_info` and give access to info via the response's `#coins` method
+
+### Fixed
+- `Deposit#insert_time` returns `Time` and not an Integer of milliseconds
+
+### Added
+- Add Deposit, RateLimit factories
+
 ## [2.1.0]
 ### Added
 - `exchange_info` endpoint

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binance_client (2.1.0)
+    binance_client (3.0.1)
       activesupport
       api_client_base (~> 1.11)
       typhoeus

data/README.md

@@ -34,7 +34,7 @@ We provide one method per API endpoint.
 ```
 client.system_status
 client.account_snapshot
-client.get_all
+client.coins_info
 client.book_ticker(symbol: "BTCETH")
 client.order_book_depth(symbol: "BTCUSDT", limit: 100)
 ```

data/lib/binance_client/client.rb

@@ -5,7 +5,7 @@ module BinanceClient
     api_action :account
     api_action :system_status
     api_action :account_snapshot
-    api_action :get_all
+    api_action :coins_info
     api_action :exchange_info
     api_action :book_ticker
     api_action :order_book_depth

data/lib/binance_client/factories.rb

@@ -10,4 +10,59 @@ FactoryBot.define do
     end
   end
 
+  factory :binance_client_deposit, class: "BinanceClient::Deposit" do
+    sequence(:sub_account_id) { |n| n.to_s }
+    sequence(:address) { |n| "address#{n}" }
+    sequence(:address_tag) { |n| "address_tag#{n}" }
+    sequence(:amount) { |n| n * 10 }
+    sequence(:coin) { |n| "coin#{n}" }
+    sequence(:insert_time) { |n| Time.now }
+    sequence(:network) { |n| "network#{n}" }
+    sequence(:status) { |n| "status#{n}" }
+    sequence(:tx_id) { |n| "tx_id#{n}" }
+    sequence(:source_address) { |n| "source_address#{n}" }
+    sequence(:confirm_times) { |n| "#{n}/#{n}" }
+  end
+
+  factory :binance_client_rate_limit, class: "BinanceClient::RateLimit" do
+    rate_limit_type { "REQUEST_WEIGHT" }
+    interval { %w[SECOND MINUTE DAY].sample }
+    sequence(:interval_num) { |n| n }
+    sequence(:limit) { |n| n }
+  end
+
+  factory :binance_client_coin, class: "BinanceClient::Coin" do
+    sequence(:coin) { |n| "ASSET#{n}" }
+    sequence(:name) { |n| "Asset #{n}" }
+    free { 0.001 }
+    freeze { 0.001 }
+    ipoable { 0.002 }
+    ipoing { 0.003 }
+    locked { 0.004 }
+    storage { 0.005 }
+    withdrawing { 0.006 }
+  end
+
+  factory :binance_client_network, class: "BinanceClient::Network" do
+    address_regex { "^(bnb1)[0-9a-z]{38}$" }
+    coin { "BTC" }
+    deposit_desc { "Wallet Maintenance" }
+    deposit_enable { false }
+    is_default { false }
+    memo_regex { "^[0-9A-Za-z\\-_]{1,120}$" }
+    min_confirm { 1 }
+    name { "BEP2" }
+    network { "BNB" }
+    reset_address_status { false }
+    special_tips { "Both a MEMO is required" }
+    un_lock_confirm { 0 }
+    withdraw_desc { "Wallet Maintenance" }
+    withdraw_enable { false }
+    withdraw_fee { "0.00000220" }
+    withdraw_integer_multiple { "0.00000001" }
+    withdraw_max { "9999999999.99999999" }
+    withdraw_min { "0.00000440" }
+    same_address { true }
+  end
+
 end

data/lib/binance_client/models/base_model.rb

@@ -3,5 +3,12 @@ module BinanceClient
 
     include Virtus.model
 
+    private
+
+    def memoize_results(key)
+      return instance_variable_get(key) if instance_variable_defined?(key)
+      instance_variable_set key, yield
+    end
+
   end
 end

data/lib/binance_client/models/coin.rb

@@ -0,0 +1,70 @@
+module BinanceClient
+  class Coin < BaseModel
+
+    STR_METHODS = %i[
+      coin
+      name
+    ].freeze
+
+    DECIMAL_METHODS = %i[
+      free
+      freeze
+      ipoable
+      ipoing
+      locked
+      storage
+      withdrawing
+    ].freeze
+
+    BOOL_MAP = {
+      deposit_all_enable: :deposit_all_enabled?,
+      is_legal_money: :legal_money?,
+      trading: :trading?,
+      withdraw_all_enable: :withdraw_all_enabled?,
+    }.freeze
+
+    METHODS = (STR_METHODS + DECIMAL_METHODS + BOOL_MAP.keys).freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    STR_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    DECIMAL_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)].to_d
+        end
+      end
+    end
+
+    BOOL_MAP.each do |original_method_name, alias_method_name|
+      define_method original_method_name do
+        memoize_results "@#{original_method_name}" do
+          raw_hash[original_method_name.to_s.camelcase(:lower)]
+        end
+      end
+
+      alias_method alias_method_name, original_method_name
+    end
+
+    def network_list
+      @network_list ||= raw_hash["networkList"].map do |network_hash|
+        Network.new(raw_hash: network_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/deposit.rb

@@ -1,5 +1,5 @@
 module BinanceClient
-  class Deposit
+  class Deposit < BaseModel
 
     METHODS = %i[
       sub_account_id
@@ -7,25 +7,34 @@ module BinanceClient
       address_tag
       amount
       coin
-      insert_time
       network
       status
       tx_id
       source_address
       confirm_times
+      insert_time
     ].freeze
 
-    attr_reader :raw_hash
+    attr_accessor :raw_hash
+    attr_writer *METHODS
 
-    def initialize(raw_hash:)
-      @raw_hash = raw_hash
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
     end
 
     METHODS.each do |method_name|
       define_method method_name do
-        raw_hash[method_name.to_s.camelcase(:lower)]
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
       end
     end
 
+    def insert_time
+      @insert_time ||= Time.at(raw_hash["insertTime"] / 1_000)
+    end
+
   end
 end

data/lib/binance_client/models/market.rb

@@ -27,15 +27,20 @@ module BinanceClient
       is_margin_trading_allowed: :margin_trading_allowed?,
     }.freeze
 
-    attr_reader :raw_hash
+    attr_accessor :raw_hash
+    attr_writer *METHODS
 
-    def initialize(raw_hash:)
-      @raw_hash = raw_hash
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
     end
 
     METHODS.each do |method_name|
       define_method method_name do
-        raw_hash[method_name.to_s.camelcase(:lower)]
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
       end
     end
 

data/lib/binance_client/models/network.rb

@@ -0,0 +1,70 @@
+module BinanceClient
+  class Network < BaseModel
+
+    PLAIN_METHODS = %i[
+      address_regex
+      coin
+      deposit_desc
+      memo_regex
+      min_confirm
+      name
+      network
+      special_tips
+      un_lock_confirm
+      withdraw_desc
+    ].freeze
+
+    DECIMAL_METHODS = %i[
+      withdraw_fee
+      withdraw_integer_multiple
+      withdraw_max
+      withdraw_min
+    ].freeze
+
+    BOOL_MAP = {
+      deposit_enable: :deposit_enabled?,
+      is_default: :default?,
+      reset_address_status: :reset_address_status?,
+      withdraw_enable: :withdraw_enabled?,
+      same_address: :same_address?
+    }.freeze
+
+    METHODS = (PLAIN_METHODS + DECIMAL_METHODS + BOOL_MAP.keys).freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    PLAIN_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    DECIMAL_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)].to_d
+        end
+      end
+    end
+
+    BOOL_MAP.each do |original_method_name, alias_method_name|
+      define_method original_method_name do
+        memoize_results "@#{original_method_name}" do
+          raw_hash[original_method_name.to_s.camelcase(:lower)]
+        end
+      end
+
+      alias_method alias_method_name, original_method_name
+    end
+
+  end
+end

data/lib/binance_client/models/rate_limit.rb

@@ -1,6 +1,7 @@
 module BinanceClient
-  class RateLimit
+  class RateLimit < BaseModel
 
+    INTERVALS = %w[SECOND MINUTE DAY].freeze
     METHODS = %i[
       rate_limit_type
       interval
@@ -8,15 +9,26 @@ module BinanceClient
       limit
     ].freeze
 
-    attr_reader :raw_hash
+    attr_accessor :raw_hash
+    attr_writer *METHODS
 
-    def initialize(raw_hash:)
-      @raw_hash = raw_hash
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
     end
 
     METHODS.each do |method_name|
       define_method method_name do
-        raw_hash[method_name.to_s.camelcase(:lower)]
+        memoize_results("@#{method_name}") do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    INTERVALS.each do |interval|
+      define_method "#{interval.downcase}?" do
+        interval == self.interval
       end
     end
 

data/lib/binance_client/requests/{get_all_request.rb → coins_info_request.rb}

@@ -1,5 +1,5 @@
 module BinanceClient
-  class GetAllRequest < AuthenticatedBaseRequest
+  class CoinsInfoRequest < AuthenticatedBaseRequest
     private
 
     def path

data/lib/binance_client/responses/coins_info_response.rb

@@ -0,0 +1,11 @@
+module BinanceClient
+  class CoinsInfoResponse < BaseResponse
+
+    def coins
+      @coins ||= body.map do |coin_hash|
+        Coin.new(raw_hash: coin_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/version.rb

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

data/lib/binance_client.rb

@@ -19,6 +19,8 @@ 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/models/network"
+require "binance_client/models/coin"
 
 require "binance_client/requests/base_request"
 require "binance_client/requests/authenticated_base_request"
@@ -26,7 +28,7 @@ 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/coins_info_request"
 require "binance_client/requests/book_ticker_request"
 require "binance_client/requests/order_book_depth_request"
 require "binance_client/requests/sub_account_assets_request"
@@ -35,7 +37,7 @@ 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/coins_info_response"
 require "binance_client/responses/exchange_info_response"
 require "binance_client/responses/book_ticker_response"
 require "binance_client/responses/order_book_depth_response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.1
 platform: ruby
 authors:
 - AJ Villalobos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -119,10 +119,12 @@ files:
 - lib/binance_client/factories.rb
 - lib/binance_client/models/asset_balance.rb
 - lib/binance_client/models/base_model.rb
+- lib/binance_client/models/coin.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/network.rb
 - lib/binance_client/models/order_book.rb
 - lib/binance_client/models/order_book_entry.rb
 - lib/binance_client/models/rate_limit.rb
@@ -131,8 +133,8 @@ files:
 - 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/coins_info_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
@@ -142,8 +144,8 @@ files:
 - 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/coins_info_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

data/lib/binance_client/responses/get_all_response.rb

@@ -1,4 +0,0 @@
-module BinanceClient
-  class GetAllResponse < BaseResponse
-  end
-end