src/cm/media/js/lib/yui/yui3-3.15.0/build/yql/yql.js
author gibus
Mon, 10 Mar 2014 15:19:48 +0100
changeset 602 e16a97fb364a
permissions -rw-r--r--
Use YUI 3.15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('yql', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
 * This class adds a sugar class to allow access to YQL (http://developer.yahoo.com/yql/).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
 * @module yql
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
 * Utility Class used under the hood by the YQL class
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
 * @class YQLRequest
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
 * @param {String} sql The SQL statement to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
 * @param {Function/Object} callback The callback to execute after the query (Falls through to JSONP).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
 * @param {Object} params An object literal of extra parameters to pass along (optional).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
 * @param {Object} opts An object literal of configuration options (optional): proto (http|https), base (url)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
var YQLRequest = function (sql, callback, params, opts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
    if (!params) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
        params = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
    params.q = sql;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
    //Allow format override.. JSON-P-X
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
    if (!params.format) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
        params.format = Y.YQLRequest.FORMAT;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
    if (!params.env) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
        params.env = Y.YQLRequest.ENV;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
    this._context = this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
    if (opts && opts.context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
        this._context = opts.context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
        delete opts.context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
    if (params && params.context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
        this._context = params.context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
        delete params.context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
    this._params = params;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
    this._opts = opts;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
    this._callback = callback;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
YQLRequest.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
    * @property _jsonp
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
    * @description Reference to the JSONP instance used to make the queries
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
    _jsonp: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
    * @property _opts
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
    * @description Holder for the opts argument
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
    _opts: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
    * @property _callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
    * @description Holder for the callback argument
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
    _callback: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
    * @property _params
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
    * @description Holder for the params argument
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
    _params: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
    * @property _context
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
    * @description The context to execute the callback in
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
    _context: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
    * @method _internal
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
    * @description Internal Callback Handler
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
    _internal: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
        this._callback.apply(this._context, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
    * @method send
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
    * @description The method that executes the YQL Request.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
    * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
    * @return {YQLRequest}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
    send: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
        var qs = [], url = ((this._opts && this._opts.proto) ? this._opts.proto : Y.YQLRequest.PROTO), o;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
        Y.Object.each(this._params, function (v, k) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
            qs.push(k + '=' + encodeURIComponent(v));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
        qs = qs.join('&');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
        url += ((this._opts && this._opts.base) ? this._opts.base : Y.YQLRequest.BASE_URL) + qs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
        o = (!Y.Lang.isFunction(this._callback)) ? this._callback : { on: { success: this._callback } };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
        o.on = o.on || {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
        this._callback = o.on.success;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
        o.on.success = Y.bind(this._internal, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
        this._send(url, o);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
    * Private method to send the request, overwritten in plugins
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
    * @method _send
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
    * @param {String} url The URL to request
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
    * @param {Object} o The config object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
    _send: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
        //Overwritten in plugins
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
* @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
* @property FORMAT
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
* @description Default format to use: json
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
*/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
YQLRequest.FORMAT = 'json';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
* @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
* @property PROTO
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
* @description Default protocol to use: http
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
*/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
YQLRequest.PROTO = 'http';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
* @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
* @property BASE_URL
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
* @description The base URL to query: query.yahooapis.com/v1/public/yql?
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
*/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
YQLRequest.BASE_URL = ':/' + '/query.yahooapis.com/v1/public/yql?';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
* @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
* @property ENV
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
* @description The environment file to load: http://datatables.org/alltables.env
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
*/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
YQLRequest.ENV = 'http:/' + '/datatables.org/alltables.env';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
Y.YQLRequest = YQLRequest;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
 * This class adds a sugar class to allow access to YQL (http://developer.yahoo.com/yql/).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
 * @class YQL
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
 * @param {String} sql The SQL statement to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
 * @param {Function} callback The callback to execute after the query (optional).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
 * @param {Object} params An object literal of extra parameters to pass along (optional).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
 * @param {Object} opts An object literal of configuration options (optional): proto (http|https), base (url)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
Y.YQL = function (sql, callback, params, opts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
    return new Y.YQLRequest(sql, callback, params, opts).send();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
}, '@VERSION@', {"requires": ["oop"]});