got 5.4.1 → 5.6.0

package/index.js

@@ -21,6 +21,7 @@ var nodeStatusCodes = require('node-status-codes');
 var isPlainObj = require('is-plain-obj');
 var parseJson = require('parse-json');
 var isRetryAllowed = require('is-retry-allowed');
+var pkg = require('./package.json');
 
 function requestAsEventEmitter(opts) {
 	opts = opts || {};
@@ -35,7 +36,7 @@ function requestAsEventEmitter(opts) {
 		var req = fn.request(opts, function (res) {
 			var statusCode = res.statusCode;
 
-			if (isRedirect(statusCode) && 'location' in res.headers && (opts.method === 'GET' || opts.method === 'HEAD')) {
+			if (isRedirect(statusCode) && opts.followRedirect && 'location' in res.headers && (opts.method === 'GET' || opts.method === 'HEAD')) {
 				res.resume();
 
 				if (++redirectCount > 10) {
@@ -95,22 +96,23 @@ function asCallback(opts, cb) {
 	ee.on('response', function (res) {
 		readAllStream(res, opts.encoding, function (err, data) {
 			var statusCode = res.statusCode;
+			var limitStatusCode = opts.followRedirect ? 299 : 399;
 
 			if (err) {
 				cb(new got.ReadError(err, opts), null, res);
 				return;
 			}
 
-			if (statusCode < 200 || statusCode > 299) {
+			if (statusCode < 200 || statusCode > limitStatusCode) {
 				err = new got.HTTPError(statusCode, opts);
 			}
 
-			if (opts.json && statusCode !== 204) {
+			if (opts.json && data) {
 				try {
 					data = parseJson(data);
 				} catch (e) {
 					e.fileName = urlLib.format(opts);
-					err = new got.ParseError(e, opts);
+					err = new got.ParseError(e, statusCode, opts);
 				}
 			}
 
@@ -182,10 +184,11 @@ function asStream(opts) {
 
 	ee.on('response', function (res) {
 		var statusCode = res.statusCode;
+		var limitStatusCode = opts.followRedirect ? 299 : 399;
 
 		res.pipe(output);
 
-		if (statusCode < 200 || statusCode > 299) {
+		if (statusCode < 200 || statusCode > limitStatusCode) {
 			proxy.emit('error', new got.HTTPError(statusCode, opts), null, res);
 			return;
 		}
@@ -220,7 +223,7 @@ function normalizeArguments(url, opts) {
 	);
 
 	opts.headers = objectAssign({
-		'user-agent': 'https://github.com/sindresorhus/got',
+		'user-agent': pkg.name + '/' + pkg.version + ' (https://github.com/sindresorhus/got)',
 		'accept-encoding': 'gzip,deflate'
 	}, lowercaseKeys(opts.headers));
 
@@ -285,6 +288,10 @@ function normalizeArguments(url, opts) {
 		};
 	}
 
+	if (opts.followRedirect === undefined) {
+		opts.followRedirect = true;
+	}
+
 	return opts;
 }
 
@@ -361,7 +368,12 @@ function stdError(error, opts) {
 
 got.RequestError = createErrorClass('RequestError', stdError);
 got.ReadError = createErrorClass('ReadError', stdError);
-got.ParseError = createErrorClass('ParseError', stdError);
+
+got.ParseError = createErrorClass('ParseError', function (e, statusCode, opts) {
+	stdError.call(this, e, opts);
+	this.statusCode = statusCode;
+	this.statusMessage = nodeStatusCodes[this.statusCode];
+});
 
 got.HTTPError = createErrorClass('HTTPError', function (statusCode, opts) {
 	stdError.call(this, {}, opts);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "got",
-  "version": "5.4.1",
+  "version": "5.6.0",
   "description": "Simplified HTTP/HTTPS requests",
   "license": "MIT",
   "repository": "sindresorhus/got",
@@ -45,7 +45,7 @@
     "fetch"
   ],
   "dependencies": {
-    "create-error-class": "^2.0.0",
+    "create-error-class": "^3.0.1",
     "duplexer2": "^0.1.4",
     "is-plain-obj": "^1.0.0",
     "is-redirect": "^1.0.0",

package/readme.md

@@ -121,12 +121,19 @@ Milliseconds after which the request will be aborted and an error event with `ET
 Type: `number`, `function`  
 Default: `5`
 
-Number of request retries when network errors happens. Delays between retries counts with function `Math.pow(2, retry) + Math.random() * 100`, where `retry` is attempt number (starts from 0).
-
-**Note:** `ENOTFOUND` and `ENETUNREACH` error will not be retried (see full list in [`is-retry-allowed`](https://github.com/floatdrop/is-retry-allowed/blob/master/index.js#L12) module).
+Number of request retries when network errors happens. Delays between retries counts with function `1000 * Math.pow(2, retry) + Math.random() * 100`, where `retry` is attempt number (starts from 0).
 
 Option accepts `function` with `retry` and `error` arguments. Function must return delay in milliseconds (`0` return value cancels retry).
 
+**Note:** if `retries` is `number`, `ENOTFOUND` and `ENETUNREACH` error will not be retried (see full list in [`is-retry-allowed`](https://github.com/floatdrop/is-retry-allowed/blob/master/index.js#L12) module).
+
+###### followRedirect
+
+Type: `boolean`  
+Default: `true`
+
+Defines if redirect responses should be followed automatically.
+
 ##### callback(error, data, response)
 
 Function to be called when error or data are received. If omitted, a promise will be returned.
@@ -135,8 +142,6 @@ Function to be called when error or data are received. If omitted, a promise wil
 
 `Error` object with HTTP status code as `statusCode` property.
 
-###### data
-
 The data you requested.
 
 ###### response
@@ -180,7 +185,7 @@ Sets `options.method` to the method name and makes a request.
 
 ## Errors
 
-Each error contains (if available) `host`, `hostname`, `method` and `path` properties to make debugging easier.
+Each error contains (if available) `statusCode`, `statusMessage`, `host`, `hostname`, `method` and `path` properties to make debugging easier.
 
 In Promise mode, the `response` is attached to the error.
 
@@ -260,10 +265,11 @@ It's a good idea to set the `'user-agent'` header so the provider can more easil
 
 ```js
 var got = require('got');
+var pkg = require('./package.json');
 
 got('todomvc.com', {
 	headers: {
-		'user-agent': 'https://github.com/your-username/repo-name'
+		'user-agent': 'my-module/' + pkg.version + ' (https://github.com/username/my-module)'
 	}
 }, function () {});
 ```