fix some issues

new custom method, and follow redirects

Author: aacerox

lib/node-rest-client.js

@@ -1,5 +1,5 @@
-var http = require('http'),
-	https = require('https'),
+var http = require('follow-redirects').http,
+	https = require('follow-redirects').https,
 	parseString = require('xml2js').parseString,
 	urlParser = require('url'),
 	util = require("util"),
@@ -10,14 +10,19 @@ var http = require('http'),
 exports.Client = function (options){
 	var self = this;
 	var connectManager = new ConnectManager();
+	//declare util constants
+	var CONSTANTS={
+		HEADER_CONTENT_LENGTH:"Content-Length"
+	};
+
 
 	self.options = options || {},
 	self.useProxy = (self.options.proxy || false)?true:false,
     self.useProxyTunnel = (!self.useProxy || self.options.proxy.tunnel===undefined)?false:self.options.proxy.tunnel,
 	self.proxy = self.options.proxy,
 	self.connection = self.options.connection || {},
-	self.mimetypes = self.options.mimetypes || {};
-	self.requestConfig = self.options.requestConfig || {};
+	self.mimetypes = self.options.mimetypes || {},
+	self.requestConfig = self.options.requestConfig || {},
 	self.responseConfig = self.options.responseConfig || {};
 
 	this.methods={};
@@ -42,8 +47,9 @@ exports.Client = function (options){
 		this._httpRequest = req;
 	};
 
-	var Util = {
 
+
+	var Util = {
 	 createProxyPath:function(url){
 	    var result = url.host;
 		 // check url protocol to set path in request options
@@ -78,7 +84,8 @@ exports.Client = function (options){
 				host: url.host.indexOf(":") == -1?url.host:url.host.substring(0,url.host.indexOf(":")),
 				port: url.port === undefined?defaultPort:url.port,
 				path: url.path,
-				protocol:protocol
+				protocol:protocol,
+				href:url.href
 		     };
 
 		     if (self.useProxy) result.agent = false; // cannot use default agent in proxy mode
@@ -88,7 +95,7 @@ exports.Client = function (options){
 
 			 } else if (self.options.user && !self.options.password){
 			 	// some sites only needs user with no password to authenticate
-			 	result.auth = self.options.user;
+			 	result.auth = self.options.user + ":";
 			 }	
 
 
@@ -201,6 +208,7 @@ exports.Client = function (options){
 			var options = this.createConnectOptions(this.parsePathParameters(args,url), method);
 			debug("options pre connect",options);
 			options.method = method,
+			clientRequest.href=options.href,
 			options.clientRequest = clientRequest,
 			options.headers= options.headers || {};
 
@@ -211,7 +219,7 @@ exports.Client = function (options){
 				callback = args;
 				//add Content-length to POST/PUT/DELETE/PATCH methods
 				if (method === 'POST' || method === 'PUT' || method === 'DELETE' || method === 'PATCH'){					
-					options.headers['Content-Length'] = 0;					 	
+					options.headers[CONSTANTS.HEADER_CONTENT_LENGTH] = 0;					 	
 				}
 			} else if (typeof args === 'object') {
 				// add headers and POST/PUT/DELETE/PATCH data to connect options to be passed
@@ -225,13 +233,13 @@ exports.Client = function (options){
 
 				}
 
-				//always set Content-length header
-				//set Content lentgh for some servers to work (nginx, apache)
-				if (args.data !== undefined){
+				//always set Content-length header if not set previously
+				//set Content lentgh for some servers to work (nginx, apache) 
+				if (args.data !== undefined && !options.headers.hasOwnProperty(CONSTANTS.HEADER_CONTENT_LENGTH)){
 					options.data = args.data;					
-					options.headers['Content-Length'] = Buffer.byteLength((typeof args.data === 'string' ? args.data:JSON.stringify(args.data)), 'utf8');
+					options.headers[CONSTANTS.HEADER_CONTENT_LENGTH] = Buffer.byteLength((typeof args.data === 'string' ? args.data:JSON.stringify(args.data)), 'utf8');
 				}else{
-					options.headers['Content-Length'] = 0;
+					options.headers[CONSTANTS.HEADER_CONTENT_LENGTH] = 0;
 				}
 		        // we have args, go and check if we have parameters
 		        if (args.parameters && Object.keys(args.parameters).length > 0){
@@ -265,6 +273,13 @@ exports.Client = function (options){
 					connectManager.xmlctype = mimetypes.xml;
 				}
 			}
+		},
+		createHttpMethod:function(methodName){
+			return function(url, args, callback){
+				var clientRequest = new ClientRequest();		
+				Util.connect(methodName.toUpperCase(), url, args, callback, clientRequest);
+				return clientRequest;
+			};
 		}
 	},
 	Method = function(url, method){
@@ -294,35 +309,15 @@ exports.Client = function (options){
 
 
 
-	this.get = function(url, args, callback){
-		var clientRequest = new ClientRequest();		
-		Util.connect('GET', url, args, callback, clientRequest);
-		return clientRequest;
-	};
-
-	this.post = function(url, args, callback){
-		var clientRequest = new ClientRequest();
-		Util.connect('POST', url, args, callback, clientRequest);
-		return clientRequest;
-	};
+	this.get = Util.createHttpMethod("get");
 
-	this.put = function(url, args, callback){
-		var clientRequest = new ClientRequest();
-		Util.connect('PUT', url, args, callback, clientRequest);
-		return clientRequest;
-	};
+	this.post = Util.createHttpMethod("post");
+	
+	this.put = Util.createHttpMethod("put");
 
-	this.delete = function(url, args, callback){
-		var clientRequest = new ClientRequest();
-		Util.connect('DELETE', url, args, callback, clientRequest);
-		return clientRequest;
-	};
+	this.delete = Util.createHttpMethod("delete");
 
-	this.patch = function(url, args, callback){
-		var clientRequest = new ClientRequest();
-		Util.connect('PATCH', url, args, callback, clientRequest);
-		return clientRequest;
-	};
+	this.patch = Util.createHttpMethod("patch");
 
 
 	this.registerMethod = function(name, url, method){
@@ -335,6 +330,10 @@ exports.Client = function (options){
 		delete this.methods[name];
 	};
 
+	this.addCustomHttpMethod=function(methodName){
+		self[methodName.toLowerCase()] = Util.createHttpMethod(methodName);
+	}
+
 	// handle ConnectManager events
 	connectManager.on('error',function(err){
 		self.emit('error',err);
@@ -348,14 +347,14 @@ exports.Client = function (options){
 
 
 	var ConnectManager = function() {
-		this.xmlctype  = ["application/xml","application/xml;charset=utf-8"];
+		this.xmlctype  = ["application/xml","application/xml;charset=utf-8","text/xml","text/xml;charset=utf-8"];
 		this.jsonctype = ["application/json","application/json;charset=utf-8"],
 		this.isXML = function(content){
 			var result = false;
 			if (!content) return result;
 
 			for (var i=0; i<this.xmlctype.length;i++){
-				result = this.xmlctype[i].toLowerCase() === content.toLowerCase();
+				result = this.xmlctype[i].trim().toLowerCase() === content.trim().toLowerCase();
 				if (result) break;
 			}
 
@@ -366,7 +365,7 @@ exports.Client = function (options){
 			if (!content) return result;
 
 			for (var i=0; i<this.jsonctype.length;i++){
-				result = this.jsonctype[i].toLowerCase() === content.toLowerCase();
+				result = this.jsonctype[i].trim().toLowerCase() === content.trim().toLowerCase();
 				if (result) break;
 			}
 
@@ -426,13 +425,15 @@ exports.Client = function (options){
 		this.handleResponse = function(res,data,callback){
 			var content = res.headers["content-type"] && res.headers["content-type"].replace(/ /g, '');
 
-			debug("response content is ",content);
+			debug("response content is [",content,"]");
 			// XML data need to be parsed as JS object
 			if (this.isXML(content)){
+				debug("detected XML response");
 				parseString(data.toString(), function (err, result) {
 					callback(result, res);
 			    });
 			}else if (this.isJSON(content)){
+				debug("detected JSON response");
 				var jsonData,
 				data = data.toString();
                 try {
@@ -447,6 +448,7 @@ exports.Client = function (options){
                 }
 				callback(jsonData, res);
 			}else{
+				debug("detected unknown response");
 				callback(data, res);
 			}
 		},

package.json

@@ -2,15 +2,16 @@
   "author": "Alejandro Alvarez Acero",
   "name": "node-rest-client",
   "description": "node API REST client",
-  "version": "2.0.1",
+  "version": "2.5.0",
   "repository": {
     "type":"git",
     "url": "https://github.com/aacerox/node-rest-client.git"
   },
   "main": "./lib/node-rest-client",
   "dependencies": {
     "xml2js":">=0.2.4",
-    "debug": "~2.2.0"
+    "debug": "~2.2.0",
+    "follow-redirects":">=1.2.0"
     },
   "devDependencies": {
     "jasmine-node":">=1.2.3"

readme.md

@@ -1,4 +1,8 @@
 # REST Client for Node.js
+[![npm version](https://badge.fury.io/js/node-rest-client.svg)](https://www.npmjs.com/package/node-rest-client)
+[![Build Status](https://travis-ci.org/olalonde/node-rest-client.svg?branch=master)](https://travis-ci.org/olalonde/node-rest-client)
+
+[![NPM](https://nodei.co/npm/node-rest-client.png?downloads=true)](https://nodei.co/npm/node-rest-client.png?downloads=true)
 
 **NOTE:** _Since version 0.8.0 node does not contain node-waf anymore. The node-zlib package which node-rest-client make use of, depends on node-waf.Fortunately since version 0.8.0 zlib is a core dependency of node, so since version 1.0 of node-rest-client the explicit dependency to "zlib" has been removed from package.json. therefore if you are using a version below 0.8.0 of node please use a versión below 1.0.0 of "node-rest-client". _ 
 
@@ -7,12 +11,14 @@ Allows connecting to any API REST and get results as js Object. The client has t
 - Transparent HTTP/HTTPS connection to remote API sites.
 - Allows simple HTTP basic authentication.
 - Allows most common HTTP operations: GET, POST, PUT, DELETE, PATCH.
+- Allows creation of custom HTTP Methods (PURGE, etc.)
 - Direct or through proxy connection to remote API sites.
 - Register remote API operations as client own methods, simplifying reuse.
 - Automatic parsing of XML and JSON response documents as js objects.
 - Dynamic path and query parameters and request headers.
 - Improved Error handling mechanism (client or specific request)
 - Added support for compressed responses: gzip and deflate
+- Added support for follow redirects thanks to great [follow-redirects](https://www.npmjs.com/package/follow-redirects) package
 
 
 ## Installation
@@ -152,8 +158,6 @@ client.get("http://remote.site/rest/json/${id}/method?arg1=${arg1}&arg2=${arg2}"
 	});
 ```
 
-
-
 ###  HTTP POST and PUT methods
 
 To send data to remote site using POST or PUT methods, just add a data attribute to args object:
@@ -284,7 +288,23 @@ req.on('error', function (err) {
 	console.log('request error', err);
 });
 ```
+### Follows Redirect
+Node REST client follows redirects by default to a maximum of 21 redirects, but it's also possible to change follows redirect default config in each request done by the client
+```javascript
+var client = new Client();
 
+// request and response additional configuration
+var args = {
+	requestConfig: {
+		followRedirects:true,//whether redirects should be followed(default,true) 
+		maxRedirects:10//set max redirects allowed (default:21)
+	},
+	responseConfig: {
+		timeout: 1000 //response timeout
+	}
+};
+
+```
 
 ### Connect through proxy
 

test/local-test.js

@@ -0,0 +1,12 @@
+	var Client = require("../lib/node-rest-client.js").Client;
+	var client = new Client();
+
+	console.log("client es ", client);
+/*
+	client.get("http://localhost:8080/xml",(data,response) => console.log("DATA IS ", data));
+*/
+	client.addCustomHttpMethod("purge");
+
+	var request = client.purge("http://localhost:8080/xml",(data,response) => console.log("DATA IS ", data) );
+
+	console.log("REQUEST is ", request);