Custom error attribute (code), closes #4

Author: kkamkou

README.md

@@ -5,7 +5,7 @@ Akamai NetStorage HTTP API for the Node.js
 ## Installation
 ```
 "dependencies": {
-  "akamai-http-api": "0.2.2"
+  "akamai-http-api": "0.3.*"
 }
 ```
 ```npm update```
@@ -85,6 +85,20 @@ akamai.symlink('/12345/MyFile.jpg', '/12345/MyFileSymlink.jpg', function (err, d
 akamai.fileExists('/12345/MyFile.jpg', function (err, boolFlag) {});
 ```
 
+### Exceptions
+For the communication netstorage HTTP API uses [HTTP codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+Hence, a number of methods may trigger an exception. For example `mkdir` in case the target already exists.
+Or `symlink` in case the target doesn't exist.
+
+To handle these exceptions the `err` object has an abnormal `code` attribute.
+
+```javascript
+akamai.mkdir('...', function (err, data) {
+  if (err.code === 409) { } // it already exists
+  if (err.message.indexOf(409) !== -1) // the same
+});
+```
+
 ### How to extend it?
 ```javascript
 var akamai = require('akamai-http-api'),
@@ -117,6 +131,7 @@ module.exports = myAkamai;
 
 ## Docker
 ```sh
+# modify test/akamai.js#15 first
 [sudo] docker build -t node-akamai-http-api .
 [sudo] docker run -ti --rm node-akamai-http-api
 ```

lib/akamai.js

@@ -147,18 +147,19 @@ akamai.getRequestObject = function (path, params, cb) {
 
   if (typeof(cb) === 'function') {
     callback = function (err, resp, body) {
-      // we have an error
       if (err) {
         return cb(err);
       }
 
       // wrong response code
       if (resp.statusCode >= 300) {
-        var errMsg = 'The server sent us the ' + resp.statusCode + ' code';
+        var exception = new Error();
+        exception.code = resp.statusCode;
+        exception.message = 'The server sent us the ' + resp.statusCode + ' code';
         if (self.getConfig().verbose && body) {
-          errMsg += '. Body: ' + body;
+          exception.message += '. Body: ' + body;
         }
-        return cb(new Error(errMsg));
+        return cb(exception);
       }
 
       if (!body.match(/^<\?xml\s+/)) {

package.json

@@ -1,10 +1,10 @@
 {
   "name": "akamai-http-api",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "main": "./lib/akamai.js",
   "author": "Kanstantsin Kamkou <kkamkou@gmail.com>",
   "description": "Akamai NetStorage HTTP API for the Node.js",
-  "keywords": ["akamai", "api", "http"],
+  "keywords": ["akamai", "api", "http", "netstorage"],
   "repository" : {
     "type" : "git",
     "url" : "https://github.com/kkamkou/node-akamai-http-api.git"

test/akamai.js

@@ -52,8 +52,10 @@ module.exports = {
       var clone = Object.create(akamai);
       clone.setConfig({key: 'invalidKey', verbose: true})
         .du(path.dirname(pathRemoteFile), function (err) {
+          err.should.be.an.instanceof(Error);
           err.message.should.include("You don't have permission to access");
           err.message.should.include(403);
+          err.code.should.eql(403);
           done();
         });
     }
@@ -74,6 +76,7 @@ module.exports = {
       'Folder does not exist': function (done) {
         akamai.du('AnEpicFolder', function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -94,6 +97,7 @@ module.exports = {
       'Folder does not exist': function (done) {
         akamai.dir('AnEpicFolder', function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -118,6 +122,7 @@ module.exports = {
 
         akamai.upload(stream, '/1234', function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -141,6 +146,7 @@ module.exports = {
 
         akamai.download('AnEpicFile.txt', stream, function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -158,6 +164,7 @@ module.exports = {
       'File does not exist': function (done) {
         akamai.mtime('AnEpicFile.txt', new Date(), function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -178,6 +185,7 @@ module.exports = {
       'File does not exist': function (done) {
         akamai.stat('AnEpicFile.txt', function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -214,6 +222,7 @@ module.exports = {
       'File does not exist': function (done) {
         akamai.symlink(pathRemoteFile + '.fake', pathRemoteFile + '.symlink', function (err) {
           err.message.should.include(409);
+          err.code.should.eql(409);
           done();
         });
       }
@@ -231,6 +240,7 @@ module.exports = {
       'Folder exists': function (done) {
         akamai.mkdir(pathRemoteDir, function (err) {
           err.message.should.include(409);
+          err.code.should.eql(409);
           done();
         });
       }
@@ -248,6 +258,7 @@ module.exports = {
       'Folder does not exist': function (done) {
         akamai.rmdir(pathRemoteDir, function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -265,6 +276,7 @@ module.exports = {
       'File does not exist': function (done) {
         akamai.rename(pathRemoteFile, pathRemoteFile + '.renamed', function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }
@@ -283,6 +295,7 @@ module.exports = {
       'File does not exist': function (done) {
         akamai.delete(pathRemoteFile + '.renamed', function (err) {
           err.message.should.include(404);
+          err.code.should.eql(404);
           done();
         });
       }