got 5.5.0 → 5.7.1

package/index.js

@@ -18,7 +18,6 @@ var PinkiePromise = require('pinkie-promise');
 var unzipResponse = require('unzip-response');
 var createErrorClass = require('create-error-class');
 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');
@@ -27,8 +26,10 @@ function requestAsEventEmitter(opts) {
 	opts = opts || {};
 
 	var ee = new EventEmitter();
+	var requestUrl = opts.href || urlLib.resolve(urlLib.format(opts), opts.path);
 	var redirectCount = 0;
 	var retryCount = 0;
+	var redirectUrl;
 
 	var get = function (opts) {
 		var fn = opts.protocol === 'https:' ? https : http;
@@ -36,7 +37,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) {
@@ -44,7 +45,7 @@ function requestAsEventEmitter(opts) {
 					return;
 				}
 
-				var redirectUrl = urlLib.resolve(urlLib.format(opts), res.headers.location);
+				redirectUrl = urlLib.resolve(urlLib.format(opts), res.headers.location);
 				var redirectOpts = objectAssign({}, opts, urlLib.parse(redirectUrl));
 
 				ee.emit('redirect', res, redirectOpts);
@@ -55,7 +56,11 @@ function requestAsEventEmitter(opts) {
 
 			// do not write ee.bind(...) instead of function - it will break gzip in Node.js 0.10
 			setImmediate(function () {
-				ee.emit('response', typeof unzipResponse === 'function' && req.method !== 'HEAD' ? unzipResponse(res) : res);
+				var response = typeof unzipResponse === 'function' && req.method !== 'HEAD' ? unzipResponse(res) : res;
+				response.url = redirectUrl || requestUrl;
+				response.requestUrl = requestUrl;
+
+				ee.emit('response', response);
 			});
 		});
 
@@ -94,28 +99,29 @@ function asCallback(opts, cb) {
 	});
 
 	ee.on('response', function (res) {
-		readAllStream(res, opts.encoding, function (err, data) {
+		readAllStream(res, opts.encoding, function (error, data) {
 			var statusCode = res.statusCode;
+			var limitStatusCode = opts.followRedirect ? 299 : 399;
 
-			if (err) {
-				cb(new got.ReadError(err, opts), null, res);
+			if (error) {
+				cb(new got.ReadError(error, opts), null, res);
 				return;
 			}
 
-			if (statusCode < 200 || statusCode > 299) {
-				err = new got.HTTPError(statusCode, opts);
+			if (statusCode < 200 || statusCode > limitStatusCode) {
+				error = new got.HTTPError(statusCode, opts);
 			}
 
 			if (opts.json && data) {
 				try {
 					data = parseJson(data);
-				} catch (e) {
-					e.fileName = urlLib.format(opts);
-					err = new got.ParseError(e, statusCode, opts);
+				} catch (err) {
+					err.fileName = urlLib.format(opts);
+					error = new got.ParseError(err, statusCode, opts);
 				}
 			}
 
-			cb(err, data, res);
+			cb(error, data, res);
 		});
 	});
 
@@ -183,10 +189,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;
 		}
@@ -207,6 +214,7 @@ function normalizeArguments(url, opts) {
 	}
 
 	if (typeof url === 'string') {
+		url = url.replace(/^unix:/, 'http://$&');
 		url = urlParseLax(url);
 
 		if (url.auth) {
@@ -243,13 +251,16 @@ function normalizeArguments(url, opts) {
 	var body = opts.body;
 
 	if (body) {
-		if (typeof body !== 'string' && !Buffer.isBuffer(body) && !isStream(body) && !isPlainObj(body)) {
+		if (typeof body !== 'string' && !(body !== null && typeof body === 'object')) {
 			throw new Error('options.body must be a ReadableStream, string, Buffer or plain Object');
 		}
 
 		opts.method = opts.method || 'POST';
 
-		if (isPlainObj(body)) {
+		if (isStream(body) && typeof body.getBoundary === 'function') {
+			// Special case for https://github.com/form-data/form-data
+			opts.headers['content-type'] = opts.headers['content-type'] || 'multipart/form-data; boundary=' + body.getBoundary();
+		} else if (body !== null && typeof body === 'object' && !Buffer.isBuffer(body) && !isStream(body)) {
 			opts.headers['content-type'] = opts.headers['content-type'] || 'application/x-www-form-urlencoded';
 			body = opts.body = querystring.stringify(body);
 		}
@@ -265,7 +276,7 @@ function normalizeArguments(url, opts) {
 	opts.method = opts.method.toUpperCase();
 
 	if (opts.hostname === 'unix') {
-		var matches = /(.+)\:(.+)/.exec(opts.path);
+		var matches = /(.+):(.+)/.exec(opts.path);
 
 		if (matches) {
 			opts.socketPath = matches[1];
@@ -282,10 +293,14 @@ function normalizeArguments(url, opts) {
 			}
 
 			var noise = Math.random() * 100;
-			return (1 << iter) * 1000 + noise;
+			return ((1 << iter) * 1000) + noise;
 		};
 	}
 
+	if (opts.followRedirect === undefined) {
+		opts.followRedirect = true;
+	}
+
 	return opts;
 }
 
@@ -302,8 +317,8 @@ function got(url, opts, cb) {
 
 	try {
 		return asPromise(normalizeArguments(url, opts));
-	} catch (error) {
-		return PinkiePromise.reject(error);
+	} catch (err) {
+		return PinkiePromise.reject(err);
 	}
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "got",
-  "version": "5.5.0",
+  "version": "5.7.1",
   "description": "Simplified HTTP/HTTPS requests",
   "license": "MIT",
   "repository": "sindresorhus/got",
@@ -17,7 +17,7 @@
     }
   ],
   "engines": {
-    "node": ">=0.10.0"
+    "node": ">=0.10.0 <7"
   },
   "browser": {
     "unzip-response": false
@@ -45,9 +45,8 @@
     "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",
     "is-retry-allowed": "^1.0.0",
     "is-stream": "^1.0.0",
@@ -58,20 +57,22 @@
     "pinkie-promise": "^2.0.0",
     "read-all-stream": "^3.0.0",
     "readable-stream": "^2.0.5",
-    "timed-out": "^2.0.0",
-    "unzip-response": "^1.0.0",
+    "timed-out": "^3.0.0",
+    "unzip-response": "^1.0.2",
     "url-parse-lax": "^1.0.0"
   },
   "devDependencies": {
-    "ava": "^0.5.0",
+    "ava": "^0.16.0",
     "coveralls": "^2.11.4",
+    "form-data": "^2.1.1",
     "get-port": "^2.0.0",
+    "get-stream": "^2.3.0",
     "into-stream": "^2.0.0",
-    "nyc": "^3.2.2",
+    "nyc": "^8.1.0",
     "pem": "^1.4.4",
     "pify": "^2.3.0",
     "tempfile": "^1.1.1",
-    "xo": "*"
+    "xo": "0.16.x"
   },
   "xo": {
     "ignores": [

package/readme.md

@@ -60,6 +60,10 @@ It's a `GET` request by default, but can be changed in `options`.
 
 #### got(url, [options], [callback])
 
+Returns a Promise for a `response` object with a `body` property, a `url` property with the request URL or the final URL after redirects, and a `requestUrl` property with the original request URL.
+
+Otherwise calls callback with `response` object (same as in previous case).
+
 ##### url
 
 Type: `string`, `object`
@@ -121,12 +125,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`<br>
+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 +146,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
@@ -239,6 +248,54 @@ got('google.com', {
 ```
 
 
+## Form data
+
+You can use the [`form-data`](https://github.com/form-data/form-data) module to create POST request with form data:
+
+```js
+const fs = require('fs');
+const got = require('got');
+const FormData = require('form-data');
+const form = new FormData();
+
+form.append('my_file', fs.createReadStream('/foo/bar.jpg'));
+
+got.post('google.com', {
+	body: form
+});
+```
+
+
+## OAuth
+
+You can use the [`oauth-1.0a`](https://github.com/ddo/oauth-1.0a) module to create a signed OAuth request:
+
+```js
+const got = require('got');
+const OAuth = require('oauth-1.0a');
+
+const oauth = OAuth({
+	consumer: {
+		public: process.env.CONSUMER_KEY,
+		secret: process.env.CONSUMER_SECRET
+	},
+	signature_method: 'HMAC-SHA1'
+});
+
+const token = {
+	public: process.env.ACCESS_TOKEN,
+	secret: process.env.ACCESS_TOKEN_SECRET
+};
+
+const url = 'https://api.twitter.com/1.1/statuses/home_timeline.json';
+
+got(url, {
+	headers: oauth.toHeader(oauth.authorize({url, method: 'GET'}, token)),
+	json: true
+});
+```
+
+
 ## Unix Domain Sockets
 
 Requests can also be sent via [unix domain sockets](http://serverfault.com/questions/124517/whats-the-difference-between-unix-socket-and-tcp-ip-socket). Use the following URL scheme: `PROTOCOL://unix:SOCKET:PATH`.