binance 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e860ec11ba1d0b5997779e051d950ed1f107aef
-  data.tar.gz: beb925d31c5779175a6ae792f3548a6c9a900ac8
+  metadata.gz: 4b8366cc935a0035bd2e70601ee916f1cfdbc22d
+  data.tar.gz: 01a47ff596c0ebbc7c466a75ea6d0e831c584bc9
 SHA512:
-  metadata.gz: 1afd91d95a45e4dbe2f5c9f1fccde5db0f404efeecdb3e03ab8a66ca3e3a259314f8134f388ebf96196a91d13fbd7b819cab2c5d4fabf4b1a5b66bae77300fcf
-  data.tar.gz: c2855fa5f67d34672723a843a9c06613432d5594fbb27671fb5433eb3dcf82bfd2e4f440e959e7ae4ca81e3192a159e0a224dcf4507b3e24fb11f061db1ab0fb
+  metadata.gz: 272b026095a34ec596cb50b1b9a37fa8e08324e8acf2285fd8829aa48498ad192a8452df21e4dd72827b53c19f96bda8ce9f9acc209ad63ac2a39b62afdc75d9
+  data.tar.gz: 0abed3c7a6528027df5228a010c674d2bca0712838dfb2c688212ef80813266d8ed098f81dbf079ae326825f48b3106e1d6da2d70fd6dec21ea2f0449ad11aeb

data/lib/binance/client/rest.rb

@@ -1,10 +1,15 @@
 
 require 'faraday'
-require_relative 'rest/api_endpoints'
+require 'faraday_middleware'
+
+require_relative 'rest/sign_request_middleware'
+require_relative 'rest/timestamp_request_middleware'
+
 require_relative 'rest/public_api'
 require_relative 'rest/account_api'
 require_relative 'rest/withdraw_api'
-require_relative 'rest/user_data_api'
+
+require_relative 'rest/api_endpoints'
 
 module Binance
   module Client
@@ -13,14 +18,9 @@ module Binance
       # Public: String base url for REST client to use
       BASE_URL = 'https://www.binance.com'.freeze
 
-      # Gets populated by the different APIs that get extended by the instances
-      @api = {}
-
-      class << self
-        attr_accessor :api
-      end
-
-      attr_reader :api_key, :secret_key, :adapter
+      include PublicAPI
+      include AccountAPI
+      include WithdrawAPI
 
       # Public: Initialize a REST Client
       #
@@ -32,18 +32,58 @@ module Binance
       #               (Default = Faraday.default_adapter).
       def initialize(api_key: '', secret_key: '',
                      adapter: Faraday.default_adapter)
-        @api_key = api_key
-        @secret_key = secret_key
-        @adapter = adapter
-
-        extend Public_API
-        extend Account_API
-        extend Withdraw_API
-        extend UserData_API
+        @library = {}
+        # Endpoint doesn't require an api_key or secret_key
+        @library[:public]   = public_client adapter
+        # Endpoint requires an api_key
+        @library[:verified] = verified_client api_key, adapter
+        # Endpoint requires an api_key and secret_key
+        @library[:signed]   = signed_client api_key, secret_key, adapter
+        # Endpoint requires an api_key and secret_key - for the Withdraw API
+        @library[:withdraw] = withdraw_client api_key, secret_key, adapter
+
       end
 
       private
 
+      def public_client(adapter)
+        Faraday.new(url: "#{BASE_URL}/api") do |conn|
+          conn.request :json
+          conn.response :json, content_type: /\bjson$/
+          conn.adapter adapter
+        end
+      end
+
+      def signed_client(api_key, secret_key, adapter)
+        Faraday.new(url: "#{BASE_URL}/api") do |conn|
+          conn.request :json
+          conn.response :json, content_type: /\bjson$/
+          conn.headers['X-MBX-APIKEY'] = api_key
+          conn.use TimestampRequestMiddleware
+          conn.use SignRequestMiddleware, secret_key
+          conn.adapter adapter
+        end
+      end
+
+      def withdraw_client(api_key, secret_key, adapter)
+        Faraday.new(url: "#{BASE_URL}/wapi") do |conn|
+          conn.request :url_encoded
+          conn.response :json, content_type: /\bjson$/
+          conn.headers['X-MBX-APIKEY'] = api_key
+          conn.use TimestampRequestMiddleware
+          conn.use SignRequestMiddleware, secret_key
+          conn.adapter adapter
+        end
+      end
+
+      def verified_client(api_key, adapter)
+        Faraday.new(url: "#{BASE_URL}/api") do |conn|
+          conn.response :json, content_type: /\bjson$/
+          conn.headers['X-MBX-APIKEY'] = api_key
+          conn.adapter adapter
+        end
+      end
+
       # Internal: Create a request that hits one of the REST APIs
       #
       # api - The Symbol that represents which API to use.
