(feature) add public REST API model tests where possible

Author: f3rno

lib/public_trade.js

@@ -1,24 +1,55 @@
 'use strict'
 
+const _isArray = require('lodash/isArray')
+const _isObject = require('lodash/isObject')
 const Model = require('./model')
 const BOOL_FIELDS = []
-const FIELDS = {
+const TRADING_FIELDS = {
   id: 0,
   mts: 1,
   amount: 2,
   price: 3
 }
 
-const FIELD_KEYS = Object.keys(FIELDS)
+const FUNDING_FIELDS = {
+  id: 0,
+  mts: 1,
+  amount: 2,
+  rate: 3,
+  period: 4
+}
+
+const TRADING_FIELD_KEYS = Object.keys(TRADING_FIELDS)
+const FUNDING_FIELD_KEYS = Object.keys(FUNDING_FIELDS)
 
 class PublicTrade extends Model {
   constructor (data = {}) {
-    super(data, FIELDS, BOOL_FIELDS, FIELD_KEYS)
+    if (_isArray(data)) {
+      if (data.length === 5) {
+        super(data, FUNDING_FIELDS, BOOL_FIELDS, FUNDING_FIELD_KEYS)
+      } else {
+        super(data, TRADING_FIELDS, BOOL_FIELDS, TRADING_FIELD_KEYS)
+      }
+    } else if (_isObject(data)) {
+      if (data.rate) {
+        super(data, FUNDING_FIELDS, BOOL_FIELDS, FUNDING_FIELD_KEYS)
+      } else {
+        super(data, TRADING_FIELDS, BOOL_FIELDS, TRADING_FIELD_KEYS)
+      }
+    } else {
+      throw new Error('unknown data type')
+    }
   }
 
   static unserialize (arr) {
-    return super.unserialize(arr, FIELDS, BOOL_FIELDS, FIELD_KEYS)
+    if ((_isArray(arr[0]) && arr[0].length === 5) || (arr.length === 5)) {
+      return super.unserialize(arr, FUNDING_FIELDS, BOOL_FIELDS, FUNDING_FIELD_KEYS)
+    } else {
+      return super.unserialize(arr, TRADING_FIELDS, BOOL_FIELDS, TRADING_FIELD_KEYS)
+    }
   }
 }
 
 module.exports = PublicTrade
+module.exports.TRADING_FIELDS = TRADING_FIELDS
+module.exports.FUNDING_FIELDS = FUNDING_FIELDS

package.json

@@ -33,6 +33,7 @@
   },
   "homepage": "http://bitfinexcom.github.io/bfx-api-node-models/",
   "devDependencies": {
+    "bfx-api-node-rest": "^1.0.0",
     "chai": "^3.4.1",
     "debug": "^3.1.0",
     "mocha": "^3.4.2",

test/lib/models/candle.js

@@ -1,6 +1,8 @@
 /* eslint-env mocha */
 'use strict'
 
+const assert = require('assert')
+const { RESTv2 } = require('bfx-api-node-rest')
 const { Candle } = require('../../../lib')
 const testModel = require('../../helpers/test_model')
 
@@ -9,4 +11,20 @@ describe('Candle model', () => {
     model: Candle,
     orderedFields: ['mts', 'open', 'close', 'high', 'low', 'volume']
   })
+
+  it('unserializes live data correctly', async () => {
+    const rest = new RESTv2()
+    const arr = await rest.candles('tBTCUSD')
+
+    arr.forEach(candle => {
+      const obj = Candle.unserialize(candle)
+
+      assert.equal(obj.mts, candle[0])
+      assert.equal(obj.open, candle[1])
+      assert.equal(obj.close, candle[2])
+      assert.equal(obj.high, candle[3])
+      assert.equal(obj.low, candle[4])
+      assert.equal(obj.volume, candle[5])
+    })
+  })
 })

test/lib/models/funding_ticker.js

@@ -2,6 +2,7 @@
 'use strict'
 
 const assert = require('assert')
+const { RESTv2 } = require('bfx-api-node-rest')
 const { FundingTicker } = require('../../../lib')
 
 const DATA = [
@@ -63,4 +64,24 @@ describe('FundingTicker model', () => {
     assert.equal(obj.high, 0.000163)
     assert.equal(obj.low, 2.7e-7)
   })
+
+  it('unserializes live data correctly', async () => {
+    const rest = new RESTv2()
+    const arr = await rest.ticker('fUSD')
+    const obj = FundingTicker.unserialize(arr)
+
+    assert.equal(obj.frr, arr[0])
+    assert.equal(obj.bid, arr[1])
+    assert.equal(obj.bidPeriod, arr[2])
+    assert.equal(obj.bidSize, arr[3])
+    assert.equal(obj.ask, arr[4])
+    assert.equal(obj.askPeriod, arr[5])
+    assert.equal(obj.askSize, arr[6])
+    assert.equal(obj.dailyChange, arr[7])
+    assert.equal(obj.dailyChangePerc, arr[8])
+    assert.equal(obj.lastPrice, arr[9])
+    assert.equal(obj.volume, arr[10])
+    assert.equal(obj.high, arr[11])
+    assert.equal(obj.low, arr[12])
+  })
 })

