stocks_exchange_api_client 0.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f5276b14f88f028f92918ff4d93cd54272a744b136521333d540f8db5903dbc
-  data.tar.gz: fd9564868f88d9ff67a923dfd53848e238dff2f36949a45ce237e84c5e80c3d4
+  metadata.gz: 2d0847320eac0c013dbd66653b3973d7be3c23be6e51b554ca2db079cf822746
+  data.tar.gz: afa8667073e56d959c3a6c1e1608364c8e91164d1f99202ad18e3d7f3933f108
 SHA512:
-  metadata.gz: 44e409f86d0e545c749af69ae65351ef6a4b07daa30711371c2a5b1f4a15d4be0f35c231dcb93fe1037a4fd7e5888fcb94d63224ca079ef5012351bcf7d47c38
-  data.tar.gz: 4012da2f6c11387904bf508024742a0c123f5bf5eb9b7b096493060e9751a13199631da6d0fc91e2f172f98405a60629e6e2b390b327639d2b554dd04f01b2a4
+  metadata.gz: 7f220621254bc69a3d94a00842e3b411560986c43fb22d9f17192e7f6ec57f9e0ea7c996d052e275293442e7808ff99b5966e935cd443b4a41876f04ce52ba6d
+  data.tar.gz: a8e1df7d4cd84ae62061ef0802cbab5f11d8faa58254ea7d2d3a63bc66424b5d770c45e5a652ec5823c2b10148291fe72b1043edda8fb8efde0bbd5896dbf9c2

data/.gitignore

@@ -49,3 +49,5 @@ build-iPhoneSimulator/
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 /.idea
+Gemfile.lock
+settings.json

data/README.md

@@ -14,10 +14,12 @@ The base URL for all the requests other than public methods is
 ```
 https://app.stocks.exchange/api2
 https://app.stex.com/api2
+https://api3.stex.com
 ```
 
 ## Getting started
