yql.js revision 7368220dd87582da2552f8152bbff2508e5ddf1d
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt SweeneyYUI.add('yql', function(Y) {
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt Sweeney
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt Sweeney /**
e0e25f8d302fa5ef03a5960832fd3eefec659ce3Matt Sweeney * This class adds a sugar class to allow access to YQL (http://developer.yahoo.com/yql/).
e0e25f8d302fa5ef03a5960832fd3eefec659ce3Matt Sweeney * @module yql
e0e25f8d302fa5ef03a5960832fd3eefec659ce3Matt Sweeney */
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt Sweeney /**
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt Sweeney * Utility Class used under the hood my the YQL class
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt Sweeney * @class YQLRequest
651f50fab63220a4fdab7ac7bdd363ec676713aaMatt Sweeney * @constructor
* @param {String} sql The SQL statement to execute
* @param {Function/Object} callback The callback to execute after the query (Falls through to JSONP).
* @param {Object} params An object literal of extra parameters to pass along (optional).
* @param {Object} opts An object literal of configuration options (optional): proto (http|https), base (url)
*/
var YQLRequest = function (sql, callback, params, opts) {
if (!params) {
params = {};
}
params.q = sql;
//Allow format override.. JSON-P-X
if (!params.format) {
params.format = Y.YQLRequest.FORMAT;
}
if (!params.env) {
params.env = Y.YQLRequest.ENV;
}
this._params = params;
this._opts = opts;
this._callback = callback;
};
YQLRequest.prototype = {
/**
* @private
* @property _opts
* @description Holder for the opts argument
*/
_opts: null,
/**
* @private
* @property _callback
* @description Holder for the callback argument
*/
_callback: null,
/**
* @private
* @property _params
* @description Holder for the params argument
*/
_params: null,
/**
* @method send
* @description The method that executes the YQL Request.
* @chainable
* @returns {YQLRequest}
*/
send: function() {
var qs = '', url = ((this._opts && this._opts.proto) ? this._opts.proto : Y.YQLRequest.PROTO);
Y.each(this._params, function(v, k) {
qs += k + '=' + encodeURIComponent(v) + '&';
});
url += ((this._opts && this._opts.base) ? this._opts.base : Y.YQLRequest.BASE_URL) + qs;
Y.jsonp(url, this._callback);
return this;
}
};
/**
* @static
* @property FORMAT
* @description Default format to use: json
*/
YQLRequest.FORMAT = 'json';
/**
* @static
* @property PROTO
* @description Default protocol to use: http
*/
YQLRequest.PROTO = 'http';
/**
* @static
* @property BASE_URL
* @description The base URL to query: query.yahooapis.com/v1/public/yql?
*/
YQLRequest.BASE_URL = ':/'+'/query.yahooapis.com/v1/public/yql?';
/**
* @static
* @property ENV
* @description The environment file to load: http://datatables.org/alltables.env
*/
YQLRequest.ENV = 'http:/'+'/datatables.org/alltables.env';
Y.YQLRequest = YQLRequest;
/**
* This class adds a sugar class to allow access to YQL (http://developer.yahoo.com/yql/).
* @class YQL
* @constructor
* @param {String} sql The SQL statement to execute
* @param {Function} callback The callback to execute after the query (optional).
* @param {Object} params An object literal of extra parameters to pass along (optional).
*/
Y.YQL = function(sql, callback, params) {
return new Y.YQLRequest(sql, callback, params).send();
};
}, '@VERSION@' ,{requires:['jsonp']});