1078 lines
23 KiB
JavaScript
1078 lines
23 KiB
JavaScript
|
/**
|
||
|
* Module dependencies.
|
||
|
*/
|
||
|
|
||
|
var Emitter = require('emitter');
|
||
|
var reduce = require('reduce');
|
||
|
var requestBase = require('./request-base');
|
||
|
var isObject = require('./is-object');
|
||
|
|
||
|
/**
|
||
|
* Root reference for iframes.
|
||
|
*/
|
||
|
|
||
|
var root;
|
||
|
if (typeof window !== 'undefined') { // Browser window
|
||
|
root = window;
|
||
|
} else if (typeof self !== 'undefined') { // Web Worker
|
||
|
root = self;
|
||
|
} else { // Other environments
|
||
|
root = this;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Noop.
|
||
|
*/
|
||
|
|
||
|
function noop(){};
|
||
|
|
||
|
/**
|
||
|
* Check if `obj` is a host object,
|
||
|
* we don't want to serialize these :)
|
||
|
*
|
||
|
* TODO: future proof, move to compoent land
|
||
|
*
|
||
|
* @param {Object} obj
|
||
|
* @return {Boolean}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function isHost(obj) {
|
||
|
var str = {}.toString.call(obj);
|
||
|
|
||
|
switch (str) {
|
||
|
case '[object File]':
|
||
|
case '[object Blob]':
|
||
|
case '[object FormData]':
|
||
|
return true;
|
||
|
default:
|
||
|
return false;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Expose `request`.
|
||
|
*/
|
||
|
|
||
|
var request = module.exports = require('./request').bind(null, Request);
|
||
|
|
||
|
/**
|
||
|
* Determine XHR.
|
||
|
*/
|
||
|
|
||
|
request.getXHR = function () {
|
||
|
if (root.XMLHttpRequest
|
||
|
&& (!root.location || 'file:' != root.location.protocol
|
||
|
|| !root.ActiveXObject)) {
|
||
|
return new XMLHttpRequest;
|
||
|
} else {
|
||
|
try { return new ActiveXObject('Microsoft.XMLHTTP'); } catch(e) {}
|
||
|
try { return new ActiveXObject('Msxml2.XMLHTTP.6.0'); } catch(e) {}
|
||
|
try { return new ActiveXObject('Msxml2.XMLHTTP.3.0'); } catch(e) {}
|
||
|
try { return new ActiveXObject('Msxml2.XMLHTTP'); } catch(e) {}
|
||
|
}
|
||
|
return false;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Removes leading and trailing whitespace, added to support IE.
|
||
|
*
|
||
|
* @param {String} s
|
||
|
* @return {String}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
var trim = ''.trim
|
||
|
? function(s) { return s.trim(); }
|
||
|
: function(s) { return s.replace(/(^\s*|\s*$)/g, ''); };
|
||
|
|
||
|
/**
|
||
|
* Serialize the given `obj`.
|
||
|
*
|
||
|
* @param {Object} obj
|
||
|
* @return {String}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function serialize(obj) {
|
||
|
if (!isObject(obj)) return obj;
|
||
|
var pairs = [];
|
||
|
for (var key in obj) {
|
||
|
if (null != obj[key]) {
|
||
|
pushEncodedKeyValuePair(pairs, key, obj[key]);
|
||
|
}
|
||
|
}
|
||
|
return pairs.join('&');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Helps 'serialize' with serializing arrays.
|
||
|
* Mutates the pairs array.
|
||
|
*
|
||
|
* @param {Array} pairs
|
||
|
* @param {String} key
|
||
|
* @param {Mixed} val
|
||
|
*/
|
||
|
|
||
|
function pushEncodedKeyValuePair(pairs, key, val) {
|
||
|
if (Array.isArray(val)) {
|
||
|
return val.forEach(function(v) {
|
||
|
pushEncodedKeyValuePair(pairs, key, v);
|
||
|
});
|
||
|
}
|
||
|
pairs.push(encodeURIComponent(key)
|
||
|
+ '=' + encodeURIComponent(val));
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Expose serialization method.
|
||
|
*/
|
||
|
|
||
|
request.serializeObject = serialize;
|
||
|
|
||
|
/**
|
||
|
* Parse the given x-www-form-urlencoded `str`.
|
||
|
*
|
||
|
* @param {String} str
|
||
|
* @return {Object}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function parseString(str) {
|
||
|
var obj = {};
|
||
|
var pairs = str.split('&');
|
||
|
var parts;
|
||
|
var pair;
|
||
|
|
||
|
for (var i = 0, len = pairs.length; i < len; ++i) {
|
||
|
pair = pairs[i];
|
||
|
parts = pair.split('=');
|
||
|
obj[decodeURIComponent(parts[0])] = decodeURIComponent(parts[1]);
|
||
|
}
|
||
|
|
||
|
return obj;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Expose parser.
|
||
|
*/
|
||
|
|
||
|
request.parseString = parseString;
|
||
|
|
||
|
/**
|
||
|
* Default MIME type map.
|
||
|
*
|
||
|
* superagent.types.xml = 'application/xml';
|
||
|
*
|
||
|
*/
|
||
|
|
||
|
request.types = {
|
||
|
html: 'text/html',
|
||
|
json: 'application/json',
|
||
|
xml: 'application/xml',
|
||
|
urlencoded: 'application/x-www-form-urlencoded',
|
||
|
'form': 'application/x-www-form-urlencoded',
|
||
|
'form-data': 'application/x-www-form-urlencoded'
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Default serialization map.
|
||
|
*
|
||
|
* superagent.serialize['application/xml'] = function(obj){
|
||
|
* return 'generated xml here';
|
||
|
* };
|
||
|
*
|
||
|
*/
|
||
|
|
||
|
request.serialize = {
|
||
|
'application/x-www-form-urlencoded': serialize,
|
||
|
'application/json': JSON.stringify
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Default parsers.
|
||
|
*
|
||
|
* superagent.parse['application/xml'] = function(str){
|
||
|
* return { object parsed from str };
|
||
|
* };
|
||
|
*
|
||
|
*/
|
||
|
|
||
|
request.parse = {
|
||
|
'application/x-www-form-urlencoded': parseString,
|
||
|
'application/json': JSON.parse
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Parse the given header `str` into
|
||
|
* an object containing the mapped fields.
|
||
|
*
|
||
|
* @param {String} str
|
||
|
* @return {Object}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function parseHeader(str) {
|
||
|
var lines = str.split(/\r?\n/);
|
||
|
var fields = {};
|
||
|
var index;
|
||
|
var line;
|
||
|
var field;
|
||
|
var val;
|
||
|
|
||
|
lines.pop(); // trailing CRLF
|
||
|
|
||
|
for (var i = 0, len = lines.length; i < len; ++i) {
|
||
|
line = lines[i];
|
||
|
index = line.indexOf(':');
|
||
|
field = line.slice(0, index).toLowerCase();
|
||
|
val = trim(line.slice(index + 1));
|
||
|
fields[field] = val;
|
||
|
}
|
||
|
|
||
|
return fields;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Check if `mime` is json or has +json structured syntax suffix.
|
||
|
*
|
||
|
* @param {String} mime
|
||
|
* @return {Boolean}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function isJSON(mime) {
|
||
|
return /[\/+]json\b/.test(mime);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Return the mime type for the given `str`.
|
||
|
*
|
||
|
* @param {String} str
|
||
|
* @return {String}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function type(str){
|
||
|
return str.split(/ *; */).shift();
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Return header field parameters.
|
||
|
*
|
||
|
* @param {String} str
|
||
|
* @return {Object}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function params(str){
|
||
|
return reduce(str.split(/ *; */), function(obj, str){
|
||
|
var parts = str.split(/ *= */)
|
||
|
, key = parts.shift()
|
||
|
, val = parts.shift();
|
||
|
|
||
|
if (key && val) obj[key] = val;
|
||
|
return obj;
|
||
|
}, {});
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Initialize a new `Response` with the given `xhr`.
|
||
|
*
|
||
|
* - set flags (.ok, .error, etc)
|
||
|
* - parse header
|
||
|
*
|
||
|
* Examples:
|
||
|
*
|
||
|
* Aliasing `superagent` as `request` is nice:
|
||
|
*
|
||
|
* request = superagent;
|
||
|
*
|
||
|
* We can use the promise-like API, or pass callbacks:
|
||
|
*
|
||
|
* request.get('/').end(function(res){});
|
||
|
* request.get('/', function(res){});
|
||
|
*
|
||
|
* Sending data can be chained:
|
||
|
*
|
||
|
* request
|
||
|
* .post('/user')
|
||
|
* .send({ name: 'tj' })
|
||
|
* .end(function(res){});
|
||
|
*
|
||
|
* Or passed to `.send()`:
|
||
|
*
|
||
|
* request
|
||
|
* .post('/user')
|
||
|
* .send({ name: 'tj' }, function(res){});
|
||
|
*
|
||
|
* Or passed to `.post()`:
|
||
|
*
|
||
|
* request
|
||
|
* .post('/user', { name: 'tj' })
|
||
|
* .end(function(res){});
|
||
|
*
|
||
|
* Or further reduced to a single call for simple cases:
|
||
|
*
|
||
|
* request
|
||
|
* .post('/user', { name: 'tj' }, function(res){});
|
||
|
*
|
||
|
* @param {XMLHTTPRequest} xhr
|
||
|
* @param {Object} options
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
function Response(req, options) {
|
||
|
options = options || {};
|
||
|
this.req = req;
|
||
|
this.xhr = this.req.xhr;
|
||
|
// responseText is accessible only if responseType is '' or 'text' and on older browsers
|
||
|
this.text = ((this.req.method !='HEAD' && (this.xhr.responseType === '' || this.xhr.responseType === 'text')) || typeof this.xhr.responseType === 'undefined')
|
||
|
? this.xhr.responseText
|
||
|
: null;
|
||
|
this.statusText = this.req.xhr.statusText;
|
||
|
this.setStatusProperties(this.xhr.status);
|
||
|
this.header = this.headers = parseHeader(this.xhr.getAllResponseHeaders());
|
||
|
// getAllResponseHeaders sometimes falsely returns "" for CORS requests, but
|
||
|
// getResponseHeader still works. so we get content-type even if getting
|
||
|
// other headers fails.
|
||
|
this.header['content-type'] = this.xhr.getResponseHeader('content-type');
|
||
|
this.setHeaderProperties(this.header);
|
||
|
this.body = this.req.method != 'HEAD'
|
||
|
? this.parseBody(this.text ? this.text : this.xhr.response)
|
||
|
: null;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Get case-insensitive `field` value.
|
||
|
*
|
||
|
* @param {String} field
|
||
|
* @return {String}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Response.prototype.get = function(field){
|
||
|
return this.header[field.toLowerCase()];
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Set header related properties:
|
||
|
*
|
||
|
* - `.type` the content type without params
|
||
|
*
|
||
|
* A response of "Content-Type: text/plain; charset=utf-8"
|
||
|
* will provide you with a `.type` of "text/plain".
|
||
|
*
|
||
|
* @param {Object} header
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
Response.prototype.setHeaderProperties = function(header){
|
||
|
// content-type
|
||
|
var ct = this.header['content-type'] || '';
|
||
|
this.type = type(ct);
|
||
|
|
||
|
// params
|
||
|
var obj = params(ct);
|
||
|
for (var key in obj) this[key] = obj[key];
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Parse the given body `str`.
|
||
|
*
|
||
|
* Used for auto-parsing of bodies. Parsers
|
||
|
* are defined on the `superagent.parse` object.
|
||
|
*
|
||
|
* @param {String} str
|
||
|
* @return {Mixed}
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
Response.prototype.parseBody = function(str){
|
||
|
var parse = request.parse[this.type];
|
||
|
if (!parse && isJSON(this.type)) {
|
||
|
parse = request.parse['application/json'];
|
||
|
}
|
||
|
return parse && str && (str.length || str instanceof Object)
|
||
|
? parse(str)
|
||
|
: null;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Set flags such as `.ok` based on `status`.
|
||
|
*
|
||
|
* For example a 2xx response will give you a `.ok` of __true__
|
||
|
* whereas 5xx will be __false__ and `.error` will be __true__. The
|
||
|
* `.clientError` and `.serverError` are also available to be more
|
||
|
* specific, and `.statusType` is the class of error ranging from 1..5
|
||
|
* sometimes useful for mapping respond colors etc.
|
||
|
*
|
||
|
* "sugar" properties are also defined for common cases. Currently providing:
|
||
|
*
|
||
|
* - .noContent
|
||
|
* - .badRequest
|
||
|
* - .unauthorized
|
||
|
* - .notAcceptable
|
||
|
* - .notFound
|
||
|
*
|
||
|
* @param {Number} status
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
Response.prototype.setStatusProperties = function(status){
|
||
|
// handle IE9 bug: http://stackoverflow.com/questions/10046972/msie-returns-status-code-of-1223-for-ajax-request
|
||
|
if (status === 1223) {
|
||
|
status = 204;
|
||
|
}
|
||
|
|
||
|
var type = status / 100 | 0;
|
||
|
|
||
|
// status / class
|
||
|
this.status = this.statusCode = status;
|
||
|
this.statusType = type;
|
||
|
|
||
|
// basics
|
||
|
this.info = 1 == type;
|
||
|
this.ok = 2 == type;
|
||
|
this.clientError = 4 == type;
|
||
|
this.serverError = 5 == type;
|
||
|
this.error = (4 == type || 5 == type)
|
||
|
? this.toError()
|
||
|
: false;
|
||
|
|
||
|
// sugar
|
||
|
this.accepted = 202 == status;
|
||
|
this.noContent = 204 == status;
|
||
|
this.badRequest = 400 == status;
|
||
|
this.unauthorized = 401 == status;
|
||
|
this.notAcceptable = 406 == status;
|
||
|
this.notFound = 404 == status;
|
||
|
this.forbidden = 403 == status;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Return an `Error` representative of this response.
|
||
|
*
|
||
|
* @return {Error}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Response.prototype.toError = function(){
|
||
|
var req = this.req;
|
||
|
var method = req.method;
|
||
|
var url = req.url;
|
||
|
|
||
|
var msg = 'cannot ' + method + ' ' + url + ' (' + this.status + ')';
|
||
|
var err = new Error(msg);
|
||
|
err.status = this.status;
|
||
|
err.method = method;
|
||
|
err.url = url;
|
||
|
|
||
|
return err;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Expose `Response`.
|
||
|
*/
|
||
|
|
||
|
request.Response = Response;
|
||
|
|
||
|
/**
|
||
|
* Initialize a new `Request` with the given `method` and `url`.
|
||
|
*
|
||
|
* @param {String} method
|
||
|
* @param {String} url
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
function Request(method, url) {
|
||
|
var self = this;
|
||
|
this._query = this._query || [];
|
||
|
this.method = method;
|
||
|
this.url = url;
|
||
|
this.header = {}; // preserves header name case
|
||
|
this._header = {}; // coerces header names to lowercase
|
||
|
this.on('end', function(){
|
||
|
var err = null;
|
||
|
var res = null;
|
||
|
|
||
|
try {
|
||
|
res = new Response(self);
|
||
|
} catch(e) {
|
||
|
err = new Error('Parser is unable to parse the response');
|
||
|
err.parse = true;
|
||
|
err.original = e;
|
||
|
// issue #675: return the raw response if the response parsing fails
|
||
|
err.rawResponse = self.xhr && self.xhr.responseText ? self.xhr.responseText : null;
|
||
|
// issue #876: return the http status code if the response parsing fails
|
||
|
err.statusCode = self.xhr && self.xhr.status ? self.xhr.status : null;
|
||
|
return self.callback(err);
|
||
|
}
|
||
|
|
||
|
self.emit('response', res);
|
||
|
|
||
|
if (err) {
|
||
|
return self.callback(err, res);
|
||
|
}
|
||
|
|
||
|
if (res.status >= 200 && res.status < 300) {
|
||
|
return self.callback(err, res);
|
||
|
}
|
||
|
|
||
|
var new_err = new Error(res.statusText || 'Unsuccessful HTTP response');
|
||
|
new_err.original = err;
|
||
|
new_err.response = res;
|
||
|
new_err.status = res.status;
|
||
|
|
||
|
self.callback(new_err, res);
|
||
|
});
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Mixin `Emitter` and `requestBase`.
|
||
|
*/
|
||
|
|
||
|
Emitter(Request.prototype);
|
||
|
for (var key in requestBase) {
|
||
|
Request.prototype[key] = requestBase[key];
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Abort the request, and clear potential timeout.
|
||
|
*
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.abort = function(){
|
||
|
if (this.aborted) return;
|
||
|
this.aborted = true;
|
||
|
this.xhr && this.xhr.abort();
|
||
|
this.clearTimeout();
|
||
|
this.emit('abort');
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Set Content-Type to `type`, mapping values from `request.types`.
|
||
|
*
|
||
|
* Examples:
|
||
|
*
|
||
|
* superagent.types.xml = 'application/xml';
|
||
|
*
|
||
|
* request.post('/')
|
||
|
* .type('xml')
|
||
|
* .send(xmlstring)
|
||
|
* .end(callback);
|
||
|
*
|
||
|
* request.post('/')
|
||
|
* .type('application/xml')
|
||
|
* .send(xmlstring)
|
||
|
* .end(callback);
|
||
|
*
|
||
|
* @param {String} type
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.type = function(type){
|
||
|
this.set('Content-Type', request.types[type] || type);
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Set responseType to `val`. Presently valid responseTypes are 'blob' and
|
||
|
* 'arraybuffer'.
|
||
|
*
|
||
|
* Examples:
|
||
|
*
|
||
|
* req.get('/')
|
||
|
* .responseType('blob')
|
||
|
* .end(callback);
|
||
|
*
|
||
|
* @param {String} val
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.responseType = function(val){
|
||
|
this._responseType = val;
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Set Accept to `type`, mapping values from `request.types`.
|
||
|
*
|
||
|
* Examples:
|
||
|
*
|
||
|
* superagent.types.json = 'application/json';
|
||
|
*
|
||
|
* request.get('/agent')
|
||
|
* .accept('json')
|
||
|
* .end(callback);
|
||
|
*
|
||
|
* request.get('/agent')
|
||
|
* .accept('application/json')
|
||
|
* .end(callback);
|
||
|
*
|
||
|
* @param {String} accept
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.accept = function(type){
|
||
|
this.set('Accept', request.types[type] || type);
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Set Authorization field value with `user` and `pass`.
|
||
|
*
|
||
|
* @param {String} user
|
||
|
* @param {String} pass
|
||
|
* @param {Object} options with 'type' property 'auto' or 'basic' (default 'basic')
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.auth = function(user, pass, options){
|
||
|
if (!options) {
|
||
|
options = {
|
||
|
type: 'basic'
|
||
|
}
|
||
|
}
|
||
|
|
||
|
switch (options.type) {
|
||
|
case 'basic':
|
||
|
var str = btoa(user + ':' + pass);
|
||
|
this.set('Authorization', 'Basic ' + str);
|
||
|
break;
|
||
|
|
||
|
case 'auto':
|
||
|
this.username = user;
|
||
|
this.password = pass;
|
||
|
break;
|
||
|
}
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Add query-string `val`.
|
||
|
*
|
||
|
* Examples:
|
||
|
*
|
||
|
* request.get('/shoes')
|
||
|
* .query('size=10')
|
||
|
* .query({ color: 'blue' })
|
||
|
*
|
||
|
* @param {Object|String} val
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.query = function(val){
|
||
|
if ('string' != typeof val) val = serialize(val);
|
||
|
if (val) this._query.push(val);
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Queue the given `file` as an attachment to the specified `field`,
|
||
|
* with optional `filename`.
|
||
|
*
|
||
|
* ``` js
|
||
|
* request.post('/upload')
|
||
|
* .attach(new Blob(['<a id="a"><b id="b">hey!</b></a>'], { type: "text/html"}))
|
||
|
* .end(callback);
|
||
|
* ```
|
||
|
*
|
||
|
* @param {String} field
|
||
|
* @param {Blob|File} file
|
||
|
* @param {String} filename
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.attach = function(field, file, filename){
|
||
|
this._getFormData().append(field, file, filename || file.name);
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
Request.prototype._getFormData = function(){
|
||
|
if (!this._formData) {
|
||
|
this._formData = new root.FormData();
|
||
|
}
|
||
|
return this._formData;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Send `data` as the request body, defaulting the `.type()` to "json" when
|
||
|
* an object is given.
|
||
|
*
|
||
|
* Examples:
|
||
|
*
|
||
|
* // manual json
|
||
|
* request.post('/user')
|
||
|
* .type('json')
|
||
|
* .send('{"name":"tj"}')
|
||
|
* .end(callback)
|
||
|
*
|
||
|
* // auto json
|
||
|
* request.post('/user')
|
||
|
* .send({ name: 'tj' })
|
||
|
* .end(callback)
|
||
|
*
|
||
|
* // manual x-www-form-urlencoded
|
||
|
* request.post('/user')
|
||
|
* .type('form')
|
||
|
* .send('name=tj')
|
||
|
* .end(callback)
|
||
|
*
|
||
|
* // auto x-www-form-urlencoded
|
||
|
* request.post('/user')
|
||
|
* .type('form')
|
||
|
* .send({ name: 'tj' })
|
||
|
* .end(callback)
|
||
|
*
|
||
|
* // defaults to x-www-form-urlencoded
|
||
|
* request.post('/user')
|
||
|
* .send('name=tobi')
|
||
|
* .send('species=ferret')
|
||
|
* .end(callback)
|
||
|
*
|
||
|
* @param {String|Object} data
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.send = function(data){
|
||
|
var obj = isObject(data);
|
||
|
var type = this._header['content-type'];
|
||
|
|
||
|
// merge
|
||
|
if (obj && isObject(this._data)) {
|
||
|
for (var key in data) {
|
||
|
this._data[key] = data[key];
|
||
|
}
|
||
|
} else if ('string' == typeof data) {
|
||
|
if (!type) this.type('form');
|
||
|
type = this._header['content-type'];
|
||
|
if ('application/x-www-form-urlencoded' == type) {
|
||
|
this._data = this._data
|
||
|
? this._data + '&' + data
|
||
|
: data;
|
||
|
} else {
|
||
|
this._data = (this._data || '') + data;
|
||
|
}
|
||
|
} else {
|
||
|
this._data = data;
|
||
|
}
|
||
|
|
||
|
if (!obj || isHost(data)) return this;
|
||
|
if (!type) this.type('json');
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* @deprecated
|
||
|
*/
|
||
|
Response.prototype.parse = function serialize(fn){
|
||
|
if (root.console) {
|
||
|
console.warn("Client-side parse() method has been renamed to serialize(). This method is not compatible with superagent v2.0");
|
||
|
}
|
||
|
this.serialize(fn);
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
Response.prototype.serialize = function serialize(fn){
|
||
|
this._parser = fn;
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Invoke the callback with `err` and `res`
|
||
|
* and handle arity check.
|
||
|
*
|
||
|
* @param {Error} err
|
||
|
* @param {Response} res
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
Request.prototype.callback = function(err, res){
|
||
|
var fn = this._callback;
|
||
|
this.clearTimeout();
|
||
|
fn(err, res);
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Invoke callback with x-domain error.
|
||
|
*
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
Request.prototype.crossDomainError = function(){
|
||
|
var err = new Error('Request has been terminated\nPossible causes: the network is offline, Origin is not allowed by Access-Control-Allow-Origin, the page is being unloaded, etc.');
|
||
|
err.crossDomain = true;
|
||
|
|
||
|
err.status = this.status;
|
||
|
err.method = this.method;
|
||
|
err.url = this.url;
|
||
|
|
||
|
this.callback(err);
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Invoke callback with timeout error.
|
||
|
*
|
||
|
* @api private
|
||
|
*/
|
||
|
|
||
|
Request.prototype.timeoutError = function(){
|
||
|
var timeout = this._timeout;
|
||
|
var err = new Error('timeout of ' + timeout + 'ms exceeded');
|
||
|
err.timeout = timeout;
|
||
|
this.callback(err);
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Enable transmission of cookies with x-domain requests.
|
||
|
*
|
||
|
* Note that for this to work the origin must not be
|
||
|
* using "Access-Control-Allow-Origin" with a wildcard,
|
||
|
* and also must set "Access-Control-Allow-Credentials"
|
||
|
* to "true".
|
||
|
*
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.withCredentials = function(){
|
||
|
this._withCredentials = true;
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Initiate request, invoking callback `fn(res)`
|
||
|
* with an instanceof `Response`.
|
||
|
*
|
||
|
* @param {Function} fn
|
||
|
* @return {Request} for chaining
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
Request.prototype.end = function(fn){
|
||
|
var self = this;
|
||
|
var xhr = this.xhr = request.getXHR();
|
||
|
var query = this._query.join('&');
|
||
|
var timeout = this._timeout;
|
||
|
var data = this._formData || this._data;
|
||
|
|
||
|
// store callback
|
||
|
this._callback = fn || noop;
|
||
|
|
||
|
// state change
|
||
|
xhr.onreadystatechange = function(){
|
||
|
if (4 != xhr.readyState) return;
|
||
|
|
||
|
// In IE9, reads to any property (e.g. status) off of an aborted XHR will
|
||
|
// result in the error "Could not complete the operation due to error c00c023f"
|
||
|
var status;
|
||
|
try { status = xhr.status } catch(e) { status = 0; }
|
||
|
|
||
|
if (0 == status) {
|
||
|
if (self.timedout) return self.timeoutError();
|
||
|
if (self.aborted) return;
|
||
|
return self.crossDomainError();
|
||
|
}
|
||
|
self.emit('end');
|
||
|
};
|
||
|
|
||
|
// progress
|
||
|
var handleProgress = function(e){
|
||
|
if (e.total > 0) {
|
||
|
e.percent = e.loaded / e.total * 100;
|
||
|
}
|
||
|
e.direction = 'download';
|
||
|
self.emit('progress', e);
|
||
|
};
|
||
|
if (this.hasListeners('progress')) {
|
||
|
xhr.onprogress = handleProgress;
|
||
|
}
|
||
|
try {
|
||
|
if (xhr.upload && this.hasListeners('progress')) {
|
||
|
xhr.upload.onprogress = handleProgress;
|
||
|
}
|
||
|
} catch(e) {
|
||
|
// Accessing xhr.upload fails in IE from a web worker, so just pretend it doesn't exist.
|
||
|
// Reported here:
|
||
|
// https://connect.microsoft.com/IE/feedback/details/837245/xmlhttprequest-upload-throws-invalid-argument-when-used-from-web-worker-context
|
||
|
}
|
||
|
|
||
|
// timeout
|
||
|
if (timeout && !this._timer) {
|
||
|
this._timer = setTimeout(function(){
|
||
|
self.timedout = true;
|
||
|
self.abort();
|
||
|
}, timeout);
|
||
|
}
|
||
|
|
||
|
// querystring
|
||
|
if (query) {
|
||
|
query = request.serializeObject(query);
|
||
|
this.url += ~this.url.indexOf('?')
|
||
|
? '&' + query
|
||
|
: '?' + query;
|
||
|
}
|
||
|
|
||
|
// initiate request
|
||
|
if (this.username && this.password) {
|
||
|
xhr.open(this.method, this.url, true, this.username, this.password);
|
||
|
} else {
|
||
|
xhr.open(this.method, this.url, true);
|
||
|
}
|
||
|
|
||
|
// CORS
|
||
|
if (this._withCredentials) xhr.withCredentials = true;
|
||
|
|
||
|
// body
|
||
|
if ('GET' != this.method && 'HEAD' != this.method && 'string' != typeof data && !isHost(data)) {
|
||
|
// serialize stuff
|
||
|
var contentType = this._header['content-type'];
|
||
|
var serialize = this._parser || request.serialize[contentType ? contentType.split(';')[0] : ''];
|
||
|
if (!serialize && isJSON(contentType)) serialize = request.serialize['application/json'];
|
||
|
if (serialize) data = serialize(data);
|
||
|
}
|
||
|
|
||
|
// set header fields
|
||
|
for (var field in this.header) {
|
||
|
if (null == this.header[field]) continue;
|
||
|
xhr.setRequestHeader(field, this.header[field]);
|
||
|
}
|
||
|
|
||
|
if (this._responseType) {
|
||
|
xhr.responseType = this._responseType;
|
||
|
}
|
||
|
|
||
|
// send stuff
|
||
|
this.emit('request', this);
|
||
|
|
||
|
// IE11 xhr.send(undefined) sends 'undefined' string as POST payload (instead of nothing)
|
||
|
// We need null here if data is undefined
|
||
|
xhr.send(typeof data !== 'undefined' ? data : null);
|
||
|
return this;
|
||
|
};
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Expose `Request`.
|
||
|
*/
|
||
|
|
||
|
request.Request = Request;
|
||
|
|
||
|
/**
|
||
|
* GET `url` with optional callback `fn(res)`.
|
||
|
*
|
||
|
* @param {String} url
|
||
|
* @param {Mixed|Function} data or fn
|
||
|
* @param {Function} fn
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
request.get = function(url, data, fn){
|
||
|
var req = request('GET', url);
|
||
|
if ('function' == typeof data) fn = data, data = null;
|
||
|
if (data) req.query(data);
|
||
|
if (fn) req.end(fn);
|
||
|
return req;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* HEAD `url` with optional callback `fn(res)`.
|
||
|
*
|
||
|
* @param {String} url
|
||
|
* @param {Mixed|Function} data or fn
|
||
|
* @param {Function} fn
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
request.head = function(url, data, fn){
|
||
|
var req = request('HEAD', url);
|
||
|
if ('function' == typeof data) fn = data, data = null;
|
||
|
if (data) req.send(data);
|
||
|
if (fn) req.end(fn);
|
||
|
return req;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* DELETE `url` with optional callback `fn(res)`.
|
||
|
*
|
||
|
* @param {String} url
|
||
|
* @param {Function} fn
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
function del(url, fn){
|
||
|
var req = request('DELETE', url);
|
||
|
if (fn) req.end(fn);
|
||
|
return req;
|
||
|
};
|
||
|
|
||
|
request['del'] = del;
|
||
|
request['delete'] = del;
|
||
|
|
||
|
/**
|
||
|
* PATCH `url` with optional `data` and callback `fn(res)`.
|
||
|
*
|
||
|
* @param {String} url
|
||
|
* @param {Mixed} data
|
||
|
* @param {Function} fn
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
request.patch = function(url, data, fn){
|
||
|
var req = request('PATCH', url);
|
||
|
if ('function' == typeof data) fn = data, data = null;
|
||
|
if (data) req.send(data);
|
||
|
if (fn) req.end(fn);
|
||
|
return req;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* POST `url` with optional `data` and callback `fn(res)`.
|
||
|
*
|
||
|
* @param {String} url
|
||
|
* @param {Mixed} data
|
||
|
* @param {Function} fn
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
request.post = function(url, data, fn){
|
||
|
var req = request('POST', url);
|
||
|
if ('function' == typeof data) fn = data, data = null;
|
||
|
if (data) req.send(data);
|
||
|
if (fn) req.end(fn);
|
||
|
return req;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* PUT `url` with optional `data` and callback `fn(res)`.
|
||
|
*
|
||
|
* @param {String} url
|
||
|
* @param {Mixed|Function} data or fn
|
||
|
* @param {Function} fn
|
||
|
* @return {Request}
|
||
|
* @api public
|
||
|
*/
|
||
|
|
||
|
request.put = function(url, data, fn){
|
||
|
var req = request('PUT', url);
|
||
|
if ('function' == typeof data) fn = data, data = null;
|
||
|
if (data) req.send(data);
|
||
|
if (fn) req.end(fn);
|
||
|
return req;
|
||
|
};
|