bittrex-enterprise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2e5017cf52aae7b40cdfd73476a59ed0fbfee048946c5bf66556570c3927d6a
+  data.tar.gz: e608bcab6dc763b91395e9a4109c391a0ac616dab7af48b8eb028f55fcf6b3a8
+SHA512:
+  metadata.gz: 10f6f44bbcdac296519b2306232ae954892af23c7399b1876ca63b14bddb5babc4e86659e5909ada494b4408d2056ac769fceb87698e8277f7a12af9216aa745
+  data.tar.gz: 3c9194e3f28433f3f1ad9674ef6c11c5ff4e969e34c20bb08cc9ba307abdd63891c546e00da0b97f16de8e5cbdd2ede8919cd95104548f44655b1e7e1531cefc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+bittrex-enterprise-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bittrex-enterprise.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    bittrex-enterprise (0.1.0)
+      addressable (~> 2.6)
+      httparty (~> 0.17)
+      json (~> 2.2)
+      openssl (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.2.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    multi_xml (0.6.0)
+    openssl (2.1.2)
+    public_suffix (3.1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.5.0)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bittrex-enterprise!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16.0)
+  simplecov-console (~> 0.5.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Vertbase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# BittrexEnterprise
+
+A simple Ruby gem for the Bittrex.com v3 API protocol.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bittrex-enterprise'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bittrex-enterprise
+
+## Usage
+
+### Load the gem
+```
+require 'bittrex-enterprise'
+```
+
+### Setup your Bittrex API key
+
+```
+BittrexEnterprise.setup do |config|
+  config.key = 'BITTREX_KEY'
+  config.secret = 'BITTREX_SECRET'
+end
+```
+
+### Use the gem
+
+This gem methods are named after the official Bittrex v3 Beta API Documentation: https://bittrex.github.io/api/v3
+
+```
+# NO AUTH REQUIRED
+
+## Currencies
+
+BittrexEnterprise::Currencies.list
+BittrexEnterprise::Currencies.info
+
+## Markets
+
+BittrexEnterprise::Markets.list
+BittrexEnterprise::Markets.summaries
+BittrexEnterprise::Markets.info
+BittrexEnterprise::Markets.summary
+BittrexEnterprise::Markets.order_book
+BittrexEnterprise::Markets.trades
+BittrexEnterprise::Markets.ticker
+BittrexEnterprise::Markets.candles
+
+## Ping
+
+BittrexEnterprise::Ping.send
+
+# AUTH REQUIRED
+
+## Account
+
+BittrexEnterprise::Account.retrieve
+
+## Addresses
+
+BittrexEnterprise::Addresses.list
+BittrexEnterprise::Addresses.create
+BittrexEnterprise::Addresses.status
+
+## Balances
+
+BittrexEnterprise::Balances.list
+BittrexEnterprise::Balances.info
+
+## Deposits
+
+BittrexEnterprise::Deposits.open
+BittrexEnterprise::Deposits.closed
+BittrexEnterprise::Deposits.by_tx_id
+BittrexEnterprise::Deposits.retrieve
+
+## Orders
+
+BittrexEnterprise::Orders.open
+BittrexEnterprise::Orders.closed
+BittrexEnterprise::Orders.retrieve
+BittrexEnterprise::Orders.cancel
+BittrexEnterprise::Orders.create
+
+## SubAccounts
+
+BittrexEnterprise::SubAccounts.list
+BittrexEnterprise::SubAccounts.create
+BittrexEnterprise::SubAccounts.retrieve
+
+## Transfers
+
+BittrexEnterprise::Transfers.sent
+BittrexEnterprise::Transfers.received
+BittrexEnterprise::Transfers.retrieve
+BittrexEnterprise::Transfers.create
+
+## Withdrawals
+
+BittrexEnterprise::Withdrawals.open
+BittrexEnterprise::Withdrawals.closed
+BittrexEnterprise::Withdrawals.by_tx_id
+BittrexEnterprise::Withdrawals.retrieve
+BittrexEnterprise::Withdrawals.cancel
+BittrexEnterprise::Withdrawals.create
+
+```

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bittrex_enterprise'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# BittrexEnterprise.setup do |config|
+#   config.key = ENV['BITTREX_KEY']
+#   config.secret = ENV['BITTREX_SECRET']
+# end
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bittrex-enterprise.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bittrex-enterprise/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bittrex-enterprise'
+  spec.version = BittrexEnterprise::VERSION
+  spec.licenses = ['MIT']
+  spec.authors = ['Vertbase']
+  spec.email = ['dev@vertbase.com']
+
+  spec.summary = 'Ruby implementation of the Bittrex v3 API'
+  spec.description = 'Ruby implementation of the Bittrex v3 API'
+  spec.homepage = 'https://github.com/vertbase/bittrex-enterprise'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'addressable', '~> 2.6'
+  spec.add_dependency 'json', '~> 2.2'
+  spec.add_dependency 'openssl', '~> 2.1'
+  spec.add_dependency 'httparty', '~> 0.17'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.0'
+  spec.add_development_dependency 'simplecov-console', '~> 0.5.0'
+end

data/lib/bittrex-enterprise/account.rb

@@ -0,0 +1,19 @@
+module BittrexEnterprise
+  class Account
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ----------------------------------------- RETRIEVE -----------------------------------------
+    # Retrieve information for the account associated with the request. For now, it only echoes
+    # the subaccount if one was specified in the header, which can be used to verify that one is
+    # operating on the intended account. More fields will be added later.
+    # --------------------------------------------------------------------------------------------
+    def self.retrieve
+      get_signed 'account'
+    end
+
+  end
+end

data/lib/bittrex-enterprise/addresses.rb

@@ -0,0 +1,41 @@
+module BittrexEnterprise
+  class Addresses
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # -------------------------------------- LIST ------------------------------------------------
+    # List deposit addresses that have been requested or provisioned.
+    # --------------------------------------------------------------------------------------------
+    def self.list
+      get_signed 'addresses'
+    end
+
+
+    # -------------------------------------- CREATE ----------------------------------------------
+    # Request provisioning of a deposit address for a currency for which no address has been
+    # requested or provisioned.
+    #
+    # ------ PARAMS ------
+    # currency_symbol - string - required - the currency ID to provision a new address for
+    # --------------------------------------------------------------------------------------------
+    def self.create(currency_symbol)
+      post_signed 'addresses', currencySymbol: currency_symbol
+    end
+
+
+    # -------------------------------------- STATUS ----------------------------------------------
+    # Retrieve the status of the deposit address for a particular currency for which one has
+    # been requested or provisioned.
+    # ------ PARAMS ------
+    # currency_symbol - string - required - symbol of the currency to retrieve the deposit
+    #                                       address for
+    # --------------------------------------------------------------------------------------------
+    def self.status(currency_symbol)
+      get_signed 'addresses/{currencySymbol}', currencySymbol: currency_symbol
+    end
+
+  end
+end

data/lib/bittrex-enterprise/api_helpers.rb

@@ -0,0 +1,122 @@
+module ApiHelpers
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def base_uri
+      'https://api.bittrex.com/v3/'
+    end
+
+    def get(api_group, params = {})
+      params.compact!
+      api_group, params = setup_params(api_group, params)
+
+      begin
+        response = HTTParty.get(base_uri + api_group, query: params)
+        res_hash response
+      rescue => e
+        res_hash e.response
+      end
+    end
+
+    def get_signed(api_group, params = {})
+      params.compact!
+      api_group, params = setup_params(api_group, params)
+
+      url = base_uri + api_group
+
+      headers = setup_headers(url)
+
+      begin
+        response = HTTParty.get(url, {query: params, headers: headers})
+        res_hash response
+      rescue => e
+        res_hash e.response
+      end
+    end
+
+    def post_signed(api_group, params = {})
+      params.compact!
+      api_group, params = setup_params(api_group, params)
+
+      url = base_uri + api_group
+
+      headers = setup_headers(url)
+
+      begin
+        response = HTTParty.post(url, {body: params, headers: headers})
+        res_hash response
+      rescue => e
+        res_hash e.response
+      end
+    end
+
+    def delete_signed(api_group)
+      params.compact!
+      api_group, params = setup_params(api_group, params)
+
+      url = base_uri + api_group
+
+      headers = setup_headers(url)
+
+      begin
+        response = HTTParty.delete(url, {body: params, headers: headers})
+        res_hash response
+      rescue => e
+        res_hash e.response
+      end
+    end
+
+    def setup_params(api_group, params)
+      matchArr = api_group.match(/{(\D*)}/)&.captures
+      if matchArr
+        matchArr.each do |m|
+          api_group.gsub!("{#{m}}", params.delete(m.to_sym))
+        end
+      end
+      [api_group, params]
+    end
+
+    def setup_headers(uri, content='')
+      api_key = BittrexEnterprise.configuration.key
+      api_timestamp = DateTime.now.strftime('%Q')
+      api_content_hash = create_content_sign(content)
+      puts "CONTENT HASH: #{api_content_hash.inspect}"
+      api_subaccount_id = '' # TODO: make this work with Subaccounts
+      pre_sign = [api_timestamp, uri, 'GET', api_content_hash, api_subaccount_id].join('')
+      puts "PRE_SIGN: #{pre_sign.inspect}"
+      api_signature = create_sign_hmac(pre_sign)
+      puts "SIGNED SIG: #{api_signature.inspect}"
+
+      headers = {
+        "Content-Type": 'application/json',
+        "Api-Key": api_key,
+        "Api-Timestamp": api_timestamp,
+        "Api-Content-Hash": api_content_hash,
+        "Api-Signature": api_signature
+      }
+
+      # headers['Api-Subaccount-Id'] = api_subaccount_id if api_subaccount_id
+
+      headers
+    end
+
+    def create_sign_hmac(pre_sign)
+      OpenSSL::HMAC.hexdigest('sha512', BittrexEnterprise.configuration.secret, pre_sign) #.to_s
+    end
+
+    def create_content_sign(content)
+      Digest::SHA512.hexdigest(content.to_s)
+    end
+
+    def res_hash(res)
+      data = JSON.parse(res.body)
+      data.extend DeepSymbolizable
+      #### IF YOU WANT THE RAW RESPONSE IN ADDITION TO THE DATA USE THIS
+      #### { data: data.deep_symbolize, res: res }
+      #### INSTEAD OF THE FOLLOWING LINE
+      { data: data.deep_symbolize }
+    end
+  end
+end

data/lib/bittrex-enterprise/balances.rb

@@ -0,0 +1,31 @@
+module BittrexEnterprise
+  class Balances
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ---------------------------------------- LIST ----------------------------------------------
+    # List account balances across available currencies. Returns a Balance entry for each
+    # currency for which there is either a balance or an address.
+    # --------------------------------------------------------------------------------------------
+    def self.list
+      get_signed 'balances'
+    end
+
+
+    # --------------------------------------- INFO -----------------------------------------------
+    # Retrieve account balance for a specific currency. Request will always succeed when the
+    # currency exists, regardless of whether there is a balance or address.
+    #
+    # ------ PARAMS ------
+    # currency_symbol: string - required - unique symbol of the currency to retrieve the
+    #                                      account balance for
+    # --------------------------------------------------------------------------------------------
+    def self.info(currency_symbol)
+      get_signed 'currencies/{currencySymbol}', currencySymbol: currency_symbol
+    end
+
+  end
+end

data/lib/bittrex-enterprise/currencies.rb

@@ -0,0 +1,28 @@
+module BittrexEnterprise
+  class Currencies
+    include ApiHelpers
+
+  # ==============================================================================================
+  # PUBLIC METHODS - NO AUTH REQUIRED ============================================================
+  # ==============================================================================================
+
+    # ------------------------------------- LIST -------------------------------------------------
+    # List currencies
+    # --------------------------------------------------------------------------------------------
+    def self.list
+      get 'currencies'
+    end
+
+
+    # ------------------------------------ INFO --------------------------------------------------
+    # Retrieve info on a specified currency.
+    #
+    # ------ PARAMS ------
+    # symbol: string - required - symbol of the currency to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.info(symbol)
+      get 'currencies/{symbol}', symbol: symbol
+    end
+
+  end
+end

data/lib/bittrex-enterprise/deposits.rb

@@ -0,0 +1,78 @@
+module BittrexEnterprise
+  class Deposits
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ------------------------------------------ OPEN --------------------------------------------
+    # List open deposits. Results are sorted in inverse order of UpdatedAt, and are limited to
+    # the first 1000.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # status - string enum [PENDING] - optional - filter by an open deposit status
+    # currencySymbol - string - optional - filter by currency
+    # --------------------------------------------------------------------------------------------
+    def self.open(params={})
+      get_signed 'deposits/open', params
+    end
+
+
+    # ----------------------------------------- CLOSED -------------------------------------------
+    # List closed deposits. StartDate and EndDate filters apply to the CompletedAt field.
+    # Pagination and the sort order of the results are in inverse order of the CompletedAt field.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # status - string enum [COMPLETED, ORPHANED, INVALIDATED] - optional - filter by deposit status
+    #
+    # currencySymbol - string - optional - filter by currency
+    #
+    # nextPageToken - string - The unique identifier of the item that the resulting query result
+    #         should start after, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the forward direction. (May only be specified if PreviousPageToken
+    #         is not specified.)
+    #
+    # previousPageToken - string - The unique identifier of the item that the resulting query
+    #         result should end before, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the reverse direction. (May only be specified if NextPageToken is
+    #         not specified.)
+    #
+    # pageSize - integer - maximum number of items to retrieve -- default 100, minimum 1, maximum 200
+    #
+    # startDate - string(date-time) - Filters out results before this timestamp. In ISO 8601 format
+    #         (e.g., "2019-01-02T16:23:45Z"). Precision beyond one second is not supported. Use
+    #         pagination parameters for more precise filtering.
+    #
+    # endDate - string(date-time) - Filters out result after this timestamp. Uses the same format
+    #         as StartDate. Either, both, or neither of StartDate and EndDate can be set. The only
+    #         constraint on the pair is that, if both are set, then EndDate cannot be before StartDate.
+    # --------------------------------------------------------------------------------------------
+    def self.closed(params={})
+      get_signed 'deposits/closed', params
+    end
+
+
+    # ---------------------------------- BY TRANSACTION ID ---------------------------------------
+    # Retrieves all deposits for this account with the given TxId
+    #
+    # ------ PARAMS ------
+    # tx_id - string - required - the transaction id to lookup
+    # --------------------------------------------------------------------------------------------
+    def self.by_tx_id(tx_id)
+      get_signed 'deposits/ByTxId/{tdId}', txId: tx_id
+    end
+
+
+    # --------------------------------------- RETRIEVE -------------------------------------------
+    # Retrieve information for a specific deposit.
+    #
+    # ------ PARAMS ------
+    # deposit_id - string - required - (guid-formatted string) - ID of the deposit to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.retrieve(deposit_id)
+      get_signed 'deposits/{depositId}', depositId: deposit_id
+    end
+
+  end
+end