ldbws 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.editorconfig +14 -0
- data/.envrc +1 -0
- data/.gitignore +8 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +79 -0
- data/LICENSE +21 -0
- data/Makefile +8 -0
- data/README.md +47 -0
- data/doc/LICENSE.html +93 -0
- data/doc/Ldbws/Request/GetDeparturesBoard.html +114 -0
- data/doc/Ldbws/Request/GetDeparturesBoardWithDetails.html +116 -0
- data/doc/Ldbws/Request/GetServiceDetails.html +105 -0
- data/doc/Ldbws/Request/GetStationBoard.html +120 -0
- data/doc/Ldbws/Request/GetStationBoardWithDetails.html +120 -0
- data/doc/Ldbws/Request.html +91 -0
- data/doc/Ldbws/ResponseTypes/BaseStationBoard.html +108 -0
- data/doc/Ldbws/ResponseTypes/CallingPoint.html +129 -0
- data/doc/Ldbws/ResponseTypes/Coach.html +114 -0
- data/doc/Ldbws/ResponseTypes/DepartureItem.html +108 -0
- data/doc/Ldbws/ResponseTypes/DepartureItemWithDetails.html +108 -0
- data/doc/Ldbws/ResponseTypes/DeparturesBoard.html +105 -0
- data/doc/Ldbws/ResponseTypes/DeparturesBoardWithDetails.html +105 -0
- data/doc/Ldbws/ResponseTypes/Formation.html +108 -0
- data/doc/Ldbws/ResponseTypes/LoadingCategory.html +105 -0
- data/doc/Ldbws/ResponseTypes/Location.html +105 -0
- data/doc/Ldbws/ResponseTypes/ServiceDetails.html +143 -0
- data/doc/Ldbws/ResponseTypes/ServiceItem.html +132 -0
- data/doc/Ldbws/ResponseTypes/ServiceItemWithCallingPoints.html +106 -0
- data/doc/Ldbws/ResponseTypes/StationBoard.html +107 -0
- data/doc/Ldbws/ResponseTypes/StationBoardWithDetails.html +107 -0
- data/doc/Ldbws/ResponseTypes/ToiletAvailability.html +108 -0
- data/doc/Ldbws/ResponseTypes.html +91 -0
- data/doc/Ldbws/Service.html +538 -0
- data/doc/Ldbws.html +149 -0
- data/doc/README_md.html +159 -0
- data/doc/created.rid +19 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +662 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +165 -0
- data/doc/js/darkfish.js +84 -0
- data/doc/js/navigation.js +105 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +110 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +229 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +299 -0
- data/ldbws.gemspec +25 -0
- data/lib/ldbws/request/base.rb +69 -0
- data/lib/ldbws/request/get_departures_board.rb +54 -0
- data/lib/ldbws/request/get_service_details.rb +29 -0
- data/lib/ldbws/request/get_station_board.rb +60 -0
- data/lib/ldbws/response_types/base.rb +34 -0
- data/lib/ldbws/response_types/calling_point.rb +40 -0
- data/lib/ldbws/response_types/departures_board.rb +39 -0
- data/lib/ldbws/response_types/formation.rb +49 -0
- data/lib/ldbws/response_types/parsing_functions.rb +177 -0
- data/lib/ldbws/response_types/service_details.rb +69 -0
- data/lib/ldbws/response_types/service_item.rb +77 -0
- data/lib/ldbws/response_types/station_board.rb +50 -0
- data/lib/ldbws/service.rb +218 -0
- data/lib/ldbws/utils.rb +60 -0
- data/lib/ldbws/version.rb +4 -0
- data/lib/ldbws.rb +13 -0
- data/spec/response_types/parsing_spec.rb +46 -0
- data/spec/spec_helper.rb +4 -0
- metadata +224 -0
|
@@ -0,0 +1,538 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class Ldbws::Service - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="class">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
<div class="nav-section">
|
|
58
|
+
<h3>Table of Contents</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
<ul class="link-list" role="directory">
|
|
63
|
+
<li> <a href="#class-Ldbws::Service-label-Usage+example">Usage example</a>
|
|
64
|
+
<li> <a href="#class-Ldbws::Service-label-Side+note">Side note</a>
|
|
65
|
+
|
|
66
|
+
</ul>
|
|
67
|
+
</div>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<div id="class-metadata">
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<div id="parent-class-section" class="nav-section">
|
|
74
|
+
<h3>Parent</h3>
|
|
75
|
+
|
|
76
|
+
<p class="link">Object
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
<!-- Method Quickref -->
|
|
83
|
+
<div id="method-list-section" class="nav-section">
|
|
84
|
+
<h3>Methods</h3>
|
|
85
|
+
|
|
86
|
+
<ul class="link-list" role="directory">
|
|
87
|
+
<li ><a href="#method-c-new">::new</a>
|
|
88
|
+
<li ><a href="#method-i-get_arr_board_with_details">#get_arr_board_with_details</a>
|
|
89
|
+
<li ><a href="#method-i-get_arr_dep_board_with_details">#get_arr_dep_board_with_details</a>
|
|
90
|
+
<li ><a href="#method-i-get_arrival_board">#get_arrival_board</a>
|
|
91
|
+
<li ><a href="#method-i-get_arrival_board_with_details">#get_arrival_board_with_details</a>
|
|
92
|
+
<li ><a href="#method-i-get_arrival_departure_board">#get_arrival_departure_board</a>
|
|
93
|
+
<li ><a href="#method-i-get_arrival_departure_board_with_details">#get_arrival_departure_board_with_details</a>
|
|
94
|
+
<li ><a href="#method-i-get_dep_board_with_details">#get_dep_board_with_details</a>
|
|
95
|
+
<li ><a href="#method-i-get_departure_board">#get_departure_board</a>
|
|
96
|
+
<li ><a href="#method-i-get_departure_board_with_details">#get_departure_board_with_details</a>
|
|
97
|
+
<li ><a href="#method-i-get_fastest_departures_with_details">#get_fastest_departures_with_details</a>
|
|
98
|
+
<li ><a href="#method-i-get_next_departures">#get_next_departures</a>
|
|
99
|
+
<li ><a href="#method-i-get_next_departures_with_details">#get_next_departures_with_details</a>
|
|
100
|
+
<li ><a href="#method-i-get_service_details">#get_service_details</a>
|
|
101
|
+
</ul>
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
</nav>
|
|
106
|
+
|
|
107
|
+
<main role="main" aria-labelledby="class-Ldbws::Service">
|
|
108
|
+
<h1 id="class-Ldbws::Service" class="class">
|
|
109
|
+
class Ldbws::Service
|
|
110
|
+
</h1>
|
|
111
|
+
|
|
112
|
+
<section class="description">
|
|
113
|
+
|
|
114
|
+
<p>A wrapper around the National Rail Live Departure Boards Webservice (LDBWS) API.</p>
|
|
115
|
+
|
|
116
|
+
<p>API methods are pretty much as-specified in <a href="https://lite.realtime.nationalrail.co.uk/openldbws/">the documentation</a>, although methods on this class are specified using snake_case rather than the CamelCase used in the web service.</p>
|
|
117
|
+
|
|
118
|
+
<h3 id="class-Ldbws::Service-label-Usage+example">Usage example<span><a href="#class-Ldbws::Service-label-Usage+example">¶</a> <a href="#top">↑</a></span></h3>
|
|
119
|
+
|
|
120
|
+
<p>TL;DR:</p>
|
|
121
|
+
|
|
122
|
+
<pre class="ruby"><span class="ruby-identifier">service</span> = <span class="ruby-identifier">new</span> <span class="ruby-constant">Ldbws</span><span class="ruby-operator">::</span><span class="ruby-constant">Service</span>( <span class="ruby-string">"YOUR-API-TOKEN"</span> )
|
|
123
|
+
<span class="ruby-identifier">departures</span> = <span class="ruby-identifier">service</span>.<span class="ruby-identifier">get_departure_board</span>( <span class="ruby-value">crs:</span> <span class="ruby-string">"CDF"</span> )
|
|
124
|
+
</pre>
|
|
125
|
+
|
|
126
|
+
<p>Will furnish you with a list of all departures from Cardiff Central. Other methods work pretty much as you’d expect if you’ve any familiarity with the service. Individual requests use <a href="Request.html"><code>Request</code></a> objects to validate input parameters, and this is noted below. See the corresponding request object for each method for further information as to the parameters.</p>
|
|
127
|
+
|
|
128
|
+
<h3 id="class-Ldbws::Service-label-Side+note">Side note<span><a href="#class-Ldbws::Service-label-Side+note">¶</a> <a href="#top">↑</a></span></h3>
|
|
129
|
+
|
|
130
|
+
<p>The official documentation for this web service is… lacking. While an attempt has been made to elucidate on both the request parameters and response properties, it shouldn’t be taken as any kind of source of truth. Caveat emptor.</p>
|
|
131
|
+
|
|
132
|
+
</section>
|
|
133
|
+
|
|
134
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
141
|
+
<header>
|
|
142
|
+
<h3>Public Class Methods</h3>
|
|
143
|
+
</header>
|
|
144
|
+
|
|
145
|
+
<div id="method-c-new" class="method-detail ">
|
|
146
|
+
<div class="method-header">
|
|
147
|
+
<div class="method-heading">
|
|
148
|
+
<span class="method-name">new</span><span
|
|
149
|
+
class="method-args">(token)</span>
|
|
150
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
151
|
+
</div>
|
|
152
|
+
</div>
|
|
153
|
+
|
|
154
|
+
<div class="method-description">
|
|
155
|
+
<p>Creates a service object.</p>
|
|
156
|
+
|
|
157
|
+
<h3 id="method-c-new-label-Parameters">Parameters<span><a href="#method-c-new-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
|
158
|
+
<dl class="rdoc-list note-list"><dt>token
|
|
159
|
+
<dd>
|
|
160
|
+
<p>the API token used to connect to the service</p>
|
|
161
|
+
</dd></dl>
|
|
162
|
+
|
|
163
|
+
<div class="method-source-code" id="new-source">
|
|
164
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 39</span>
|
|
165
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">token</span>)
|
|
166
|
+
<span class="ruby-ivar">@token</span> = <span class="ruby-identifier">token</span>
|
|
167
|
+
<span class="ruby-keyword">end</span></pre>
|
|
168
|
+
</div>
|
|
169
|
+
</div>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</div>
|
|
173
|
+
|
|
174
|
+
</section>
|
|
175
|
+
|
|
176
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
177
|
+
<header>
|
|
178
|
+
<h3>Public Instance Methods</h3>
|
|
179
|
+
</header>
|
|
180
|
+
|
|
181
|
+
<div id="method-i-get_arr_board_with_details" class="method-detail ">
|
|
182
|
+
<div class="method-header">
|
|
183
|
+
<div class="method-heading">
|
|
184
|
+
<span class="method-name">get_arr_board_with_details</span><span
|
|
185
|
+
class="method-args">(params)</span>
|
|
186
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
187
|
+
</div>
|
|
188
|
+
</div>
|
|
189
|
+
|
|
190
|
+
<div class="method-description">
|
|
191
|
+
<p>Retrieves a detailed station arrival board.</p>
|
|
192
|
+
|
|
193
|
+
<p>Parameters are validated using <a href="Request/GetStationBoardWithDetails.html">GetStationBoardWithDetails</a>, returns a <a href="ResponseTypes/StationBoardWithDetails.html">StationBoardWithDetails</a> object.</p>
|
|
194
|
+
|
|
195
|
+
<div class="method-source-code" id="get_arr_board_with_details-source">
|
|
196
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 91</span>
|
|
197
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_arr_board_with_details</span>(<span class="ruby-identifier">params</span>)
|
|
198
|
+
<span class="ruby-identifier">request</span>(
|
|
199
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2015-05-14/ldb/GetArrBoardWithDetails"</span>,
|
|
200
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetStationBoardWithDetails</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
201
|
+
)
|
|
202
|
+
<span class="ruby-keyword">end</span></pre>
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
|
|
206
|
+
<div class="aliases">
|
|
207
|
+
Also aliased as: <a href="Service.html#method-i-get_arrival_board_with_details">get_arrival_board_with_details</a>
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div id="method-i-get_arr_dep_board_with_details" class="method-detail ">
|
|
213
|
+
<div class="method-header">
|
|
214
|
+
<div class="method-heading">
|
|
215
|
+
<span class="method-name">get_arr_dep_board_with_details</span><span
|
|
216
|
+
class="method-args">(params)</span>
|
|
217
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
218
|
+
</div>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
<div class="method-description">
|
|
222
|
+
<p>Retrieves a detailed station arrival + departures board.</p>
|
|
223
|
+
|
|
224
|
+
<p>Parameters are validated using <a href="Request/GetStationBoardWithDetails.html">GetStationBoardWithDetails</a>, returns a <a href="ResponseTypes/StationBoardWithDetails.html">StationBoardWithDetails</a> object.</p>
|
|
225
|
+
|
|
226
|
+
<div class="method-source-code" id="get_arr_dep_board_with_details-source">
|
|
227
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 102</span>
|
|
228
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_arr_dep_board_with_details</span>(<span class="ruby-identifier">params</span>)
|
|
229
|
+
<span class="ruby-identifier">request</span>(
|
|
230
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2015-05-14/ldb/GetArrDepBoardWithDetails"</span>,
|
|
231
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetStationBoardWithDetails</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
232
|
+
)
|
|
233
|
+
<span class="ruby-keyword">end</span></pre>
|
|
234
|
+
</div>
|
|
235
|
+
</div>
|
|
236
|
+
|
|
237
|
+
<div class="aliases">
|
|
238
|
+
Also aliased as: <a href="Service.html#method-i-get_arrival_departure_board_with_details">get_arrival_departure_board_with_details</a>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
<div id="method-i-get_arrival_board" class="method-detail ">
|
|
244
|
+
<div class="method-header">
|
|
245
|
+
<div class="method-heading">
|
|
246
|
+
<span class="method-name">get_arrival_board</span><span
|
|
247
|
+
class="method-args">(params)</span>
|
|
248
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
249
|
+
</div>
|
|
250
|
+
</div>
|
|
251
|
+
|
|
252
|
+
<div class="method-description">
|
|
253
|
+
<p>Retrieves a station arrival board.</p>
|
|
254
|
+
|
|
255
|
+
<p>Parameters are validated using <a href="Request/GetStationBoard.html">GetStationBoard</a>, returns a <a href="ResponseTypes/StationBoard.html">StationBoard</a> object.</p>
|
|
256
|
+
|
|
257
|
+
<div class="method-source-code" id="get_arrival_board-source">
|
|
258
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 58</span>
|
|
259
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_arrival_board</span>(<span class="ruby-identifier">params</span>)
|
|
260
|
+
<span class="ruby-identifier">request</span>(
|
|
261
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2012-01-13/ldb/GetArrivalBoard"</span>,
|
|
262
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetStationBoard</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
263
|
+
)
|
|
264
|
+
<span class="ruby-keyword">end</span></pre>
|
|
265
|
+
</div>
|
|
266
|
+
</div>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
<div id="method-i-get_arrival_board_with_details" class="method-detail method-alias">
|
|
272
|
+
<div class="method-header">
|
|
273
|
+
<div class="method-heading">
|
|
274
|
+
<span class="method-name">get_arrival_board_with_details</span><span
|
|
275
|
+
class="method-args">(params)</span>
|
|
276
|
+
</div>
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
<div class="method-description">
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<div class="aliases">
|
|
286
|
+
Alias for: <a href="Service.html#method-i-get_arr_board_with_details">get_arr_board_with_details</a>
|
|
287
|
+
</div>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
<div id="method-i-get_arrival_departure_board" class="method-detail ">
|
|
291
|
+
<div class="method-header">
|
|
292
|
+
<div class="method-heading">
|
|
293
|
+
<span class="method-name">get_arrival_departure_board</span><span
|
|
294
|
+
class="method-args">(params)</span>
|
|
295
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
296
|
+
</div>
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
<div class="method-description">
|
|
300
|
+
<p>Retrieves a station arrival + departure board.</p>
|
|
301
|
+
|
|
302
|
+
<p>Parameters are validated using <a href="Request/GetStationBoard.html">GetStationBoard</a>, returns a <a href="ResponseTypes/StationBoard.html">StationBoard</a> object.</p>
|
|
303
|
+
|
|
304
|
+
<div class="method-source-code" id="get_arrival_departure_board-source">
|
|
305
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 69</span>
|
|
306
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_arrival_departure_board</span>(<span class="ruby-identifier">params</span>)
|
|
307
|
+
<span class="ruby-identifier">request</span>(
|
|
308
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2012-01-13/ldb/GetArrivalDepartureBoard"</span>,
|
|
309
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetStationBoard</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
310
|
+
)
|
|
311
|
+
<span class="ruby-keyword">end</span></pre>
|
|
312
|
+
</div>
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</div>
|
|
317
|
+
|
|
318
|
+
<div id="method-i-get_arrival_departure_board_with_details" class="method-detail method-alias">
|
|
319
|
+
<div class="method-header">
|
|
320
|
+
<div class="method-heading">
|
|
321
|
+
<span class="method-name">get_arrival_departure_board_with_details</span><span
|
|
322
|
+
class="method-args">(params)</span>
|
|
323
|
+
</div>
|
|
324
|
+
</div>
|
|
325
|
+
|
|
326
|
+
<div class="method-description">
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<div class="aliases">
|
|
333
|
+
Alias for: <a href="Service.html#method-i-get_arr_dep_board_with_details">get_arr_dep_board_with_details</a>
|
|
334
|
+
</div>
|
|
335
|
+
</div>
|
|
336
|
+
|
|
337
|
+
<div id="method-i-get_dep_board_with_details" class="method-detail ">
|
|
338
|
+
<div class="method-header">
|
|
339
|
+
<div class="method-heading">
|
|
340
|
+
<span class="method-name">get_dep_board_with_details</span><span
|
|
341
|
+
class="method-args">(params)</span>
|
|
342
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
343
|
+
</div>
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
<div class="method-description">
|
|
347
|
+
<p>Retrieves a detailed station departure board.</p>
|
|
348
|
+
|
|
349
|
+
<p>Parameters are validated using <a href="Request/GetStationBoardWithDetails.html">GetStationBoardWithDetails</a>, returns a <a href="ResponseTypes/StationBoardWithDetails.html">StationBoardWithDetails</a> object.</p>
|
|
350
|
+
|
|
351
|
+
<div class="method-source-code" id="get_dep_board_with_details-source">
|
|
352
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 80</span>
|
|
353
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_dep_board_with_details</span>(<span class="ruby-identifier">params</span>)
|
|
354
|
+
<span class="ruby-identifier">request</span>(
|
|
355
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2015-05-14/ldb/GetDepBoardWithDetails"</span>,
|
|
356
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetStationBoardWithDetails</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
357
|
+
)
|
|
358
|
+
<span class="ruby-keyword">end</span></pre>
|
|
359
|
+
</div>
|
|
360
|
+
</div>
|
|
361
|
+
|
|
362
|
+
<div class="aliases">
|
|
363
|
+
Also aliased as: <a href="Service.html#method-i-get_departure_board_with_details">get_departure_board_with_details</a>
|
|
364
|
+
</div>
|
|
365
|
+
|
|
366
|
+
</div>
|
|
367
|
+
|
|
368
|
+
<div id="method-i-get_departure_board" class="method-detail ">
|
|
369
|
+
<div class="method-header">
|
|
370
|
+
<div class="method-heading">
|
|
371
|
+
<span class="method-name">get_departure_board</span><span
|
|
372
|
+
class="method-args">(params)</span>
|
|
373
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
374
|
+
</div>
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
<div class="method-description">
|
|
378
|
+
<p>Retrieves a station departure board.</p>
|
|
379
|
+
|
|
380
|
+
<p>Parameters are validated using <a href="Request/GetStationBoard.html">GetStationBoard</a>, returns a <a href="ResponseTypes/StationBoard.html">StationBoard</a> object.</p>
|
|
381
|
+
|
|
382
|
+
<div class="method-source-code" id="get_departure_board-source">
|
|
383
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 47</span>
|
|
384
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_departure_board</span>(<span class="ruby-identifier">params</span>)
|
|
385
|
+
<span class="ruby-identifier">request</span>(
|
|
386
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2012-01-13/ldb/GetDepartureBoard"</span>,
|
|
387
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetStationBoard</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
388
|
+
)
|
|
389
|
+
<span class="ruby-keyword">end</span></pre>
|
|
390
|
+
</div>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
<div id="method-i-get_departure_board_with_details" class="method-detail method-alias">
|
|
397
|
+
<div class="method-header">
|
|
398
|
+
<div class="method-heading">
|
|
399
|
+
<span class="method-name">get_departure_board_with_details</span><span
|
|
400
|
+
class="method-args">(params)</span>
|
|
401
|
+
</div>
|
|
402
|
+
</div>
|
|
403
|
+
|
|
404
|
+
<div class="method-description">
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<div class="aliases">
|
|
411
|
+
Alias for: <a href="Service.html#method-i-get_dep_board_with_details">get_dep_board_with_details</a>
|
|
412
|
+
</div>
|
|
413
|
+
</div>
|
|
414
|
+
|
|
415
|
+
<div id="method-i-get_fastest_departures_with_details" class="method-detail ">
|
|
416
|
+
<div class="method-header">
|
|
417
|
+
<div class="method-heading">
|
|
418
|
+
<span class="method-name">get_fastest_departures_with_details</span><span
|
|
419
|
+
class="method-args">(params)</span>
|
|
420
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
421
|
+
</div>
|
|
422
|
+
</div>
|
|
423
|
+
|
|
424
|
+
<div class="method-description">
|
|
425
|
+
<p>Retrieves detailed information about the fastest departures from one station to one or many others.</p>
|
|
426
|
+
|
|
427
|
+
<p>Parameters are validated using <a href="Request/GetDeparturesBoardWithDetails.html">GetDeparturesBoardWithDetails</a>, returns a <a href="ResponseTypes/DeparturesBoardWithDetails.html">DeparturesBoardWithDetails</a> object.</p>
|
|
428
|
+
|
|
429
|
+
<div class="method-source-code" id="get_fastest_departures_with_details-source">
|
|
430
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 146</span>
|
|
431
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_fastest_departures_with_details</span>(<span class="ruby-identifier">params</span>)
|
|
432
|
+
<span class="ruby-identifier">request</span>(
|
|
433
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2015-05-14/ldb/GetFastestDeparturesWithDetails"</span>,
|
|
434
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetDeparturesBoardWithDetails</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
435
|
+
)
|
|
436
|
+
<span class="ruby-keyword">end</span></pre>
|
|
437
|
+
</div>
|
|
438
|
+
</div>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
<div id="method-i-get_next_departures" class="method-detail ">
|
|
444
|
+
<div class="method-header">
|
|
445
|
+
<div class="method-heading">
|
|
446
|
+
<span class="method-name">get_next_departures</span><span
|
|
447
|
+
class="method-args">(params)</span>
|
|
448
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
449
|
+
</div>
|
|
450
|
+
</div>
|
|
451
|
+
|
|
452
|
+
<div class="method-description">
|
|
453
|
+
<p>Retrieves the next departures from one station to one or many others.</p>
|
|
454
|
+
|
|
455
|
+
<p>Parameters are validated using <a href="Request/GetDeparturesBoard.html">GetDeparturesBoard</a>, returns a <a href="ResponseTypes/DeparturesBoard.html">DeparturesBoard</a> object.</p>
|
|
456
|
+
|
|
457
|
+
<div class="method-source-code" id="get_next_departures-source">
|
|
458
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 113</span>
|
|
459
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_next_departures</span>(<span class="ruby-identifier">params</span>)
|
|
460
|
+
<span class="ruby-identifier">request</span>(
|
|
461
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2015-05-14/ldb/GetNextDepartures"</span>,
|
|
462
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetDeparturesBoard</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
463
|
+
)
|
|
464
|
+
<span class="ruby-keyword">end</span></pre>
|
|
465
|
+
</div>
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</div>
|
|
470
|
+
|
|
471
|
+
<div id="method-i-get_next_departures_with_details" class="method-detail ">
|
|
472
|
+
<div class="method-header">
|
|
473
|
+
<div class="method-heading">
|
|
474
|
+
<span class="method-name">get_next_departures_with_details</span><span
|
|
475
|
+
class="method-args">(params)</span>
|
|
476
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
477
|
+
</div>
|
|
478
|
+
</div>
|
|
479
|
+
|
|
480
|
+
<div class="method-description">
|
|
481
|
+
<p>Retrieves detailed information about the next departures from one station to one or many others.</p>
|
|
482
|
+
|
|
483
|
+
<p>Parameters are validated using <a href="Request/GetDeparturesBoardWithDetails.html">GetDeparturesBoardWithDetails</a>, returns a <a href="ResponseTypes/DeparturesBoardWithDetails.html">DeparturesBoardWithDetails</a> object.</p>
|
|
484
|
+
|
|
485
|
+
<div class="method-source-code" id="get_next_departures_with_details-source">
|
|
486
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 135</span>
|
|
487
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_next_departures_with_details</span>(<span class="ruby-identifier">params</span>)
|
|
488
|
+
<span class="ruby-identifier">request</span>(
|
|
489
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2015-05-14/ldb/GetNextDeparturesWithDetails"</span>,
|
|
490
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetDeparturesBoardWithDetails</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
491
|
+
)
|
|
492
|
+
<span class="ruby-keyword">end</span></pre>
|
|
493
|
+
</div>
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div>
|
|
498
|
+
|
|
499
|
+
<div id="method-i-get_service_details" class="method-detail ">
|
|
500
|
+
<div class="method-header">
|
|
501
|
+
<div class="method-heading">
|
|
502
|
+
<span class="method-name">get_service_details</span><span
|
|
503
|
+
class="method-args">(params)</span>
|
|
504
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
505
|
+
</div>
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
<div class="method-description">
|
|
509
|
+
<p>Retrieves information about a specific service.</p>
|
|
510
|
+
|
|
511
|
+
<p>Parameters are validated using <a href="Request/GetServiceDetails.html">GetServiceDetails</a>, returns a <a href="ResponseTypes/ServiceDetails.html">ServiceDetails</a> object.</p>
|
|
512
|
+
|
|
513
|
+
<div class="method-source-code" id="get_service_details-source">
|
|
514
|
+
<pre><span class="ruby-comment"># File lib/ldbws/service.rb, line 157</span>
|
|
515
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_service_details</span>(<span class="ruby-identifier">params</span>)
|
|
516
|
+
<span class="ruby-identifier">request</span>(
|
|
517
|
+
<span class="ruby-string">"http://thalesgroup.com/RTTI/2012-01-13/ldb/GetServiceDetails"</span>,
|
|
518
|
+
<span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">GetServiceDetails</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
|
|
519
|
+
)
|
|
520
|
+
<span class="ruby-keyword">end</span></pre>
|
|
521
|
+
</div>
|
|
522
|
+
</div>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
</div>
|
|
526
|
+
|
|
527
|
+
</section>
|
|
528
|
+
|
|
529
|
+
</section>
|
|
530
|
+
</main>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
<footer id="validator-badges" role="contentinfo">
|
|
534
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
535
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.5.0.
|
|
536
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
537
|
+
</footer>
|
|
538
|
+
|