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
215
216
217
218
219
|
package Travel::Status::DE::HAFAS::StopFinder;
use strict;
use warnings;
use 5.014;
use utf8;
no if $] >= 5.018, warnings => 'experimental::smartmatch';
use Carp qw(confess);
use Encode qw(decode);
use JSON;
use LWP::UserAgent;
our $VERSION = '4.03';
sub new {
my ( $obj, %conf ) = @_;
my $lang = $conf{language} // 'd';
my $ua = $conf{ua};
if ( not $ua ) {
my %lwp_options = %{ $conf{lwp_options} // { timeout => 10 } };
$ua = LWP::UserAgent->new(%lwp_options);
$ua->env_proxy;
}
my $reply;
if ( not $conf{input} ) {
confess('You need to specify an input value');
}
if ( not $conf{url} ) {
confess('You need to specify a URL');
}
my $ref = {
developer_mode => $conf{developer_mode},
post => {
getstop => 1,
REQ0JourneyStopsS0A => 255,
REQ0JourneyStopsS0G => $conf{input},
},
};
bless( $ref, $obj );
my $url = $conf{url} . "/${lang}n";
$reply = $ua->post( $url, $ref->{post} );
if ( $reply->is_error ) {
$ref->{errstr} = $reply->status_line;
return $ref;
}
$ref->{raw_reply} = $reply->decoded_content;
$ref->{raw_reply} =~ s{ ^ SLs [.] sls = }{}x;
$ref->{raw_reply} =~ s{ ; SLs [.] showSuggestion [(] [)] ; $ }{}x;
if ( $ref->{developer_mode} ) {
say $ref->{raw_reply};
}
$ref->{json} = from_json( $ref->{raw_reply} );
return $ref;
}
sub errstr {
my ($self) = @_;
return $self->{errstr};
}
sub results {
my ($self) = @_;
$self->{results} = [];
for my $result ( @{ $self->{json}->{suggestions} } ) {
if ( $result->{typeStr} eq '[Bhf/Hst]' ) {
push(
@{ $self->{results} },
{
name => decode( 'iso-8859-15', $result->{value} ),
id => $result->{extId}
}
);
}
}
return @{ $self->{results} };
}
1;
__END__
=head1 NAME
Travel::Status::DE::HAFAS::StopFinder - Interface to HAFAS-based online stop
finder services
=head1 SYNOPSIS
use Travel::Status::DE::HAFAS::StopFinder;
my $sf = Travel::Status::DE::HAFAS::StopFinder->new(
url => 'https://reiseauskunft.bahn.de/bin/ajax-getstop.exe',
input => 'Borbeck',
);
if (my $err = $sf->errstr) {
die("Request error: ${err}\n");
}
for my $candidate ($sf->results) {
printf("%s (%s)\n", $candidate->{name}, $candidate->{id});
}
=head1 VERSION
version 4.03
=head1 DESCRIPTION
Travel::Status::DE::HAFAS::StopFinder is an interface to the stop finder
service of HAFAS based arrival/departure monitors, for instance the one
available at L<https://reiseauskunft.bahn.de/bin/ajax-getstop.exe/dn>.
It takes a string (usually a location or station name) and reports all
stations and stops which are lexically similar to it.
=head1 METHODS
=over
=item my $stopfinder = Travel::Status::DE::HAFAS::StopFinder->new(I<%opts>)
Looks up stops as specified by I<opts> and teruns a new
Travel::Status::DE::HAFAS::StopFinder element with the results. Dies if the
wrong I<opts> were passed.
Supported I<opts> are:
=over
=item B<input> => I<string>
string to look up, e.g. "Borbeck" or "Koeln Bonn Flughafen". Mandatory.
=item B<url> => I<url>
Base I<url> of the stop finder service, without the language and mode
suffix ("/dn" and similar). Mandatory. See Travel::Status::DE::HAFAS(3pm)'s
B<get_services> method for a list of URLs.
=item B<language> => I<language>
Set language. Accepted arguments are B<d>eutsch, B<e>nglish, B<i>talian and
B<n> (dutch), depending on the used service.
It is unknown if this option has any effect.
=item B<lwp_options> => I<\%hashref>
Passed on to C<< LWP::UserAgent->new >>. Defaults to C<< { timeout => 10 } >>,
you can use an empty hashref to override it.
=back
=item $status->errstr
In case of an error in the HTTP request, returns a string describing it. If
no error occurred, returns undef.
=item $status->results
Returns a list of stop candidates. Each list element is a hash reference. The
hash keys are B<id> (IBNR / UIC station code) and B<name> (stop name). Both can
be used as input for the Travel::Status::DE::HAFAS(3pm) constructor.
If no matching results were found or the parser / http request failed, returns
the empty list.
=back
=head1 DIAGNOSTICS
None.
=head1 DEPENDENCIES
=over
=item * LWP::UserAgent(3pm)
=item * JSON(3pm)
=back
=head1 BUGS AND LIMITATIONS
Unknown.
=head1 SEE ALSO
Travel::Status::DE::HAFAS(3pm).
=head1 AUTHOR
Copyright (C) 2015-2017 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
=head1 LICENSE
This module is licensed under the same terms as Perl itself.
|
