binance 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17ceeaf8ec5393a0d116114d857bdea05c6e626b
-  data.tar.gz: 69fe61ac677f70dbe01f4b253fde3fe5e135d6ca
+  metadata.gz: 93fa8d27b55c0314452ebe5ce297136461cf33bc
+  data.tar.gz: fe2d138b2c69481c3c31796c2addadf44e03fa0e
 SHA512:
-  metadata.gz: a0b708aeacc91c3155701f518cff5223a97c1ec4c6732b82de4df5016bbd6288cbe9fac58f6afcdacbdb4320df71bd05cac96b452c7beed158ab76c4655bf7fe
-  data.tar.gz: e6719b7cb44ceb107a32ad6b92095425239f96f8efadc0edc63ad5816ed7c7be1a3820fd9087da9bdab3fc631aee2c835bebe61d0a0bbb696470125561f736ca
+  metadata.gz: a2d91b7c1774dbda1ccc2cb993116a0938d543986d058d7b03b16d39164b47bce86653d0c494e7d225403e243e34dfdc8c80ce24bb039992fdd82665a3bbd515
+  data.tar.gz: 732ab2f1be0f5bca04a792d4a3386ac87b06db57e70246819d04fecdeff1aadd238497c57d4cebcf11df1f9ae12dff224694e064e43f61dfee4ebb6f5fb6a0d8

data/lib/binance/client/rest.rb

@@ -4,6 +4,7 @@ require_relative 'rest/api_endpoints'
 require_relative 'rest/public_api'
 require_relative 'rest/account_api'
 require_relative 'rest/withdraw_api'
+require_relative 'rest/user_data_api'
 
 module Binance
   module Client
@@ -38,6 +39,7 @@ module Binance
         extend Public_API
         extend Account_API
         extend Withdraw_API
+        extend UserData_API
       end
 
       private

data/lib/binance/client/rest/api_endpoints.rb

@@ -30,7 +30,10 @@ module Binance
         'depositHistory'  => 'v3/depositHistory.html',
         'withdrawHistory' => 'v3/withdrawHistory.html',
         'depositAddress'  => 'v3/depositAddress.html',
-        'accountStatus'   => 'v3/accountStatus.html'
+        'accountStatus'   => 'v3/accountStatus.html',
+
+        # User Data Stream API Endpoints
+        'userDataStream'  => 'v1/userDataStream'
       }.freeze
     end
   end

data/lib/binance/client/rest/user_data_api.rb

@@ -0,0 +1,54 @@
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Binance
+  module Client
+    class REST
+      # Public: A Module containing all of the User Data API endpoints
+      module UserData_API
+        # Internal: Create Lambda that returns a new Faraday client instance
+        # and add it to the REST class instance variable @api. This is called
+        # while a new instance of the REST class is created.
+        #
+        # base - The base class that is being extended into.
+        def self.extended(base)
+          REST.api[:user_data] = lambda do
+            Faraday.new(url: "#{BASE_URL}/api") do |conn|
+              conn.response :json, content_type: /\bjson$/
+              conn.headers['X-MBX-APIKEY'] = base.api_key
+              conn.adapter base.adapter
+            end
+          end
+        end
+
+        # Public: Retrieve the listen key for the given api key
+        #
+        # Returns a Hash with the request response
+        def listen_key
+          request :user_data, :post, 'userDataStream'
+        end
+
+        # Public: Ping the server to keep User Data stream alive
+        #
+        # options - The Hash which hosts various REST query params.
+        #   :listen_key - The String of which stream to keep alive
+        #
+        # Returns a Hash with the request response
+        def keep_stream_alive(options)
+          request :user_data, :put, 'userDataStream', options
+        end
+
+        # Public: Close the User Data stream associated with the listen key
+        #
+        # options - The Hash which hosts various REST query params.
+        #   :listen_key - The String of which stream to close
+        #
+        # Returns a Hash with the request response
+        def close_stream(options)
+          request :user_data, :delete, 'userDataStream', options
+        end
+      end
+    end
+  end
+end

data/lib/binance/client/websocket.rb

@@ -153,6 +153,21 @@ module Binance
         single stream: { symbol: symbol, type: 'depth' }, methods: methods
       end
 
+      # Public: Create a User Data stream
+      #
+      # listen_key - The String key the stream will listen to, attained by
+      #              interacting with the REST API userDataStream endpoint
+      #
+      # :methods - The Hash which contains the event handler methods to pass to
+      #            the WebSocket client
+      #   :open    - The Proc called when a stream is opened (optional)
+      #   :message - The Proc called when a stream receives a message
+      #   :error   - The Proc called when a stream receives an error (optional)
+      #   :close   - The Proc called when a stream is closed (optional)
+      def user_data(listen_key:, methods:)
+        create_stream "#{BASE_URL}/ws/#{listen_key}", methods: methods
+      end
+
       private
 
       # Internal: Create a valid URL for a WebSocket to use

data/lib/binance/version.rb

@@ -1,4 +1,4 @@
 
 module Binance
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Charles Ray Shisler III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2018-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,7 @@ files:
 - lib/binance/client/rest/public_api.rb
 - lib/binance/client/rest/sign_request_middleware.rb
 - lib/binance/client/rest/timestamp_request_middleware.rb
+- lib/binance/client/rest/user_data_api.rb
 - lib/binance/client/rest/withdraw_api.rb
 - lib/binance/client/websocket.rb
 - lib/binance/version.rb