adding new fund keeper model and tests

Author: Daniel1984

lib/fund_keeper.js

@@ -0,0 +1,75 @@
+'use strict'
+
+const stringValidator = require('./validators/string')
+const dateValidator = require('./validators/date')
+const Model = require('./model')
+
+const fields = {
+  mts: 0,
+  type: 1,
+  // PLACEHOLDER,
+  // PLACEHOLDER,
+  // PLACEHOLDER,
+  // PLACEHOLDER,
+  status: 6,
+  text: 7
+}
+
+/**
+ * Fund Keeper model
+ */
+class FundKeeper extends Model {
+  /**
+   * @param {object|Array} data  - fund keeper data
+   * @param {number} data.mts    - Millisecond Time Stamp of the update
+   * @param {string} data.type   - Purpose of notification ('fk-req' (funding keep request))
+   * @param {string} data.status - Status of the notification; it may vary over time (SUCCESS, ERROR, FAILURE, ...)
+   * @param {string} data.text   - Text of the notification
+   */
+  constructor (data = {}) {
+    super({ data, fields })
+  }
+
+  /**
+   * @param {object[]|object|Array[]|Array} data - data to convert to POJO
+   * @returns {object} pojo
+   */
+  static unserialize (data) {
+    return super.unserialize({ data, fields })
+  }
+
+  /**
+   * @returns {string} str
+   */
+  toString () {
+    const { mts, type, status, text } = this
+
+    return [
+      new Date(mts).toLocaleString(),
+      `type:${type}`,
+      `status:${status}`,
+      `msg:${text}`
+    ].join(' ')
+  }
+
+  /**
+   * Validates a given fund keeper instance
+   *
+   * @param {object[]|object|FundKeeper[]|FundKeeper|Array} data - instance to validate
+   * @returns {string} error - null if instance is valid
+   */
+  static validate (data) {
+    return super.validate({
+      data,
+      fields,
+      validators: {
+        mts: dateValidator,
+        type: stringValidator,
+        status: stringValidator,
+        text: stringValidator
+      }
+    })
+  }
+}
+
+module.exports = FundKeeper

lib/index.js

@@ -35,6 +35,7 @@ module.exports = {
   Invoice: require('./invoice'),
   TradingAvgPrice: require('./trading_avg_price'),
   FundingAvgRate: require('./funding_avg_rate'),
+  FundKeeper: require('./fund_keeper'),
 
   isCollection: require('./util/is_collection')
 }

test/lib/models/fund_keeper.js

@@ -0,0 +1,105 @@
+/* eslint-env mocha */
+'use strict'
+
+const assert = require('assert')
+const _includes = require('lodash/includes')
+const _compact = require('lodash/compact')
+const { FundKeeper } = require('../../../lib')
+const testModel = require('../../helpers/test_model')
+const testModelValidation = require('../../helpers/test_model_validation')
+
+describe('Fund Keeper model', () => {
+  testModel({
+    model: FundKeeper,
+    orderedFields: [
+      'mts',
+      'type',
+      null,
+      null,
+      null,
+      null,
+      'status',
+      'text'
+    ]
+  })
+
+  testModelValidation({
+    model: FundKeeper,
+    validData: {
+      mts: new Array(...(new Array(5))).map(() => Math.random()),
+      type: ['foo', 'bar', 'baz', 'qux'],
+      status: ['foo', 'bar', 'baz', 'qux'],
+      text: ['foo', 'bar', 'baz', 'qux']
+    }
+  })
+
+  it('initializes correctly', () => {
+    const fk = new FundKeeper([
+      1590052551928,
+      'fk-req',
+      null,
+      null,
+      null,
+      null,
+      'success',
+      'text'
+    ])
+
+    assert.strictEqual(fk.mts, 1590052551928)
+    assert.strictEqual(fk.type, 'fk-req')
+    assert.strictEqual(fk.status, 'success')
+    assert.strictEqual(fk.text, 'text')
+  })
+
+  it('serializes correctly', () => {
+    const fk = new FundKeeper([
+      1590052551928,
+      'fk-req',
+      null,
+      null,
+      null,
+      null,
+      'success',
+      'text'
+    ])
+
+    assert.deepStrictEqual(_compact(fk.serialize()), [
+      1590052551928,
+      'fk-req',
+      'success',
+      'text'
+    ])
+  })
+
+  it('unserializes correctly', () => {
+    const obj = FundKeeper.unserialize([
+      1590052551928,
+      'fk-req',
+      null,
+      null,
+      null,
+      null,
+      'success',
+      'text'
+    ])
+
+    assert.strictEqual(obj.mts, 1590052551928)
+    assert.strictEqual(obj.type, 'fk-req')
+    assert.strictEqual(obj.status, 'success')
+    assert.strictEqual(obj.text, 'text')
+  })
+
+  describe('toString', () => {
+    it('includes pertinent information', () => {
+      const fk = new FundKeeper({
+        mts: 1590052551928,
+        type: 'fk-req',
+        status: 'success',
+        text: 'text'
+      })
+
+      const str = fk.toString()
+      assert.ok(_includes(str, 'type:fk-req status:success msg:text'), 'missing mandatory fields')
+    })
+  })
+})