(feat) auth permission model

Author: vigan-abd

lib/auth_permission.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const boolValidator = require('./validators/bool')
+const stringValidator = require('./validators/string')
+const Model = require('./model')
+const fields = {
+  key: 0,
+  read: 1,
+  write: 2
+}
+const boolFields = ['read', 'write']
+
+/**
+ * Auth permission model
+ */
+class AuthPermission extends Model {
+  /**
+   * @param {object|Array} data - auth permission data
+   * @param {string} data.key - operation key
+   * @param {boolean} data.read - read permission
+   * @param {boolean} data.write - write permission
+   */
+  constructor (data = {}) {
+    super({ data, fields, boolFields })
+  }
+
+  /**
+   * @param {object[]|object|Array[]|Array} data - data to convert to POJO
+   * @returns {object} pojo
+   */
+  static unserialize (data) {
+    return super.unserialize({ data, fields, boolFields })
+  }
+
+  /**
+   * Validates a given auth permission setting instance
+   *
+   * @param {object[]|object|AuthPermission[]|AuthPermission|Array} data - instance to validate
+   * @returns {string} error - null if instance is valid
+   */
+  static validate (data) {
+    return super.validate({
+      data,
+      fields,
+      validators: {
+        key: stringValidator,
+        read: boolValidator,
+        write: boolValidator
+      }
+    })
+  }
+}
+
+module.exports = AuthPermission

lib/index.js

@@ -36,6 +36,7 @@ module.exports = {
   SymbolDetails: require('./symbol_details'),
   TransactionFee: require('./transaction_fee'),
   AccountSummary: require('./account_summary'),
+  AuthPermission: require('./auth_permission'),
 
   isCollection: require('./util/is_collection')
 }

test/lib/models/auth_permission.js

@@ -0,0 +1,40 @@
+/* eslint-env mocha */
+'use strict'
+
+const assert = require('assert')
+const { AuthPermission } = require('../../../lib')
+const testModelValidation = require('../../helpers/test_model_validation')
+
+const DATA = ['orders', 1, 0]
+
+describe('Auth Permission model', () => {
+  testModelValidation({
+    model: AuthPermission,
+    validData: {
+      key: ['account', 'orders', 'funding', 'settings', 'wallets', 'withdraw'],
+      read: [true, false],
+      write: [true, false]
+    }
+  })
+
+  it('initializes correctly', () => {
+    const perm = new AuthPermission(DATA)
+    assert.strictEqual(perm.key, 'orders')
+    assert.strictEqual(perm.read, true)
+    assert.strictEqual(perm.write, false)
+  })
+
+  it('serializes correctly', () => {
+    const details = new AuthPermission(DATA)
+    const arr = details.serialize()
+
+    assert.deepStrictEqual(arr, DATA)
+  })
+
+  it('unserializes correctly', () => {
+    const perm = AuthPermission.unserialize(DATA)
+    assert.strictEqual(perm.key, 'orders')
+    assert.strictEqual(perm.read, true)
+    assert.strictEqual(perm.write, false)
+  })
+})