@@ -57,8 +97,7 @@ module Binance
       #           Each endpoint will have their own required and optional
       #           params.
       def request(api, method, endpoint, options = {})
-        conn = REST.api[api].call
-        response = conn.send(method) do |req|
+        response = @library[api].send(method) do |req|
           req.url API_ENDPOINTS[endpoint]
           req.params.merge! options
         end

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

@@ -1,32 +1,9 @@
 
-require 'faraday'
-require 'faraday_middleware'
-require_relative 'sign_request_middleware'
-require_relative 'timestamp_request_middleware'
-
 module Binance
   module Client
     class REST
       # Public: A module containing all of the Account API endpoints
-      module Account_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[:account] = lambda do
-            Faraday.new(url: "#{BASE_URL}/api") do |conn|
-              conn.request :json
-              conn.response :json, content_type: /\bjson$/
-              conn.headers['X-MBX-APIKEY'] = base.api_key
-              conn.use TimestampRequestMiddleware
-              conn.use SignRequestMiddleware, base.secret_key
-              conn.adapter base.adapter
-            end
-          end
-        end
-
+      module AccountAPI
         # Public: Create a new order on the specified symbol for the
         # authenticated account
         #
@@ -55,7 +32,7 @@ module Binance
         #
         # Returns a Hash of the request response
         def create_order(options)
-          request :account, :post, 'order', options
+          request :signed, :post, :order, options
         end
 
         # Public: Create a test order on the specified symbol for the
@@ -86,7 +63,7 @@ module Binance
         #
         # Returns a Hash of the request response
         def create_test_order(options)
-          request :account, :post, 'order/test', options
+          request :signed, :post, :order_test, options
         end
 
         # Public: Query an orders status on the specified symbol for the
@@ -105,7 +82,7 @@ module Binance
         #
         # Returns a Hash of the request response
         def query_order(options)
-          request :account, :get, 'order', options
+          request :signed, :get, :order, options
         end
 
         # Public: Cancel the order specified for the authenticated account.
@@ -125,7 +102,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def cancel_order(options)
-          request :account, :delete, 'order', options
+          request :signed, :delete, :order, options
         end
 
         # Public: Retrieve open orders for the authenticated account
@@ -138,7 +115,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def open_orders(options)
-          request :account, :get, 'openOrders', options
+          request :signed, :get, :openOrders, options
         end
 
         # Public: Retrieve all orders of the specified symbol for the
@@ -154,7 +131,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def all_orders(options)
-          request :account, :get, 'allOrders', options
+          request :signed, :get, :allOrders, options
         end
 
         # Public: Retrieve account information for the authenticated account
@@ -165,7 +142,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def account_info(options = {})
-          request :account, :get, 'account', options
+          request :signed, :get, :account, options
         end
 
         # Public: Retrieve trade data of the specified symbol for the
@@ -180,7 +157,34 @@ module Binance
         #
         # Returns a Hash with the request response
         def account_trade_list(options)
-          request :account, :get, 'myTrades', options
+          request :signed, :get, :myTrades, options
+        end
+
+        # Public: Retrieve the listen key for the given api key
+        #
+        # Returns a Hash with the request response
+        def listen_key
+          request :verified, :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 :verified, :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 :verified, :delete, :userDataStream, options
         end
       end
     end

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

