new Invoice, TradingAvgPrice, FundingAvgRate models and test coverage

Author: Daniel1984

lib/funding_avg_rate.js

@@ -0,0 +1,63 @@
+'use strict'
+
+const numberValidator = require('./validators/number')
+const Model = require('./model')
+
+const fields = {
+  rateAvg: 0,
+  amount: 1
+}
+
+/**
+ * Funding Average Rate model
+ */
+class FundingAvgRate extends Model {
+  /**
+   * @param {object|Array} data   - funding average rate data
+   * @param {number} data.rateAvg - pulse User ID
+   * @param {number} data.amount  - creation timestamp
+   */
+  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 { rateAvg, amount } = this
+
+    return [
+      amount,
+      '@',
+      rateAvg
+    ].join(' ')
+  }
+
+  /**
+   * Validates a given funding average rate instance
+   *
+   * @param {object[]|object|FundingAvgRate[]|FundingAvgRate|Array} data - instance to validate
+   * @returns {string} error - null if instance is valid
+   */
+  static validate (data) {
+    return super.validate({
+      data,
+      fields,
+      validators: {
+        rateAvg: numberValidator,
+        amount: numberValidator
+      }
+    })
+  }
+}
+
+module.exports = FundingAvgRate

lib/index.js

@@ -32,6 +32,9 @@ module.exports = {
   ChangeLog: require('./change_log'),
   PublicPulseProfile: require('./public_pulse_profile'),
   PulseMessage: require('./pulse_message'),
+  Invoice: require('./invoice'),
+  TradingAvgPrice: require('./trading_avg_price'),
+  FundingAvgRate: require('./funding_avg_rate'),
 
   isCollection: require('./util/is_collection')
 }

lib/invoice.js

@@ -0,0 +1,68 @@
+'use strict'
+
+const stringValidator = require('./validators/string')
+const Model = require('./model')
+
+const fields = {
+  invoiceHash: 0,
+  invoice: 1,
+  // PLACEHOLDER
+  // PLACEHOLDER
+  amount: 4
+}
+
+/**
+ * Deposit Invoice model
+ */
+class Invoice extends Model {
+  /**
+   * @param {object|Array} data       - deposit invoice
+   * @param {string} data.invoiceHash - Hashed invoice
+   * @param {string} data.invoice     - Requested invoice
+   * @param {string} data.amount      - Amount of invoice
+   */
+  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 { invoiceHash, invoice, amount } = this
+
+    return [
+      `amount: ${amount}`,
+      `invoice: ${invoice}`,
+      `invoiceHash: ${invoiceHash}`
+    ].join(' ')
+  }
+
+  /**
+   * Validates a given invoice instance
+   *
+   * @param {object[]|object|Invoice[]|Invoice|Array} data - instance to validate
+   * @returns {string} error - null if instance is valid
+   */
+  static validate (data) {
+    return super.validate({
+      data,
+      fields,
+      validators: {
+        invoiceHash: stringValidator,
+        invoice: stringValidator,
+        amount: stringValidator
+      }
+    })
+  }
+}
+
+module.exports = Invoice

lib/trading_avg_price.js

@@ -0,0 +1,63 @@
+'use strict'
+
+const numberValidator = require('./validators/number')
+const Model = require('./model')
+
+const fields = {
+  priceAvg: 0,
+  amount: 1
+}
+
+/**
+ * Trading Average Price model
+ */
+class TradingAvgPrice extends Model {
+  /**
+   * @param {object|Array} data    - trading average price data
+   * @param {number} data.priceAvg - pulse User ID
+   * @param {number} data.amount   - creation timestamp
+   */
+  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 { priceAvg, amount } = this
+
+    return [
+      amount,
+      '@',
+      priceAvg
+    ].join(' ')
+  }
+
+  /**
+   * Validates a given trading average price instance
+   *
+   * @param {object[]|object|TradingAvgPrice[]|TradingAvgPrice|Array} data - instance to validate
+   * @returns {string} error - null if instance is valid
+   */
+  static validate (data) {
+    return super.validate({
+      data,
+      fields,
+      validators: {
+        priceAvg: numberValidator,
+        amount: numberValidator
+      }
+    })
+  }
+}
+
+module.exports = TradingAvgPrice

test/lib/models/funding_avg_rate.js

