Add transfer capability to the SDK (#60)

* Add transfer capability to the SDK

* minor version bump

Co-authored-by: KK, Amith <amith.kk@unisys.com>

Author: amithkk

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbom/sdk",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Node SDK for DBoM",
   "main": "src/dbom-node.js",
   "scripts": {

src/dbom-node.js

@@ -34,6 +34,8 @@ const {
   ParentAssetOrChannelNotFound,
   ChildAssetOrChannelNotFound,
   SigningServiceError,
+  SourceAssetOrChannelNotFound,
+  DestinationAssetAlreadyExists,
 } = require('./errors');
 
 /** Class representing a DBoM Node. */
@@ -71,7 +73,7 @@ class DbomNode {
 
   /**
    * Constructs baseURL from initialized DBoM Node
-   * @returns 
+   * @returns
    */
   _constructBaseURL() {
     return `http://${this.gatewayURI}/api/v1`;
@@ -394,7 +396,7 @@ class DbomNode {
   async queryAssets(repoID, channelID, queryParams) {
     const requestURI = `${this._constructAssetURL(repoID, channelID)}/_query`;
     try {
-      return (await this.axios.post(requestURI, 
+      return (await this.axios.post(requestURI,
         this.constructor._applyQueryParamDefaults(queryParams))).data;
     } catch (e) {
       const status = this._getErrorStatus(e);
@@ -445,6 +447,43 @@ class DbomNode {
       }
     }
   }
+
+  /**
+   * Attaches a child asset to the provided parent asset
+   * @param {string} sourceRepoID -  Repository ID of the repository where the source asset
+   *                                 is stored
+   * @param {string} sourceChannelID - Channel ID of the channel where the source asset is stored
+   * @param {string} sourceAssetID - Asset ID of the source asset
+   * @param {string} destinationRepoID -  Repository ID of the destination repository
+   * @param {string} destinationChannelID - Channel ID of the destination channel
+   * @param {string} destinationAssetID - Asset ID that must be given to the asset on
+   *                                      the destination channel
+   * @param {string} transferDescription - The reason to be associated with the transfer
+   * @returns {*} - Gateway Response
+   */
+  async transferAsset(sourceRepoID, sourceChannelID, sourceAssetID,
+    destinationRepoID, destinationChannelID, destinationAssetID,
+    transferDescription) {
+    const requestURI = `${this._constructAssetURL(sourceRepoID, sourceChannelID, sourceAssetID)}/transfer`;
+    const body = {
+      transferDescription,
+      repoID: destinationRepoID,
+      channelID: destinationChannelID,
+      assetID: destinationAssetID,
+    };
+    try {
+      return (await this.axios.post(requestURI, body)).data;
+    } catch (e) {
+      const status = this._getErrorStatus(e);
+      if (status === 404) {
+        throw new SourceAssetOrChannelNotFound();
+      } else if (status === 409 && e.response.data.status === 'Already Exists') {
+        throw new DestinationAssetAlreadyExists();
+      } else {
+        throw new GatewayError(status, e.response.data);
+      }
+    }
+  }
 }
 
 module.exports = DbomNode;

src/errors.js

@@ -50,6 +50,15 @@ class ParentAssetOrChannelNotFound extends AssetOrChannelNotFound {
   }
 }
 
+class SourceAssetOrChannelNotFound extends AssetOrChannelNotFound {
+  constructor() {
+    super();
+    this.name = this.constructor.name;
+    this.message = 'Source asset or channel was not found';
+    this.status = 404;
+  }
+}
+
 class ChildAssetOrChannelNotFound extends AssetOrChannelNotFound {
   constructor() {
     super();
@@ -68,6 +77,15 @@ class AssetAlreadyExists extends DbomError {
   }
 }
 
+class DestinationAssetAlreadyExists extends AssetAlreadyExists {
+  constructor() {
+    super();
+    this.name = this.constructor.name;
+    this.message = 'Destination asset-id already exists';
+    this.status = 409;
+  }
+}
+
 class AssetAlreadyAttached extends DbomError {
   constructor() {
     super();
@@ -105,6 +123,7 @@ class SigningServiceError extends DbomError {
   }
 }
 
+
 module.exports = {
   DbomError,
   AssetInvalid,
@@ -116,4 +135,6 @@ module.exports = {
   AssetNotAttached,
   AssetAlreadyAttached,
   GatewayError,
+  SourceAssetOrChannelNotFound,
+  DestinationAssetAlreadyExists,
 };

src/test/dbom-node.test.js

@@ -35,8 +35,10 @@ const {
   AssetAlreadyExists,
   AssetAlreadyAttached,
   ParentAssetOrChannelNotFound,
+  SourceAssetOrChannelNotFound,
   ChildAssetOrChannelNotFound,
   SigningServiceError,
+  DestinationAssetAlreadyExists,
 } = require('../errors');
 
 describe('dbom node', () => {
@@ -655,4 +657,46 @@ describe('dbom node', () => {
         .rejectedWith(GatewayError);
     });
   });
+
+  context('transferAsset', () => {
+    it('should transfer asset', (done) => {
+      axiosMock(200, 'stubResponse', done);
+      dbom.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID').then((resolve) => {
+        expect(resolve).to.equal('stubResponse');
+      });
+      dbom1.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID').then((resolve) => {
+        expect(resolve).to.equal('stubResponse');
+      });
+    });
+
+    it('should return source asset not found error', (done) => {
+      axiosMock(404, 'stubResponse', done);
+      expect(dbom.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID')).to.be.rejectedWith(SourceAssetOrChannelNotFound);
+      expect(dbom1.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID')).to.be.rejectedWith(SourceAssetOrChannelNotFound);
+    });
+
+    it('should report if destination asset already exists', (done) => {
+      axiosMock(409, {
+        success: false,
+        status: 'Already Exists',
+        error: 'Destination asset already exists',
+      }, done);
+      expect(dbom.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID')).to.be.rejectedWith(DestinationAssetAlreadyExists);
+      expect(dbom1.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID')).to.be.rejectedWith(DestinationAssetAlreadyExists);
+    });
+
+    it('should return gateway error', (done) => {
+      axiosMock(500, 'stubResponse', done);
+      expect(dbom.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID')).to.be.rejectedWith(GatewayError);
+      expect(dbom1.transferAsset('sourceRepoID', 'sourceChannelID', 'sourceAssetID',
+        'destinationRepoID', 'destinationChannelID', 'destinationAssetID')).to.be.rejectedWith(GatewayError);
+    });
+  });
 });