@@ -4,36 +4,34 @@ module Binance
     class REST
       API_ENDPOINTS = {
         # Public API Endpoints
-        'ping'              => 'v1/ping',
-        'time'              => 'v1/time',
-        'exchangeInfo'      => 'v1/exchangeInfo',
-        'products'          => '/exchange/public/products',
-        'depth'             => 'v1/depth',
-        'trades'            => 'v1/trades',
-        'historicalTrades'  => 'v1/historicalTrades',
-        'aggTrades'         => 'v1/aggTrades',
-        'klines'            => 'v1/klines',
-        '24hr'              => 'v1/ticker/24hr',
-        'price'             => 'v3/ticker/price',
-        'bookTicker'        => 'v3/ticker/bookTicker',
+        ping:             'v1/ping',
+        time:             'v1/time',
+        exchangeInfo:     'v1/exchangeInfo',
+        products:         '/exchange/public/products',
+        depth:            'v1/depth',
+        trades:           'v1/trades',
+        historicalTrades: 'v1/historicalTrades',
+        aggTrades:        'v1/aggTrades',
+        klines:           'v1/klines',
+        twenty_four_hour: 'v1/ticker/24hr',
+        price:            'v3/ticker/price',
+        bookTicker:       'v3/ticker/bookTicker',
 
         # Account API Endpoints
-        'order'       => 'v3/order',
-        'order/test'  => 'v3/order/test',
-        'openOrders'  => 'v3/openOrders',
-        'allOrders'   => 'v3/allOrders',
-        'account'     => 'v3/account',
-        'myTrades'    => 'v3/myTrades',
+        order:          'v3/order',
+        order_test:     'v3/order/test',
+        openOrders:     'v3/openOrders',
+        allOrders:      'v3/allOrders',
+        account:        'v3/account',
+        myTrades:       'v3/myTrades',
+        userDataStream: 'v1/userDataStream',
 
         # Withdraw API Endpoints
-        'withdraw'        => 'v3/withdraw.html',
-        'depositHistory'  => 'v3/depositHistory.html',
-        'withdrawHistory' => 'v3/withdrawHistory.html',
-        'depositAddress'  => 'v3/depositAddress.html',
-        'accountStatus'   => 'v3/accountStatus.html',
-
-        # User Data Stream API Endpoints
-        'userDataStream'  => 'v1/userDataStream'
+        withdraw:        'v3/withdraw.html',
+        depositHistory:  'v3/depositHistory.html',
+        withdrawHistory: 'v3/withdrawHistory.html',
+        depositAddress:  'v3/depositAddress.html',
+        accountStatus:   'v3/accountStatus.html'
       }.freeze
     end
   end

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

@@ -1,46 +1,28 @@
 
-require 'faraday'
-require 'faraday_middleware'
-
 module Binance
   module Client
     class REST
       # Public: A Module containing all of the Public API endpoints
-      module Public_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[:public] = lambda do
-            Faraday.new(url: "#{BASE_URL}/api") do |conn|
-              conn.request :json
-              conn.response :json, content_type: /\bjson$/
-              conn.adapter base.adapter
-            end
-          end
-        end
-
+      module PublicAPI
         # Public: Ping the server to test connectivity
         #
         # Returns a Hash with the request response
         def ping
-          request :public, :get, 'ping'
+          request :public, :get, :ping
         end
 
         # Public: Retrieve the server time in milliseconds
         #
         # Returns a Hash with the request response
         def time
-          request :public, :get, 'time'
+          request :public, :get, :time
         end
 
         # Public: Retrieve current exchange trading rules and symbol information
         #
         # Returns a Hash with the request response
         def exchange_info
-          request :public, :get, 'exchangeInfo'
+          request :public, :get, :exchangeInfo
         end
 
         # Public: Retrieve current exchange asset information. This is an
@@ -48,7 +30,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def products
-          request :public, :get, 'products'
+          request :public, :get, :products
         end
 
         # Public: Retrieve depth information for the specified symbol
@@ -59,7 +41,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def depth(options)
-          request :public, :get, 'depth', options
+          request :public, :get, :depth, options
         end
 
         # Public: Retrieve recent trades for the specified symbol
@@ -70,7 +52,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def trades(options)
-          request :public, :get, 'trades', options
+          request :public, :get, :trades, options
         end
 
         # Public: Retrieve old trade data for the specified symbol