--[Documentation](http://help.stex.com/api-integration).
+- [Documentation](http://help.stex.com/api-integration).
+- [Sandbox API V3](https://apidocs.stex.com).
 
 To get started with the Ruby API client, here's a snippet for creating a client with existing credentials:
 > In order to use the API functions, you must have an API key and API secret, which is generated in the user profile.
@@ -29,7 +31,7 @@ gem install stocks_exchange_api_client
 
 After install use for example this code!
 
-### Example
+### Example Example API V2
 ```ruby
 require 'stocks_exchange_api_client'
 
@@ -109,6 +111,64 @@ puts StocksExchangeApiClient::Public.trade_history('BTC_USDT')
  # Params Pair 
 puts StocksExchangeApiClient::Public.order_book('BTC_USDT')
 ```
+
+### Example V3
+```ruby
+StocksExchangeApiClient.configure do |conf|
+  conf.url = 'https://api3.stex.com'
+  conf.use_version = 3
+  conf.option = {
+    client_id: '',
+    client_secret: '',
+    token_object: {
+      access_token: '',
+      refresh_token: ''
+    },
+    access_token_url: 'https://api3.stex.com/oauth/token',
+    scope: 'trade profile reports withdrawal'
+  }
+end
+
+puts StocksExchangeApiClient::PrivateApiV3.profile_info
+```
+## Lists Methods
+- [Sandbox API V3](https://apidocs.stex.com).
+```
+profile_info() // Get general information about the current user.
+wallets() // Get a list of user wallets.
+wallets_by_id() // Single wallet information            
+add_wallets_by_currency_id() // Create a wallet for given currency
+get_wallets_address() // Get deposit address for given wallet
+new_wallets_address() // Create new deposit address
+deposits() // Get a list of deposits made by user
+deposits_by_id() // Get deposit by id
+withdrawals() // Get a list of withdrawals made by user
+withdrawals_by_id() // Get withdrawal by id
+add_withdrawal() // Create withdrawal request
+cancel_withdrawal_by_id() // Cancel unconfirmed withdrawal
+reports_orders() // Get past orders
+reports_orders_by_id() // Get specified order details
+all_trading_orders() // List your currently open orders
+delete_all_trading_orders() // Delete all active orders 
+trading_orders_by_pair() // List your currently open orders for given currency pair 
+delete_trading_orders_by_pair() // Delete active orders for given currency pair
+add_trading_orders_by_pair() // Create new order and put it to the orders processing queue
+trading_order_by_id() // Get a single order
+delete_trading_order_by_id() // Cancel order                   
+                         
+currencies() // Available Currencies
+currencies_by_id() // Get currency info   
+markets() // Available markets 
+pairs_list_by_code() // Available currency pairs
+pairs_list_by_id() // Get currency pair information 
+ticker() // Tickers list for all currency pairs
+ticker_by_pair_id() // Ticker for currency pair
+trades() // Trades for given currency pair  
+orderbook_by_pair_id() // Orderbook for given currency pair
+chart() // A list of candles for given currency pair
+ping() // Test API is working and get server time
+```
+
 ## Common Errors
 ### Here is a list with common errors and their descriptions:
   1.    Invalid Key - not generated key or the key does not correspond to the a user

data/lib/stocks_exchange_api_client.rb

@@ -2,42 +2,44 @@ require 'openssl'
 require 'httparty'
 require 'json'
 require 'ostruct'
-
+require 'date'
 
 # Version
 require 'stocks_exchange_api_client/version'
 
-# Private API method
+# Private API V2 method
 require 'stocks_exchange_api_client/private'
+# Private API V3 method
+require 'stocks_exchange_api_client/private_v3'
 
-# Public API method
+# Public API V2 method
 require 'stocks_exchange_api_client/public'
+# Private API V3 method
+require 'stocks_exchange_api_client/public_v3'
 
 # Configuration
 require 'stocks_exchange_api_client/configuration'
 
-
 module StocksExchangeApiClient
-
   METHOD_NAME = {
-      get_info: 'GetInfo',
-      active_orders: 'ActiveOrders',
-      trade: 'Trade',
-      cancel_order: 'CancelOrder',
-      trade_history: 'TradeHistory',
-      trade_register_history: 'TradeRegisterHistory',
-      user_history: 'UserHistory',
-      trans_history: 'TransHistory',
-      grafic: 'Grafic',
-      generate_wallets: 'GenerateWallets',
-      deposit: 'Deposit',
-      withdraw: 'Withdraw'
+    get_info: 'GetInfo',
+    active_orders: 'ActiveOrders',
+    trade: 'Trade',
+    cancel_order: 'CancelOrder',
+    trade_history: 'TradeHistory',
+    trade_register_history: 'TradeRegisterHistory',
+    user_history: 'UserHistory',
+    trans_history: 'TransHistory',
+    grafic: 'Grafic',
+    generate_wallets: 'GenerateWallets',
+    deposit: 'Deposit',
+    withdraw: 'Withdraw'
   }.freeze
 
-  HEX_ALGORITHM = 'sha512'
+  HEX_ALGORITHM = 'sha512'.freeze
+  JSON_SETTINGS = 'settings.json'.freeze
 
   class << self
-
     def configure
       yield(configuration)
     end
@@ -45,14 +47,16 @@ module StocksExchangeApiClient
     def make_api_request(method = :post, params = {}, type)
       configuration.validate!
       if method == :post
-        params.merge!({method: type, nonce: Time.now.to_i})
+        params[:method] = type
+        params[:nonce] = Time.now.to_i
         encode_www_form = URI.encode_www_form(params)
-        sign = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new(HEX_ALGORITHM), configuration.api_secret, encode_www_form)
+        sign = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new(HEX_ALGORITHM), configuration.option[:api_secret], encode_www_form)
         response = JSON.parse(
-            HTTParty.post(configuration.url, body: params, headers: {
-                :Sign => sign,
-                :Key => configuration.api_key
-            }).body)
+          HTTParty.post(configuration.url, body: params, headers: {
+                          Sign: sign,
+                          Key: configuration.option[:api_key]
+                        }).body
+        )
         response =  OpenStruct.new(response)
       end
       if method == :get
@@ -61,8 +65,65 @@ module StocksExchangeApiClient
       response
     end
 
+    def make_api_request_v3(url, params = {}, method = :get, _type = :url)
+      configuration.validate!
+      post_data = URI.encode_www_form(params)
+      url_full = "#{configuration.url}/#{url}#{post_data == '' ? '' : '?'}#{post_data}"
+      if method == :post
+        response = HTTParty.post(url_full, body: params, headers: {
+                                   'Authorization' => "Bearer #{get_token}",
+                                   'Accept' => 'application/json',
+                                   'User-Agent' => 'stocks.exchange-client'
+                                 }).body
+      end
+      if method == :get
+        response = HTTParty.get(url_full, headers: {
+                                  'Authorization' => "Bearer #{get_token}",
+                                  'Accept' => 'application/json',
+                                  'User-Agent' => 'stocks.exchange-client'
+                                }).body
+      end
+      if method == :delete
+        response = HTTParty.delete(url_full, headers: {
+                                'Authorization' => "Bearer #{get_token}",
+                                'Accept' => 'application/json',
+                                'User-Agent' => 'stocks.exchange-client'
+                            }).body
+      end
+      response
+    end
+
+    def get_token
+      if File.exist?(JSON_SETTINGS)
+        current_token = JSON.parse(File.read(JSON_SETTINGS))
+      else
+        current_token = { 'access_token' => configuration.option[:token_object][:access_token],
+                          'refresh_token' => configuration.option[:token_object][:refresh_token],
+                          'expires_in' => nil,
+                          'expires_in_date' => nil }
+      end
+      if !current_token.nil? && !current_token['expires_in_date'].nil?
+        return current_token['access_token'] if DateTime.parse(current_token['expires_in_date']).to_datetime > DateTime.now.to_datetime
+      end
+      begin
+        response = HTTParty.post(configuration.option[:access_token_url], body: {
+            grant_type: 'refresh_token',
+            refresh_token: current_token['refresh_token'],
+            client_id: configuration.option[:client_id],
+            client_secret: configuration.option[:client_secret],
+            scope: configuration.option[:scope]
+        }).body
+        current_token = JSON.parse(response)
+        current_token['expires_in_date'] = Time.at(Time.now.to_i + current_token['expires_in']).to_s
+        File.write(JSON_SETTINGS, current_token.to_json)
+        current_token['access_token']
+      rescue StandardError => e
+        puts "Rescued: #{e.inspect}"
+      end
+    end
+
     def configuration
       @configuration ||= Configuration.new
     end
   end
-end
+end

data/lib/stocks_exchange_api_client/configuration.rb

@@ -1,18 +1,25 @@
 module StocksExchangeApiClient
-
   class Configuration
-
-    URL = 'https://app.stocks.exchange/api2'
-
-    attr_accessor :url, :api_key, :api_secret
+    URL_V2 = 'https://app.stocks.exchange/api2'.freeze
+    URL_V3 = 'https://api3.stex.com'.freeze
+    attr_accessor :url, :option, :use_version
 
     def initialize
-      @url ||= URL
+      @use_version ||= 2
+      @url ||= URL_V2
     end
 
     def validate!
-      raise Errors::ConfigurationError unless api_key && api_secret
+      if use_version == 2
+        unless option[:api_key] && option[:api_secret]
+          raise Errors::ConfigurationError
+        end
+      end
+      if use_version == 3
+        unless option[:client_id] && option[:client_secret] && option[:token_object][:access_token] && option[:token_object][:refresh_token]
+          raise Errors::ConfigurationError
+        end
+      end
     end
   end
-
 end

data/lib/stocks_exchange_api_client/private_v3.rb

@@ -0,0 +1,119 @@
+module StocksExchangeApiClient
+  class PrivateApiV3
+    class << self
+      def profile_info
+        StocksExchangeApiClient.make_api_request_v3('/profile/info')
+      end
+
+      def wallets
+        StocksExchangeApiClient.make_api_request_v3('/profile/wallets')
+      end
+
+      def wallets_by_id(wallet_id)
+        url = "/profile/wallets/#{wallet_id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def add_wallets_by_currency_id(currency_id)
+        url = "/profile/wallets/#{currency_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {}, :post)
+      end
+
+      def get_wallets_address(wallet_id)
+        url = "/profile/wallets/address/#{wallet_id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def new_wallets_address(wallet_id)
+        url = "/profile/wallets/address/#{wallet_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {}, :post)
+      end
+
+      def deposits(params)
+        url = '/profile/deposits'
+        StocksExchangeApiClient.make_api_request_v3(url, params)
+      end
+
+      def deposits_by_id(id)
+        url = "/profile/deposits/#{id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def withdrawals(params)
+        url = '/profile/withdrawals'
+        StocksExchangeApiClient.make_api_request_v3(url, params)
+      end
+
+      def withdrawals_by_id(id)
+        url = "/profile/withdrawals/#{id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def add_withdrawal(currency_id, amount, address, additional_address)
+        url = '/profile/withdraw'
+        params = {
+          'currency_id' => currency_id,
+          'amount' => amount,
+          'address' => address
+        }
+        params['additional_address'] = additional_address unless additional_address.nil?
+        StocksExchangeApiClient.make_api_request_v3(url, params, :post)
+      end
+
+      def cancel_withdrawal_by_id(id)
+        url = "/profile/withdraw/#{id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {}, :delete)
+      end
+
+      def reports_orders(params)
+        url = '/reports/orders'
+        StocksExchangeApiClient.make_api_request_v3(url, params)
+      end
+
+      def reports_orders_by_id(order_id)
+        url = "/reports/orders/#{order_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {})
+      end
+
+      def all_trading_orders
+        url = '/trading/orders'
+        StocksExchangeApiClient.make_api_request_v3(url, {})
+      end
+
+      def delete_all_trading_orders
+        url = '/trading/orders'
+        StocksExchangeApiClient.make_api_request_v3(url, {}, :delete)
+      end
+
+      def trading_orders_by_pair(currency_pair_id)
+        url = "/trading/orders/#{currency_pair_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {})
+      end
+
+      def delete_trading_orders_by_pair(currency_pair_id)
+        url = "/trading/orders/#{currency_pair_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {}, :delete)
+      end
+
+      def add_trading_orders_by_pair(currency_pair_id, type, amount, price)
+        url = "/trading/orders/#{currency_pair_id}"
+        params = {
+            'type' => type,
+            'amount' => amount,
+            'price' => price
+        }
+        StocksExchangeApiClient.make_api_request_v3(url, params, :post)
+      end
+
+      def trading_order_by_id(order_id)
+        url = "/trading/order/#{order_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {})
+      end
+
+      def delete_trading_order_by_id(order_id)
+        url = "/trading/order/#{order_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, {}, :delete)
+      end
+    end
+  end
+end

data/lib/stocks_exchange_api_client/public_v3.rb

@@ -0,0 +1,58 @@
+module StocksExchangeApiClient
+  class PublicApiV3
+    class << self
+      def ping
+        StocksExchangeApiClient.make_api_request_v3('/public/ping')
+      end
+
+      def currencies
+        StocksExchangeApiClient.make_api_request_v3('/public/currencies')
+      end
+
+      def currencies_by_id(currency_id)
+        url = "/public/currencies/#{currency_id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def markets
+        StocksExchangeApiClient.make_api_request_v3('/public/markets')
+      end
+
+      def pairs_list_by_code(code = 'ALL')
+        url = "/public/currency_pairs/list/#{code}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def pairs_list_by_id(id)
+        url = "/public/currency_pairs/#{id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def ticker
+        StocksExchangeApiClient.make_api_request_v3('/public/ticker')
+      end
+
+      def ticker_by_pair_id(id)
+        url = "/public/ticker/#{id}"
+        StocksExchangeApiClient.make_api_request_v3(url)
+      end
+
+      def trades(currency_pair_id, params)
+        url = "/public/trades/#{currency_pair_id}"
+        StocksExchangeApiClient.make_api_request_v3(url, params)
+      end
+
+      def orderbook_by_pair_id(id, params)
+        url = "/public/orderbook/#{id}"
+        StocksExchangeApiClient.make_api_request_v3(url, params)
+      end
+
+      def chart(currency_pair_id, time_start, time_end, params, candles_type)
+        url = "/public/chart/#{currency_pair_id}/#{candles_type.nil? ? '1' : candles_type}"
+        params['timeStart'] = time_start
+        params['timeEnd'] = time_end
+        StocksExchangeApiClient.make_api_request_v3(url, params)
+      end
+    end
+  end
+end

data/lib/stocks_exchange_api_client/version.rb

@@ -1,3 +1,3 @@
 module StocksExchangeApiClient
-  VERSION = '0.1.2'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stocks_exchange_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Stocks Exchange
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl
@@ -128,7 +128,9 @@ files:
 - lib/stocks_exchange_api_client/configuration.rb
 - lib/stocks_exchange_api_client/errors/configuration_error.rb
 - lib/stocks_exchange_api_client/private.rb
+- lib/stocks_exchange_api_client/private_v3.rb
 - lib/stocks_exchange_api_client/public.rb
+- lib/stocks_exchange_api_client/public_v3.rb
 - lib/stocks_exchange_api_client/version.rb
 - stocks_exchange_api_client.gemspec
 homepage: https://github.com/StocksExchange/ruby-client#readme