Merge pull request #2 from thepeerstack/initial

v0.0.1

Author: ichtrojan

.eslintrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es2021: true
+  },
+  extends: [
+    'standard'
+  ],
+  parserOptions: {
+    ecmaVersion: 12
+  },
+  rules: {
+    camelcase: 0,
+    'valid-jsdoc': [
+      'error',
+      {
+        requireReturn: true,
+        requireReturnType: true,
+        requireParamDescription: false,
+        requireReturnDescription: true
+      }
+    ],
+    'require-jsdoc': [
+      'error',
+      {
+        require: {
+          FunctionDeclaration: true,
+          MethodDefinition: true,
+          ClassDeclaration: true
+        }
+      }
+    ]
+  }
+}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.idea

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Peerstack Technologies Inc
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -0,0 +1,73 @@
+# Thepeer node
+
+## Installation
+
+```bash
+npm i thepeer-node
+```
+
+## Usage
+
+```js
+const thepeer = new Thepeer(secretKey)
+
+let user = thepeer.indexUser("Thor Odin", "thor", "[email protected]");
+```
+
+### Available methods
+
+* validateSiganture
+    - `accepts`: 
+        - request (object)
+        - signature (object)
+    - `returns`: boolean
+    
+* getSendReceipt
+    - `accepts`: 
+        - receipt_id (string)
+    - `returns`: object
+    
+* processSendReceipt
+    - `accepts`: 
+        - receipt_id (string)
+        - insufficient_funds (bool)
+    - `returns`: object
+    
+* indexUser
+    - `accepts`:
+        - name (string)
+        - email (string)
+        - identifier (string)
+    - `returns`: object
+        
+* updateUser
+    - `accepts`:
+        - reference (string)
+        - identifier (string)
+    - `returns`: object
+        
+* deleteUser
+    - `accepts`:
+        - reference (string)
+    - `returns`: boolean
+    
+* getLink
+    - `accepts`:
+        - lind_id (string)
+    - `returns`: object
+
+* chargeLink
+    - `accepts`:
+        - lind_id (string)
+        - amount (integer)
+    - `returns`: object
+    
+* authorizaDirectCharge
+    - `accepts`:
+        - reference (string)
+        - insufficient_funds (bool)
+    - `returns`: object
+
+## Extra
+
+Refer to the [documentation](https://docs.thepeer.co) for more information.

index.js

@@ -0,0 +1,3 @@
+const Thepeer = require('./lib/Thepeer')
+
+module.exports = Thepeer

lib/Thepeer.js

@@ -0,0 +1,195 @@
+const axios = require('axios').default
+const crypto = require('crypto')
+const Helper = require('./utils/Helper')
+
+/**
+ * @class ThePeer
+ */
+class ThePeer {
+  /**
+   *This is a constructor for creating a Peer Instance
+   * @param {string} secretkey - Thepeer secret key
+   * @returns { ThePeer } - An instance of thePeer
+   */
+  constructor (secretkey) {
+    this.secretKey = secretkey
+    this.request = axios.create({
+      baseURL: 'https://api.thepeer.co',
+      headers: {
+        'x-api-key': secretkey,
+        'Content-Type': 'application/json'
+      }
+    })
+  }
+
+  /**
+   * @static
+   * @param {object} payload - The payload to be verified.
+   * @param {string} signature - The signature to compare with
+   * @returns { Boolean } - True if same signature otherwise false
+   * @memberof ThePeer
+   */
+  validateSignature (payload, signature) {
+    return signature === crypto.createHmac('sha1', this.secretKey).update(payload).digest('hex')
+  }
+
+  /**
+   * @param {string} name - The name of the user
+   * @param {string} identifier - The identifier of the user
+   * @param {string} email - The email of the user
+   * @returns {JSON}  A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async indexUser (name, identifier, email) {
+    try {
+      const response = await this.request.post('/users', {
+        name: name,
+        identifier: identifier,
+        email: email
+      })
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * @param {string} reference - The reference returned when the user was indexed
+   * @param {string} identifier - The identifier of the user
+   * @returns {JSON}  A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async updateUser (reference, identifier) {
+    try {
+      const response = await this.request.put(`/users/${reference}`, {
+        identifier: identifier
+      })
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * @param {string} reference - The reference returned when the user was indexed
+   * @returns {JSON}  A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async deleteUser (reference) {
+    try {
+      const response = await this.request.delete(`/users/${reference}`)
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * @param {string} reference - The reference returned when the user was indexed
+   * @returns {JSON}  A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async getUser (reference) {
+    try {
+      const response = await this.request.get(`/users/${reference}`)
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   *
+   * @param {string} linkid - The id of a user linked account
+   * @returns {JSON} A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async getLink (linkid) {
+    try {
+      const response = await this.request.get(`/link/${linkid}`)
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * A function that charges your user's linked account at any time
+   * @param {string} linkid - The id of the link
+   * @param {integer} amount - amount in kobo
+   * @param {string} remark - The reason for initiating a direct charge
+   * @returns {JSON} A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async chargeLink (linkid, amount, remark) {
+    try {
+      const response = await this.request.post(`/link/${linkid}/charge`, {
+        amount: amount,
+        remark: remark
+      })
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * Authorize direct charge request via webhooks
+   * @param {*} reference - The direct charge reference sent via webhook
+   * @param {boolean} insufficientFunds - Status of user funds
+   * @returns {JSON} A JSON response containing the details of the user
+   * @memberof ThePeer
+   */
+  async authorizeDirectCharge (reference, insufficientFunds) {
+    try {
+      const response = await this.request.post(`/debit/${reference}`, {
+        insufficient_funds: insufficientFunds
+      })
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * @memberof ThePeer
+   * @param {string} receipt - The reference returned to your receiptURL via the Chain SDK
+   * @param {boolean} insufficientFunds - Status of user funds
+   * @returns {JSON} A JSON response containing the details of the user
+   */
+  async processSendReceipt (receipt, insufficientFunds) {
+    try {
+      const response = await this.request.post(`/send/${receipt}`, {
+        insufficient_funds: insufficientFunds
+      })
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+
+  /**
+   * @memberof ThePeer
+   * @param {string} receipt - The reference returned to your receiptURL via the Chain SDK
+   * @returns {JSON} A JSON response containing the details of the user
+   */
+  async getSendReceipt (receipt) {
+    try {
+      const response = await this.request.get(`/send/${receipt}`)
+
+      return response.data
+    } catch (e) {
+      Helper.processError(e)
+    }
+  }
+}
+
+module.exports = ThePeer

lib/utils/Helper/index.js

@@ -0,0 +1,54 @@
+const crypto = require('crypto')
+const ForbiddenError = require('../errors/ForbiddenError')
+const InvalidResourceError = require('../errors/InvalidResourceError')
+const NotAcceptableError = require('../errors/NotAcceptableError')
+const ServerError = require('../errors/ServerError')
+const ServiceUnavailableError = require('../errors/ServiceUnavailableError')
+const UnauthorizedError = require('../errors/UnauthorizedError')
+const InvalidPayloadError = require('../errors/InvalidPayloadError')
+
+/**
+ * @class Helper
+ */
+class Helper {
+  /**
+   * @static
+   * @param {object} payload - The payload to be verified.
+   * @param {string} signature - The signature to compare with
+   * @returns { Boolean } - True if same signature otherwise false
+   * @memberof Helper
+   */
+  validateSignature (payload, signature) {
+    return signature === crypto.createHmac('sha1', this.secretKey).update(payload).digest('hex')
+  }
+
+  /**
+   *
+   * @param {object} error - The error object
+   * @returns {Object} - The an error instance
+   * @memberof Helper
+   */
+  static processError (error) {
+    const errordata = error.response.data.error
+    switch (error.response.status) {
+      case 401:
+        throw new UnauthorizedError({ message: error.response.data.message })
+      case 403:
+        throw new ForbiddenError({ message: error.response.data.message })
+      case 404:
+        throw new InvalidResourceError({ message: error.response.data.message })
+      case 406:
+        throw new NotAcceptableError({ message: error.response.data.message })
+      case 422 : Object.keys(errordata).forEach((key) => {
+        throw new InvalidPayloadError({ message: errordata[key] })
+      })
+        break
+      case 503:
+        throw new ServiceUnavailableError({ message: error.response.data.message })
+      default:
+        throw new ServerError({ message: error.response.data.message })
+    }
+  }
+}
+
+module.exports = Helper

lib/utils/errors/BaseError.js

@@ -0,0 +1,18 @@
+/**
+ * A custom error class for handling module related errors.
+ * @class BaseError
+ */
+module.exports = class BaseError extends Error {
+  /**
+   * The BaseError Constructor.
+   * @param {Object} options - A configuration object for errors.
+   * @param {String} options.message - The error message if any.
+   * @constructor BaseError
+   */
+  constructor (options = {}) {
+    super()
+    Error.captureStackTrace(this, this.constructor)
+    this.name = this.constructor.name
+    this.message = options.message
+  }
+}