request @ 2.18.0 - README.md
1
# Request -- Simplified HTTP request method
2
3
## Install
4
5
<pre>
6
npm install request
7
</pre>
8
9
Or from source:
10
11
<pre>
12
git clone git://github.com/mikeal/request.git
13
cd request
14
npm link
15
</pre>
16
17
## Super simple to use
18
19
Request is designed to be the simplest way possible to make http calls. It supports HTTPS and follows redirects by default.
20
21
```javascript
22
var request = require('request');
23
request('http://www.google.com', function (error, response, body) {
24
if (!error && response.statusCode == 200) {
25
console.log(body) // Print the google web page.
26
}
27
})
28
```
29
30
## Streaming
31
32
You can stream any response to a file stream.
33
34
```javascript
35
request('http://google.com/doodle.png').pipe(fs.createWriteStream('doodle.png'))
36
```
37
38
You can also stream a file to a PUT or POST request. This method will also check the file extension against a mapping of file extensions to content-types, in this case `application/json`, and use the proper content-type in the PUT request if one is not already provided in the headers.
39
40
```javascript
41
fs.createReadStream('file.json').pipe(request.put('http://mysite.com/obj.json'))
42
```
43
44
Request can also pipe to itself. When doing so the content-type and content-length will be preserved in the PUT headers.
45
46
```javascript
47
request.get('http://google.com/img.png').pipe(request.put('http://mysite.com/img.png'))
48
```
49
50
Now let's get fancy.
51
52
```javascript
53
http.createServer(function (req, resp) {
54
if (req.url === '/doodle.png') {
55
if (req.method === 'PUT') {
56
req.pipe(request.put('http://mysite.com/doodle.png'))
57
} else if (req.method === 'GET' || req.method === 'HEAD') {
58
request.get('http://mysite.com/doodle.png').pipe(resp)
59
}
60
}
61
})
62
```
63
64
You can also pipe() from a http.ServerRequest instance and to a http.ServerResponse instance. The HTTP method and headers will be sent as well as the entity-body data. Which means that, if you don't really care about security, you can do:
65
66
```javascript
67
http.createServer(function (req, resp) {
68
if (req.url === '/doodle.png') {
69
var x = request('http://mysite.com/doodle.png')
70
req.pipe(x)
71
x.pipe(resp)
72
}
73
})
74
```
75
76
And since pipe() returns the destination stream in node 0.5.x you can do one line proxying :)
77
78
```javascript
79
req.pipe(request('http://mysite.com/doodle.png')).pipe(resp)
80
```
81
82
Also, none of this new functionality conflicts with requests previous features, it just expands them.
83
84
```javascript
85
var r = request.defaults({'proxy':'http://localproxy.com'})
86
87
http.createServer(function (req, resp) {
88
if (req.url === '/doodle.png') {
89
r.get('http://google.com/doodle.png').pipe(resp)
90
}
91
})
92
```
93
You can still use intermediate proxies, the requests will still follow HTTP forwards, etc.
94
95
## Forms
96
97
`request` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads. For `multipart/related` refer to the `multipart` API.
98
99
Url encoded forms are simple
100
101
```javascript
102
request.post('http://service.com/upload', {form:{key:'value'}})
103
// or
104
request.post('http://service.com/upload').form({key:'value'})
105
```
106
107
For `multipart/form-data` we use the [form-data](https://github.com/felixge/node-form-data) library by [@felixge](https://github.com/felixge). You don't need to worry about piping the form object or setting the headers, `request` will handle that for you.
108
109
```javascript
110
var r = request.post('http://service.com/upload')
111
var form = r.form()
112
form.append('my_field', 'my_value')
113
form.append('my_buffer', new Buffer([1, 2, 3]))
114
form.append('my_file', fs.createReadStream(path.join(__dirname, 'doodle.png'))
115
form.append('remote_file', request('http://google.com/doodle.png'))
116
```
117
118
## HTTP Authentication
119
120
```javascript
121
request.auth('username', 'password', false).get('http://some.server.com/');
122
// or
123
request.get('http://some.server.com/', {
124
'auth': {
125
'user': 'username',
126
'pass': 'password',
127
'sendImmediately': false
128
}
129
});
130
```
131
132
If passed as an option, `auth` should be a hash containing values `user` || `username`, `password` || `pass`, and `sendImmediately` (optional). The method form takes parameters `auth(username, password, sendImmediately)`.
133
134
`sendImmediately` defaults to true, which will cause a basic 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).
135
136
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).
137
138
## OAuth Signing
139
140
```javascript
141
// Twitter OAuth
142
var qs = require('querystring')
143
, oauth =
144
{ callback: 'http://mysite.com/callback/'
145
, consumer_key: CONSUMER_KEY
146
, consumer_secret: CONSUMER_SECRET
147
}
148
, url = 'https://api.twitter.com/oauth/request_token'
149
;
150
request.post({url:url, oauth:oauth}, function (e, r, body) {
151
// Ideally, you would take the body in the response
152
// and construct a URL that a user clicks on (like a sign in button).
153
// The verifier is only available in the response after a user has
154
// verified with twitter that they are authorizing your app.
155
var access_token = qs.parse(body)
156
, oauth =
157
{ consumer_key: CONSUMER_KEY
158
, consumer_secret: CONSUMER_SECRET
159
, token: access_token.oauth_token
160
, verifier: access_token.oauth_verifier
161
}
162
, url = 'https://api.twitter.com/oauth/access_token'
163
;
164
request.post({url:url, oauth:oauth}, function (e, r, body) {
165
var perm_token = qs.parse(body)
166
, oauth =
167
{ consumer_key: CONSUMER_KEY
168
, consumer_secret: CONSUMER_SECRET
169
, token: perm_token.oauth_token
170
, token_secret: perm_token.oauth_token_secret
171
}
172
, url = 'https://api.twitter.com/1/users/show.json?'
173
, params =
174
{ screen_name: perm_token.screen_name
175
, user_id: perm_token.user_id
176
}
177
;
178
url += qs.stringify(params)
179
request.get({url:url, oauth:oauth, json:true}, function (e, r, user) {
180
console.log(user)
181
})
182
})
183
})
184
```
185
186
187
188
### request(options, callback)
189
190
The first argument can be either a url or an options object. The only required option is uri, all others are optional.
191
192
* `uri` || `url` - fully qualified uri or a parsed url object from url.parse()
193
* `qs` - object containing querystring values to be appended to the uri
194
* `method` - http method, defaults to GET
195
* `headers` - http headers, defaults to {}
196
* `body` - entity body for PATCH, POST and PUT requests. Must be buffer or string.
197
* `form` - when passed an object this will set `body` but to a querystring representation of value and adds `Content-type: application/x-www-form-urlencoded; charset=utf-8` header. When passed no option a FormData instance is returned that will be piped to request.
198
* `auth` - A hash containing values `user` || `username`, `password` || `pass`, and `sendImmediately` (optional). See documentation above.
199
* `json` - sets `body` but to JSON representation of value and adds `Content-type: application/json` header. Additionally, parses the response body as json.
200
* `multipart` - (experimental) array of objects which contains their own headers and `body` attribute. Sends `multipart/related` request. See example below.
201
* `followRedirect` - follow HTTP 3xx responses as redirects. defaults to true.
202
* `followAllRedirects` - follow non-GET HTTP 3xx responses as redirects. defaults to false.
203
* `maxRedirects` - the maximum number of redirects to follow, defaults to 10.
204
* `encoding` - Encoding to be used on `setEncoding` of response data. If set to `null`, the body is returned as a Buffer.
205
* `pool` - A hash object containing the agents for these requests. If omitted this request will use the global pool which is set to node's default maxSockets.
206
* `pool.maxSockets` - Integer containing the maximum amount of sockets in the pool.
207
* `timeout` - Integer containing the number of milliseconds to wait for a request to respond before aborting the request
208
* `proxy` - An HTTP proxy to be used. Support proxy Auth with Basic Auth the same way it's supported with the `url` parameter by embedding the auth info in the uri.
209
* `oauth` - Options for OAuth HMAC-SHA1 signing, see documentation above.
210
* `hawk` - Options for [Hawk signing](https://github.com/hueniverse/hawk). The `credentials` key must contain the necessary signing info, [see hawk docs for details](https://github.com/hueniverse/hawk#usage-example).
211
* `strictSSL` - Set to `true` to require that SSL certificates be valid. Note: to use your own certificate authority, you need to specify an agent that was created with that ca as an option.
212
* `jar` - Set to `false` if you don't want cookies to be remembered for future use or define your custom cookie jar (see examples section)
213
* `aws` - object containing aws signing information, should have the properties `key` and `secret` as well as `bucket` unless you're specifying your bucket as part of the path, or you are making a request that doesn't use a bucket (i.e. GET Services)
214
* `httpSignature` - Options for the [HTTP Signature Scheme](https://github.com/joyent/node-http-signature/blob/master/http_signing.md) using [Joyent's library](https://github.com/joyent/node-http-signature). The `keyId` and `key` properties must be specified. See the docs for other options.
215
* `localAddress` - Local interface to bind for network connections.
216
217
218
The callback argument gets 3 arguments. The first is an error when applicable (usually from the http.Client option not the http.ClientRequest object). The second in an http.ClientResponse object. The third is the response body String or Buffer.
219
220
## Convenience methods
221
222
There are also shorthand methods for different HTTP METHODs and some other conveniences.
223
224
### request.defaults(options)
225
226
This method returns a wrapper around the normal request API that defaults to whatever options you pass in to it.
227
228
### request.put
229
230
Same as request() but defaults to `method: "PUT"`.
231
232
```javascript
233
request.put(url)
234
```
235
236
### request.patch
237
238
Same as request() but defaults to `method: "PATCH"`.
239
240
```javascript
241
request.patch(url)
242
```
243
244
### request.post
245
246
Same as request() but defaults to `method: "POST"`.
247
248
```javascript
249
request.post(url)
250
```
251
252
### request.head
253
254
Same as request() but defaults to `method: "HEAD"`.
255
256
```javascript
257
request.head(url)
258
```
259
260
### request.del
261
262
Same as request() but defaults to `method: "DELETE"`.
263
264
```javascript
265
request.del(url)
266
```
267
268
### request.get
269
270
Alias to normal request method for uniformity.
271
272
```javascript
273
request.get(url)
274
```
275
### request.cookie
276
277
Function that creates a new cookie.
278
279
```javascript
280
request.cookie('cookie_string_here')
281
```
282
### request.jar
283
284
Function that creates a new cookie jar.
285
286
```javascript
287
request.jar()
288
```
289
290
291
## Examples:
292
293
```javascript
294
var request = require('request')
295
, rand = Math.floor(Math.random()*100000000).toString()
296
;
297
request(
298
{ method: 'PUT'
299
, uri: 'http://mikeal.iriscouch.com/testjs/' + rand
300
, multipart:
301
[ { 'content-type': 'application/json'
302
, body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})
303
}
304
, { body: 'I am an attachment' }
305
]
306
}
307
, function (error, response, body) {
308
if(response.statusCode == 201){
309
console.log('document saved as: http://mikeal.iriscouch.com/testjs/'+ rand)
310
} else {
311
console.log('error: '+ response.statusCode)
312
console.log(body)
313
}
314
}
315
)
316
```
317
Cookies are enabled by default (so they can be used in subsequent requests). To disable cookies set jar to false (either in defaults or in the options sent).
318
319
```javascript
320
var request = request.defaults({jar: false})
321
request('http://www.google.com', function () {
322
request('http://images.google.com')
323
})
324
```
325
326
If you to use a custom cookie jar (instead of letting request use its own global cookie jar) you do so by setting the jar default or by specifying it as an option:
327
328
```javascript
329
var j = request.jar()
330
var request = request.defaults({jar:j})
331
request('http://www.google.com', function () {
332
request('http://images.google.com')
333
})
334
```
335
OR
336
337
```javascript
338
var j = request.jar()
339
var cookie = request.cookie('your_cookie_here')
340
j.add(cookie)
341
request({url: 'http://www.google.com', jar: j}, function () {
342
request('http://images.google.com')
343
})
344
```
345