1.8.2

See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.*.sw*

.jshintrc

@@ -0,0 +1,22 @@
+{
+  "browser": true,
+  "node": true,
+  "esversion": 11,
+  "curly": true,
+  "sub": true,
+  "bitwise": true,
+  "eqeqeq": true,
+  "forin": true,
+  "freeze": true,
+  "immed": true,
+  "latedef": "nofunc",
+  "nonbsp": true,
+  "nonew": true,
+  "plusplus": true,
+  "undef": true,
+  "unused": "vars",
+  "strict": true,
+  "maxdepth": 3,
+  "maxstatements": 100,
+  "maxcomplexity": 40
+}

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "bracketSpacing": true,
+  "printWidth": 80,
+  "singleQuote": true,
+  "tabWidth": 4,
+  "trailingComma": "none",
+  "useTabs": false
+}

CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+## v1.8.0
+
+-   add `resp.ok` - same as WHATWG fetch `resp.ok = (resp.statusCode >= 200 && resp.statusCode < 300)`
+-   add `resp.stream.body()` to populate `resp.body` rather than (or perhaps in addition to) continuing to stream (useful for error handling)

EXTRA.md

@@ -0,0 +1,65 @@
+# Extra
+
+There are some niche features of @root/request which are beyond the request.js
+compatibility.
+
+## async/await & Promises
+
+The differences in async support are explained in [README.md](/README.md), up near the top.
+
+If you're familiar with Promises (and async/await), then it's pretty self-explanatory.
+
+## ok
+
+Just like WHATWG `fetch`, we have `resp.ok`:
+
+```js
+let resp = await request({
+    url: 'https://example.com'
+}).then(mustOk);
+```
+
+```js
+function mustOk(resp) {
+    if (!resp.ok) {
+        // handle error
+        throw new Error('BAD RESPONSE');
+    }
+    return resp;
+}
+```
+
+## streams
+
+The differences in stream support are explained in [README.md](/README.md), up near the top.
+
+## userAgent
+
+There's a default User-Agent string describing the version of @root/request, node.js, and the OS.
+
+Add to the default User-Agent
+
+```js
+request({
+    // ...
+    userAgent: 'my-package/1.0' // add to agent
+});
+```
+
+Replace the default User-Agent
+
+```js
+request({
+    // ...
+    headers: { 'User-Agent': 'replace/0.0' }
+});
+```
+
+Disable the default User-Agent:
+
+```js
+request({
+    // ...
+    headers: { 'User-Agent': false }
+});
+```

README.md

@@ -1,31 +1,305 @@
-# µRequest - Minimalist HTTP client
+# [@root/request](https://git.rootprojects.org/root/request.js) | a [Root](https://rootprojects.org) project
 
-A lightweight alternative to (and drop-in replacement for) request.
+> Minimalist HTTP client
 
-Written from scratch.
+A lightweight alternative to (and 80/20 drop-in replacement for) request.
+
+Has the 20% of features that 80%+ of people need, in about 500 LoC.
+
+Written from scratch, with zero-dependencies.
 
 ## Super simple to use
 
-µRequest is designed to be a drop-in replacement for request.  It supports HTTPS and follows redirects by default.
+@root/request is designed to be a drop-in replacement for request. It also supports Promises and async/await by default, enhanced stream support, and a few other things as mentioned below.
 
 ```bash
-npm install --save @coolaj86/urequest
+npm install --save @root/request
+
+# or npm install git+ssh://git@git.therootcompany.com/request.js
 ```
 
 ```js
-var request = require('@coolaj86/urequest');
+var request = require('@root/request');
 request('http://www.google.com', function (error, response, body) {
-  console.log('error:', error); // Print the error if one occurred
+    console.log('error:', error); // Print the error if one occurred
-  console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
+    console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
-  console.log('body:', body); // Print the HTML for the Google homepage.
+    console.log('body:', body); // Print the HTML for the Google homepage.
 });
 ```
 
