got 3.0.0 → 3.3.1

package/index.js

@@ -13,7 +13,7 @@ var readAllStream = require('read-all-stream');
 var timedOut = require('timed-out');
 var prependHttp = require('prepend-http');
 var lowercaseKeys = require('lowercase-keys');
-var statuses = require('statuses');
+var isRedirect = require('is-redirect');
 var NestedErrorStacks = require('nested-error-stacks');
 
 function GotError(message, nested) {
@@ -34,18 +34,36 @@ function got(url, opts, cb) {
 		opts = {};
 	}
 
-	opts = objectAssign({}, opts);
+	opts = objectAssign(
+		{
+			protocol: 'http:'
+		},
+		typeof url === 'string' ? urlLib.parse(prependHttp(url)) : url,
+		opts
+	);
 
 	opts.headers = objectAssign({
 		'user-agent': 'https://github.com/sindresorhus/got',
 		'accept-encoding': 'gzip,deflate'
 	}, lowercaseKeys(opts.headers));
 
+	if (opts.pathname) {
+		opts.path = opts.pathname;
+	}
+
+	if (opts.query) {
+		if (typeof opts.query !== 'string') {
+			opts.query = querystring.stringify(opts.query);
+		}
+
+		opts.path = opts.pathname + '?' + opts.query;
+		delete opts.query;
+	}
+
 	var encoding = opts.encoding;
 	var body = opts.body;
 	var json = opts.json;
 	var timeout = opts.timeout;
-	var query = opts.query;
 	var proxy;
 	var redirectCount = 0;
 
@@ -53,10 +71,22 @@ function got(url, opts, cb) {
 	delete opts.body;
 	delete opts.json;
 	delete opts.timeout;
-	delete opts.query;
+
+	if (json) {
+		opts.headers.accept = opts.headers.accept || 'application/json';
+	}
 
 	if (body) {
+		if (typeof body !== 'string' && !Buffer.isBuffer(body) && !isStream.readable(body)) {
+			throw new GotError('options.body must be a ReadableStream, string or Buffer');
+		}
+
 		opts.method = opts.method || 'POST';
+
+		if (!opts.headers['content-length'] && !opts.headers['transfer-encoding'] && !isStream.readable(body)) {
+			var length = typeof body === 'string' ? Buffer.byteLength(body) : body.length;
+			opts.headers['content-length'] = length;
+		}
 	}
 
 	opts.method = opts.method || 'GET';
@@ -67,8 +97,8 @@ function got(url, opts, cb) {
 		proxy = duplexify();
 
 		// forward errors on the stream
-		cb = function (err) {
-			proxy.emit('error', err);
+		cb = function (err, data, response) {
+			proxy.emit('error', err, data, response);
 		};
 	}
 
@@ -76,21 +106,13 @@ function got(url, opts, cb) {
 		throw new GotError('got can not be used as stream when options.json is used');
 	}
 
-	if (body && !(typeof body === 'string' || Buffer.isBuffer(body) || isStream.readable(body))) {
-		throw new GotError('options.body must be a ReadableStream, string or Buffer');
-	}
-
-	function get(url, opts, cb) {
-		var parsedUrl = typeof url === 'string' ? urlLib.parse(prependHttp(url)) : url;
-		var fn = parsedUrl.protocol === 'https:' ? https : http;
-		var arg = objectAssign({}, parsedUrl, opts);
-
-		url = typeof url === 'string' ? prependHttp(url) : urlLib.format(url);
+	function get(opts, cb) {
+		var fn = opts.protocol === 'https:' ? https : http;
+		var url = urlLib.format(opts);
 
-		if (arg.agent === undefined) {
-			arg.agent = infinityAgent[fn === https ? 'https' : 'http'].globalAgent;
+		if (opts.agent === undefined) {
+			opts.agent = infinityAgent[fn === https ? 'https' : 'http'].globalAgent;
 
-			// TODO: remove this when Node 0.10 will be deprecated
 			if (process.version.indexOf('v0.10') === 0 && fn === https && (
 				typeof opts.ca !== 'undefined' ||
 				typeof opts.cert !== 'undefined' ||
@@ -99,52 +121,58 @@ function got(url, opts, cb) {
 				typeof opts.passphrase !== 'undefined' ||
 				typeof opts.pfx !== 'undefined' ||
 				typeof opts.rejectUnauthorized !== 'undefined')) {
-				arg.agent = new (infinityAgent.https.Agent)(opts);
+				opts.agent = new infinityAgent.https.Agent({
+					ca: opts.ca,
+					cert: opts.cert,
+					ciphers: opts.ciphers,
+					key: opts.key,
+					passphrase: opts.passphrase,
+					pfx: opts.pfx,
+					rejectUnauthorized: opts.rejectUnauthorized
+				});
 			}
 		}
 
-		if (query) {
-			arg.path = (arg.path ? arg.path.split('?')[0] : '') + '?' + (typeof query === 'string' ? query : querystring.stringify(query));
-			query = undefined;
-		}
-
-		var req = fn.request(arg, function (response) {
+		var req = fn.request(opts, function (response) {
 			var statusCode = response.statusCode;
 			var res = response;
 
-			if (proxy) {
-				proxy.emit('response', res);
-			}
-
 			// auto-redirect only for GET and HEAD methods
-			if (statuses.redirect[statusCode] && 'location' in res.headers && (opts.method === 'GET' || opts.method === 'HEAD')) {
-				res.resume(); // Discard response
+			if (isRedirect(statusCode) && 'location' in res.headers && (opts.method === 'GET' || opts.method === 'HEAD')) {
+				// discard response
+				res.resume();
 
 				if (++redirectCount > 10) {
 					cb(new GotError('Redirected 10 times. Aborting.'), undefined, res);
 					return;
 				}
 
-				delete opts.host;
-				delete opts.hostname;
-				delete opts.port;
-				delete opts.path;
+				var redirectUrl = urlLib.resolve(url, res.headers.location);
+				var redirectOpts = objectAssign({}, opts, urlLib.parse(redirectUrl));
+
+				if (opts.agent === infinityAgent.http.globalAgent && redirectOpts.protocol === 'https:' && opts.protocol === 'http:') {
+					redirectOpts.agent = undefined;
+				}
 
 				if (proxy) {
-					proxy.emit('redirect', res, opts);
+					proxy.emit('redirect', res, redirectOpts);
 				}
 
-				get(urlLib.resolve(url, res.headers.location), opts, cb);
+				get(redirectOpts, cb);
 				return;
 			}
 
+			if (proxy) {
+				proxy.emit('response', res);
+			}
+
 			if (['gzip', 'deflate'].indexOf(res.headers['content-encoding']) !== -1) {
 				res = res.pipe(zlib.createUnzip());
 			}
 
 			if (statusCode < 200 || statusCode > 299) {
 				readAllStream(res, encoding, function (err, data) {
-					err = new GotError(opts.method + ' ' + url + ' response code is ' + statusCode + ' (' + statuses[statusCode] + ')', err);
+					err = new GotError(opts.method + ' ' + url + ' response code is ' + statusCode + ' (' + http.STATUS_CODES[statusCode] + ')', err);
 					err.code = statusCode;
 
 					if (data && json) {
@@ -157,6 +185,7 @@ function got(url, opts, cb) {
 
 					cb(err, data, response);
 				});
+
 				return;
 			}
 
@@ -169,7 +198,9 @@ function got(url, opts, cb) {
 			readAllStream(res, encoding, function (err, data) {
 				if (err) {
 					err = new GotError('Reading ' + url + ' response failed', err);
-				} else if (json) {
+				} else if (json && statusCode !== 204) {
+					// only parse json if the option is enabled, and the response
+					// is not a 204 (empty reponse)
 					try {
 						data = JSON.parse(data);
 					} catch (e) {
@@ -219,7 +250,8 @@ function got(url, opts, cb) {
 		req.end();
 	}
 
-	get(url, opts, cb);
+	get(opts, cb);
+
 	return proxy;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "got",
-  "version": "3.0.0",
+  "version": "3.3.1",
   "description": "Simplified HTTP/HTTPS requests",
   "license": "MIT",
   "repository": "sindresorhus/got",
@@ -20,7 +20,7 @@
     "node": ">=0.10.0"
   },
   "scripts": {
-    "test": "tape test/test-*.js | tap-dot",
+    "test": "tap test/test-*.js",
     "coverage": "istanbul cover tape --report html -- test/test-*.js"
   },
   "files": [
@@ -44,20 +44,19 @@
   "dependencies": {
     "duplexify": "^3.2.0",
     "infinity-agent": "^2.0.0",
+    "is-redirect": "^1.0.0",
     "is-stream": "^1.0.0",
     "lowercase-keys": "^1.0.0",
     "nested-error-stacks": "^1.0.0",
-    "object-assign": "^2.0.0",
+    "object-assign": "^3.0.0",
     "prepend-http": "^1.0.0",
-    "read-all-stream": "^2.0.0",
-    "statuses": "^1.2.1",
+    "read-all-stream": "^3.0.0",
     "timed-out": "^2.0.0"
   },
   "devDependencies": {
     "from2-array": "0.0.3",
     "istanbul": "^0.3.13",
     "pem": "^1.4.4",
-    "tap-dot": "^1.0.0",
-    "tape": "^3.5.0"
+    "tap": "^1.0.0"
   }
 }

package/readme.md

@@ -1,7 +1,15 @@
-# got [![Build Status](https://travis-ci.org/sindresorhus/got.svg?branch=master)](https://travis-ci.org/sindresorhus/got)
+<h1 align="center">
+	<br>
+	<img width="360" src="https://rawgit.com/sindresorhus/got/master/media/logo.svg" alt="got">
+	<br>
+	<br>
+	<br>
+</h1>
 
 > Simplified HTTP/HTTPS requests
 
+[![Build Status](https://travis-ci.org/sindresorhus/got.svg?branch=master)](https://travis-ci.org/sindresorhus/got)
+
 A nicer interface to the built-in [`http`](http://nodejs.org/api/http.html) module.
 
 It supports following redirects, streams, automagically handling gzip/deflate and some convenience options.
@@ -44,10 +52,12 @@ It's a `GET` request by default, but can be changed in `options`.
 ##### url
 
 *Required*  
-Type: `string`, `Object`
+Type: `string`, `object`
 
 The URL to request or bare [http.request options](https://nodejs.org/api/http.html#http_http_request_options_callback) object.
 
+Properties from `options` will override properties in the parsed `url`.
+
 ##### options
 
 Type: `object`
@@ -58,31 +68,33 @@ Any of the [`http.request`](http://nodejs.org/api/http.html#http_http_request_op
 
 Type: `string`, `Buffer`, `ReadableStream`  
 
-_This option and stream mode are mutually exclusive._
+*This option and stream mode are mutually exclusive.*
 
-Body, that will be sent with `POST` request. If present in `options` and `options.method` is not set - `options.method` will be set to `POST`.
+Body that will be sent with a `POST` request. If present in `options` and `options.method` is not set - `options.method` will be set to `POST`.
+
+If `content-length` or `transfer-encoding` is not set in `options.headers` and `body` is a string or buffer, `content-length` will be set to the body length.
 
 ###### encoding
 
 Type: `string`, `null`  
 Default: `'utf8'`
 
-Encoding to be used on `setEncoding` of the response data. If null, the body is returned as a Buffer.
+Encoding to be used on `setEncoding` of the response data. If `null`, the body is returned as a Buffer.
 
 ###### json
 
-Type: `Boolean`  
+Type: `boolean`  
 Default: `false`
 
-_This option and stream mode are mutually exclusive._
+*This option and stream mode are mutually exclusive.*
 
-If enabled, response body will be parsed with `JSON.parse`.
+Parse response body with `JSON.parse` and set `accept` header to `application/json`.
 
 ###### query
 
-Type: `string`, `Object`  
+Type: `string`, `object`  
 
-Query string object, that will be added to request url. This will override query string in `url`.
+Query string object that will be added to the request URL. This will override the query string in `url`.
 
 ###### timeout
 
@@ -94,13 +106,13 @@ Milliseconds after which the request will be aborted and an error event with `ET
 
 [http.Agent](http://nodejs.org/api/http.html#http_class_http_agent) instance.
 
-If `undefined` - [`infinity-agent`](https://github.com/floatdrop/infinity-agent) will be used to backport Agent class from Node core.
+If `undefined` - [`infinity-agent`](https://github.com/floatdrop/infinity-agent) will be used to backport Agent class from Node.js core.
 
-To use default [globalAgent](http://nodejs.org/api/http.html#http_http_globalagent) just pass `null` to this option.
+To use default [globalAgent](http://nodejs.org/api/http.html#http_http_globalagent) just pass `null`.
 
-##### callback(err, data, response)
+##### callback(error, data, response)
 
-###### err
+###### error
 
 `Error` object with HTTP status code as `code` property.
 
@@ -112,17 +124,19 @@ The data you requested.
 
 The [response object](http://nodejs.org/api/http.html#http_http_incomingmessage).
 
-
 When in stream mode, you can listen for events:
 
 ##### .on('response', response)
 
-`response` event to get the response object.
+`response` event to get the response object of the final request.
 
-##### .on('redirect', response, nextOpts)
+##### .on('redirect', response, nextOptions)
 
-`redirect` event to get the response object of redirect. Second argument is options for next request to redirect location.
+`redirect` event to get the response object of a redirect. Second argument is options for the next request to the redirect location.
 
+##### .on('error', error, body, response)
+
+`error` event emitted in case of protocol error (like `ENOTFOUND` etc.) or status error (4xx or 5xx). Second argument is body of server response in case of status error. Third argument is response object.
 
 ###### response
 
@@ -173,8 +187,15 @@ got('todomvc.com', {
 
 ## Related
 
- * [`gh-got`](https://github.com/sindresorhus/gh-got) - Convenience wrapper for interacting with the GitHub API
- * [`got-promise`](https://github.com/floatdrop/got-promise) - Promise wrapper
+- [gh-got](https://github.com/sindresorhus/gh-got) - Convenience wrapper for interacting with the GitHub API
+- [got-promise](https://github.com/floatdrop/got-promise) - Promise wrapper
+
+
+## Created by
+
+[![Sindre Sorhus](https://avatars.githubusercontent.com/u/170270?v=3&s=100)](http://sindresorhus.com) | [![Vsevolod Strukchinsky](https://avatars.githubusercontent.com/u/365089?v=3&s=100)](https://github.com/floatdrop)
+---|---
+[Sindre Sorhus](http://sindresorhus.com) | [Vsevolod Strukchinsky](https://github.com/floatdrop)
 
 
 ## License