stocks_exchange_api_client 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b9f4a242d3ee4b520912a52f1081c358b5ea19beb300b4d47a3aab67a798d4
-  data.tar.gz: ffda3c3fce465e7e6b76870322d7586029222e81eb4cb2429f06c09f344f0e5c
+  metadata.gz: 4ebadc56eaa5dd75311a797a40d4b6f910dc8b04b2da59a69f6ff78f2a4ce079
+  data.tar.gz: bd29fa6ecd9021eced24792c842f2d26a6a839e8b0fe07889459f557a157d476
 SHA512:
-  metadata.gz: '09413046673714035f8509efa697c16b463997bbeb2591cf0b1a4468f347ddada2d1e4f63f3f255c984afec29874da7a2857444e953aff74a8062d9778bb3d4a'
-  data.tar.gz: 75b96003a8fad63a4968007f704a341dc217e9ccc6527c068105d240a463473c04e5072805378f14909c1f149bb194155ba0e405b9fc6f63b1c18cd48568990d
+  metadata.gz: 41ec80c652cde01e7e39f764e39d6fc9a7f4f3bd4d293786a7f08eade46c4c1f81c62ac5d9f1c84398522faaea3df192b0ff3071d66522645e338cba1d16f20e
+  data.tar.gz: 6a0aca2fdedc4da1c1ed2498e935bcc8c95197d7d2433b1c49b8aade9e6d25be12a674d4885a92b463e69257137575b4b827059c168b8b87662111b8acf14bf3

data/README.md

