superagent 3.4.0 → 3.4.4

package/History.md

@@ -1,3 +1,16 @@
+# 3.4.3 (2017-02-14)
+
+ * Fixed being able to define own parsers when their mime type starts with `text/` (Damien Clark)
+ * `withCredentials(false)` (Andy Woods)
+ * Use `formData.on` instead of `.once` (Kornel Lesiński)
+ * Ignore `attach("file",null)` (Kornel Lesiński)
+
+# 3.4.1 (2017-01-29)
+
+ * Allow `retry()` and `retry(0)` (Alexander Pope)
+ * Allow optional body/data in DELETE requests (Alpha Shuro)
+ * Fixed query string on retried requests (Kornel Lesiński)
+
 # 3.4.0 (2017-01-25)
 
  * New `.retry(n)` method and `err.retries` (Alexander Pope)

package/lib/client.js

@@ -12,7 +12,7 @@ if (typeof window !== 'undefined') { // Browser window
   root = this;
 }
 
-var Emitter = require('emitter');
+var Emitter = require('component-emitter');
 var RequestBase = require('./request-base');
 var isObject = require('./is-object');
 var isFunction = require('./is-function');
@@ -501,13 +501,16 @@ Request.prototype.accept = function(type){
  * 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')
+ * @param {String} [pass] optional in case of using 'bearer' as type
+ * @param {Object} options with 'type' property 'auto', 'basic' or 'bearer' (default 'basic')
  * @return {Request} for chaining
  * @api public
  */
 
 Request.prototype.auth = function(user, pass, options){
+  if (typeof pass === 'object' && pass !== null) { // pass is optional and can substitute for options
+    options = pass;
+  }
   if (!options) {
     options = {
       type: 'function' === typeof btoa ? 'basic' : 'auto',
@@ -523,6 +526,10 @@ Request.prototype.auth = function(user, pass, options){
       this.username = user;
       this.password = pass;
     break;
+      
+    case 'bearer': // usage would be .auth(accessToken, { type: 'bearer' })
+      this.set('Authorization', 'Bearer ' + user);
+    break;  
   }
   return this;
 };
@@ -565,11 +572,13 @@ Request.prototype.query = function(val){
  */
 
 Request.prototype.attach = function(field, file, options){
-  if (this._data) {
-    throw Error("superagent can't mix .send() and .attach()");
-  }
+  if (file) {
+    if (this._data) {
+      throw Error("superagent can't mix .send() and .attach()");
+    }
 
-  this._getFormData().append(field, file, options || file.name);
+    this._getFormData().append(field, file, options || file.name);
+  }
   return this;
 };
 
@@ -847,16 +856,19 @@ request.options = function(url, data, fn){
 };
 
 /**
- * DELETE `url` with optional callback `fn(res)`.
+ * DELETE `url` with optional `data` and callback `fn(res)`.
  *
  * @param {String} url
+ * @param {Mixed} [data]
  * @param {Function} [fn]
  * @return {Request}
  * @api public
  */
 
-function del(url, fn){
+function del(url, data, fn){
   var req = request('DELETE', url);
+  if ('function' == typeof data) fn = data, data = null;
+  if (data) req.send(data);
   if (fn) req.end(fn);
   return req;
 };

package/lib/node/index.js

@@ -183,34 +183,37 @@ RequestBase(Request.prototype);
  */
 
 Request.prototype.attach = function(field, file, options){
-  if (this._data) {
-    throw Error("superagent can't mix .send() and .attach()");
-  }
+  if (file) {
+    if (this._data) {
+      throw Error("superagent can't mix .send() and .attach()");
+    }
 
-  var o = options || {};
-  if ('string' == typeof options) {
-    o = { filename: options };
-  }
+    var o = options || {};
+    if ('string' == typeof options) {
+      o = { filename: options };
+    }
 
-  if ('string' == typeof file) {
-    if (!o.filename) o.filename = file;
-    debug('creating `fs.ReadStream` instance for file: %s', file);
-    file = fs.createReadStream(file);
-  } else if (!o.filename && file.path) {
-    o.filename = file.path;
-  }
+    if ('string' == typeof file) {
+      if (!o.filename) o.filename = file;
+      debug('creating `fs.ReadStream` instance for file: %s', file);
+      file = fs.createReadStream(file);
+    } else if (!o.filename && file.path) {
+      o.filename = file.path;
+    }
 
-  this._getFormData().append(field, file, o);
+    this._getFormData().append(field, file, o);
+  }
   return this;
 };
 
 Request.prototype._getFormData = function() {
   if (!this._formData) {
     this._formData = new FormData();
-    this._formData.once('error', function(err) {
-      this.emit('error', err);
-      this.abort();
-    }.bind(this));
+    var that = this;
+    this._formData.on('error', function(err) {
+      that.emit('error', err);
+      that.abort();
+    });
   }
   return this._formData;
 };
@@ -324,12 +327,6 @@ Request.prototype.write = function(data, encoding){
   var req = this.request();
   if (!this._streamRequest) {
     this._streamRequest = true;
-    try {
-      // ensure querystring is appended before headers are sent
-      this._appendQueryString(req);
-    } catch (e) {
-      return this.emit('error', e);
-    }
   }
   return req.write(data, encoding);
 };
@@ -471,18 +468,30 @@ Request.prototype._redirect = function(res){
  *   .auth('tobi', 'learnboost')
  *   .auth('tobi:learnboost')
  *   .auth('tobi')
+ *   .auth(accessToken, { type: 'bearer' })
  *
  * @param {String} user
- * @param {String} pass
+ * @param {String} [pass]
+ * @param {Object} [options] options with authorization type 'basic' or 'bearer' ('basic' is default)
  * @return {Request} for chaining
  * @api public
  */
 
-Request.prototype.auth = function(user, pass){
+Request.prototype.auth = function(user, pass, options){
   if (1 === arguments.length) pass = '';
-  if (!~user.indexOf(':')) user = user + ':';
-  var str = new Buffer(user + pass).toString('base64');
-  return this.set('Authorization', 'Basic ' + str);
+  if (2 === arguments.length && typeof pass === 'object') options = pass;
+  if (!options) {
+    options = { type: 'basic' };
+  }
+  switch (options.type) {
+    case 'bearer':
+      return this.set('Authorization', 'Bearer ' + user);    
+      
+    default: // 'basic'
+      if (!~user.indexOf(':')) user = user + ':';
+      var str = new Buffer(user + pass).toString('base64');
+      return this.set('Authorization', 'Basic ' + str);    
+  }
 };
 
 /**
@@ -600,7 +609,7 @@ Request.prototype.request = function(){
     // if not the same, we are in the **old** (cancelled) request,
     // so need to continue (same as for above)
     if (self._retries !== retries) return;
-    // if we've recieved a response then we don't want to let
+    // if we've received a response then we don't want to let
     // an error in the request blow up the response
     if (self.response) return;
     self.callback(err);
@@ -623,6 +632,12 @@ Request.prototype.request = function(){
     req.setHeader(key, this.header[key]);
   }
 
+  try {
+    this._appendQueryString(req);
+  } catch (e) {
+    return this.emit('error', e);
+  }
+
   return req;
 };
 
@@ -731,7 +746,7 @@ Request.prototype._emitResponse = function(body, files){
 };
 
 Request.prototype.end = function(fn){
-  var req = this.request();
+  this.request();
   debug('%s %s', this.method, this.url);
 
   if (this._endCalled) {
@@ -742,13 +757,6 @@ Request.prototype.end = function(fn){
   // store callback
   this._callback = fn || noop;
 
-  // querystring
-  try {
-    this._appendQueryString(req);
-  } catch (e) {
-    return this.callback(e);
-  }
-
   return this._end();
 };
 
@@ -826,14 +834,14 @@ Request.prototype._end = function() {
         var form = new formidable.IncomingForm();
         parser = form.parse.bind(form);
         buffer = true;
-      } else if (isImage(mime)) {
+      } else if (isImageOrVideo(mime)) {
         parser = exports.parse.image;
         buffer = true; // For backwards-compatibility buffering default is ad-hoc MIME-dependent
+      } else if (exports.parse[mime]) {
+        parser = exports.parse[mime];
       } else if ('text' == type) {
         parser = exports.parse.text;
         buffer = (buffer !== false);
-      } else if (exports.parse[mime]) {
-        parser = exports.parse[mime];
 
         // everyone wants their own white-labeled json
       } else if (isJSON(mime)) {
@@ -1012,19 +1020,10 @@ function isText(mime) {
     || 'x-www-form-urlencoded' == subtype;
 }
 
-/**
- * Check if `mime` is image
- *
- * @param {String} mime
- * @return {Boolean}
- * @api public
- */
-
-function isImage(mime) {
-  var parts = mime.split('/');
-  var type = parts[0];
+function isImageOrVideo(mime) {
+  var type = mime.split('/')[0];
 
-  return 'image' == type;
+  return 'image' == type || 'video' == type;
 }
 
 /**
@@ -1049,4 +1048,4 @@ function isJSON(mime) {
 
 function isRedirect(code) {
   return ~[301, 302, 303, 305, 307, 308].indexOf(code);
-}
+}

package/lib/request-base.js

@@ -140,7 +140,10 @@ RequestBase.prototype.timeout = function timeout(options){
  */
 
 RequestBase.prototype.retry = function retry(count){
-  this._maxRetries = count || 1;
+  // Default to 1 if no count passed or true
+  if (arguments.length === 0 || count === true) count = 1;
+  if (count <= 0) count = 0;
+  this._maxRetries = count;
   this._retries = 0;
   return this;
 };
@@ -384,9 +387,10 @@ RequestBase.prototype.abort = function(){
  * @api public
  */
 
-RequestBase.prototype.withCredentials = function(){
+RequestBase.prototype.withCredentials = function(on){
   // This is browser-only functionality. Node side is no-op.
-  this._withCredentials = true;
+  if(on==undefined) on = true;
+  this._withCredentials = on;
   return this;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "superagent",
-  "version": "3.4.0",
+  "version": "3.4.4",
   "description": "elegant & feature rich browser / node HTTP with a fluent API",
   "scripts": {
     "prepublish": "make all",
@@ -29,7 +29,7 @@
     "debug": "^2.2.0",
     "extend": "^3.0.0",
     "form-data": "^2.1.1",
-    "formidable": "^1.0.17",
+    "formidable": "^1.1.1",
     "methods": "^1.1.1",
     "mime": "^1.3.4",
     "qs": "^6.1.0",
@@ -39,7 +39,7 @@
     "Base64": "^1.0.0",
     "basic-auth-connect": "^1.0.0",
     "body-parser": "^1.15.0",
-    "browserify": "^13.0.0",
+    "browserify": "^14.0.0",
     "cookie-parser": "^1.4.1",
     "express": "^4.13.4",
     "express-session": "^1.13.0",
@@ -52,7 +52,6 @@
   },
   "browser": {
     "./lib/node/index.js": "./lib/client.js",
-    "emitter": "component-emitter",
     "./test/support/server.js": "./test/support/blank.js"
   },
   "component": {

package/superagent.js

@@ -173,7 +173,10 @@ RequestBase.prototype.timeout = function timeout(options){
  */
 
 RequestBase.prototype.retry = function retry(count){
-  this._maxRetries = count || 1;
+  // Default to 1 if no count passed or true
+  if (arguments.length === 0 || count === true) count = 1;
+  if (count <= 0) count = 0;
+  this._maxRetries = count;
   this._retries = 0;
   return this;
 };
@@ -417,9 +420,10 @@ RequestBase.prototype.abort = function(){
  * @api public
  */
 
-RequestBase.prototype.withCredentials = function(){
+RequestBase.prototype.withCredentials = function(on){
   // This is browser-only functionality. Node side is no-op.
-  this._withCredentials = true;
+  if(on==undefined) on = true;
+  this._withCredentials = on;
   return this;
 };
 
@@ -1019,7 +1023,7 @@ if (typeof window !== 'undefined') { // Browser window
   root = this;
 }
 
-var Emitter = require('emitter');
+var Emitter = require('component-emitter');
 var RequestBase = require('./request-base');
 var isObject = require('./is-object');
 var isFunction = require('./is-function');
@@ -1508,13 +1512,16 @@ Request.prototype.accept = function(type){
  * 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')
+ * @param {String} [pass] optional in case of using 'bearer' as type
+ * @param {Object} options with 'type' property 'auto', 'basic' or 'bearer' (default 'basic')
  * @return {Request} for chaining
  * @api public
  */
 
 Request.prototype.auth = function(user, pass, options){
+  if (typeof pass === 'object' && pass !== null) { // pass is optional and can substitute for options
+    options = pass;
+  }
   if (!options) {
     options = {
       type: 'function' === typeof btoa ? 'basic' : 'auto',
@@ -1530,6 +1537,10 @@ Request.prototype.auth = function(user, pass, options){
       this.username = user;
       this.password = pass;
     break;
+      
+    case 'bearer': // usage would be .auth(accessToken, { type: 'bearer' })
+      this.set('Authorization', 'Bearer ' + user);
+    break;  
   }
   return this;
 };
@@ -1572,11 +1583,13 @@ Request.prototype.query = function(val){
  */
 
 Request.prototype.attach = function(field, file, options){
-  if (this._data) {
-    throw Error("superagent can't mix .send() and .attach()");
-  }
+  if (file) {
+    if (this._data) {
+      throw Error("superagent can't mix .send() and .attach()");
+    }
 
-  this._getFormData().append(field, file, options || file.name);
+    this._getFormData().append(field, file, options || file.name);
+  }
   return this;
 };
 
@@ -1854,16 +1867,19 @@ request.options = function(url, data, fn){
 };
 
 /**
- * DELETE `url` with optional callback `fn(res)`.
+ * DELETE `url` with optional `data` and callback `fn(res)`.
  *
  * @param {String} url
+ * @param {Mixed} [data]
  * @param {Function} [fn]
  * @return {Request}
  * @api public
  */
 
-function del(url, fn){
+function del(url, data, fn){
   var req = request('DELETE', url);
+  if ('function' == typeof data) fn = data, data = null;
+  if (data) req.send(data);
   if (fn) req.end(fn);
   return req;
 };
@@ -1925,5 +1941,5 @@ request.put = function(url, data, fn){
   return req;
 };
 
-},{"./is-function":1,"./is-object":2,"./request-base":3,"./response-base":4,"./should-retry":5,"emitter":7}]},{},[8])(8)
+},{"./is-function":1,"./is-object":2,"./request-base":3,"./response-base":4,"./should-retry":5,"component-emitter":7}]},{},[8])(8)
 });

package/changelog.sh

@@ -1,7 +0,0 @@
-#!/bin/bash
-VER=$(git tag -l v[0-9].[0-9]*.[0-9]* | tail -n 1)
-echo "# ($(date +%Y-%m-%d))"
-echo
-git log $VER...HEAD --no-merges --topo-order --format=' * %s (%an)'
-echo
-echo "# $VER"

package/test.js

@@ -1,8 +0,0 @@
-var request = require('.');
-request.get('https://google.com').timeout(1140).end(function(err, res) { console.log(err); });
-request.get('http://google.com').timeout(140).end(function(err, res) { console.log(err); });
-request.get('https://google.com').timeout(40).end(function(err, res) { console.log(err); });
-request.get('http://google.com').timeout(140).end(function(err, res) { console.log(err); });
-request.get('https://google.com').timeout(140).end(function(err, res) { console.log(err); });
-request.get('http://google.com').timeout(1140).end(function(err, res) { console.log(err); });
-request.get('http://google.com').timeout(40).end(function(err, res) { console.log(err); });