/
urturn.js
207 lines (174 loc) · 5.38 KB
/
urturn.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/**
* URTURN API
*/
if (!urturn) {
var urturn = (function(window) {
// We create the API object
var urturn = {};
var HOST = 'www.urturn.com';
var ENDPOINT_SEARCH = "/api/search/thumbnails.json";
/**
* urturn.get let you retrieve post from urturn
* @param {Object} options A set of options
* {
* query [String] : The query to get,
* perPage (optional, default 200 or last set value on this query) [Number]: The page to return,
* page (optional, default 0 or last page called + 1) [Number]: the page number
* }
*
* @param {[type]} successCallback The success callback
*/
urturn.get = function(options, successCallback, errorCallback) {
if (typeof (options) === 'string') {
options = {
query : options
};
}
// if no options.query we do not know what to search so raise error
if (!options.query) {
errorCallback(error('get', 'MISSING_QUERY', {}));
return -1;
}
if (typeof(options.query) != 'string') {
errorCallback(error('get', 'WRONG_FORMAT', {key : 'options.query', type : typeof(options.query)}));
return -1;
}
// Get the query object
var query = _queryStore.get(options.query);
if (options.page) {
if (typeof(options.page) != 'number') {
errorCallback(error('get', 'WRONG_FORMAT', {key : 'options.page', type : typeof(options.page)}));
return;
}
query.setPage(options.page);
}
if (options.perPage) {
if (typeof(options.perPage) != 'number') {
errorCallback(error('get', 'WRONG_FORMAT', {key : 'options.perPage', type : typeof(options.perPage)}));
return;
}
query.setPageSize(options.perPage);
}
query.next(successCallback, errorCallback);
};
/**
* Internals Stuff
*/
/**
* The Query object
*/
var Query = function(query) {
this.query = query;
this.page = 1;
this.per_pages = 50;
/**
* return the ne
* @return {Function} [description]
*/
this.next = function (successCallback, errorCallback) {
var url = 'http://' + HOST + ENDPOINT_SEARCH;
url += '?q=' + encodeURIComponent(this.query);
url += '&page=' + this.page++;
url += '&per_page=' + this.per_pages;
var status = AJAX(url, successCallback, errorCallback);
if (status) {
errorCallback(error('get', status, {}));
}
};
this.setPage = function(page) {
if (page | 0 > 0) {
// |0 we prevent not rounded values!
this.page = page | 0;
}
};
this.setPageSize = function(pageSize) {
this.per_pages = pageSize;
};
};
/**
* A helper to manage AJAX
*/
var AJAX = function(url, successCallback, errorCallback) {
var xhr = false;
// Creat XMLHTTPRequest object
if (window.XMLHttpRequest) { // if Mozilla, Safari etc
xhr = new XMLHttpRequest();
}
else if (window.ActiveXObject) {// if IE
try {
xhr = new ActiveXObject("Msxml2.XMLHTTP");
}
catch (catchedError) {
try {
xhr = new ActiveXObject("Microsoft.XMLHTTP");
}
catch (catchedError2) {
return 'XHR_IE_FAIL';
}
}
}
else {
return 'NO_XHR';
}
xhr.open('GET', url, true);
xhr.onload = function (e) {
var result = JSON.parse(xhr.responseText);
successCallback(result);
};
xhr.ontimeout = function(e) {
errorCallback(error('get', 'XHR_TIMEOUT', {}));
};
xhr.onerror = function (e) {
errorCallback(error('get', 'XHR_ERROR', {}));
};
xhr.send(null);
};
/**
* An object to manage query hystory (singleton)
* @return {[type]} [description]
*/
var _queryStore = new function () {
/**
* An hash table to manage query history
*/
this._queryHistory = {};
/**
* get Query Object
*/
this.get = function(query) {
if (this._queryHistory[query]) {
return this._queryHistory[query];
}
var _query = new Query(query);
this._queryHistory[query] = _query;
return _query;
};
}();
/**
* A function that create human readable error messages
*/
var error = function(fn, code, options) {
var errorHash = {};
errorHash.api_method = 'urturn.' + fn;
errorHash.message = 'An unknow Error happen!';
errorHash.code = code;
var messages = {
'MISSING_QUERY' : 'No query in options hash. We do not know what to search.',
'WRONG_FORMAT' : '{key} should be a String, was a {type} instead!',
'NO_XHR' : 'Can not instanciate XMLHttpRequest Object.',
'XHR_ERROR' : 'There was an error on urturn server.',
'XHR_TIMEOUT' : 'Request to urturn server Timeout.',
'XHR_IE_FAIL' : 'No ActiveXObject for XMLHTTP. (ActiveX not activated?)'
};
if (messages[code]) {
errorHash.message = messages[code];
for (var key in options) {
errorHash.message.replace('{' + key + '}', options.key);
}
}
return errorHash;
};
// We return the api object
return urturn;
})(window);
}