binance_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3905cb869b611e99b318cb5066477236ed55a9fc206681b7991c91c6bdaad3
-  data.tar.gz: a0f67542cf08ebaa538c4a740cf6ca4186ab619bc92a6b842ae3f3a5e1e039ef
+  metadata.gz: 2b8e52b3c3199ac128f970071e84b73cc25781a92f2206170b1513d523321631
+  data.tar.gz: 81f4c9e55772be4cb4ba350c764ebca822d66d541cb560a6477fe5e6ae0bd91e
 SHA512:
-  metadata.gz: e57ec0318a7ed587a32154bd2c8de4c7ec5499137a33c46bb4cf166f1c89846c83cb8872037b87723a74c94c5c6ebef9aea0c72983b6a18cd4e4dae486400b18
-  data.tar.gz: e9a67ecd796b0a7baa21c8fc48e3b2e49ede84b3271f816a014bf007c0950d5255937242c8910af7d42c98659944cf1484ed59cc49977f4786f9fccd37cbc647
+  metadata.gz: bfb4049818b8846b1e2bcb1913ff473b9d9a9c782aab2a7dfc9b7b6cd262a2144aa17530fc2aeccccd4314df0a77f074c5b9ffa5afad615ab269b645edcb9e09
+  data.tar.gz: 55054e667ceb9219fdb4098dcbd14257126d8568a463eb8fbe28692d0b545587ce30a1d1372f30141b688b5ad06402e88469f6b484079f91c028b6884b958069

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binance_client (1.0.0)
+    binance_client (1.1.0)
       activesupport
       api_client_base
       typhoeus
@@ -9,15 +9,15 @@ PATH
 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.10.0)
       activesupport (>= 3.0)
       gem_config (>= 0.3.1)
       virtus (>= 1.0)
@@ -29,23 +29,22 @@ 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.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.4)
     gem_config (0.3.2)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       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 +62,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,14 +73,13 @@ 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)
@@ -93,8 +94,9 @@ DEPENDENCIES
   pry-byebug
   rake (~> 12.0)
   rspec (~> 3.0)
+  rspec-its
   vcr
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.24

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,6 +36,7 @@ client.system_status
 client.account_snapshot
 client.get_all
 client.book_ticker(symbol: "BTCETH")
+client.order_book_depth(symbol: "BTCUSDT", limit: 100)
 ```
 
 ## Responses

data/binance_client.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rspec-its"
 end

data/lib/binance_client/client.rb

@@ -6,6 +6,7 @@ module BinanceClient
     api_action :account_snapshot
     api_action :get_all
     api_action :book_ticker
+    api_action :order_book_depth
 
     attribute :host
     attribute :api_key

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/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/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/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/version.rb

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

data/lib/binance_client.rb

@@ -7,16 +7,22 @@ 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/requests/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/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"
 
 module BinanceClient
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - AJ Villalobos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -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,20 @@ files:
 - binance_client.gemspec
 - lib/binance_client.rb
 - lib/binance_client/client.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/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/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/system_status_response.rb
 - lib/binance_client/version.rb
 homepage: https://github.com/bloom-solutions/binance_client-ruby
@@ -135,7 +154,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