@@ -0,0 +1,70 @@
+/* eslint-env mocha */
+'use strict'
+
+const assert = require('assert')
+const _includes = require('lodash/includes')
+const { FundingAvgRate } = require('../../../lib')
+const testModel = require('../../helpers/test_model')
+const testModelValidation = require('../../helpers/test_model_validation')
+
+describe('Funding Average Rate model', () => {
+  testModel({
+    model: FundingAvgRate,
+    orderedFields: [
+      'rateAvg',
+      'amount'
+    ]
+  })
+
+  testModelValidation({
+    model: FundingAvgRate,
+    validData: {
+      rateAvg: new Array(...(new Array(5))).map(() => Math.random()),
+      amount: new Array(...(new Array(5))).map(() => Math.random())
+    }
+  })
+
+  it('initializes correctly', () => {
+    const tap = new FundingAvgRate([
+      0.0002303,
+      100
+    ])
+
+    assert.strictEqual(tap.rateAvg, 0.0002303)
+    assert.strictEqual(tap.amount, 100)
+  })
+
+  it('serializes correctly', () => {
+    const tap = new FundingAvgRate([
+      0.0002303,
+      100
+    ])
+
+    assert.deepStrictEqual(tap.serialize(), [
+      0.0002303,
+      100
+    ])
+  })
+
+  it('unserializes correctly', () => {
+    const obj = FundingAvgRate.unserialize([
+      0.0002303,
+      100
+    ])
+
+    assert.strictEqual(obj.rateAvg, 0.0002303)
+    assert.strictEqual(obj.amount, 100)
+  })
+
+  describe('toString', () => {
+    it('includes pertinent information', () => {
+      const tap = new FundingAvgRate({
+        rateAvg: 0.0002303,
+        amount: 100
+      })
+
+      const str = tap.toString()
+      assert.ok(_includes(str, '100 @ 0.0002303'), 'missing mandatory fields')
+    })
+  })
+})

test/lib/models/invoice.js

@@ -0,0 +1,91 @@
+/* eslint-env mocha */
+'use strict'
+
+const assert = require('assert')
+const _compact = require('lodash/compact')
+const _includes = require('lodash/includes')
+const { Invoice } = require('../../../lib')
+const testModel = require('../../helpers/test_model')
+// const testModelValidation = require('../../helpers/test_model_validation')
+
+describe('Invoice model', () => {
+  testModel({
+    model: Invoice,
+    orderedFields: [
+      'invoiceHash',
+      'invoice',
+      null,
+      null,
+      'amount'
+    ]
+  })
+
+  // testModelValidation({
+  //   model: Invoice,
+  //   validData: {
+  //     invoiceHash: ['foo', 'bar', 'baz', 'qux'],
+  //     invoice: ['foo1', 'bar2', 'baz3', 'qux4'],
+  //     amount: ['0.001', '0.002', '0.003', '0.004']
+  //   }
+  // })
+
+  it('initializes correctly', () => {
+    const invc = new Invoice([
+      'invoiceHash',
+      'invoice',
+      null,
+      null,
+      'amount'
+    ])
+
+    assert.strictEqual(invc.invoiceHash, 'invoiceHash')
+    assert.strictEqual(invc.invoice, 'invoice')
+    assert.strictEqual(invc.amount, 'amount')
+  })
+
+  it('serializes correctly', () => {
+    const invc = new Invoice([
+      'invoiceHash',
+      'invoice',
+      null,
+      null,
+      'amount'
+    ])
+
+    const arr = _compact(invc.serialize())
+    assert.deepStrictEqual(arr, [
+      'invoiceHash',
+      'invoice',
+      'amount'
+    ])
+  })
+
+  it('unserializes correctly', () => {
+    const obj = Invoice.unserialize([
+      'invoiceHash',
+      'invoice',
+      null,
+      null,
+      'amount'
+    ])
+
+    assert.strictEqual(obj.invoiceHash, 'invoiceHash')
+    assert.strictEqual(obj.invoice, 'invoice')
+    assert.strictEqual(obj.amount, 'amount')
+  })
+
+  describe('toString', () => {
+    it('includes pertinent information', () => {
+      const invc = new Invoice({
+        invoiceHash: 'invoiceHash',
+        invoice: 'invoice',
+        amount: '0.0001'
+      })
+
+      const str = invc.toString()
+      assert.ok(_includes(str, 'invoiceHash: invoiceHash'), 'invoiceHash missing')
+      assert.ok(_includes(str, 'invoice: invoice'), 'invoice missing')
+      assert.ok(_includes(str, 'amount: 0.0001'), 'amount missing')
+    })
+  })
+})