Add HitBTC

Author: polyrabbit

README.md

@@ -8,15 +8,15 @@
 
 > NEVER LEAVE YOUR TERMINAL
 
-![token-ticker](https://user-images.githubusercontent.com/2657334/38620004-0a04640e-3dd0-11e8-9708-00484845cdb9.png)
+![token-ticker](https://user-images.githubusercontent.com/2657334/40175207-ff9e6504-5a09-11e8-9a3d-a887ebc4895a.png)
 
 Track token prices in your favorite exchanges from the terminal. Best CLI tool for those who are both **Crypto investors** and **Engineers**.
 
 ### Features
 
  * Auto refresh on a specified interval, watch prices in live update mode
  * Proxy aware HTTP request, for easy access to blocked exchanges
- * Real-time prices from 8+ exchanges
+ * Real-time prices from 9+ exchanges
 
 ### Supported Exchanges
 
@@ -28,6 +28,7 @@ Track token prices in your favorite exchanges from the terminal. Best CLI tool f
  * [OKEx](https://www.okex.com/)
  * [Gate.io](https://gate.io/)
  * [Bittrex](https://bittrex.com/)
+ * [HitBTC](https://hitbtc.com/)
  * _still adding..._
 
 ### Installation

exchange/coinmarketcap.go

@@ -76,7 +76,7 @@ func (client *coinMarketCapClient) GetSymbolPrice(symbol string) (*SymbolPrice,
 	token := tokens[0]
 
 	return &SymbolPrice{
-		Symbol:           token.Symbol,
+		Symbol:           symbol,
 		Price:            token.PriceUSD,
 		Source:           client.GetName(),
 		UpdateAt:         time.Unix(token.LastUpdated, 0),

exchange/hitbtc.go

@@ -0,0 +1,159 @@
+package exchange
+
+import (
+	"encoding/json"
+	"errors"
+	"github.com/sirupsen/logrus"
+	"math"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+)
+
+// https://api.hitbtc.com/#market-data
+const hitBtcBaseApi = "https://api.hitbtc.com/api/2/"
+
+// ZB api is very similar to OKEx, who copied whom?
+
+type hitBtcClient struct {
+	exchangeBaseClient
+	AccessKey string
+	SecretKey string
+}
+
+type hitBtcCommonResponse struct {
+	Error *struct {
+		Code        int
+		Message     string
+		Description string
+	}
+}
+
+type hitBtcTickerResponse struct {
+	hitBtcCommonResponse
+	Last      float64 `json:",string"`
+	Open      float64 `json:",string"`
+	Timestamp string
+}
+
+type hitBtcKlineResponse struct {
+	hitBtcCommonResponse
+	Timestamp string
+	Open      float64 `json:",string"`
+}
+
+func (resp *hitBtcTickerResponse) getCommonResponse() hitBtcCommonResponse {
+	return resp.hitBtcCommonResponse
+}
+
+func (resp *hitBtcKlineResponse) getCommonResponse() hitBtcCommonResponse {
+	return resp.hitBtcCommonResponse
+}
+
+// Any way to hold the common response, instead of adding an interface here?
+type hitBtcCommonResponseProvider interface {
+	getCommonResponse() hitBtcCommonResponse
+}
+
+func NewHitBtcClient(httpClient *http.Client) *hitBtcClient {
+	return &hitBtcClient{exchangeBaseClient: *newExchangeBase(hitBtcBaseApi, httpClient)}
+}
+
+func (client *hitBtcClient) GetName() string {
+	return "HitBTC"
+}
+
+func (client *hitBtcClient) decodeResponse(resp *http.Response, respJSON hitBtcCommonResponseProvider) error {
+	defer resp.Body.Close()
+
+	decoder := json.NewDecoder(resp.Body)
+	if err := decoder.Decode(&respJSON); err != nil {
+		if resp.StatusCode != 200 {
+			return errors.New(resp.Status)
+		}
+		return err
+	}
+
+	// All I need is to get the common part, I don't like this
+	commonResponse := respJSON.getCommonResponse()
+	if commonResponse.Error != nil {
+		return errors.New(commonResponse.Error.Message + " - " + commonResponse.Error.Description)
+	}
+	return nil
+}
+
+func (client *hitBtcClient) GetKlinePrice(symbol, period string, limit int) (float64, error) {
+	symbol = strings.ToLower(symbol)
+	resp, err := client.httpGet("public/candles/"+strings.ToUpper(symbol), map[string]string{
+		"period": period,
+		"limit":  strconv.Itoa(limit),
+	})
+	if err != nil {
+		return 0, err
+	}
+
+	if resp.StatusCode != 200 {
+		var respJSON hitBtcKlineResponse
+		return 0, client.decodeResponse(resp, &respJSON)
+	}
+	var respJSON []hitBtcKlineResponse
+	defer resp.Body.Close()
+
+	decoder := json.NewDecoder(resp.Body)
+	if err := decoder.Decode(&respJSON); err != nil {
+		if resp.StatusCode != 200 {
+			return 0, errors.New(resp.Status)
+		}
+		return 0, err
+	}
+	logrus.Debugf("%s - Kline for %s*%v uses price at %s", client.GetName(), period, limit, respJSON[0].Timestamp)
+	return respJSON[0].Open, nil
+}
+
+func (client *hitBtcClient) GetSymbolPrice(symbol string) (*SymbolPrice, error) {
+	resp, err := client.httpGet("/public/ticker/"+strings.ToUpper(symbol), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	var respJSON hitBtcTickerResponse
+	err = client.decodeResponse(resp, &respJSON)
+	if err != nil {
+		return nil, err
+	}
+	updated, err := time.Parse(time.RFC3339, respJSON.Timestamp)
+	if err != nil {
+		return nil, err
+	}
+
+	var percentChange1h, percentChange24h = math.MaxFloat64, math.MaxFloat64
+	price1hAgo, err := client.GetKlinePrice(symbol, "M1", 60)
+	if err != nil {
+		logrus.Warnf("%s - Failed to get price 1 hour ago, error: %v\n", client.GetName(), err)
+	} else if price1hAgo != 0 {
+		percentChange1h = (respJSON.Last - price1hAgo) / price1hAgo * 100
+	}
+
+	//price24hAgo_, err := client.GetKlinePrice(symbol, "M3", 480)
+	//logrus.Warnf("%s - %s", price24hAgo_, respJSON.Open)
+
+	price24hAgo := respJSON.Open
+	percentChange24h = (respJSON.Last - price24hAgo) / price24hAgo * 100
+
+	return &SymbolPrice{
+		Symbol:           symbol,
+		Price:            strconv.FormatFloat(respJSON.Last, 'f', -1, 64),
+		UpdateAt:         updated,
+		Source:           client.GetName(),
+		PercentChange1h:  percentChange1h,
+		PercentChange24h: percentChange24h,
+	}, nil
+}
+
+func init() {
+	register((&hitBtcClient{}).GetName(), func(client *http.Client) ExchangeClient {
+		// Limited by type system in Go, I hate wrapper/adapter
+		return NewHitBtcClient(client)
+	})
+}

exchange/hitbtc_test.go

@@ -0,0 +1,47 @@
+package exchange
+
+import (
+	"net/http"
+	"testing"
+)
+
+func TestHitBtcClient(t *testing.T) {
+
+	var client = NewHitBtcClient(http.DefaultClient)
+
+	t.Run("GetKlinePrice", func(t *testing.T) {
+		_, err := client.GetKlinePrice("bTCusd", "M1", 60)
+
+		if err != nil {
+			t.Fatalf("Unexpected error: %v", err)
+		}
+	})
+
+	t.Run("GetKlinePrice of unknown symbol", func(t *testing.T) {
+		_, err := client.GetKlinePrice("abcedfg", "M1", 60)
+
+		if err == nil {
+			t.Fatalf("Expecting error when fetching unknown price, but get nil")
+		}
+		t.Logf("Returned error is %v, expected?", err)
+	})
+
+	t.Run("GetSymbolPrice", func(t *testing.T) {
+		sp, err := client.GetSymbolPrice("bTCusd")
+
+		if err != nil {
+			t.Fatalf("Unexpected error: %v", err)
+		}
+		if sp.Price == "" {
+			t.Fatalf("Get an empty price?")
+		}
+	})
+
+	t.Run("GetUnexistSymbolPrice", func(t *testing.T) {
+		_, err := client.GetSymbolPrice("ABC123")
+
+		if err == nil {
+			t.Fatalf("Should throws on invalid symbol")
+		}
+	})
+}

main.go

@@ -123,7 +123,7 @@ func renderTable(symbolPriceList []*SymbolPrice, writer *uilive.Writer) {
 	// Fill in data
 	for _, sp := range symbolPriceList {
 		table.Append([]string{sp.Symbol, sp.Price, highlightChange(sp.PercentChange1h),
-			highlightChange(sp.PercentChange24h), sp.Source, sp.UpdateAt.Format("15:04:05")})
+			highlightChange(sp.PercentChange24h), sp.Source, sp.UpdateAt.Local().Format("15:04:05")})
 	}
 
 	table.Render()

token_ticker.example.yaml

@@ -15,31 +15,31 @@
 
 exchanges:
 ## Exchanges are identified by name, following are supported exchanges
-- name: coinmarketcap
+- name: CoinMarketCap
   tokens:
   ## Tokens supported by this exchange, note that different exchanges have different
   ## formats to denote their tokens/markets, refer to their URLs to find the format
   - Bitcoin
 #  - Ethereum
 #  - Litecoin
 
-- name: bitfinex
+- name: Bitfinex
   tokens:
   - btcusd
 
-- name: binance
+- name: Binance
   tokens:
   ## Tokens in Binance are actually token-currency pairs
   - BNBUSDT
 #  - BTCUSDT
 # - ETHUSDT
 #  - EOSETH
 
-- name: huobi
+- name: Huobi
   tokens:
   - HTUSDT
 
-- name: zb
+- name: ZB
   tokens:
   - ZB_QC
 
@@ -53,4 +53,8 @@ exchanges:
 
 - name: Bittrex
   tokens:
-  - USDT-BTC
+  - USDT-BTC
+
+- name: HitBTC
+  tokens:
+  - BTCUSD