got 7.0.0 → 7.1.0

package/index.js

@@ -10,6 +10,7 @@ const isStream = require('is-stream');
 const getStream = require('get-stream');
 const timedOut = require('timed-out');
 const urlParseLax = require('url-parse-lax');
+const urlToOptions = require('url-to-options');
 const lowercaseKeys = require('lowercase-keys');
 const decompressResponse = require('decompress-response');
 const isRetryAllowed = require('is-retry-allowed');
@@ -85,9 +86,14 @@ function requestAsEventEmitter(opts) {
 			}
 
 			setImmediate(() => {
-				const response = typeof decompressResponse === 'function' &&
+				const response = opts.decompress === true &&
+					typeof decompressResponse === 'function' &&
 					req.method !== 'HEAD' ? decompressResponse(res) : res;
 
+				if (!opts.decompress && ['gzip', 'deflate'].indexOf(res.headers['content-encoding']) !== -1) {
+					opts.encoding = null;
+				}
+
 				response.redirectUrls = redirects;
 
 				ee.emit('response', response);
@@ -257,29 +263,22 @@ function asStream(opts) {
 function normalizeArguments(url, opts) {
 	if (typeof url !== 'string' && typeof url !== 'object') {
 		throw new TypeError(`Parameter \`url\` must be a string or object, not ${typeof url}`);
-	}
-
-	if (typeof url === 'string') {
+	} else if (typeof url === 'string') {
 		url = url.replace(/^unix:/, 'http://$&');
 		url = urlParseLax(url);
-
-		if (url.auth) {
-			throw new Error('Basic authentication must be done with auth option');
-		}
+	} else if (isURL.lenient(url)) {
+		url = urlToOptions(url);
 	}
 
-	if (isURL.lenient(url)) {
-		url = urlParseLax(url.href);
-
-		if (url.auth) {
-			throw new Error('Basic authentication must be done with auth option');
-		}
+	if (url.auth) {
+		throw new Error('Basic authentication must be done with auth option');
 	}
 
 	opts = Object.assign(
 		{
 			path: '',
 			retries: 2,
+			decompress: true,
 			useElectronNet: true
 		},
 		url,
@@ -316,17 +315,18 @@ function normalizeArguments(url, opts) {
 			throw new TypeError('options.body must be a ReadableStream, string, Buffer or plain Object');
 		}
 
-		if ((opts.form || opts.json) && !isPlainObj(body)) {
-			throw new TypeError('options.body must be a plain Object when options.form or options.json is used');
+		const canBodyBeStringified = isPlainObj(body) || Array.isArray(body);
+		if ((opts.form || opts.json) && !canBodyBeStringified) {
+			throw new TypeError('options.body must be a plain Object or Array when options.form or options.json is used');
 		}
 
 		if (isStream(body) && typeof body.getBoundary === 'function') {
 			// Special case for https://github.com/form-data/form-data
 			headers['content-type'] = headers['content-type'] || `multipart/form-data; boundary=${body.getBoundary()}`;
-		} else if (opts.form && isPlainObj(body)) {
+		} else if (opts.form && canBodyBeStringified) {
 			headers['content-type'] = headers['content-type'] || 'application/x-www-form-urlencoded';
 			opts.body = querystring.stringify(body);
-		} else if (opts.json && isPlainObj(body)) {
+		} else if (opts.json && canBodyBeStringified) {
 			headers['content-type'] = headers['content-type'] || 'application/json';
 			opts.body = JSON.stringify(body);
 		}
@@ -342,7 +342,7 @@ function normalizeArguments(url, opts) {
 	}
 
 	if (opts.hostname === 'unix') {
-		const matches = /(.+):(.+)/.exec(opts.path);
+		const matches = /(.+?):(.+)/.exec(opts.path);
 
 		if (matches) {
 			opts.socketPath = matches[1];
@@ -389,7 +389,9 @@ function got(url, opts) {
 	}
 }
 
-const helpers = [
+got.stream = (url, opts) => asStream(normalizeArguments(url, opts));
+
+const methods = [
 	'get',
 	'post',
 	'put',
@@ -398,14 +400,9 @@ const helpers = [
 	'delete'
 ];
 
-helpers.forEach(el => {
-	got[el] = (url, opts) => got(url, Object.assign({}, opts, {method: el}));
-});
-
-got.stream = (url, opts) => asStream(normalizeArguments(url, opts));
-
-for (const el of helpers) {
-	got.stream[el] = (url, opts) => got.stream(url, Object.assign({}, opts, {method: el}));
+for (const method of methods) {
+	got[method] = (url, opts) => got(url, Object.assign({}, opts, {method}));
+	got.stream[method] = (url, opts) => got.stream(url, Object.assign({}, opts, {method}));
 }
 
 class StdError extends Error {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "got",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Simplified HTTP requests",
   "license": "MIT",
   "repository": "sindresorhus/got",
@@ -58,22 +58,23 @@
     "is-stream": "^1.0.0",
     "isurl": "^1.0.0-alpha5",
     "lowercase-keys": "^1.0.0",
-    "p-cancelable": "^0.2.0",
+    "p-cancelable": "^0.3.0",
     "p-timeout": "^1.1.1",
     "safe-buffer": "^5.0.1",
     "timed-out": "^4.0.0",
-    "url-parse-lax": "^1.0.0"
+    "url-parse-lax": "^1.0.0",
+    "url-to-options": "^1.0.1"
   },
   "devDependencies": {
-    "ava": "^0.19.1",
+    "ava": "^0.20.0",
     "coveralls": "^2.11.4",
     "form-data": "^2.1.1",
     "get-port": "^3.0.0",
     "into-stream": "^3.0.0",
-    "nyc": "^10.0.0",
+    "nyc": "^11.0.2",
     "pem": "^1.4.4",
-    "pify": "^2.3.0",
-    "tempfile": "^1.1.1",
+    "pify": "^3.0.0",
+    "tempfile": "^2.0.0",
     "tempy": "^0.1.0",
     "universal-url": "^1.0.0-alpha",
     "xo": "^0.18.0"

package/readme.md

@@ -12,16 +12,24 @@
 
 A nicer interface to the built-in [`http`](http://nodejs.org/api/http.html) module.
 
-It supports following redirects, promises, streams, retries, automagically handling gzip/deflate, canceling of requests, and some convenience options.
-
 Created because [`request`](https://github.com/request/request) is bloated *(several megabytes!)*.
 
-When used with Electron, it takes advantage of [`electron.net`](https://electron.atom.io/docs/api/net/).
 
+## Highlights
 
-## Install
+- [Promise & stream API](#api)
+- [Request cancelation](#aborting-the-request)
+- [Follows redirects](#followredirect)
+- [Retries on network failure](#retries)
+- [Handles gzip/deflate](#decompress)
+- [Timeout handling](#timeout)
+- [Errors with metadata](#errors)
+- [JSON mode](#json)
+- [WHATWG URL support](#url)
+- [Electron support](#useelectronnet)
 
-**WARNING: Node.js 4 or higher is required for got@6 and above.** For older Node.js versions use [got@5](https://github.com/sindresorhus/got/tree/v5.x).
+
+## Install
 
 ```
 $ npm install --save got
@@ -62,7 +70,7 @@ Returns a Promise for a `response` object with a `body` property, a `url` proper
 
 ##### url
 
-Type: `string`, `object`
+Type: `string` `Object`
 
 The URL to request as simple string, a [`http.request` options](https://nodejs.org/api/http.html#http_http_request_options_callback), or a [WHATWG `URL`](https://nodejs.org/api/url.html#url_class_url).
 
@@ -70,13 +78,13 @@ Properties from `options` will override properties in the parsed `url`.
 
 ##### options
 
-Type: `object`
+Type: `Object`
 
 Any of the [`http.request`](http://nodejs.org/api/http.html#http_http_request_options_callback) options.
 
 ###### body
 
-Type: `string`, `buffer`, `readableStream`
+Type: `string` `Buffer` `stream.Readable`
 
 *This is mutually exclusive with stream mode.*
 
@@ -88,10 +96,10 @@ If `content-length` or `transfer-encoding` is not set in `options.headers` and `
 
 ###### encoding
 
-Type: `string`, `null`<br>
+Type: `string` `null`<br>
 Default: `'utf8'`
 
-Encoding to be used on `setEncoding` of the response data. If `null`, the body is returned as a Buffer.
+[Encoding](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings) to be used on `setEncoding` of the response data. If `null`, the body is returned as a Buffer.
 
 ###### form
 
@@ -102,7 +110,7 @@ Default: `false`
 
 If set to `true` and `Content-Type` header is not set, it will be set to `application/x-www-form-urlencoded`.
 
-`body` must be a plain object and will be stringified.
+`body` must be a plain object or array and will be stringified.
 
 ###### json
 
@@ -115,17 +123,17 @@ If set to `true` and `Content-Type` header is not set, it will be set to `applic
 
 Parse response body with `JSON.parse` and set `accept` header to `application/json`. If used in conjunction with the `form` option, the `body` will the stringified as querystring and the response parsed as JSON.
 
-`body` must be a plain object and will be stringified.
+`body` must be a plain object or array and will be stringified.
 
 ###### query
 
-Type: `string`, `object`<br>
+Type: `string` `Object`<br>
 
 Query string object that will be added to the request URL. This will override the query string in `url`.
 
 ###### timeout
 
-Type: `number`, `object`
+Type: `number` `Object`
 
 Milliseconds to wait for the server to end the response before aborting request with `ETIMEDOUT` error.
 
@@ -133,7 +141,7 @@ This also accepts an object with separate `connect`, `socket`, and `request` fie
 
 ###### retries
 
-Type: `number`, `function`<br>
+Type: `number` `Function`<br>
 Default: `2`
 
 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).
@@ -152,6 +160,15 @@ Defines if redirect responses should be followed automatically.
 Note that if a `303` is sent by the server in response to any request type (`POST`, `DELETE`, etc.), got will automatically
 request the resource pointed to in the location header via `GET`. This is in accordance with [the spec](https://tools.ietf.org/html/rfc7231#section-6.4.4).
 
+###### decompress
+
+Type: `boolean`<br>
+Default: `true`
+
+Decompress the response automatically.
+
+If this is disabled, a compressed response is returned as a `Buffer`. This may be useful if you want to handle decompression yourself or stream the raw compressed data.
+
 ###### useElectronNet
 
 Type: `boolean`<br>