implemented remove() method

Author: Hovhannes Babayan

dist/attask.min.js

@@ -0,0 +1,43 @@
+/**
+ * Logs in, then creates a new template with name "API Template", then removes it
+ */
+
+var ApiFactory = require('./../../').ApiFactory;
+var util = require('util');
+
+var instance = ApiFactory.getInstance({
+	url: 'http://localhost:8080',
+	version: '4.0'
+});
+
+util.print('Logs in, then creates a new template with name "API Template", then removes it\n');
+util.log('Logging in ...');
+instance.login('new@user.attask', 'user').then(
+	function(data) {
+		util.log('Creating new template ...');
+		instance.post('tmpl', {name: 'API Template', description: 'This template has been created using API'}).then(
+			function(data) {
+				util.log('Create success. Received data:');
+				console.log(util.inspect(data, {colors:true}));
+				util.log('Removing template with objID=' + data.ID + ' ...');
+				instance.remove('tmpl', data.ID, true).then(
+					function() {
+						util.log('Remove success');
+					},
+					function(error) {
+						util.log('Remove failure. Received data:');
+						console.log(util.inspect(error, {colors:true}));
+					}
+				);
+			},
+			function(error) {
+				util.log('Create failure. Received data:');
+				console.log(util.inspect(error, {colors:true}));
+			}
+		);
+	},
+	function(error) {
+		util.log('Login failure. Received data:');
+		console.log(util.inspect(error, {colors:true}));
+	}
+);

examples/node/create-and-remove-template.js

@@ -16,9 +16,8 @@ instance.login('new@user.attask', 'user').then(
 	function(data) {
 		util.log('Logging out ...');
 		instance.logout().then(
-			function(data) {
-				util.log('Logout success. Received data:');
-				console.log(util.inspect(data, {colors:true}));
+			function() {
+				util.log('Logout success.');
 			},
 			function(error) {
 				util.log('Logout failure. Received data:');

examples/node/logout.js

@@ -43,7 +43,7 @@ require('./plugins/search')(Api);
 require('./plugins/get')(Api);
 require('./plugins/post')(Api);
 require('./plugins/put')(Api);
-require('./plugins/delete')(Api);
+require('./plugins/remove')(Api);
 require('./plugins/report')(Api);
 require('./plugins/count')(Api);
 require('./plugins/copy')(Api);

src/Api.js

@@ -1,17 +1,17 @@
 module.exports = function(Api) {
     /**
      * Logs out from AtTask
-     * @return {Promise}    A promise which will resolved with <code>true</code> if everything went ok and rejected otherwise
+     * @return {Promise}    A promise which will resolved if everything went ok and rejected otherwise
      */
     Api.prototype.logout = function () {
         var that = this;
         return new Promise(function (resolve, reject) {
             that.request('logout', null, null, 'GET').then(function (result) {
-                if (result) {
+                if (result && result.success) {
                     delete that.httpOptions.headers.sessionID;
-                    resolve(result.success);
+                    resolve();
                 } else {
-                    reject(false);
+                    reject();
                 }
             });
         });

src/plugins/delete.js

@@ -0,0 +1,24 @@
+module.exports = function(Api) {
+
+    /**
+     * Deletes an object
+     * @param {String} objCode    One of object codes from {@link https://developers.attask.com/api-docs/api-explorer/|AtTask API Explorer}
+     * @param {String} objID    ID of object
+     * @param {Boolean} [bForce]    Pass true to cause the server to remove the specified data and its dependants
+     * @returns {Promise}    A promise which will resolved if everything went ok and rejected otherwise
+     */
+    Api.prototype.remove = function (objCode, objID, bForce) {
+        var that = this;
+        return new Promise(function (resolve, reject) {
+            var params = bForce ? {force: true} : null;
+            return that.request(objCode + '/' + objID, params, null, 'DELETE').then(function (result) {
+                if (result && result.success) {
+                    resolve();
+                } else {
+                    reject();
+                }
+            });
+        });
+
+    };
+};

src/plugins/logout.js

@@ -11,7 +11,7 @@ describe('Create new instance for API', function() {
 		expect(api).to.respondTo('post');
 		expect(api).to.respondTo('put');
 		expect(api).to.respondTo('search');
-		expect(api).to.respondTo('delete');
+		expect(api).to.respondTo('remove');
 		expect(api).to.respondTo('report');
 		expect(api).to.respondTo('count');
 		expect(api).to.respondTo('copy');

src/plugins/remove.js

@@ -0,0 +1,44 @@
+require('./../common');
+
+var Api = require('./../../').Api;
+
+
+describe('Api.remove() method', function() {
+
+	var api;
+	var url = 'http://foobar:8080';
+
+	beforeEach(function () {
+		api = new Api({url: url});
+		sinon.stub(api, "request");
+	});
+
+	afterEach(function () {
+		api.request.restore(); // Unwraps the spy
+	});
+
+	it('should call request() with proper params (force=false)', function() {
+		api.remove('foo', '123');
+		expect(api.request).to.have.callCount(1);
+		expect(api.request).to.have.been.calledWith('foo/123', null, null, "DELETE");
+	});
+
+	it('should call request() with proper params (force=true)', function() {
+		api.remove('foo', '123', true);
+		expect(api.request).to.have.callCount(1);
+		expect(api.request).to.have.been.calledWith('foo/123', {force: true}, null, "DELETE");
+	});
+
+	it('should resolve returned promise if removal was ok', function(done) {
+		api.request.resolves({success: true});
+		var promise = api.logout();
+		expect(promise).to.be.fulfilled.and.notify(done);
+	});
+
+	it('should reject returned promise if removal was not ok', function(done) {
+		api.httpOptions.headers.sessionID = 123;
+		api.request.resolves(false);
+		var promise = api.remove('foo', '123');
+		expect(promise).to.be.rejected.and.notify(done);
+	});
+});