+**Using Promises**
+
+```js
+var request = require('@root/request');
+
+request('http://www.google.com')
+    .then(function (response) {
+        console.log('statusCode:', response.statusCode); // Print the response status code if a response was received
+        console.log('body:', response.body); // Print the HTML for the Google homepage.
+    })
+    .catch(function (error) {
+        console.log('error:', error); // Print the error if one occurred
+    });
+```
+
+**Streaming**
+
+In order to keep this library lightweight, performant, and keep the code easy to
+read, the streaming behavior is **_slightly different_** from that of
+`request.js`.
+
+```diff
+-var request = require('request');
++var request = require('@root/request');
+
+-var stream = request({ url, headers });
++var stream = await request({ url, headers });
+
+ let attachment = await new MailgunAPI.Attachment({
+   data: stream
+ })
+```
+
+Example:
+
+```js
+var request = require('@root/request');
+
+var resp = await request({
+    url: 'http://www.google.com',
+    stream: true // true | 'filename.ext' | stream.Writable
+});
+
+// 'resp' itself is a ReadableStream
+resp.on('data', function () {
+    // got some data
+});
+
+resp.on('end', function () {
+    // the data has ended
+});
+
+// 'resp.stream' is a Promise that is resolved when the read stream is destroyed
+await resp.stream; // returns `undefined`
+console.log('Done');
+```
+
+The difference is that we don't add an extra layer of stream abstraction.
+You must use the response from await, a Promise, or the callback.
+
+You can also give a file path:
+
+```js
+request({
+    url: 'http://www.google.com',
+    stream: '/tmp/google-index.html'
+});
+```
+
+Which is equivalent to passing a write stream for the file:
+
+```js
+request({
+    url: 'http://www.google.com',
+    stream: fs.createWriteStream('/tmp/google-index.html')
+});
+```
+
+Also, `await resp.stream.body()` can be used to get back the full body (the same as if you didn't use the `stream` option:
+
+```js
+let resp = await request({
+    url: 'http://www.google.com',
+    stream: true
+});
+if (!resp.ok) {
+    await resp.stream.body();
+    console.error(resp.body);
+}
+```
+
 ## Table of contents
 
-- [Custom HTTP Headers](#custom-http-headers)
+-   [Extra Features](/EXTRA.md)
-- [Unix Domain Sockets](#unix-domain-sockets)
+-   [Forms](#forms)
-- [**All Available Options**](#requestoptions-callback)
+-   [HTTP Authentication](#http-authentication)
+-   [Custom HTTP Headers](#custom-http-headers)
+-   [Unix Domain Sockets](#unix-domain-sockets)
+-   [**All Available Options**](#requestoptions-callback)
+
+## Extra Features
+
+The following are features that the original `request` did not have, but have been added for convenience in `@root/request`.
+
+-   Support for `async`/`await` & `Promise`s (as explained above)
+-   `request({ userAgent: 'my-api/1.1' })` (for building API clients)
+-   `resp.ok` (just like `fetch`)
+-   `resp.stream` (see above)
+
+See [EXTRA.md](/EXTRA.md)
+
+## Forms
+
+`@root/request` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
+
+<!-- For `multipart/related` refer to the `multipart` API. -->
+
+#### application/x-www-form-urlencoded (URL-Encoded Forms)
+
+URL-encoded forms are simple.
+
+```js
+request.post('http://service.com/upload', { form: { key: 'value' } });
+// or
+request.post(
+    { url: 'http://service.com/upload', form: { key: 'value' } },
+    function (err, httpResponse, body) {
+        /* ... */
+    }
+);
+```
+
+<!--
+// or
+request.post('http://service.com/upload').form({key:'value'})
+-->
+
+#### multipart/form-data (Multipart Form Uploads)
+
+For `multipart/form-data` we use the [form-data](https://github.com/form-data/form-data/tree/v2.5.1) library by [@felixge](https://github.com/felixge). For the most cases, you can pass your upload form data via the `formData` option.
+
+To use `form-data`, you must install it separately:
+
+```bash
+npm install --save form-data@2.x
+```
+
+```js
+var formData = {
+    // Pass a simple key-value pair
+    my_field: 'my_value',
+    // Pass data via Buffers
+    my_buffer: Buffer.from([1, 2, 3]),
+    // Pass data via Streams
+    my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),
+    // Pass multiple values /w an Array
+    attachments: [
+        fs.createReadStream(__dirname + '/attachment1.jpg'),
+        fs.createReadStream(__dirname + '/attachment2.jpg')
+    ],
+    // Pass optional meta-data with an 'options' object with style: {value: DATA, options: OPTIONS}
+    // Use case: for some types of streams, you'll need to provide "file"-related information manually.
+    // See the `form-data` README for more information about options: https://github.com/form-data/form-data
+    custom_file: {
+        value: fs.createReadStream('/dev/urandom'),
+        options: {
+            filename: 'topsecret.jpg',
+            contentType: 'image/jpeg'
+        }
+    }
+};
+request.post(
+    { url: 'http://service.com/upload', formData: formData },
+    function optionalCallback(err, httpResponse, body) {
+        if (err) {
+            return console.error('upload failed:', err);
+        }
+        console.log('Upload successful!  Server responded with:', body);
+    }
+);
+```
+
+<!--
+
+For advanced cases, you can access the form-data object itself via `r.form()`. This can be modified until the request is fired on the next cycle of the event-loop. (Note that this calling `form()` will clear the currently set form data for that request.)
+
+```js
+// NOTE: Advanced use-case, for normal use see 'formData' usage above
+var r = request.post('http://service.com/upload', function optionalCallback(err, httpResponse, body) {...})
+var form = r.form();
+form.append('my_field', 'my_value');
+form.append('my_buffer', Buffer.from([1, 2, 3]));
+form.append('custom_file', fs.createReadStream(__dirname + '/unicycle.jpg'), {filename: 'unicycle.jpg'});
+```
+-->
+
+See the [form-data README](https://github.com/form-data/form-data) for more information & examples.
+
+---
+
+## HTTP Authentication
+
+<!--
+request.get('http://some.server.com/').auth('username', 'password', false);
+// or
+request.get('http://some.server.com/').auth(null, null, true, 'bearerToken');
+// or
+-->
+
+```js
+request.get('http://some.server.com/', {
+    auth: {
+        user: 'username',
+        pass: 'password',
+        sendImmediately: false
+    }
+});
+// or
+request.get('http://some.server.com/', {
+    auth: {
+        bearer: 'bearerToken'
+    }
+});
+```
+
+If passed as an option, `auth` should be a hash containing values:
+
+-   `user` || `username`
+-   `pass` || `password`
+-   `bearer` (optional)
+
+<!--
+- `sendImmediately` (optional)
+
+The method form takes parameters
+`auth(username, password, sendImmediately, bearer)`.
+
+`sendImmediately` defaults to `true`, which causes a basic or bearer
+authentication header to be sent. If `sendImmediately` is `false`, then
+`request` will retry with a proper authentication header after receiving a
+`401` response from the server (which must contain a `WWW-Authenticate` header
+indicating the required authentication method).
+-->
+
+Note that you can also specify basic authentication using the URL itself, as
+detailed in [RFC 1738](http://www.ietf.org/rfc/rfc1738.txt). Simply pass the
+`user:password` before the host with an `@` sign:
+
+```js
+var username = 'username',
+    password = 'password',
+    url = 'http://' + username + ':' + password + '@some.server.com';
+
+request({ url: url }, function (error, response, body) {
+    // Do more stuff with 'body' here
+});
+```
+
+<!--
+Digest authentication is supported, but it only works with `sendImmediately`
+set to `false`; otherwise `request` will send basic authentication on the
+initial request, which will probably cause the request to fail.
+-->
+
+Bearer authentication is supported, and is activated when the `bearer` value is
+available. The value may be either a `String` or a `Function` returning a
+`String`. Using a function to supply the bearer token is particularly useful if
+used in conjunction with `defaults` to allow a single function to supply the
+last known token at the time of sending a request, or to compute one on the fly.
+
+[back to top](#table-of-contents)
+
+---
 
 ## Custom HTTP Headers
 
@@ -38,18 +312,18 @@ custom `User-Agent` header as well as https.
 var request = require('request');
 
 var options = {
-  url: 'https://api.github.com/repos/request/request',
+    url: 'https://api.github.com/repos/request/request',
-  headers: {
+    headers: {
-    'User-Agent': 'request'
+        'User-Agent': 'request'
-  }
+    }
 };
 
 function callback(error, response, body) {
-  if (!error && response.statusCode == 200) {
+    if (!error && response.statusCode == 200) {
-    var info = JSON.parse(body);
+        var info = JSON.parse(body);
-    console.log(info.stargazers_count + " Stars");
+        console.log(info.stargazers_count + ' Stars');
-    console.log(info.forks_count + " Forks");
+        console.log(info.forks_count + ' Forks');
-  }
+    }
 }
 
 request(options, callback);
@@ -61,11 +335,13 @@ request(options, callback);
 
 ## UNIX Domain Sockets
 
-`request` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
+`@root/request` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
 
 ```js
-/* Pattern */ 'http://unix:SOCKET:PATH'
+/* Pattern */ 'http://unix:SOCKET:PATH';
-/* Example */ request.get('http://unix:/absolute/path/to/unix.socket:/request/path')
+/* Example */ request.get(
+    'http://unix:/absolute/path/to/unix.socket:/request/path'
+);
 ```
 
 Note: The `SOCKET` path is assumed to be absolute to the root of the host file system.
@@ -78,9 +354,9 @@ Note: The `SOCKET` path is assumed to be absolute to the root of the host file s
 
 The first argument can be either a `url` or an `options` object. The only required option is `uri`; all others are optional.
 
-- `uri` || `url` - fully qualified uri or a parsed url object from `url.parse()`
+-   `uri` || `url` - fully qualified uri or a parsed url object from `url.parse()`
-- `method` - http method (default: `"GET"`)
+-   `method` - http method (default: `"GET"`)
-- `headers` - http headers (default: `{}`)
+-   `headers` - http headers (default: `{}`)
 
 <!-- TODO
 - `baseUrl` - fully qualified uri string used as the base url. Most useful with `request.defaults`, for example when you want to do many requests to the same domain. If `baseUrl` is `https://example.com/api/`, then requesting `/end/point?test=true` will fetch `https://example.com/api/end/point?test=true`. When `baseUrl` is given, `uri` must also be a string.
@@ -88,8 +364,8 @@ The first argument can be either a `url` or an `options` object. The only requir
 
 ---
 
-- `body` - entity body for PATCH, POST and PUT requests. Must be a `Buffer`, `String` or `ReadStream`. If `json` is `true`, then `body` must be a JSON-serializable object.
+-   `body` - entity body for PATCH, POST and PUT requests. Must be a `Buffer`, `String` or `ReadStream`. If `json` is `true`, then `body` must be a JSON-serializable object.
-- `json` - sets `body` to JSON representation of value and adds `Content-type: application/json` header. Additionally, parses the response body as JSON.
+-   `json` - sets `body` to JSON representation of value and adds `Content-type: application/json` header. Additionally, parses the response body as JSON.
 
 <!-- TODO
 - `form` - when passed an object or a querystring, this sets `body` to a querystring representation of value, and adds `Content-type: application/x-www-form-urlencoded` header. When passed no options, a `FormData` instance is returned (and is piped to request). See "Forms" section above.
@@ -110,15 +386,15 @@ The first argument can be either a `url` or an `options` object. The only requir
 
 ---
 
-- `followRedirect` - follow HTTP 3xx responses as redirects (default: `true`). This property can also be implemented as function which gets `response` object as a single argument and should return `true` if redirects should continue or `false` otherwise.
+-   `followRedirect` - follow HTTP 3xx responses as redirects (default: `true`). This property can also be implemented as function which gets `response` object as a single argument and should return `true` if redirects should continue or `false` otherwise.
-- `followAllRedirects` - follow non-GET HTTP 3xx responses as redirects (default: `false`)
+-   `followAllRedirects` - follow non-GET HTTP 3xx responses as redirects (default: `false`)
-- `followOriginalHttpMethod` - by default we redirect to HTTP method GET. you can enable this property to redirect to the original HTTP method (default: `false`)
+-   `followOriginalHttpMethod` - by default we redirect to HTTP method GET. you can enable this property to redirect to the original HTTP method (default: `false`)
-- `maxRedirects` - the maximum number of redirects to follow (default: `10`)
+-   `maxRedirects` - the maximum number of redirects to follow (default: `10`)
-- `removeRefererHeader` - removes the referer header when a redirect happens (default: `false`). **Note:** if true, referer header set in the initial request is preserved during redirect chain.
+-   `removeRefererHeader` - removes the referer header when a redirect happens (default: `false`). **Note:** if true, referer header set in the initial request is preserved during redirect chain.
 
 ---
 
-- `encoding` - encoding to be used on `setEncoding` of response data. If `null`, the `body` is returned as a `Buffer`. Anything else **(including the default value of `undefined`)** will be passed as the [encoding](http://nodejs.org/api/buffer.html#buffer_buffer) parameter to `toString()` (meaning this is effectively `utf8` by default). (**Note:** if you expect binary data, you should set `encoding: null`.)
+-   `encoding` - encoding to be used on `setEncoding` of response data. If `null`, the `body` is returned as a `Buffer`. Anything else **(including the default value of `undefined`)** will be passed as the [encoding](http://nodejs.org/api/buffer.html#buffer_buffer) parameter to `toString()` (meaning this is effectively `utf8` by default). (**Note:** if you expect binary data, you should set `encoding: null`.)
 
 <!-- TODO
 - `gzip` - if `true`, add an `Accept-Encoding` header to request compressed content encodings from the server (if not already present) and decode supported content encodings in the response. **Note:** Automatic decoding of the response content is performed on the body data returned through `request` (both through the `request` stream and passed to the callback function) but is not performed on the `response` stream (available from the `response` event) which is the unmodified `http.IncomingMessage` object which may contain compressed data. See example below.
@@ -143,39 +419,42 @@ instead, it **returns a wrapper** that has your default settings applied to it.
 `request.defaults` to add/override defaults that were previously defaulted.
 
 For example:
+
 ```js
 //requests using baseRequest() will set the 'x-token' header
 var baseRequest = request.defaults({
-  headers: {'x-token': 'my-token'}
+    headers: { 'x-token': 'my-token' }
-})
+});
 
 //requests using specialRequest() will include the 'x-token' header set in
 //baseRequest and will also include the 'special' header
 var specialRequest = baseRequest.defaults({
-  headers: {special: 'special value'}
+    headers: { special: 'special value' }
-})
+});
 ```
 
 ### request.METHOD()
 
 These HTTP method convenience functions act just like `request()` but with a default method already set for you:
 
-- *request.get()*: Defaults to `method: "GET"`.
+-   _request.get()_: Defaults to `method: "GET"`.
-- *request.post()*: Defaults to `method: "POST"`.
+-   _request.post()_: Defaults to `method: "POST"`.
-- *request.put()*: Defaults to `method: "PUT"`.
+-   _request.put()_: Defaults to `method: "PUT"`.
-- *request.patch()*: Defaults to `method: "PATCH"`.
+-   _request.patch()_: Defaults to `method: "PATCH"`.
-- *request.del() / request.delete()*: Defaults to `method: "DELETE"`.
+-   _request.del() / request.delete()_: Defaults to `method: "DELETE"`.
-- *request.head()*: Defaults to `method: "HEAD"`.
+-   _request.head()_: Defaults to `method: "HEAD"`.
-- *request.options()*: Defaults to `method: "OPTIONS"`.
+-   _request.options()_: Defaults to `method: "OPTIONS"`.
+
+---
 
 ## Debugging
 
 There are at least <!--three--> two ways to debug the operation of `request`:
 
-1. Launch the node process like `NODE_DEBUG=urequest node script.js`
+1. Launch the node process like `NODE_DEBUG=@root/request node script.js`
    (`lib,request,otherlib` works too).
 
-2. Set `require('@coolaj86/urequest').debug = true` at any time (this does the same thing
+2. Set `require('@root/request').debug = true` at any time (this does the same thing
    as #1).
 
 <!-- TODO

examples/follow-redirect.js

@@ -5,12 +5,15 @@ var request = require('../');
 
 // will redirect to https://www.github.com and then https://github.com
 //request('http://www.github.com', function (error, response, body) {
-request({ uri: { protocol: 'http:', hostname: 'www.github.com' } }, function (error, response, body) {
+request(
-  if (error) {
+    { uri: { protocol: 'http:', hostname: 'www.github.com' } },
-    console.log('error:', error); // Print the error if one occurred
+    function (error, response, body) {
-    return;
+        if (error) {
-  }
+            console.log('error:', error); // Print the error if one occurred
-  console.log('statusCode:', response.statusCode); // The final statusCode
+            return;
-  console.log('Final href:', response.request.uri.href); // The final URI
+        }
-  console.log('Body Length:', body.length); // body length
+        console.log('statusCode:', response.statusCode); // The final statusCode
-});
+        console.log('Final href:', response.request.uri.href); // The final URI
+        console.log('Body Length:', body.length); // body length
+    }
+);

examples/form-data.js

@@ -0,0 +1,31 @@
+'use strict';
+
+//var request = require('@coolaj86/urequest');
+// To check and make sure the outputs are the same
+//var request = require('request');
+var request = require('../');
+
+// will redirect to https://www.github.com and then https://github.com
+//request('http://www.github.com', function (error, response, body) {
+request(
+    //{ url: 'http://postb.in/syfxxnko'
+    {
+        url: 'http://localhost:3007/form-data/',
+        method: 'POST',
+        headers: { 'X-Foo': 'Bar' },
+        formData: {
+            foo: 'bar',
+            baz: require('fs').createReadStream(
+                require('path').join(__dirname, 'get-to-json.js')
+            )
+        }
+    },
+    function (error, response, body) {
+        if (error) {
+            console.log('error:', error); // Print the error if one occurred
+            return;
+        }
+        console.log('statusCode:', response.statusCode); // The final statusCode
+        console.log('Body Length:', body.length); // body length
+    }
+);

examples/get-to-json.js

@@ -3,10 +3,10 @@
 //var request = require('urequest');
 var request = require('../');
 request('https://www.google.com', function (error, response, body) {
-  if (error) {
+    if (error) {
-    console.log('error:', error); // Print the error if one occurred
+        console.log('error:', error); // Print the error if one occurred
-    return;
+        return;
-  }
+    }
-  console.log('response.toJSON()');
+    console.log('response.toJSON()');
-  console.log(response.toJSON());
+    console.log(response.toJSON());
 });

examples/http-string.js

@@ -3,7 +3,7 @@
 //var request = require('urequest');
 var request = require('../');
 request('http://www.google.com', function (error, response, body) {
-  console.log('error:', error); // Print the error if one occurred
+    console.log('error:', error); // Print the error if one occurred
-  console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
+    console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
-  console.log('body:', body); // Print the HTML for the Google homepage.
+    console.log('body:', body); // Print the HTML for the Google homepage.
 });

examples/https-string.js

@@ -3,7 +3,7 @@
 //var request = require('urequest');
 var request = require('../');
 request('https://www.google.com', function (error, response, body) {
-  console.log('error:', error); // Print the error if one occurred
+    console.log('error:', error); // Print the error if one occurred
-  console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
+    console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
-  console.log('body:', body); // Print the HTML for the Google homepage.
+    console.log('body:', body); // Print the HTML for the Google homepage.
 });

examples/no-follow-redirect.js

@@ -4,13 +4,16 @@
 var request = require('../');
 
 // would normally redirect to https://www.github.com and then https://github.com
-request({ uri: 'https://www.github.com', followRedirect: false }, function (error, response, body) {
+request(
-  if (error) {
+    { uri: 'https://www.github.com', followRedirect: false },
-    console.log('error:', error); // Print the error if one occurred
+    function (error, response, body) {
-    return;
+        if (error) {
-  }
+            console.log('error:', error); // Print the error if one occurred
-  console.log('href:', response.request.uri.href); // The final URI
+            return;
-  console.log('statusCode:', response.statusCode); // Should be 301 or 302
+        }
-  console.log('Location:', response.headers.location); // The redirect
+        console.log('href:', response.request.uri.href); // The final URI
-  console.log('Body:', body || JSON.stringify(body));
+        console.log('statusCode:', response.statusCode); // Should be 301 or 302
-});
+        console.log('Location:', response.headers.location); // The redirect
+        console.log('Body:', body || JSON.stringify(body));
+    }
+);

examples/postbin.js

@@ -0,0 +1,15 @@
+'use strict';
+
+var request = require('../');
+request({
+    url: 'https://postb.in/1588134650162-6019286897499?hello=world'
+    //headers: { 'user-agent': false } // remove
+    //headers: { 'user-agent': 'test/1.0' } // overwrite
+    //userAgent: 'test/1.1' // add to the default
+})
+    .then(function (resp) {
+        console.log(resp.body);
+    })
+    .catch(function (err) {
+        console.error(err);
+    });

examples/stream-to-file.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var request = require('../');
+
+async function main() {
+    var tpath = '/tmp/google-index.html';
+    var resp = await request({
+        url: 'https://google.com',
+        encoding: null,
+        stream: tpath
+    });
+    console.log('[Response Headers]');
+    console.log(resp.toJSON().headers);
+
+    //console.error(resp.headers, resp.body.byteLength);
+    await resp.stream;
+    console.log('[Response Body] written to', tpath);
+}
+
+main()
+    .then(function () {
+        console.log('Pass');
+    })
+    .catch(function (e) {
+        console.error('Fail');
+        console.error(e.stack);
+    });

examples/stream.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var request = require('../');
+
+async function main() {
+    var tpath = '/tmp/google-index.html';
+    var resp = await request({
+        url: 'https://google.com',
+        encoding: null,
+        stream: true
+    });
+    console.log('[Response Headers]');
+    console.log(resp.toJSON().headers);
+
+    resp.on('data', function (chunk) {
+	    console.log('[Data]', chunk.byteLength);
+    });
+    resp.on('end', function (chunk) {
+	    console.log('[End]');
+    });
+
+    //console.error(resp.headers, resp.body.byteLength);
+    await resp.stream;
+    console.log('[Close]');
+}
+
+main()
+    .then(function () {
+        console.log('Pass');
+    })
+    .catch(function (e) {
+        console.error('Fail');
+        console.error(e.stack);
+    });

examples/www-form.js

@@ -0,0 +1,26 @@
+'use strict';
+
+//var request = require('@coolaj86/urequest');
+// To check and make sure the outputs are the same
+//var request = require('request');
+var request = require('../');
+
+// will redirect to https://www.github.com and then https://github.com
+//request('http://www.github.com', function (error, response, body) {
+request(
+    {
+        url: 'http://postb.in/2meyt50C',
+        method: 'POST',
+        headers: { 'X-Foo': 'Bar' },
+        form: { foo: 'bar', baz: 'qux' }
+    },
+    function (error, response, body) {
+        if (error) {
+            console.log('error:', error); // Print the error if one occurred
+            return;
+        }
+        console.log('statusCode:', response.statusCode); // The final statusCode
+        console.log('Body Length:', body.length); // body length
+        console.log('Response:', response.toJSON()); // body length
+    }
+);

index.js

@@ -3,324 +3,683 @@
 var http = require('http');
 var https = require('https');
 var url = require('url');
+var os = require('os');
+var pkg = require('./package.json');
+var fs = require('fs'); // only for streams
 
 function debug() {
-  if (module.exports.debug) {
+    if (module.exports.debug) {
-    console.log.apply(console, arguments);
+        console.log.apply(console, arguments);
-  }
+    }
 }
 
 function mergeOrDelete(defaults, updates) {
-  Object.keys(defaults).forEach(function (key) {
+    Object.keys(defaults).forEach(function (key) {
-    if (!(key in updates)) {
+        if (!(key in updates)) {
-      updates[key] = defaults[key];
+            updates[key] = defaults[key];
-      return;
+            return;
-    }
+        }
 
-    // neither accept the prior default nor define an explicit value
+        // neither accept the prior default nor define an explicit value
-    // CRDT probs...
+        // CRDT probs...
-    if ('undefined' === typeof updates[key]) {
+        if ('undefined' === typeof updates[key]) {
-      delete updates[key];
+            delete updates[key];
-    } else if ('object' === typeof defaults[key] && 'object' === typeof updates[key]) {
+        } else if (
-      updates[key] = mergeOrDelete(defaults[key], updates[key]);
+            'object' === typeof defaults[key] &&
-    }
+            'object' === typeof updates[key]
-  });
+        ) {
+            updates[key] = mergeOrDelete(defaults[key], updates[key]);
+        }
+    });
 
-  return updates;
+    return updates;
 }
 
+// retrieves an existing header, case-sensitive
+function getHeaderName(reqOpts, header) {
+    var headerNames = {};
+    Object.keys(reqOpts.headers).forEach(function (casedName) {
+        headerNames[casedName.toLowerCase()] = casedName;
+    });
+    // returns the key, which in erroneous cases could be an empty string
+    return headerNames[header.toLowerCase()];
+}
+// returns whether or not a header exists, case-insensitive
 function hasHeader(reqOpts, header) {
-  var headers = {};
+    return 'undefined' !== typeof getHeaderName(reqOpts, header);
-  Object.keys(reqOpts.headers).forEach(function (key) {
-    headers[key.toLowerCase()] = true;
-  });
-  return headers[header.toLowerCase()];
 }
 
 function toJSONifier(keys) {
+    return function () {
+        var obj = {};
+        var me = this;
 
-  return function () {
+        keys.forEach(function (key) {
-    var obj = {};
+            if (me[key] && 'function' === typeof me[key].toJSON) {
-    var me = this;
+                obj[key] = me[key].toJSON();
+            } else {
+                obj[key] = me[key];
+            }
+        });
 
-    keys.forEach(function (key) {
+        return obj;
-      if (me[key] && 'function' === typeof me[key].toJSON) {
+    };
-        obj[key] = me[key].toJSON();
+}
-      } else {
+
-        obj[key] = me[key];
+function setupPipe(resp, opts) {
-      }
+    // make the response await-able
+    var resolve;
+    var reject;
+    var p = new Promise(function (_resolve, _reject) {
+        resolve = _resolve;
+        reject = _reject;
     });
 
-    return obj;
+    // or an existing write stream
-  };
+    if ('function' === typeof opts.stream.pipe) {
+        if (opts.debug) {
+            console.debug('[@root/request] stream piped');
+        }
+        resp.pipe(opts.stream);
+    }
+    resp.once('error', function (e) {
+        if (opts.debug) {
+            console.debug("[@root/request] stream 'error'");
+            console.error(e.stack);
+        }
+        resp.destroy();
+        if ('function' === opts.stream.destroy) {
+            opts.stream.destroy(e);
+        }
+        reject(e);
+    });
+    resp.once('end', function () {
+        if (opts.debug) {
+            console.debug("[@root/request] stream 'end'");
+        }
+        if ('function' === opts.stream.destroy) {
+            opts.stream.end();
+            // this will close the stream (i.e. sync to disk)
+            opts.stream.destroy();
+        }
+    });
+    resp.once('close', function () {
+        if (opts.debug) {
+            console.debug("[@root/request] stream 'close'");
+        }
+        resolve();
+    });
+    return p;
+}
+
+function handleResponse(resp, opts, cb) {
+    // body can be buffer, string, or json
+    if (null === opts.encoding) {
+        resp._body = [];
+    } else {
+        resp.body = '';
+    }
+    resp._bodyLength = 0;
+    resp.on('readable', function () {
+        var chunk;
+        while ((chunk = resp.read())) {
+            if ('string' === typeof resp.body) {
+                resp.body += chunk.toString(opts.encoding);
+            } else {
+                resp._body.push(chunk);
+                resp._bodyLength += chunk.length;
+            }
+        }
+    });
+    resp.once('end', function () {
+        if ('string' !== typeof resp.body) {
+            if (1 === resp._body.length) {
+                resp.body = resp._body[0];
+            } else {
+                resp.body = Buffer.concat(resp._body, resp._bodyLength);
+            }
+            resp._body = null;
+        }
+        if (opts.json && 'string' === typeof resp.body) {
+            // TODO I would parse based on Content-Type
+            // but request.js doesn't do that.
+            try {
+                resp.body = JSON.parse(resp.body);
+            } catch (e) {
+                // ignore
+            }
+        }
+
+        debug('\n[urequest] resp.toJSON():');
+        if (module.exports.debug) {
+            debug(resp.toJSON());
+        }
+        if (opts.debug) {
+            console.debug('[@root/request] Response Body:');
+            console.debug(resp.body);
+        }
+        cb(null, resp, resp.body);
+    });
 }
 
 function setDefaults(defs) {
-  defs = defs || {};
+    defs = defs || {};
 
-  function urequestHelper(opts, cb) {
+    function urequestHelper(opts, cb) {
-    debug("\n[urequest] processed options:");
+        debug('\n[urequest] processed options:');
-    debug(opts);
+        debug(opts);
 
-    function onResponse(resp) {
+        var req;
-      var followRedirect;
+        var finalOpts = {};
 
-      Object.keys(defs).forEach(function (key) {
+        // allow specifying a file
-        if (key in opts && 'undefined' !== typeof opts[key]) {
+        if ('string' === typeof opts.stream) {
-          return;
+            if (opts.debug) {
+                console.debug('[@root/request] creating file write stream');
+            }
+            try {
+                opts.stream = fs.createWriteStream(opts.stream);
+            } catch (e) {
+                cb(e);
+                return;
+            }
         }
-        opts[key] = defs[key];
-      });
-      followRedirect = opts.followRedirect;
 
-      resp.toJSON = toJSONifier([ 'statusCode', 'body', 'headers', 'request' ]);
+        function onResponse(resp) {
+            var followRedirect;
 
-      resp.request = req;
+            Object.keys(defs).forEach(function (key) {
-      resp.request.uri = url.parse(opts.url);
+                if (key in opts && 'undefined' !== typeof opts[key]) {
-      //resp.request.method = opts.method;
+                    return;
-      resp.request.headers = opts.headers;
+                }
-      resp.request.toJSON = toJSONifier([ 'uri', 'method', 'headers' ]);
+                opts[key] = defs[key];
+            });
+            followRedirect = opts.followRedirect;
 
-      if (followRedirect && resp.headers.location && -1 !== [ 301, 302 ].indexOf(resp.statusCode)) {
+            // copied from WHATWG fetch
-        debug('Following redirect: ' + resp.headers.location);
+            resp.ok = false;
-        if ('GET' !== opts.method && !opts.followAllRedirects) {
+            if (resp.statusCode >= 200 && resp.statusCode < 300) {
-          followRedirect = false;
+                resp.ok = true;
+            }
+
+            resp.toJSON = toJSONifier([
+                'statusCode',
+                'body',
+                'ok',
+                'headers',
+                'request'
+            ]);
+
+            resp.request = req;
+            resp.request.uri = url.parse(opts.url);
+            //resp.request.method = opts.method;
+            resp.request.headers = finalOpts.headers;
+            resp.request.toJSON = toJSONifier(['uri', 'method', 'headers']);
+            if (opts.debug) {
+                console.debug('[@root/request] Response Headers:');
+                console.debug(resp.toJSON());
+            }
+
+            if (
+                followRedirect &&
+                resp.headers.location &&
+                -1 !== [301, 302, 307, 308].indexOf(resp.statusCode)
+            ) {
+                debug('Following redirect: ' + resp.headers.location);
+                if ('GET' !== opts.method && !opts.followAllRedirects) {
+                    followRedirect = false;
+                }
+                if (opts._redirectCount >= opts.maxRedirects) {
+                    followRedirect = false;
+                }
+                if ('function' === opts.followRedirect) {
+                    if (!opts.followRedirect(resp)) {
+                        followRedirect = false;
+                    }
+                }
+                if (followRedirect) {
+                    if (!opts.followOriginalHttpMethod) {
+                        opts.method = 'GET';
+                        opts.body = null;
+                        delete opts.headers[
+                            getHeaderName(opts, 'Content-Length')
+                        ];
+                        delete opts.headers[
+                            getHeaderName(opts, 'Transfer-Encoding')
+                        ];
+                    }
+                    if (opts.removeRefererHeader && opts.headers) {
+                        delete opts.headers.referer;
+                    }
+                    // TODO needs baseUrl, maybe test for host / socketPath?
+                    opts.url = resp.headers.location;
+                    opts.uri = url.parse(opts.url);
+                    return urequestHelper(opts, cb);
+                }
+            }
+
+            if (opts.stream) {
+                resp.stream = setupPipe(resp, opts);
+                // can be string, buffer, or json... why not an async function too?
+                resp.stream.body = async function () {
+                    handleResponse(resp, opts, cb);
+                    await resp.stream;
+                    return resp.body;
+                };
+                cb(null, resp);
+                return;
+            }
+
+            handleResponse(resp, opts, cb);
         }
-        if (opts._redirectCount >= opts.maxRedirects) {
+
-          followRedirect = false;
+        var _body;
+        var MyFormData;
+        var form;
+        var formHeaders;
+        var requester;
+
+        if (opts.body) {
+            if (true === opts.json && 'string' !== typeof opts.body) {
+                _body = JSON.stringify(opts.body);
+            } else {
+                _body = opts.body;
+            }
+        } else if (opts.json && true !== opts.json) {
+            _body = JSON.stringify(opts.json);
+        } else if (opts.form) {
+            _body = Object.keys(opts.form)
+                .filter(function (key) {
+                    if ('undefined' !== typeof opts.form[key]) {
+                        return true;
+                    }
+                })
+                .map(function (key) {
+                    return (
+                        encodeURIComponent(key) +
+                        '=' +
+                        encodeURIComponent(String(opts.form[key]))
+                    );
+                })
+                .join('&');
+            opts.headers['Content-Type'] = 'application/x-www-form-urlencoded';
         }
-        if ('function' === opts.followRedirect) {
+        if ('string' === typeof _body) {
-          if (!opts.followRedirect(resp)) {
+            _body = Buffer.from(_body);
-            followRedirect = false;
-          }
         }
-        if (followRedirect) {
+
-          if (!opts.followOriginalHttpMethod) {
+        Object.keys(opts.uri).forEach(function (key) {
-            opts.method = 'GET';
+            finalOpts[key] = opts.uri[key];
-            opts.body = null;
+        });
-          }
+
-          if (opts.removeRefererHeader && opts.headers) {
+        // A bug should be raised if request does it differently,
-            delete opts.headers.referer;
+        // but I think we're supposed to pass all acceptable options
-          }
+        // on to the raw http request
-          // TODO needs baseUrl, maybe test for host / socketPath?
+        [
-          opts.url = resp.headers.location;
+            'family',
-          opts.uri = url.parse(opts.url);
+            'host',
-          return urequestHelper(opts, cb);
+            'localAddress',
+            'agent',
+            'createConnection',
+            'timeout',
+            'setHost'
+        ].forEach(function (key) {
+            if (key in opts) {
+                finalOpts[key] = opts[key];
+            }
+        });
+
+        finalOpts.method = opts.method;
+        finalOpts.headers = JSON.parse(JSON.stringify(opts.headers));
+
+        var uaHeader = getHeaderName(finalOpts, 'User-Agent') || 'User-Agent';
+        // set a default user-agent
+        if (!finalOpts.headers[uaHeader]) {
+            if (false === finalOpts.headers[uaHeader]) {
+                delete finalOpts.headers[uaHeader];
+            } else {
+                finalOpts.headers[uaHeader] = getUserAgent(opts.userAgent);
+            }
         }
-      }
+        if (_body) {
-      if (null === opts.encoding) {
+            // Most APIs expect (or require) Content-Length except in the case of multipart uploads
-        resp._body = [];
+            // Transfer-Encoding: Chunked (the default) is generally only well-supported downstream
-      } else {
+            if (
-        resp.body = '';
+                'undefined' !== typeof _body.byteLength ||
-      }
+                'undefined' !== typeof _body.length
-      resp._bodyLength = 0;
+            ) {
-      resp.on('data', function (chunk) {
+                finalOpts.headers['Content-Length'] =
-        if ('string' === typeof resp.body) {
+                    _body.byteLength || _body.length;
-          resp.body += chunk.toString(opts.encoding);
+            }
+        }
+        if (opts.auth) {
+            // if opts.uri specifies auth it will be parsed by url.parse and passed directly to the http module
+            if ('string' !== typeof opts.auth) {
+                opts.auth =
+                    (opts.auth.user || opts.auth.username || '') +
+                    ':' +
+                    (opts.auth.pass || opts.auth.password || '');
+            }
+            if ('string' === typeof opts.auth) {
+                finalOpts.auth = opts.auth;
+            }
+            if (false === opts.sendImmediately) {
+                console.warn(
+                    '[Warn] setting `sendImmediately: false` is not yet supported. Please open an issue if this is an important feature that you need.'
+                );
+            }
+            // [request-compat]
+            if (opts.auth.bearer) {
+                // having a shortcut for base64 encoding makes sense, but this? Eh, whatevs...
+                finalOpts.header.Authorization = 'Bearer ' + opts.auth.bearer;
+            }
+        }
+        if (opts.formData) {
+            try {
+                MyFormData = opts.FormData || require('form-data');
+                // potential options https://github.com/felixge/node-combined-stream/blob/master/lib/combined_stream.js#L7-L15
+            } catch (e) {
+                console.error(
+                    'urequest does not include extra dependencies by default'
+                );
+                console.error(
+                    "if you need to use 'form-data' you may install it, like so:"
+                );
+                console.error('  npm install --save form-data');
+                cb(e);
+                return;
+            }
+            try {
+                form = new MyFormData();
+                Object.keys(opts.formData).forEach(function (key) {
+                    function add(key, data, opts) {
+                        if (data.value) {
+                            opts = data.options;
+                            data = data.value;
+                        }
+                        form.append(key, data, opts);
+                    }
+                    if (Array.isArray(opts.formData[key])) {
+                        opts.formData[key].forEach(function (data) {
+                            add(key, data);
+                        });
+                    } else {
+                        add(key, opts.formData[key]);
+                    }
+                });
+            } catch (e) {
+                cb(e);
+                return;
+            }
+            formHeaders = form.getHeaders();
+            Object.keys(formHeaders).forEach(function (header) {
+                finalOpts.headers[header] = formHeaders[header];
+            });
+        }
+
+        // TODO support unix sockets
+        if ('https:' === finalOpts.protocol) {
+            // https://nodejs.org/api/https.html#https_https_request_options_callback
+            debug('\n[urequest] https.request(opts):');
+            debug(finalOpts);
+            requester = https;
+        } else if ('http:' === finalOpts.protocol) {
+            // https://nodejs.org/api/http.html#http_http_request_options_callback
+            debug('\n[urequest] http.request(opts):');
+            debug(finalOpts);
+            requester = http;
         } else {
-          resp._body.push(chunk);
+            cb(new Error("unknown protocol: '" + opts.uri.protocol + "'"));
-          resp._bodyLength += chunk.length;
+            return;
-        }
-      });
-      resp.on('end', function () {
-        if ('string' !== typeof resp.body) {
-          if (1 === resp._body.length) {
-            resp.body = resp._body[0];
-          } else {
-            resp.body = Buffer.concat(resp._body, resp._bodyLength);
-          }
-          resp._body = null;
-        }
-        if (opts.json && 'string' === typeof resp.body) {
-          // TODO I would parse based on Content-Type
-          // but request.js doesn't do that.
-          try {
-            resp.body = JSON.parse(resp.body);
-          } catch(e) {
-            // ignore
-          }
         }
 
-        debug("\n[urequest] resp.toJSON():");
+        if (form) {
-        debug(resp.toJSON());
+            debug("\n[urequest] '" + finalOpts.method + "' (request) form");
-        cb(null, resp, resp.body);
+            debug(formHeaders);
-      });
+            // generally uploads don't use Chunked Encoding (some systems have issues with it)
+            // and I don't want to do the work to calculate the content-lengths. This seems to work.
+            req = form.submit(finalOpts, function (err, resp) {
+                if (err) {
+                    cb(err);
+                    return;
+                }
+                onResponse(resp);
+                resp.resume();
+            });
+            //req = requester.request(finalOpts, onResponse);
+            //req.on('error', cb);
+            //form.pipe(req);
+            return;
+        }
+
+        if (opts.debug) {
+            console.debug('');
+            console.debug('[@root/request] Request Options:');
+            console.debug(finalOpts);
+            if (_body) {
+                console.debug('[@root/request] Request Body:');
+                console.debug(
+                    opts.body || opts.form || opts.formData || opts.json
+                );
+            }
+        }
+        req = requester.request(finalOpts, onResponse);
+        req.once('error', cb);
+
+        if (_body) {
+            debug("\n[urequest] '" + finalOpts.method + "' (request) body");
+            debug(_body);
+            if ('function' === typeof _body.pipe) {
+                // used for chunked encoding
+                _body.pipe(req);
+                _body.once('error', function (err) {
+                    // https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
+                    // if the Readable stream emits an error during processing,
+                    // the Writable destination is not closed automatically
+                    _body.destroy();
+                    req.destroy(err);
+                });
+            } else {
+                // used for known content-length
+                req.end(_body);
+            }
+        } else {
+            req.end();
+        }
     }
 
-    var req;
+    function parseUrl(str) {
-    var finalOpts = {};
+        var obj = url.parse(str);
-    var _body;
+        var paths;
+        if ('unix' !== (obj.hostname || obj.host || '').toLowerCase()) {
+            return obj;
+        }
 
-    if (opts.body) {
+        obj.href = null;
-      if (true === opts.json) {
+        obj.hostname = obj.host = null;
-        _body = JSON.stringify(opts.body);
+
-      } else {
+        paths = (obj.pathname || obj.path || '').split(':');
-        _body = opts.body;
+
-      }
+        obj.socketPath = paths.shift();
-    } else if (opts.json && true !== opts.json) {
+        obj.pathname = obj.path = paths.join(':');
-      _body = JSON.stringify(opts.json);
+
-    }
+        return obj;
-    if ('string' === typeof _body) {
-      _body = Buffer.from(_body);
     }
 
-    Object.keys(opts.uri).forEach(function (key) {
+    function urequest(opts, cb) {
-      finalOpts[key] = opts.uri[key];
+        debug('\n[urequest] received options:');
-    });
+        debug(opts);
-    finalOpts.method = opts.method;
+        var reqOpts = {};
-    finalOpts.headers = opts.headers;
+        // request.js behavior:
-    if (_body) {
+        // encoding: null + json ? unknown
-      // Most APIs expect (or require) Content-Length except in the case of multipart uploads
+        // json => attempt to parse, fail silently
-      // chunked is generally only well-supported downstream
+        // encoding => buffer.toString(encoding)
-      //finalOpts.headers['Content-Length'] = _body.byteLength || _body.length;
+        // null === encoding => Buffer.concat(buffers)
+        if ('string' === typeof opts) {
+            opts = { url: opts };
+        }
+
+        module.exports._keys.forEach(function (key) {
+            if (key in opts && 'undefined' !== typeof opts[key]) {
+                reqOpts[key] = opts[key];
+            } else if (key in defs) {
+                reqOpts[key] = defs[key];
+            }
+        });
+
+        // TODO url.resolve(defs.baseUrl, opts.url);
+        if ('string' === typeof opts.url || 'string' === typeof opts.uri) {
+            if ('string' === typeof opts.url) {
+                reqOpts.url = opts.url;
+                reqOpts.uri = parseUrl(opts.url);
+            } else if ('string' === typeof opts.uri) {
+                reqOpts.url = opts.uri;
+                reqOpts.uri = parseUrl(opts.uri);
+            }
+        } else {
+            if ('object' === typeof opts.uri) {
+                reqOpts.url = url.format(opts.uri);
+                reqOpts.uri = opts.uri;
+                //reqOpts.uri = url.parse(reqOpts.uri);
+            } else if ('object' === typeof opts.url) {
+                reqOpts.url = url.format(opts.url);
+                reqOpts.uri = opts.url;
+                //reqOpts.uri = url.parse(reqOpts.url);
+            }
+        }
+
+        if (
+            opts.body ||
+            (opts.json && true !== opts.json) ||
+            opts.form ||
+            opts.formData
+        ) {
+            // TODO this is probably a deviation from request's API
+            // need to check and probably eliminate it
+            reqOpts.method = (reqOpts.method || 'POST').toUpperCase();
+        } else {
+            reqOpts.method = (reqOpts.method || 'GET').toUpperCase();
+        }
+        if (!reqOpts.headers) {
+            reqOpts.headers = {};
+        }
+
+        // crazy case for easier testing
+        if (!hasHeader(reqOpts, 'CoNTeNT-TyPe')) {
+            if (
+                (true === reqOpts.json && reqOpts.body) ||
+                (true !== reqOpts.json && reqOpts.json)
+            ) {
+                reqOpts.headers['Content-Type'] = 'application/json';
+            }
+        }
+
+        if (opts.debug) {
+            reqOpts.debug = opts.debug;
+        }
+        return urequestHelper(reqOpts, cb);
     }
 
-    // TODO support unix sockets
+    function smartPromisify(fn) {
-    if ('https:' === finalOpts.protocol) {
+        return function (opts) {
-      // https://nodejs.org/api/https.html#https_https_request_options_callback
+            var cb;
-      debug("\n[urequest] https.request(opts):");
+            if ('function' === typeof arguments[1]) {
-      debug(finalOpts);
+                cb = Array.prototype.slice.call(arguments)[1];
-      req = https.request(finalOpts, onResponse);
+                return fn(opts, cb);
-    } else if ('http:' === finalOpts.protocol) {
+            }
-      // https://nodejs.org/api/http.html#http_http_request_options_callback
+            return new Promise(function (resolve, reject) {
-      debug("\n[urequest] http.request(opts):");
+                fn(opts, function (err, resp) {
-      debug(finalOpts);
+                    if (err) {
-      req = http.request(finalOpts, onResponse);
+                        err._response = resp;
-    } else {
+                        reject(err);
-      cb(new Error("unknown protocol: '" + opts.uri.protocol + "'"));
+                        return;
-      return;
+                    }
+                    resolve(resp);
+                });
+            });
+        };
     }
 
-    req.on('error', function (e) {
+    var smartUrequest = smartPromisify(urequest);
-      cb(e);
-    });
 
-    if (_body) {
+    smartUrequest.defaults = function (_defs) {
-      debug("\n[urequest] '" + finalOpts.method + "' (request) body");
+        _defs = mergeOrDelete(defs, _defs);
-      debug(_body);
+        return setDefaults(_defs);
-      // used for chunked encoding
-      //req.write(_body);
-      // used for known content-length
-      req.end(_body);
-    } else {
-      req.end();
-    }
-  }
-
-  function parseUrl(str) {
-    var obj = url.parse(str);
-    var paths;
-    if ('unix' !== (obj.hostname||obj.host||'').toLowerCase()) {
-      return obj;
-    }
-
-    obj.href = null;
-    obj.hostname = obj.host = null;
-
-    paths = (obj.pathname||obj.path||'').split(':');
-
-    obj.socketPath = paths.shift();
-    obj.pathname = obj.path = paths.join(':');
-
-    return obj;
-  }
-
-  function urequest(opts, cb) {
-    debug("\n[urequest] received options:");
-    debug(opts);
-    var reqOpts = {};
-    // request.js behavior:
-    // encoding: null + json ? unknown
-    // json => attempt to parse, fail silently
-    // encoding => buffer.toString(encoding)
-    // null === encoding => Buffer.concat(buffers)
-    if ('string' === typeof opts) {
-      opts = { url: opts };
-    }
-
-    module.exports._keys.forEach(function (key) {
-      if (key in opts && 'undefined' !== typeof opts[key]) {
-        reqOpts[key] = opts[key];
-      } else if (key in defs) {
-        reqOpts[key] = defs[key];
-      }
-    });
-
-    // TODO url.resolve(defs.baseUrl, opts.url);
-    if ('string' === typeof opts.url || 'string' === typeof opts.uri) {
-      if ('string' === typeof opts.url) {
-        reqOpts.url = opts.url;
-        reqOpts.uri = parseUrl(opts.url);
-      } else if ('string' === typeof opts.uri) {
-        reqOpts.url = opts.uri;
-        reqOpts.uri = parseUrl(opts.uri);
-      }
-    } else {
-      if ('object' === typeof opts.uri) {
-        reqOpts.url = url.format(opts.uri);
-        reqOpts.uri = opts.uri;
-        //reqOpts.uri = url.parse(reqOpts.uri);
-      } else if ('object' === typeof opts.url) {
-        reqOpts.url = url.format(opts.url);
-        reqOpts.uri = opts.url;
-        //reqOpts.uri = url.parse(reqOpts.url);
-      }
-    }
-
-    reqOpts.method = (reqOpts.method || 'GET').toUpperCase();
-    reqOpts.headers = reqOpts.headers || {};
-
-    // crazy case for easier testing
-    if (!hasHeader(reqOpts, 'CoNTeNT-TyPe')) {
-      if ((true === reqOpts.json && reqOpts.body)
-        || (true !== reqOpts.json && reqOpts.json)) {
-        reqOpts.headers['Content-Type'] = 'application/json';
-      }
-    }
-
-    return urequestHelper(reqOpts, cb);
-  }
-
-  urequest.defaults = function (_defs) {
-    _defs = mergeOrDelete(defs, _defs);
-    return setDefaults(_defs);
-  };
-  [ 'get', 'put', 'post', 'patch', 'delete', 'head', 'options' ].forEach(function (method) {
-    urequest[method] = function (obj) {
-      if ('string' === typeof obj) {
-        obj = { url: obj };
-      }
-      obj.method = method.toUpperCase();
-      urequest(obj);
     };
-  });
+    ['get', 'put', 'post', 'patch', 'delete', 'head', 'options'].forEach(
-  urequest.del = urequest.delete;
+        function (method) {
+            smartUrequest[method] = smartPromisify(function (obj, cb) {
+                if ('string' === typeof obj) {
+                    obj = { url: obj };
+                }
+                obj.method = method.toUpperCase();
+                urequest(obj, cb);
+            });
+        }
+    );
+    smartUrequest.del = urequest.delete;
 
-  return urequest;
+    return smartUrequest;
+}
+
+var nodeUa =
+    '@root+request/' +
+    pkg.version +
+    ' ' +
+    process.release.name +
+    '/' +
+    process.version +
+    ' ' +
+    os.platform() +
+    '/' +
+    os.release() +
+    ' ' +
+    os.type() +
+    '/' +
+    process.arch;
+function getUserAgent(additional) {
+    // See https://tools.ietf.org/html/rfc8555#section-6.1
+    // And https://tools.ietf.org/html/rfc7231#section-5.5.3
+    // And https://community.letsencrypt.org/t/user-agent-flag-explained/3843/2
+
+    var ua = nodeUa;
+    if (additional) {
+        ua = additional + ' ' + ua;
+    }
+
+    return ua;
 }
 
 var _defaults = {
-  sendImmediately: true
+    sendImmediately: true,
-, method: 'GET'
+    method: '',
-, headers: {}
+    headers: {},
-, useQuerystring: false
+    useQuerystring: false,
-, followRedirect: true
+    followRedirect: true,
-, followAllRedirects: false
+    followAllRedirects: false,
-, followOriginalHttpMethod: false
+    followOriginalHttpMethod: false,
-, maxRedirects: 10
+    maxRedirects: 10,
-, removeRefererHeader: false
+    removeRefererHeader: false,
-//, encoding: undefined
+    // encoding: undefined,
-, gzip: false
+    // stream: false, // TODO allow a stream?
-//, body: undefined
+    gzip: false
-//, json: undefined
+    //, body: undefined
+    //, json: undefined
 };
 module.exports = setDefaults(_defaults);
 
 module.exports._keys = Object.keys(_defaults).concat([
-  'encoding'
+    'encoding',
-, 'body'
+    'stream',
-, 'json'
+    'body',
+    'json',
+    'form',
+    'auth',
+    'formData',
+    'FormData',
+    'userAgent' // non-standard for request.js
 ]);
-module.exports.debug = (-1 !== (process.env.NODE_DEBUG||'').split(/\s+/g).indexOf('urequest'));
+module.exports.debug =
+    -1 !== (process.env.NODE_DEBUG || '').split(/\s+/g).indexOf('urequest');
 
-debug("DEBUG ON for urequest");
+debug('DEBUG ON for urequest');

package-lock.json

@@ -0,0 +1,5 @@
+{
+    "name": "@root/request",
+    "version": "1.8.2",
+    "lockfileVersion": 1
+}

package.json

@@ -1,26 +1,29 @@
 {
-  "name": "@coolaj86/urequest",
+    "name": "@root/request",
-  "version": "1.1.4",
+    "version": "1.8.2",
-  "description": "A lightweight drop-in replacement for request",
+    "description": "A lightweight, zero-dependency drop-in replacement for request",
-  "main": "index.js",
+    "main": "index.js",
-  "directories": {
+    "files": [
-    "example": "examples"
+        "lib"
-  },
+    ],
-  "scripts": {
+    "directories": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+        "example": "examples"
-  },
+    },
-  "repository": {
+    "scripts": {
-    "type": "git",
+        "test": "echo \"Error: no test specified\" && exit 1"
-    "url": "https://git.ppl.family/ppl/urequest.js.git"
+    },
-  },
+    "repository": {
-  "keywords": [
+        "type": "git",
-    "request",
+        "url": "https://git.rootprojects.org/root/request.js.git"
-    "lightweight",
+    },
-    "alternative",
+    "keywords": [
-    "http",
+        "request",
-    "https",
+        "lightweight",
-    "call"
+        "alternative",
-  ],
+        "http",
-  "author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
+        "https",
-  "license": "(MIT OR Apache-2.0)"
+        "call"
+    ],
+    "author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
+    "license": "(MIT OR Apache-2.0)"
 }

tests/tcp-listener.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var net = require('net');
+var server = net.createServer(function (socket) {
+    socket.on('data', function (chunk) {
+        console.info(chunk.toString('utf8'));
+    });
+});
+server.listen(3007, function () {
+    console.info('Listening on', this.address());
+});