test/lib/models/order_book.js

@@ -3,6 +3,7 @@
 
 const assert = require('assert')
 const CRC = require('crc-32')
+const { RESTv2 } = require('bfx-api-node-rest')
 const { OrderBook } = require('../../../lib')
 
 describe('OrderBook model', () => {
@@ -742,4 +743,52 @@ describe('OrderBook model', () => {
     assert.deepEqual(entryA, expA)
     assert.deepEqual(entryB, expB)
   })
+
+  it('unserializes live trading data correctly', async () => {
+    const rest = new RESTv2()
+    const book = await rest.orderBook('tBTCUSD', 'P0')
+    const obj = new OrderBook(book)
+    let firstAsk = -1
+
+    book.forEach((entry, i) => {
+      if (entry[2] < 0) {
+        if (firstAsk === -1) {
+          firstAsk = i
+        }
+
+        assert.equal(obj.asks[i - firstAsk][0], entry[0])
+        assert.equal(obj.asks[i - firstAsk][1], entry[1])
+        assert.equal(obj.asks[i - firstAsk][2], entry[2])
+      } else {
+        assert.equal(obj.bids[i][0], entry[0])
+        assert.equal(obj.bids[i][1], entry[1])
+        assert.equal(obj.bids[i][2], entry[2])
+      }
+    })
+  })
+
+  it('unserializes live funding data correctly', async () => {
+    const rest = new RESTv2()
+    const book = await rest.orderBook('fUSD', 'P0')
+    const obj = new OrderBook(book)
+    let firstAsk = -1
+
+    book.forEach((entry, i) => {
+      if (entry[3] > 0) {
+        if (firstAsk === -1) {
+          firstAsk = i
+        }
+
+        assert.equal(obj.asks[i - firstAsk][0], entry[0])
+        assert.equal(obj.asks[i - firstAsk][1], entry[1])
+        assert.equal(obj.asks[i - firstAsk][2], entry[2])
+        assert.equal(obj.asks[i - firstAsk][3], entry[3])
+      } else {
+        assert.equal(obj.bids[i][0], entry[0])
+        assert.equal(obj.bids[i][1], entry[1])
+        assert.equal(obj.bids[i][2], entry[2])
+        assert.equal(obj.bids[i][3], entry[3])
+      }
+    })
+  })
 })

test/lib/models/public_trade.js

@@ -1,6 +1,8 @@
 /* eslint-env mocha */
 'use strict'
 
+const assert = require('assert')
+const { RESTv2 } = require('bfx-api-node-rest')
 const { PublicTrade } = require('../../../lib')
 const testModel = require('../../helpers/test_model')
 
@@ -11,4 +13,30 @@ describe('Public Trade model', () => {
       'id', 'mts', 'amount', 'price'
     ]
   })
+
+  it('unserializes live trading data correctly', async () => {
+    const rest = new RESTv2()
+    const arr = await rest.trades('tBTCUSD')
+
+    arr.forEach(trade => {
+      const obj = PublicTrade.unserialize(trade)
+
+      Object.keys(PublicTrade.TRADING_FIELDS).forEach(field => {
+        assert.equal(obj[field], trade[PublicTrade.TRADING_FIELDS[field]])
+      })
+    })
+  })
+
+  it('unserializes live funding data correctly', async () => {
+    const rest = new RESTv2()
+    const arr = await rest.trades('fUSD')
+
+    arr.forEach(trade => {
+      const obj = PublicTrade.unserialize(trade)
+
+      Object.keys(PublicTrade.FUNDING_FIELDS).forEach(field => {
+        assert.equal(obj[field], trade[PublicTrade.FUNDING_FIELDS[field]])
+      })
+    })
+  })
 })

test/lib/models/trading_ticker.js

@@ -2,6 +2,7 @@
 'use strict'
 
 const assert = require('assert')
+const { RESTv2 } = require('bfx-api-node-rest')
 const { TradingTicker } = require('../../../lib')
 
 const DATA = [
@@ -54,4 +55,21 @@ describe('TradingTicker model', () => {
     assert.equal(obj.high, 284.62)
     assert.equal(obj.low, 211.19)
   })
+
+  it('unserializes live data correctly', async () => {
+    const rest = new RESTv2()
+    const arr = await rest.ticker('tBTCUSD')
+    const obj = TradingTicker.unserialize(arr)
+
+    assert.equal(obj.bid, arr[0])
+    assert.equal(obj.bidSize, arr[1])
+    assert.equal(obj.ask, arr[2])
+    assert.equal(obj.askSize, arr[3])
+    assert.equal(obj.dailyChange, arr[4])
+    assert.equal(obj.dailyChangePerc, arr[5])
+    assert.equal(obj.lastPrice, arr[6])
+    assert.equal(obj.volume, arr[7])
+    assert.equal(obj.high, arr[8])
+    assert.equal(obj.low, arr[9])
+  })
 })