@@ -12,13 +12,12 @@ STEX (former Stocks.Exchange) provides all the core exchange functionality, and
 ## General
 The base URL for all the requests other than public methods is 
 ```
-https://app.stex.com/api2
 https://api3.stex.com
 ```
 
 ## Getting started
 - [Documentation](http://help.stex.com/api-integration).
-- [Sandbox API V3](https://apidocs.stex.com).
+- [Sandbox API](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.
@@ -30,92 +29,10 @@ gem install stocks_exchange_api_client
 
 After install use for example this code!
 
-### Example Example API V2
-```ruby
-require 'stocks_exchange_api_client'
-
-StocksExchangeApiClient.configure do |conf|
-  conf.url = 'https://app.stocks.exchange/api2'
-  conf.api_key = '' # Your Api Key
-  conf.api_secret = '' # Your Api Secret
-end
- # Get information about your account
-puts StocksExchangeApiClient::Private.get_info
-
- # Get information about active orders.
- # Params: pair, count, order, type, owner, since, end
-puts StocksExchangeApiClient::Private.active_order
-
- # Create orders for the purchase and sale.
- # Params: type, pair, amount, rate
-puts StocksExchangeApiClient::Private.trade('BUY', 'LTC_BTC', 0.1, 0.00002)
-
- # Cancel selected order.
- # Params: order_id 
-puts StocksExchangeApiClient::Private.cancel_order(2761025)
-
- # Get information about all orders.
- # Params: pair, count, order, status, owner, since, end 
-puts StocksExchangeApiClient::Private.trade_history
-
- # Get information about all closed orders from Register
- # Params: currency, since, end 
-puts StocksExchangeApiClient::Private.trade_register_history
-
- # Get information about all orders User
- # Params: since, end 
-puts StocksExchangeApiClient::Private.user_history
-
- # Get information about your deposits and withdrawals.
- # Params: currency, count, order, operation, status 
-puts StocksExchangeApiClient::Private.trans_history
-
- # Get information about trade statistic.
- # Params: currency, count, order, operation, status, since, end 
-puts StocksExchangeApiClient::Private.grafic
-
- # Generate currency wallet address.
- # Params: currency 
-puts StocksExchangeApiClient::Private.generate_wallets('ONION')
-
- # Get information about your wallet to deposit funds.
- # Params: currency 
-puts StocksExchangeApiClient::Private.deposit('ETH')
-
- # Withdraw your funds.
- # Params: currency, address, amount 
-puts StocksExchangeApiClient::Private.withdraw('EAG', '12345', 1.001)
-
- # Get all available currencies with additional info.
-puts StocksExchangeApiClient::Public.currencies
-
- # Get all available currency pairs with additional info.
-puts StocksExchangeApiClient::Public.markets
-
- # Get currency pair with additional info.
- # Params Currency1 and Currency2 
-puts StocksExchangeApiClient::Public.markets_summary('BTC', 'USDT')
-
- # Use it to get the recommended retail exchange rates for all currency pairs.
-puts StocksExchangeApiClient::Public.ticker
-
- # Use it to get the new retail exchange rates for all currency pairs.
-puts StocksExchangeApiClient::Public.prices
-
- # Used to retrieve the latest trades that have occurred for a specific market. 
- # Params Pair 
-puts StocksExchangeApiClient::Public.trade_history('BTC_USDT')
-
- # Used to get retrieve the orderbook for a given market.
- # Params Pair 
-puts StocksExchangeApiClient::Public.order_book('BTC_USDT')
-```
-
-### Example V3
+### Example
 ```ruby
 StocksExchangeApiClient.configure do |conf|
   conf.url = 'https://api3.stex.com'
-  conf.use_version = 3
   conf.option = {
     client_id: '',
     client_secret: '',
@@ -130,8 +47,23 @@ end
 
 puts StocksExchangeApiClient::PrivateApiV3.profile_info
 ```
+### Example Server-To-Server integrations
+```ruby
+StocksExchangeApiClient.configure do |conf|
+  conf.s2s = true
+  conf.option = {
+    token_object: {
+      access_token: '<access_token>',
+    },
+    scope: 'profile trade withdrawal reports push settings'
+  }
+end
+
+puts StocksExchangeApiClient::PrivateApiV3.profile_info
+```
+
 ## Lists Methods
-- [Sandbox API V3](https://apidocs.stex.com).
+- [Sandbox API](https://apidocs.stex.com).
 ```
 profile_info() // Get general information about the current user.
 wallets() // Get a list of user wallets.

data/lib/stocks_exchange_api_client.rb

@@ -7,14 +7,10 @@ require 'date'
 # Version
 require 'stocks_exchange_api_client/version'
 
-# Private API V2 method
-require 'stocks_exchange_api_client/private'
-# Private API V3 method
+# Private API method
 require 'stocks_exchange_api_client/private_v3'
 
-# Public API V2 method
-require 'stocks_exchange_api_client/public'
-# Private API V3 method
+# Private API method
 require 'stocks_exchange_api_client/public_v3'
 
 # Configuration
@@ -44,27 +40,6 @@ module StocksExchangeApiClient
       yield(configuration)
     end
 
-    def make_api_request(method = :post, params = {}, type)
-      configuration.validate!
-      if method == :post
-        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.option[:api_secret], encode_www_form)
-        response = JSON.parse(
-            HTTParty.post(configuration.url, body: params, headers: {
-                Sign: sign,
-                Key: configuration.option[:api_key]
-            }).body
-        )
-        response = OpenStruct.new(response)
-      end
-      if method == :get
-        response = JSON.parse(HTTParty.get("#{configuration.url}/#{type}").body)
-      end
-      response
-    end
-
     def make_api_request_v3(url, params = {}, method = :get, _type = :url, auth = true)
       configuration.validate!
       post_data = URI.encode_www_form(params)

data/lib/stocks_exchange_api_client/configuration.rb

@@ -2,16 +2,11 @@ require 'stocks_exchange_api_client/errors/configuration_error'
 
 module StocksExchangeApiClient
   class Configuration
-    URL_V2 = 'https://app.stex.com/api2'.freeze
     URL_V3 = 'https://api3.stex.com'.freeze
     attr_accessor :url, :option, :use_version, :s2s
 
-    def initialize(url: URL_V2, option: {}, use_version: 2, s2s: false)
-      if use_version == 3
-        @url||= URL_V3
-      else
-        @url||= URL_V3
-      end
+    def initialize(url: URL_V3, option: {}, use_version: 3, s2s: false)
+      @url||= url
       @option||= option
       @use_version||= use_version
       @s2s||= s2s
@@ -19,9 +14,7 @@ module StocksExchangeApiClient
 
     def validate!
       if use_version == 2
-        unless option[:api_key] && option[:api_secret]
-          raise Errors::ConfigurationError
-        end
+        raise 'Disabled supporting version 2 API'
       end
       if use_version == 3 && !s2s
         unless option[:client_id] && option[:client_secret] && option[:token_object][:access_token] && option[:token_object][:refresh_token]

data/lib/stocks_exchange_api_client/version.rb

@@ -1,3 +1,3 @@
 module StocksExchangeApiClient
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/stocks_exchange_api_client.gemspec

@@ -6,10 +6,10 @@ require 'stocks_exchange_api_client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'stocks_exchange_api_client'
   spec.version       = StocksExchangeApiClient::VERSION
-  spec.authors       = ['Stocks Exchange']
+  spec.authors       = ['STEX']
 
-  spec.summary       = 'Stocks Exchange API client for ruby.'
-  spec.description   = 'Stocks Exchange provides all the core exchange functionality, and additional merchant tools available via the HTTP API where all returned messages are in JSON. Its much easier to work with the API by using one of the clients provided by Stocks.Exchange, so while this page describes the API in case you want or need to build your own client, the examples use the Ruby client.'
+  spec.summary       = 'STEX (former Stocks.Exchange) API client for ruby.'
+  spec.description   = 'STEX (former Stocks.Exchange) provides all the core exchange functionality, and additional merchant tools available via the HTTP API where all returned messages are in JSON. Its much easier to work with the API by using one of the clients provided by Stocks.Exchange, so while this page describes the API in case you want or need to build your own client, the examples use the Ruby client.'
   spec.homepage      = 'https://github.com/StocksExchange/ruby-client#readme'
   spec.license       = 'MIT'
 
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stocks_exchange_api_client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
-- Stocks Exchange
+- STEX
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl
@@ -48,22 +48,22 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -106,11 +106,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Stocks Exchange provides all the core exchange functionality, and additional
-  merchant tools available via the HTTP API where all returned messages are in JSON.
-  Its much easier to work with the API by using one of the clients provided by Stocks.Exchange,
-  so while this page describes the API in case you want or need to build your own
-  client, the examples use the Ruby client.
+description: STEX (former Stocks.Exchange) provides all the core exchange functionality,
+  and additional merchant tools available via the HTTP API where all returned messages
+  are in JSON. Its much easier to work with the API by using one of the clients provided
+  by Stocks.Exchange, so while this page describes the API in case you want or need
+  to build your own client, the examples use the Ruby client.
 email: 
 executables: []
 extensions: []
@@ -127,9 +127,7 @@ files:
 - lib/stocks_exchange_api_client.rb
 - 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
@@ -152,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Stocks Exchange API client for ruby.
+summary: STEX (former Stocks.Exchange) API client for ruby.
 test_files: []

data/lib/stocks_exchange_api_client/private.rb

@@ -1,157 +0,0 @@
-module StocksExchangeApiClient
-  ASC = 'ASC'.freeze
-
-  ALL = 'ALL'.freeze
-
-  MAX_COUNT = 50
-
-  STATUS_ORDER = {
-    pending: 1,
-    processing: 2,
-    finished: 3,
-    canceled: 4
-  }.freeze
-
-  STATUS_ORDER_HUMAN_NAME = {
-    1 => 'PENDING',
-    2 => 'PROCESSING',
-    3 => 'FINISHED',
-    4 => 'CANCELED'
-  }.freeze
-
-  OWNER = {
-    all: 'ALL',
-    own: 'OWN'
-  }.freeze
-
-  INTERVAL = {
-    day: '1D',
-    month: '1M',
-    three_month: '3M',
-    year: '1Y'
-  }.freeze
-
-  DEFAULT_PAIRS = 'ETH_BTC'.freeze
-
-  class Private
-    class << self
-      def get_info
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 {},
-                                                 METHOD_NAME[:get_info])
-      end
-
-      def active_order(params = {})
-        params[:pair] = params[:pair].nil? ? ALL : params[:pair]
-        params[:count] = params[:count].nil? ? MAX_COUNT : params[:count]
-        params[:order] = params[:order].nil? ? ASC : params[:order]
-        params[:type] = params[:type].nil? ? ALL : params[:type]
-        params[:owner] = params[:owner].nil? ? ALL : params[:owner]
-
-        params[:order] = ASC unless params[:since].nil? || params[:end].nil?
-
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:active_orders])
-      end
-
-      def trade(type = nil, pair = nil, amount = nil, rate = nil)
-        params = {
-          type: type,
-          pair: pair,
-          amount: amount,
-          rate: rate
-        }
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:trade])
-      end
-
-      def cancel_order(order_id)
-        params = { order_id: order_id }
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:cancel_order])
-      end
-
-      def trade_history(params = {})
-        params[:pair] = params[:pair].nil? ? ALL : params[:pair]
-        params[:count] = params[:count].nil? ? MAX_COUNT : params[:count]
-        params[:order] = params[:order].nil? ? ASC : params[:order]
-        params[:owner] = params[:owner].nil? ? OWNER[:own] : params[:owner]
-        params[:status] = params[:status].nil? ? STATUS_ORDER[:finished] : params[:status]
-        params[:order] = ASC unless params[:since].nil? || params[:end].nil?
-
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:trade_history])
-      end
-
-      def trade_register_history(params = {})
-        params[:currency] = params[:currency].nil? ? ALL : params[:currency]
-
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:trade_register_history])
-      end
-
-      def user_history(params = {})
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:user_history])
-      end
-
-      def trans_history(params = {})
-        params[:currency] = params[:currency].nil? ? ALL : params[:currency]
-        params[:count] = params[:count].nil? ? MAX_COUNT : params[:count]
-        params[:order] = params[:order].nil? ? 'DESC' : params[:order]
-        params[:operation] = params[:operation].nil? ? ALL : params[:operation]
-        params[:status] = params[:status].nil? ? STATUS_ORDER_HUMAN_NAME[STATUS_ORDER[:finished]] : params[:status]
-        params[:order] = ASC unless params[:since].nil? || params[:end].nil?
-
-        params[:status] = STATUS_ORDER_HUMAN_NAME[STATUS_ORDER[:finished]] unless params[:operation].nil? && params[:operation] == ALL
-
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:trans_history])
-      end
-
-      def grafic(params = {})
-        params[:pair] = params[:pair].nil? ? DEFAULT_PAIRS : params[:pair]
-        params[:count] = params[:count].nil? ? MAX_COUNT : params[:count]
-        params[:order] = params[:order].nil? ? ASC : params[:order]
-        params[:interval] = params[:interval].nil? ? INTERVAL[:day] : params[:interval]
-        params[:page] = params[:page].nil? ? 1 : params[:page]
-        params[:order] = ASC unless params[:since].nil? || params[:end].nil?
-
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:grafic])
-      end
-
-      def generate_wallets(currency)
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 { currency: currency },
-                                                 METHOD_NAME[:generate_wallets])
-      end
-
-      def deposit(currency)
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 { currency: currency },
-                                                 METHOD_NAME[:deposit])
-      end
-
-      def withdraw(currency, address, amount)
-        params = {
-          currency: currency,
-          address: address,
-          amount: amount
-        }
-
-        StocksExchangeApiClient.make_api_request(:post,
-                                                 params,
-                                                 METHOD_NAME[:withdraw])
-      end
-    end
-  end
-end

data/lib/stocks_exchange_api_client/public.rb

@@ -1,65 +0,0 @@
-module StocksExchangeApiClient
-  class Public
-    class << self
-      def currencies
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 'currencies')
-      end
-
-      def markets
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 'markets')
-      end
-
-      def markets_summary(currency1 = 'ETH', currency2 = 'BTC')
-        url = "market_summary/#{currency1}/#{currency2}"
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 url)
-      end
-
-      def ticker
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 'ticker')
-      end
-
-      def prices
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 'prices')
-      end
-
-      def trade_history(pair = DEFAULT_PAIRS)
-        url = "trades?pair=#{pair}"
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 url)
-      end
-
-      def order_book(pair = DEFAULT_PAIRS)
-        url = "orderbook?pair=#{pair}"
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 url)
-      end
-
-      def grafic(params = {})
-        params[:pair] = params[:pair].nil? ? DEFAULT_PAIRS : params[:pair]
-        params[:count] = params[:count].nil? ? MAX_COUNT : params[:count]
-        params[:order] = params[:order].nil? ? ASC : params[:order]
-        params[:interval] = params[:interval].nil? ? INTERVAL[:day] : params[:interval]
-        params[:page] = params[:page].nil? ? 1 : params[:page]
-        params[:order] = ASC unless params[:since].nil? || params[:end].nil?
-        encode_www_form = URI.encode_www_form(params)
-
-        url = "grafic_public?#{encode_www_form}"
-        StocksExchangeApiClient.make_api_request(:get,
-                                                 nil,
-                                                 url)
-      end
-    end
-  end
-end