mirror of
https://github.com/therootcompany/request.js.git
synced 2024-11-16 17:28:58 +00:00
Compare commits
No commits in common. "master" and "v1.1.0" have entirely different histories.
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,2 +0,0 @@
|
||||
node_modules
|
||||
.*.sw*
|
||||
22
.jshintrc
22
.jshintrc
@ -1,22 +0,0 @@
|
||||
{
|
||||
"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
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"bracketSpacing": true,
|
||||
"printWidth": 80,
|
||||
"singleQuote": true,
|
||||
"tabWidth": 4,
|
||||
"trailingComma": "none",
|
||||
"useTabs": false
|
||||
}
|
||||
@ -1,6 +0,0 @@
|
||||
# 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)
|
||||
65
EXTRA.md
65
EXTRA.md
@ -1,65 +0,0 @@
|
||||
# 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 }
|
||||
});
|
||||
```
|
||||
366
README.md
366
README.md
@ -1,25 +1,19 @@
|
||||
# [@root/request](https://git.rootprojects.org/root/request.js) | a [Root](https://rootprojects.org) project
|
||||
# µRequest - Minimalist HTTP client
|
||||
|
||||
> Minimalist HTTP client
|
||||
A lightweight alternative to (and drop-in replacement for) request.
|
||||
|
||||
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.
|
||||
Written from scratch.
|
||||
|
||||
## Super simple to use
|
||||
|
||||
@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.
|
||||
µRequest is designed to be a drop-in replacement for request. It supports HTTPS and follows redirects by default.
|
||||
|
||||
```bash
|
||||
npm install --save @root/request
|
||||
|
||||
# or npm install git+ssh://git@git.therootcompany.com/request.js
|
||||
npm install --save @coolaj86/urequest
|
||||
```
|
||||
|
||||
```js
|
||||
var request = require('@root/request');
|
||||
var request = require('@coolaj86/urequest');
|
||||
request('http://www.google.com', function (error, response, body) {
|
||||
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
|
||||
@ -27,327 +21,6 @@ request('http://www.google.com', function (error, response, body) {
|
||||
});
|
||||
```
|
||||
|
||||
**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
|
||||
|
||||
- [Extra Features](/EXTRA.md)
|
||||
- [Forms](#forms)
|
||||
- [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
|
||||
|
||||
HTTP Headers, such as `User-Agent`, can be set in the `options` object.
|
||||
In the example below, we call the github API to find out the number
|
||||
of stars and forks for the request repository. This requires a
|
||||
custom `User-Agent` header as well as https.
|
||||
|
||||
```js
|
||||
var request = require('request');
|
||||
|
||||
var options = {
|
||||
url: 'https://api.github.com/repos/request/request',
|
||||
headers: {
|
||||
'User-Agent': 'request'
|
||||
}
|
||||
};
|
||||
|
||||
function callback(error, response, body) {
|
||||
if (!error && response.statusCode == 200) {
|
||||
var info = JSON.parse(body);
|
||||
console.log(info.stargazers_count + ' Stars');
|
||||
console.log(info.forks_count + ' Forks');
|
||||
}
|
||||
}
|
||||
|
||||
request(options, callback);
|
||||
```
|
||||
|
||||
[back to top](#table-of-contents)
|
||||
|
||||
---
|
||||
|
||||
## UNIX Domain Sockets
|
||||
|
||||
`@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';
|
||||
/* 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.
|
||||
|
||||
[back to top](#table-of-contents)
|
||||
|
||||
---
|
||||
|
||||
## request(options, callback)
|
||||
@ -419,42 +92,39 @@ 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'}
|
||||
});
|
||||
})
|
||||
|
||||
//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'}
|
||||
});
|
||||
})
|
||||
```
|
||||
|
||||
### 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.post()_: Defaults to `method: "POST"`.
|
||||
- _request.put()_: Defaults to `method: "PUT"`.
|
||||
- _request.patch()_: Defaults to `method: "PATCH"`.
|
||||
- _request.del() / request.delete()_: Defaults to `method: "DELETE"`.
|
||||
- _request.head()_: Defaults to `method: "HEAD"`.
|
||||
- _request.options()_: Defaults to `method: "OPTIONS"`.
|
||||
|
||||
---
|
||||
- *request.get()*: Defaults to `method: "GET"`.
|
||||
- *request.post()*: Defaults to `method: "POST"`.
|
||||
- *request.put()*: Defaults to `method: "PUT"`.
|
||||
- *request.patch()*: Defaults to `method: "PATCH"`.
|
||||
- *request.del() / request.delete()*: Defaults to `method: "DELETE"`.
|
||||
- *request.head()*: Defaults to `method: "HEAD"`.
|
||||
- *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=@root/request node script.js`
|
||||
1. Launch the node process like `NODE_DEBUG=urequest node script.js`
|
||||
(`lib,request,otherlib` works too).
|
||||
|
||||
2. Set `require('@root/request').debug = true` at any time (this does the same thing
|
||||
2. Set `require('@coolaj86/urequest').debug = true` at any time (this does the same thing
|
||||
as #1).
|
||||
|
||||
<!-- TODO
|
||||
@ -463,5 +133,3 @@ There are at least <!--three--> two ways to debug the operation of `request`:
|
||||
|
||||
[back to top](#table-of-contents)
|
||||
-->
|
||||
|
||||
[back to top](#table-of-contents)
|
||||
|
||||
@ -5,9 +5,7 @@ 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({ uri: { protocol: 'http:', hostname: 'www.github.com' } }, function (error, response, body) {
|
||||
if (error) {
|
||||
console.log('error:', error); // Print the error if one occurred
|
||||
return;
|
||||
@ -15,5 +13,4 @@ request(
|
||||
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
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
@ -1,31 +0,0 @@
|
||||
'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
|
||||
}
|
||||
);
|
||||
@ -4,9 +4,7 @@
|
||||
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({ uri: 'https://www.github.com', followRedirect: false }, function (error, response, body) {
|
||||
if (error) {
|
||||
console.log('error:', error); // Print the error if one occurred
|
||||
return;
|
||||
@ -15,5 +13,4 @@ request(
|
||||
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));
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
'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);
|
||||
});
|
||||
@ -1,27 +0,0 @@
|
||||
'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);
|
||||
});
|
||||
@ -1,34 +0,0 @@
|
||||
'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);
|
||||
});
|
||||
@ -1,26 +0,0 @@
|
||||
'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
|
||||
}
|
||||
);
|
||||
626
index.js
626
index.js
@ -3,9 +3,6 @@
|
||||
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) {
|
||||
@ -24,10 +21,7 @@ function mergeOrDelete(defaults, updates) {
|
||||
// CRDT probs...
|
||||
if ('undefined' === typeof updates[key]) {
|
||||
delete updates[key];
|
||||
} else if (
|
||||
'object' === typeof defaults[key] &&
|
||||
'object' === typeof updates[key]
|
||||
) {
|
||||
} else if ('object' === typeof defaults[key] && 'object' === typeof updates[key]) {
|
||||
updates[key] = mergeOrDelete(defaults[key], updates[key]);
|
||||
}
|
||||
});
|
||||
@ -35,20 +29,6 @@ function mergeOrDelete(defaults, 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) {
|
||||
return 'undefined' !== typeof getHeaderName(reqOpts, header);
|
||||
}
|
||||
|
||||
function toJSONifier(keys) {
|
||||
return function () {
|
||||
var obj = {};
|
||||
@ -66,72 +46,73 @@ function toJSONifier(keys) {
|
||||
};
|
||||
}
|
||||
|
||||
function setupPipe(resp, opts) {
|
||||
// make the response await-able
|
||||
var resolve;
|
||||
var reject;
|
||||
var p = new Promise(function (_resolve, _reject) {
|
||||
resolve = _resolve;
|
||||
reject = _reject;
|
||||
});
|
||||
function setDefaults(defs) {
|
||||
defs = defs || {};
|
||||
|
||||
// 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 urequestHelper(opts, cb) {
|
||||
debug("[urequest] processed options:");
|
||||
debug(opts);
|
||||
|
||||
function handleResponse(resp, opts, cb) {
|
||||
// body can be buffer, string, or json
|
||||
function onResponse(resp) {
|
||||
var followRedirect;
|
||||
|
||||
Object.keys(defs).forEach(function (key) {
|
||||
if (key in opts && 'undefined' !== typeof opts[key]) {
|
||||
return;
|
||||
}
|
||||
opts[key] = defs[key];
|
||||
});
|
||||
followRedirect = opts.followRedirect;
|
||||
|
||||
resp.toJSON = toJSONifier([ 'statusCode', 'body', 'headers', 'request' ]);
|
||||
|
||||
resp.request = req;
|
||||
resp.request.uri = url.parse(opts.url);
|
||||
//resp.request.method = opts.method;
|
||||
resp.request.headers = opts.headers;
|
||||
resp.request.toJSON = toJSONifier([ 'uri', 'method', 'headers' ]);
|
||||
|
||||
if (resp.headers.location && opts.followRedirect) {
|
||||
debug('Following redirect: ' + resp.headers.location);
|
||||
if (opts.followAllRedirects || -1 !== [ 301, 302 ].indexOf(resp.statusCode)) {
|
||||
followRedirect = true;
|
||||
}
|
||||
if (opts._redirectCount >= opts.maxRedirects) {
|
||||
followRedirect = false;
|
||||
}
|
||||
if ('function' === opts.followRedirect) {
|
||||
if (!opts.followRedirect(resp)) {
|
||||
followRedirect = false;
|
||||
}
|
||||
}
|
||||
if (!opts.followOriginalHttpMethod) {
|
||||
opts.method = 'GET';
|
||||
opts.body = null;
|
||||
}
|
||||
if (followRedirect) {
|
||||
opts.url = resp.headers.location;
|
||||
opts.uri = url.parse(opts.url);
|
||||
return urequestHelper(opts, cb);
|
||||
}
|
||||
if (opts.removeRefererHeader && opts.headers) {
|
||||
delete opts.headers.referer;
|
||||
}
|
||||
}
|
||||
if (null === opts.encoding) {
|
||||
resp._body = [];
|
||||
} else {
|
||||
resp.body = '';
|
||||
}
|
||||
resp._bodyLength = 0;
|
||||
resp.on('readable', function () {
|
||||
var chunk;
|
||||
while ((chunk = resp.read())) {
|
||||
resp.on('data', function (chunk) {
|
||||
if ('string' === typeof resp.body) {
|
||||
resp.body += chunk.toString(opts.encoding);
|
||||
} else {
|
||||
resp._body.push(chunk);
|
||||
resp._bodyLength += chunk.length;
|
||||
}
|
||||
}
|
||||
});
|
||||
resp.once('end', function () {
|
||||
resp.on('end', function () {
|
||||
if ('string' !== typeof resp.body) {
|
||||
if (1 === resp._body.length) {
|
||||
resp.body = resp._body[0];
|
||||
@ -149,365 +130,48 @@ function handleResponse(resp, opts, cb) {
|
||||
// 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 || {};
|
||||
|
||||
function urequestHelper(opts, cb) {
|
||||
debug('\n[urequest] processed options:');
|
||||
debug(opts);
|
||||
|
||||
var req;
|
||||
var finalOpts = {};
|
||||
|
||||
// allow specifying a file
|
||||
if ('string' === typeof opts.stream) {
|
||||
if (opts.debug) {
|
||||
console.debug('[@root/request] creating file write stream');
|
||||
}
|
||||
try {
|
||||
opts.stream = fs.createWriteStream(opts.stream);
|
||||
} catch (e) {
|
||||
cb(e);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
function onResponse(resp) {
|
||||
var followRedirect;
|
||||
|
||||
Object.keys(defs).forEach(function (key) {
|
||||
if (key in opts && 'undefined' !== typeof opts[key]) {
|
||||
return;
|
||||
}
|
||||
opts[key] = defs[key];
|
||||
});
|
||||
followRedirect = opts.followRedirect;
|
||||
|
||||
// copied from WHATWG fetch
|
||||
resp.ok = false;
|
||||
if (resp.statusCode >= 200 && resp.statusCode < 300) {
|
||||
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);
|
||||
}
|
||||
|
||||
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 ('string' === typeof _body) {
|
||||
_body = Buffer.from(_body);
|
||||
}
|
||||
|
||||
Object.keys(opts.uri).forEach(function (key) {
|
||||
finalOpts[key] = opts.uri[key];
|
||||
});
|
||||
|
||||
// A bug should be raised if request does it differently,
|
||||
// but I think we're supposed to pass all acceptable options
|
||||
// on to the raw http request
|
||||
[
|
||||
'family',
|
||||
'host',
|
||||
'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) {
|
||||
// Most APIs expect (or require) Content-Length except in the case of multipart uploads
|
||||
// Transfer-Encoding: Chunked (the default) is generally only well-supported downstream
|
||||
if (
|
||||
'undefined' !== typeof _body.byteLength ||
|
||||
'undefined' !== typeof _body.length
|
||||
) {
|
||||
finalOpts.headers['Content-Length'] =
|
||||
_body.byteLength || _body.length;
|
||||
}
|
||||
}
|
||||
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];
|
||||
});
|
||||
}
|
||||
finalOpts.headers = opts.headers;
|
||||
|
||||
// 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;
|
||||
req = https.request(finalOpts, onResponse);
|
||||
} 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;
|
||||
req = http.request(finalOpts, onResponse);
|
||||
} else {
|
||||
cb(new Error("unknown protocol: '" + opts.uri.protocol + "'"));
|
||||
return;
|
||||
throw new Error("unknown protocol: '" + opts.uri.protocol + "'");
|
||||
}
|
||||
|
||||
if (form) {
|
||||
debug("\n[urequest] '" + finalOpts.method + "' (request) form");
|
||||
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.on('error', function (e) {
|
||||
cb(e);
|
||||
});
|
||||
//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);
|
||||
});
|
||||
if (opts.body) {
|
||||
if (true === opts.json) {
|
||||
req.write(JSON.stringify(opts.json));
|
||||
} else {
|
||||
// used for known content-length
|
||||
req.end(_body);
|
||||
req.write(opts.body);
|
||||
}
|
||||
} else if (opts.json && true !== opts.json) {
|
||||
req.write(JSON.stringify(opts.json));
|
||||
}
|
||||
} 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("[urequest] received options:");
|
||||
debug(opts);
|
||||
var reqOpts = {};
|
||||
// request.js behavior:
|
||||
@ -518,23 +182,13 @@ function setDefaults(defs) {
|
||||
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);
|
||||
reqOpts.uri = url.parse(opts.url);
|
||||
} else if ('string' === typeof opts.uri) {
|
||||
reqOpts.url = opts.uri;
|
||||
reqOpts.uri = parseUrl(opts.uri);
|
||||
reqOpts.uri = url.parse(opts.uri);
|
||||
}
|
||||
} else {
|
||||
if ('object' === typeof opts.uri) {
|
||||
@ -547,139 +201,63 @@ function setDefaults(defs) {
|
||||
//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.method = opts.method || 'GET';
|
||||
reqOpts.headers = opts.headers || {};
|
||||
if ((true === reqOpts.json && reqOpts.body) || reqOpts.json) {
|
||||
reqOpts.headers['Content-Type'] = 'application/json';
|
||||
}
|
||||
}
|
||||
|
||||
if (opts.debug) {
|
||||
reqOpts.debug = opts.debug;
|
||||
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];
|
||||
}
|
||||
});
|
||||
|
||||
return urequestHelper(reqOpts, cb);
|
||||
}
|
||||
|
||||
function smartPromisify(fn) {
|
||||
return function (opts) {
|
||||
var cb;
|
||||
if ('function' === typeof arguments[1]) {
|
||||
cb = Array.prototype.slice.call(arguments)[1];
|
||||
return fn(opts, cb);
|
||||
}
|
||||
return new Promise(function (resolve, reject) {
|
||||
fn(opts, function (err, resp) {
|
||||
if (err) {
|
||||
err._response = resp;
|
||||
reject(err);
|
||||
return;
|
||||
}
|
||||
resolve(resp);
|
||||
});
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
var smartUrequest = smartPromisify(urequest);
|
||||
|
||||
smartUrequest.defaults = function (_defs) {
|
||||
urequest.defaults = function (_defs) {
|
||||
_defs = mergeOrDelete(defs, _defs);
|
||||
return setDefaults(_defs);
|
||||
};
|
||||
['get', 'put', 'post', 'patch', 'delete', 'head', 'options'].forEach(
|
||||
function (method) {
|
||||
smartUrequest[method] = smartPromisify(function (obj, cb) {
|
||||
[ '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, cb);
|
||||
urequest(obj);
|
||||
};
|
||||
});
|
||||
}
|
||||
);
|
||||
smartUrequest.del = urequest.delete;
|
||||
urequest.del = urequest.delete;
|
||||
|
||||
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;
|
||||
return urequest;
|
||||
}
|
||||
|
||||
var _defaults = {
|
||||
sendImmediately: true,
|
||||
method: '',
|
||||
headers: {},
|
||||
useQuerystring: false,
|
||||
followRedirect: true,
|
||||
followAllRedirects: false,
|
||||
followOriginalHttpMethod: false,
|
||||
maxRedirects: 10,
|
||||
removeRefererHeader: false,
|
||||
// encoding: undefined,
|
||||
// stream: false, // TODO allow a stream?
|
||||
gzip: false
|
||||
sendImmediately: true
|
||||
, method: 'GET'
|
||||
, headers: {}
|
||||
, useQuerystring: false
|
||||
, followRedirect: true
|
||||
, followAllRedirects: false
|
||||
, followOriginalHttpMethod: false
|
||||
, maxRedirects: 10
|
||||
, removeRefererHeader: false
|
||||
//, encoding: undefined
|
||||
, gzip: false
|
||||
//, body: undefined
|
||||
//, json: undefined
|
||||
};
|
||||
module.exports = setDefaults(_defaults);
|
||||
|
||||
module.exports._keys = Object.keys(_defaults).concat([
|
||||
'encoding',
|
||||
'stream',
|
||||
'body',
|
||||
'json',
|
||||
'form',
|
||||
'auth',
|
||||
'formData',
|
||||
'FormData',
|
||||
'userAgent' // non-standard for request.js
|
||||
'encoding'
|
||||
, 'body'
|
||||
, 'json'
|
||||
]);
|
||||
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");
|
||||
|
||||
5
package-lock.json
generated
5
package-lock.json
generated
@ -1,5 +0,0 @@
|
||||
{
|
||||
"name": "@root/request",
|
||||
"version": "1.8.2",
|
||||
"lockfileVersion": 1
|
||||
}
|
||||
11
package.json
11
package.json
@ -1,11 +1,8 @@
|
||||
{
|
||||
"name": "@root/request",
|
||||
"version": "1.8.2",
|
||||
"description": "A lightweight, zero-dependency drop-in replacement for request",
|
||||
"name": "@coolaj86/urequest",
|
||||
"version": "1.1.0",
|
||||
"description": "A lightweight drop-in replacement for request",
|
||||
"main": "index.js",
|
||||
"files": [
|
||||
"lib"
|
||||
],
|
||||
"directories": {
|
||||
"example": "examples"
|
||||
},
|
||||
@ -14,7 +11,7 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://git.rootprojects.org/root/request.js.git"
|
||||
"url": "https://git.ppl.family/ppl/urequest.js.git"
|
||||
},
|
||||
"keywords": [
|
||||
"request",
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
'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());
|
||||
});
|
||||
Loading…
x
Reference in New Issue
Block a user