143 lines
4.7 KiB
JavaScript
143 lines
4.7 KiB
JavaScript
/* JSON-P implementation for Prototype.js somewhat by Dan Dean (http://www.dandean.com)
|
|
*
|
|
* *HEAVILY* based on Tobie Langel's version: http://gist.github.com/145466.
|
|
* Might as well just call this an iteration.
|
|
*
|
|
* This version introduces:
|
|
* - Support for predefined callbacks (Necessary for OAuth signed requests, by @rboyce)
|
|
* - Partial integration with Ajax.Responders (Thanks to @sr3d for the kick in this direction)
|
|
* - Compatibility with Prototype 1.7 (Thanks to @soung3 for the bug report)
|
|
* - Will not break if page lacks a <head> element
|
|
*
|
|
* See examples in README for usage
|
|
*
|
|
* VERSION 1.1.2
|
|
*
|
|
* new Ajax.JSONRequest(url, options);
|
|
* - url (String): JSON-P endpoint url.
|
|
* - options (Object): Configuration options for the request.
|
|
*/
|
|
Ajax.JSONRequest = Class.create(Ajax.Base, (function() {
|
|
var id = 0, head = document.getElementsByTagName('head')[0] || document.body;
|
|
return {
|
|
initialize: function($super, url, options) {
|
|
$super(options);
|
|
this.options.url = url;
|
|
this.options.callbackParamName = this.options.callbackParamName || 'callback';
|
|
this.options.timeout = this.options.timeout || 10; // Default timeout: 10 seconds
|
|
this.options.invokeImmediately = (!Object.isUndefined(this.options.invokeImmediately)) ? this.options.invokeImmediately : true ;
|
|
|
|
if (!Object.isUndefined(this.options.parameters) && Object.isString(this.options.parameters)) {
|
|
this.options.parameters = this.options.parameters.toQueryParams();
|
|
}
|
|
|
|
if (this.options.invokeImmediately) {
|
|
this.request();
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Ajax.JSONRequest#_cleanup() -> undefined
|
|
* Cleans up after the request
|
|
**/
|
|
_cleanup: function() {
|
|
if (this.timeout) {
|
|
clearTimeout(this.timeout);
|
|
this.timeout = null;
|
|
}
|
|
if (this.transport && Object.isElement(this.transport)) {
|
|
this.transport.remove();
|
|
this.transport = null;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Ajax.JSONRequest#request() -> undefined
|
|
* Invokes the JSON-P request lifecycle
|
|
**/
|
|
request: function() {
|
|
|
|
// Define local vars
|
|
var response = new Ajax.JSONResponse(this);
|
|
var key = this.options.callbackParamName,
|
|
name = '_prototypeJSONPCallback_' + (id++),
|
|
complete = function() {
|
|
if (Object.isFunction(this.options.onComplete)) {
|
|
this.options.onComplete.call(this, response);
|
|
}
|
|
Ajax.Responders.dispatch('onComplete', this, response);
|
|
}.bind(this);
|
|
|
|
// If the callback parameter is already defined, use that
|
|
if (this.options.parameters[key] !== undefined) {
|
|
name = this.options.parameters[key];
|
|
}
|
|
// Otherwise, add callback as a parameter
|
|
else {
|
|
this.options.parameters[key] = name;
|
|
}
|
|
|
|
// Build request URL
|
|
this.options.parameters[key] = name;
|
|
var url = this.options.url + ((this.options.url.include('?') ? '&' : '?') + Object.toQueryString(this.options.parameters));
|
|
|
|
// Define callback function
|
|
window[name] = function(json) {
|
|
this._cleanup(); // Garbage collection
|
|
window[name] = undefined;
|
|
|
|
response.status = 200;
|
|
response.statusText = "OK";
|
|
response.setResponseContent(json);
|
|
|
|
if (Object.isFunction(this.options.onSuccess)) {
|
|
this.options.onSuccess.call(this, response);
|
|
}
|
|
Ajax.Responders.dispatch('onSuccess', this, response);
|
|
|
|
complete();
|
|
|
|
}.bind(this);
|
|
|
|
this.transport = new Element('script', { type: 'text/javascript', src: url });
|
|
|
|
if (Object.isFunction(this.options.onCreate)) {
|
|
this.options.onCreate.call(this, response);
|
|
}
|
|
Ajax.Responders.dispatch('onCreate', this);
|
|
|
|
head.appendChild(this.transport);
|
|
|
|
this.timeout = setTimeout(function() {
|
|
this._cleanup();
|
|
window[name] = Prototype.emptyFunction;
|
|
if (Object.isFunction(this.options.onFailure)) {
|
|
response.status = 504;
|
|
response.statusText = "Gateway Timeout";
|
|
this.options.onFailure.call(this, response);
|
|
}
|
|
complete();
|
|
}.bind(this), this.options.timeout * 1000);
|
|
},
|
|
toString: function() { return "[object Ajax.JSONRequest]"; }
|
|
};
|
|
})());
|
|
|
|
Ajax.JSONResponse = Class.create({
|
|
initialize: function(request) {
|
|
this.request = request;
|
|
},
|
|
request: undefined,
|
|
status: 0,
|
|
statusText: '',
|
|
responseJSON: undefined,
|
|
responseText: undefined,
|
|
setResponseContent: function(json) {
|
|
this.responseJSON = json;
|
|
this.responseText = Object.toJSON(json);
|
|
},
|
|
getTransport: function() {
|
|
if (this.request) return this.request.transport;
|
|
},
|
|
toString: function() { return "[object Ajax.JSONResponse]"; }
|
|
}); |