@@ -82,7 +64,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def historical_trades(options)
-          request :user_data, :get, 'historicalTrades', options
+          request :verified, :get, :historicalTrades, options
         end
 
         # Public: Retrieve aggregate trade data for the specified symbol
@@ -98,7 +80,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def agg_trades(options)
-          request :public, :get, 'aggTrades', options
+          request :public, :get, :aggTrades, options
         end
 
         # Public: Retrieve kline data for the specified symbol
@@ -115,7 +97,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def klines(options)
-          request :public, :get, 'klines', options
+          request :public, :get, :klines, options
         end
 
         # Public: Retrieve 24 hour ticker price data
@@ -125,7 +107,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def twenty_four_hour(options)
-          request :public, :get, '24hr', options
+          request :public, :get, :twenty_four_hour, options
         end
 
         # Public: Retrieve price ticker data for the specified symbol
@@ -135,14 +117,14 @@ module Binance
         #
         # Returns a Hash with the request response
         def price(options)
-          request :public, :get, 'price', options
+          request :public, :get, :price, options
         end
 
         # Public: Retrieve all price ticker data
         #
         # Returns a Hash with the request response
         def all_prices
-          request :public, :get, 'price'
+          request :public, :get, :price
         end
 
         # Public: Retrieve best price per quantity on the order book
@@ -152,14 +134,14 @@ module Binance
         #
         # Returns a Hash with the request response
         def book_ticker(options)
-          request :public, :get, 'bookTicker', options
+          request :public, :get, :bookTicker, options
         end
 
         # Public: Retrieve all book ticker data  for all symbols
         #
         # Returns a Hash with the request response
         def all_book_tickers
-          request :public, :get, 'bookTicker'
+          request :public, :get, :bookTicker
         end
       end
     end

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

@@ -1,32 +1,9 @@
 
-require 'faraday'
-require 'faraday_middleware'
-require_relative 'sign_request_middleware'
-require_relative 'timestamp_request_middleware'
-
 module Binance
   module Client
     class REST
       # Public: A Module containing all of the Withdraw API endpoints
-      module Withdraw_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[:withdraw] = lambda do
-            Faraday.new(url: "#{BASE_URL}/wapi") do |conn|
-              conn.request :url_encoded
-              conn.response :json, content_type: /\bjson$/
-              conn.headers['X-MBX-APIKEY'] = base.api_key
-              conn.use TimestampRequestMiddleware
-              conn.use SignRequestMiddleware, base.secret_key
-              conn.adapter base.adapter
-            end
-          end
-        end
-
+      module WithdrawAPI
         # Public: Withdraw the specified asset to the given address using
         # the authenticated account
         #
@@ -41,7 +18,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def withdraw(options)
-          request :withdraw, :post, 'withdraw', options
+          request :withdraw, :post, :withdraw, options
         end
 
         # Public: Retrieve the deposit history for the authenticated account
@@ -58,7 +35,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def deposit_history(options = {})
-          request :withdraw, :get, 'depositHistory', options
+          request :withdraw, :get, :depositHistory, options
         end
 
         # Public: Retrieve the withdraw history for the authenticated account
@@ -75,7 +52,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def withdraw_history(options = {})
-          request :withdraw, :get, 'withdrawHistory', options
+          request :withdraw, :get, :withdrawHistory, options
         end
 
         # Public: Retrieve the deposit address for a specific asset
@@ -87,7 +64,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def deposit_address(options)
-          request :withdraw, :get, 'depositAddress', options
+          request :withdraw, :get, :depositAddress, options
         end
 
         # Public: Retrieve current account status
@@ -98,7 +75,7 @@ module Binance
         #
         # Returns a Hash with the request response
         def account_status(options)
-          request :withdraw, :get, 'accountStatus', options
+          request :withdraw, :get, :accountStatus, options
         end
       end
     end

data/lib/binance/version.rb

@@ -1,4 +1,4 @@
 
 module Binance
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Charles Ray Shisler III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-21 00:00:00.000000000 Z
+date: 2018-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: '0.10'
 description: 
 email:
 - charles@cray.io
@@ -110,7 +110,6 @@ 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

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

@@ -1,54 +0,0 @@
-
-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