-
Notifications
You must be signed in to change notification settings - Fork 0
/
irail-api.js
214 lines (189 loc) · 7.9 KB
/
irail-api.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
208
209
210
211
212
213
214
// iRail Website, mobile and desktop; Get public transit information for Belgium
// Copyright (C) 2010 Mathias Baert
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// iRail Web - Mathias Baert 2010 - Some kind of free licence
// IRail: JavaScript wrapper for the iRail REST api (note to self: verify that it really is REST)
// started from http://mathiasbynens.be/demo/irail-api
if (IRail) {
throw("'IRail' already exists");
}
var IRail = (function(){
var baseUri = 'http://dev.api.irail.be';
var uniqueGlobalNameCounter = {};
var uniqueGlobalName = function(name) {
uniqueGlobalNameCounter[name] = uniqueGlobalNameCounter[name] ? uniqueGlobalNameCounter[name]+1 : 1;
// just to be sure: find a name which is not in use yet.
for (; window[name+uniqueGlobalNameCounter[name]]; uniqueGlobalNameCounter[name]++) {}
return name+uniqueGlobalNameCounter[name];
}
var insertScript = function(uri, callbackSuccess, callbackError) {
var callbackName = uniqueGlobalName('iRailCallback');
window[callbackName] = function() {
if (arguments[0].error) {
callbackError && callbackError.apply(null, arguments);
} else {
callbackSuccess.apply(null, arguments);
}
delete window[callbackName];
var elScript = document.getElementById(callbackName);
elScript.parentNode.removeChild(elScript);
};
var elScript = document.createElement('script');
elScript.id = callbackName;
elScript.src = uri+'&callback='+callbackName;
document.body.appendChild(elScript);
};
// object structure should be predictable
var processResponseLiveboard = function(data) {
// 1. Normalize departures:
// 1.1. departures object must exist
if (!data.departures || !data.departures.departure) {
data.departures = {'number':'0', 'departure':[]};
}
// 1.2. and it must have an array of departure's
if (!data.departures.departure.pop) {
data.departures.departure = [data.departures.departure];
}
// 2. Normalize error property
data.error = false;
return data;
};
// object structure should be predictable
var processResponseConnections = function(data) {
// 1. Normalize vias:
for (var i=0; i<data.connection.length; i++) {
// 1.1. vias object must exist
if (!data.connection[i].vias) {
data.connection[i].vias = {'number':'0', 'via':[]};
}
// 1.2. and it must have an array of via's
if (!data.connection[i].vias.via.pop) {
data.connection[i].vias.via = [data.connection[i].vias.via];
}
// 1.3. and delay must exist on departure and arrival
for (var j=0; j<data.connection[i].vias.via.length; j++) {
data.connection[i].vias.via[j].departure.delay = data.connection[i].vias.via[j].departure.delay || "0";
data.connection[i].vias.via[j].arrival.delay = data.connection[i].vias.via[j].arrival.delay || "0";
}
}
// 2. Normalize error property
data.error = false;
return data;
};
var t = function(time, format) {
switch (format) {
case 'ddmmyy':
return _.padZeroes(time.getDate())+_.padZeroes(time.getMonth()+1)+(time.getYear()%100);
break;
case 'mmhh':
return _.padZeroes(time.getHours())+_.padZeroes(time.getMinutes());
break;
}
};
return {
// IRail.stations()
// takes 1 parameters object with:
// - success; function; required; callback in case of success
// - error; function; optional; callback in case of error
connections : function(args) {
if (!args['success']) {throw('Missing argument "success"');}
insertScript(
baseUri+'/stations/?format=json',
function(data) {
args['success'](data);
},
args['error']
);
},
// IRail.connections({departure:'GENT', arrival:'ANTWERPEN', success:function(data){...}})
// takes 1 parameters object with:
// - departure; string; required; name of the station of departure
// - arrival; string; required; name of the station of arrival
// - departAt; date; this or arriveAt is required; the prefered time of departure
// - arriveAt; date; this or departAt is required; the prefered time of arrival
// - transport; array of strings; optional; possible values ['train', 'bus', 'taxi']; methods of transportation which are acceptable
// - limit; number; optional, default=3; the amount of results to return; this is not guaranteed: if 2 connections have the same arrival time, they will be counted as 1
// - success; function; required; callback in case of success
// - error; function; optional; callback in case of error
connections : function(args) {
if (!args['departure']) {throw('Missing argument "departure"');}
if (!args['arrival']) {throw('Missing argument "arrival"');}
if (!args['departAt'] && !args['arriveAt']) {throw('Missing argument "departAt" or "arriveAt"');}
if (!args['success']) {throw('Missing argument "success"');}
var limit = Number(args['limit']) || 3;
var date = (args['departAt'] || args['arriveAt']);
var uri = baseUri+'/connections/?format=json'+
'&from='+encodeURIComponent(args['departure'])+
'&to='+encodeURIComponent(args['arrival'])+
'&date='+t(date, 'ddmmyy')+
'&time='+t(date, 'mmhh')+
'&timeSel='+(args['departAt'] ? 'depart' : 'arrive')+
'&results='+limit+
'&typeOfTransport='+encodeURIComponent((args['transport']||[]).join(';'));
insertScript(
uri,
function(data) {
args['success'](processResponseConnections(data));
},
args['error']
);
},
// IRail.liveboard({station:'ANTWERPEN CENTRAAL', success:function(data){...}})
// takes 1 parameters object with:
// - station; string; this or id is required; name of the station
// - id; string; this or station is required; id of the station
// - departAt; date; this or arriveAt is required; the prefered time of departure
// - arriveAt; date; this or departAt is required; the prefered time of arrival
// - success; function; required; callback in case of success
// - error; function; optional; callback in case of error
liveboard : function(args) {
if (!args['station'] && !args['id']) {throw('Missing argument "station" or "id"');}
if (!args['departAt'] && !args['arriveAt']) {throw('Missing argument "departAt" or "arriveAt"');}
if (!args['success']) {throw('Missing argument "success"');}
var date = (args['departAt'] || args['arriveAt']);
var uri = baseUri+'/liveboard/?format=json'+
'&station='+encodeURIComponent(args['station'])+
'&id='+encodeURIComponent(args['id'])+
'&date='+t(date, 'ddmmyy')+
'&time='+t(date, 'mmhh')+
'&arrdep='+(args['departAt'] ? 'DEP' : 'ARR');
insertScript(
uri,
function(data) {
args['success'](processResponseLiveboard(data));
},
args['error']
);
},
// IRail.vehicle({id:'Be.NMBS.P1234', success:function(data){...}})
// takes 1 parameters object with:
// - id; string; required; id of the vehicle
// - success; function; required; callback in case of success
// - error; function; optional; callback in case of error
vehicle : function(args) {
if (!args['id']) {throw('Missing argument "id"');}
if (!args['success']) {throw('Missing argument "success"');}
var uri = baseUri+'/vehicle/?format=json'+
'&id='+encodeURIComponent(args['id']);
insertScript(
uri,
function(data) {
args['success'](data);
},
args['error']
);
}
};
})();