+ xhr-promise

RubaXa · RubaXa · commit a787d5907792 · 2013-10-20T11:31:52.000+04:00
diff --git a/README.md b/README.md
@@ -178,7 +178,7 @@ FileAPI.event.on(document, 'drop', function (evt/**Event*/){
 ---
 
 <a name="FileAPI.upload"></a>
-### upload(opts`:Object`)`:XmlHttpRequest`
+### upload(opts`:Object`)`:XmlHttpRequestPromise`
 Uploading files to the server (successively). Returns XHR-like object.
 It is important to remember to correctly worked flash-transport server response body must not be empty,
 for example, you can pass, just text "ok".
@@ -633,9 +633,70 @@ The type (MIME type) of the file referenced by the File object.
 ### size
 The size (in bytes) of the file referenced by the File object.
 
+---
+
+<a name="XmlHttpRequestPromise"></a>
+## XmlHttpRequestPromise
+
+<a name="XmlHttpRequestPromise.status"></a>
+### status`:Number`
+The status of the response to the request. This is the HTTP result code (for example, status is 200 for a successful request).
+
+---
+
+<a name="XmlHttpRequestPromise.statusText"></a>
+### statusText`:String`
+The response string returned by the HTTP server. Unlike status, this includes the entire text of the response message ("200 OK", for example).
+
+---
+
+<a name="XmlHttpRequestPromise.responseXML"></a>
+### responseXML`:Document`
+The response to the request as a DOM Document object, or null if the request was unsuccessful, has not yet been sent, or cannot be parsed as XML or HTML. The response is parsed as if it were a text/xml stream. When the responseType is set to "document" and the request has been made asynchronously, the response is parsed as it were a text/html stream.
+
+---
+
+<a name="XmlHttpRequestPromise.responseText"></a>
+### responseText`:String`
+The response to the request as text, or null if the request was unsuccessful or has not yet been sent.
+
+---
+
+<a name="XmlHttpRequestPromise.abort"></a>
+### abort()`:void`
+Aborts the request if it has already been sent.
 
 ---
 
+<a name="XmlHttpRequestPromise.getAllResponseHeaders"></a>
+### getAllResponseHeaders()`:String`
+Returns all the response headers as a string, or null if no response has been received.
+
+---
+
+<a name="XmlHttpRequestPromise.getResponseHeader"></a>
+### getResponseHeader(name`:String`)`:String`
+Returns the string containing the text of the specified header, or null if either the response has not yet been received or the header doesn't exist in the response.
+
+* name — header name
+
+---
+
+<a name="XmlHttpRequestPromise.success"></a>
+### success(callback`:Function`)`:XmlHttpRequestPromise`
+A function to be called if the request succeeds.
+
+ * callback — receives two arguments: `xhr` and `options`
+
+---
+
+<a name="XmlHttpRequestPromise.error"></a>
+### error(callback`:Function`)`:XmlHttpRequestPromise`
+A function to be called if the request succeeds.
+
+ * callback — receives three arguments: `error`, `xhr` and `options`
+
+---
 
 <a name="FileAPI.event"></a>
 ## FileAPI.event
diff --git a/README.ru.md b/README.ru.md
@@ -177,7 +177,7 @@ FileAPI.event.on(document, 'drop', function (evt/**Event*/){
 ---
 
 <a name="FileAPI.upload"></a>
-### upload(opts`:Object`)`:XmlHttpRequest`
+### upload(opts`:Object`)`:XmlHttpRequestPromise`
 Загрузка файлов на сервер (последовательно). Возвращает XHR-подобный объект.
 Помните, для корректной работы flash-транспорта, тело ответа сервера не должно быть пустым,
 например можно ответить простым текстом "ok".
@@ -616,6 +616,71 @@ MIME type
 Размер файла в байтах.
 
 
+---
+
+<a name="XmlHttpRequestPromise"></a>
+## XmlHttpRequestPromise
+
+
+<a name="XmlHttpRequestPromise.status"></a>
+### status`:Number`
+HTTP-статус в виде числа (404 — «Not Found», 200 — «OK» и т. д.)
+
+---
+
+<a name="XmlHttpRequestPromise.statusText"></a>
+### statusText`:String`
+Статус в виде строки («Not Found», «OK» и т. д.).
+
+---
+
+<a name="XmlHttpRequestPromise.responseXML"></a>
+### responseXML`:Document`
+Текст ответа на запрос в виде XML, который затем может быть обработан посредством DOM.
+
+---
+
+<a name="XmlHttpRequestPromise.responseText"></a>
+### responseText`:String`
+Текст ответа на запрос.
+
+---
+
+<a name="XmlHttpRequestPromise.abort"></a>
+### abort()`:void`
+Отменяет текущий запрос, удаляет все заголовки, ставит текст ответа сервера в null.
+
+---
+
+<a name="XmlHttpRequestPromise.getAllResponseHeaders"></a>
+### getAllResponseHeaders()`:String`
+Возвращает полный список HTTP-заголовков в виде строки.
+
+---
+
+<a name="XmlHttpRequestPromise.getResponseHeader"></a>
+### getResponseHeader(name`:String`)`:String`
+Возвращает значение указанного заголовка. Если заголовок не найден, возвращает null.
+
+* name — имя заголовка
+
+---
+
+<a name="XmlHttpRequestPromise.success"></a>
+### success(callback`:Function`)`:XmlHttpRequestPromise`
+Функция, которая исполняется в случае неудачного запроса.
+
+ * callback — принимает два аргумента: `xhr` и `options`
+
+---
+
+<a name="XmlHttpRequestPromise.error"></a>
+### error(callback`:Function`)`:XmlHttpRequestPromise`
+Функция, которая исполняется в случае успешного запроса.
+
+ * callback — принимает три аргумента: `error`, `xhr` и `options`
+
+
 ---
 
 
diff --git a/examples/demo.html b/examples/demo.html
@@ -28,7 +28,7 @@
 			, staticPath: '../dist/'
 		};
 	</script>
-	<script src="../dist/FileAPI.min.js"></script>
+	<script src="../dist/FileAPI.js"></script>
 	<script src="../plugins/FileAPI.id3.js"></script>
 	<script src="../plugins/FileAPI.exif.js"></script>
 
diff --git a/lib/FileAPI.core.js b/lib/FileAPI.core.js
@@ -20,9 +20,8 @@
 		FileReader = window.FileReader,
 		FormData = window.FormData,
 
-
-		XMLHttpRequest = window.XMLHttpRequest,
 		jQuery = window.jQuery,
+		XMLHttpRequest = window.XMLHttpRequest,
 
 		html5 =    !!(File && (FileReader && (window.Uint8Array || FormData || XMLHttpRequest.prototype.sendAsBinary)))
 				&& !(/safari\//i.test(userAgent) && !/chrome\//i.test(userAgent) && /windows/i.test(userAgent)), // BugFix: https://github.com/mailru/FileAPI/issues/25
@@ -34,15 +33,15 @@
 		// https://github.com/blueimp/JavaScript-Canvas-to-Blob
 		dataURLtoBlob = window.dataURLtoBlob,
 
-
 		_rimg = /img/i,
 		_rcanvas = /canvas/i,
 		_rimgcanvas = /img|canvas/i,
 		_rinput = /input/i,
 		_rdata = /^data:[^,]+,/,
 
-
 		Math = window.Math,
+		setTimeout = window.setTimeout,
+		clearTimeout = window.clearTimeout,
 
 		_SIZE_CONST = function (pow){
 			pow = new window.Number(Math.pow(1024, pow));
@@ -349,26 +348,75 @@
 			 */
 			defer: function (){
 				var
-					  list = []
-					, result
-					, error
+					  doneList = []
+					, failList = []
+					, progressList = []
+
+					, _push = function (x, fn){
+						(x ? doneList : failList).push(fn);
+						return	this;
+					}
+
+					, _complete = function (state, args){
+						var
+							  list = state ? doneList : failList
+							, i = 0, n = list.length
+						;
+
+						_push = function (x, fn){
+							(x === state) && fn.apply(this, args);
+						};
+
+						_complete = noop;
+
+						doneList =
+						failList =
+						progressList = null;
+
+						for( ; i < n; i++ ){
+							list[i] && list[i].apply(this, args);
+						}
+					}
+
 					, defer = {
-						resolve: function (err, res){
-							defer.resolve = noop;
-							error	= err || false;
-							result	= res;
+						done: function (fn){
+							_push(1, fn);
+							return this;
+						},
 
-							while( res = list.shift() ){
-								res(error, result);
-							}
+						fail: function (fn){
+							_push(0, fn);
+							return this;
+						},
+
+						resolve: function (){
+							_complete(1, arguments);
+							return this;
 						},
 
-						then: function (fn){
-							if( error !== undef ){
-								fn(error, result);
-							} else {
-								list.push(fn);
+						reject: function (){
+							_complete(0, arguments);
+							return this;
+						},
+
+						notify: function (){
+							var i = 0, n = progressList.length;
+							for( ; i< n; i++ ){
+								progressList[i].apply(this, arguments);
 							}
+						},
+
+						progress: function (fn){
+							progressList.push(fn);
+							return	this;
+						},
+
+						then: function (doneFn, failFn){
+							return	defer.done(doneFn).fail(failFn);
+						},
+
+						promise: function (){
+							return	this;
 						}
 				};
 
@@ -411,6 +459,7 @@
 						}
 					}
 				;
+
 				return queue;
 			},
 
@@ -936,6 +985,8 @@
 				var
 					  proxyXHR = new api.XHR(options)
 					, dataArray = _getUploadFiles(options.files, options.postName)
+					, defer = api.defer()
+
 					, _this = this
 					, _total = 0
 					, _loaded = 0
@@ -963,6 +1014,11 @@
 				// emit "beforeupload"  event
 				options.beforeupload(proxyXHR, options);
 
+				// Subscribe to `defer`
+				defer.progress(options.progress);
+				defer.done(options.success);
+				defer.fail(options.error);
+
 				// Upload by file
 				_nextFile = function (){
 					var
@@ -1015,7 +1071,7 @@
 										}, _file, xhr, _fileOptions);
 
 										// emit "progress" event
-										options.progress({
+										defer.notify({
 											  type:   'progress'
 											, total:  _total
 											, loaded: proxyXHR.loaded = (_loaded + data.size * (evt.loaded/evt.total))|0
@@ -1063,7 +1119,16 @@
 						});
 					}
 					else {
-						options.complete(proxyXHR.status == 200 || proxyXHR.status == 201 ? false : (proxyXHR.statusText || 'error'), proxyXHR, options);
+						var err = proxyXHR.status == 200 || proxyXHR.status == 201 ? false : (proxyXHR.statusText || 'error');
+
+						if( err ){
+							defer.reject(err, proxyXHR, options);
+						} else {
+							defer.resolve(proxyXHR, options);
+						}
+
+						options.complete(err, proxyXHR, options);
+
 						// Mark done state
 						_complete = true;
 					}
@@ -1082,7 +1147,7 @@
 					_each(files, function (data) {
 						_total += data.size;
 						proxyXHR.files.push(data.file);
-						if (first) {
+						if( first ){
 							dataArray.unshift(data);
 						} else {
 							dataArray.push(data);
@@ -1109,7 +1174,10 @@
 					return	_file;
 				};
 
-				return proxyXHR;
+				proxyXHR.error = defer.fail;
+				proxyXHR.success = defer.done;
+
+				return _extend(proxyXHR, defer);
 			},
 
 
diff --git a/plugins/FileAPI.id3.js b/plugins/FileAPI.id3.js
diff --git a/tests/tests.js b/tests/tests.js
