Move EFA logic to ::EFA, just set URL in ::VRR

1 files changed, 225 insertions, 0 deletions

diff --git a/lib/Travel/Status/DE/EFA/Result.pm b/lib/Travel/Status/DE/EFA/Result.pm
new file mode 100644
index 0000000..c623f6e
--- /dev/null
+++ b/lib/Travel/Status/DE/EFA/Result.pm
@@ -0,0 +1,225 @@
+package Travel::Status::DE::EFA::Result;
+
+use strict;
+use warnings;
+use 5.010;
+
+use parent 'Class::Accessor';
+
+our $VERSION = '1.05';
+
+Travel::Status::DE::EFA::Result->mk_ro_accessors(
+	qw(countdown date delay destination is_cancelled info key line lineref platform
+	  platform_db sched_date sched_time time type)
+);
+
+sub new {
+	my ( $obj, %conf ) = @_;
+
+	my $ref = \%conf;
+
+	if ($ref->{delay} eq '-9999') {
+		$ref->{delay} = 0;
+		$ref->{is_cancelled} = 1;
+	}
+	else {
+		$ref->{is_cancelled} = 0;
+	}
+
+	return bless( $ref, $obj );
+}
+
+sub TO_JSON {
+	my ($self) = @_;
+
+	return { %{$self} };
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+Travel::Status::DE::EFA::Result - Information about a single
+departure received by Travel::Status::DE::EFA
+
+=head1 SYNOPSIS
+
+    for my $departure ($status->results) {
+        printf(
+            "At %s: %s to %s from platform %s\n",
+            $departure->time, $departure->line, $departure->destination,
+            $departure->platform
+        );
+    }
+
+=head1 VERSION
+
+version 1.05
+
+=head1 DESCRIPTION
+
+Travel::Status::DE::EFA::Result describes a single departure as obtained by
+Travel::Status::DE::EFA.  It contains information about the time, platform,
+line number and destination.
+
+=head1 METHODS
+
+=head2 ACCESSORS
+
+"Actual" in the description means that the delay (if available) is already
+included in the calculation, "Scheduled" means it isn't.
+
+=over
+
+=item $departure->countdown
+
+Actual time in minutes from now until the tram/bus/train will depart.
+
+If delay information is available, it is already included.
+
+=item $departure->date
+
+Actual departure date (DD.MM.YYYY).
+
+=item $departure->delay
+
+Expected delay from scheduled departure time in minutes. A delay of 0
+indicates either departure on time or that no delay information is available.
+
+=item $departure->destination
+
+Destination name.
+
+=item $departure->info
+
+Additional information related to the departure (string).  If departures for
+an address were requested, this is the stop name, otherwise it may be recent
+news related to the line's schedule.  If no information is available, returns
+an empty string.
+
+=item $departure->is_cancelled
+
+1 if the departure got cancelled, 0 otherwise.
+
+=item $departure->key
+
+Unknown.  Unlike the name may suggest, this is not a unique key / UUID for a
+departure: On the same day, different lines departing at the same station
+may have the same key.  It might, however, be unique when combined with the
+B<line> information.
+
+=item $departure->line
+
+The name/number of the line.
+
+=item $departure->lineref
+
+Travel::Status::DE::EFA::Line(3pm) object describing the departing line in
+detail.
+
+=item $departure->platform
+
+Departure platform number.
+
+=item $departure->platform_db
+
+true if the platform number is operated by DB ("Gleis x"), false ("Bstg. x")
+otherwise.
+
+Unfortunately, there is no distinction between tram and bus platforms yet,
+which also may have the same numbers.
+
+=item $departure->sched_date
+
+Scheduled departure date (DD.MM.YYYY).
+
+=item $departure->sched_time
+
+Scheduled departure time (HH:MM).
+
+=item $departure->time
+
+Actual departure time (HH:MM).
+
+=item $departure->type
+
+Type of the departure.  Note that efa.vrr.de sometimes puts bogus data in this
+field.  See L</DEPARTURE TYPES>.
+
+=back
+
+=head2 INTERNAL
+
+=over
+
+=item $departure = Travel::Status::DE::EFA::Result->new(I<%data>)
+
+Returns a new Travel::Status::DE::EFA::Result object.  You should not need to
+call this.
+
+=item $departure->TO_JSON
+
+Allows the object data to be serialized to JSON.
+
+=back
+
+=head1 DEPARTURE TYPES
+
+The following are known so far:
+
+=over
+
+=item * Abellio-Zug
+
+=item * Bus
+
+=item * Eurocity
+
+=item * Intercity-Express
+
+=item * NE (NachtExpress / night bus)
+
+=item * Niederflurbus
+
+=item * R-Bahn (RE / RegionalExpress)
+
+=item * S-Bahn
+
+=item * SB (Schnellbus)
+
+=item * StraE<szlig>enbahn
+
+=item * U-Bahn
+
+=back
+
+=head1 DIAGNOSTICS
+
+None.
+
+=head1 DEPENDENCIES
+
+=over
+
+=item Class::Accessor(3pm)
+
+=back
+
+=head1 BUGS AND LIMITATIONS
+
+C<< $result->type >> may contain bogus data.  This comes from the efa.vrr.de
+interface.
+
+=head1 SEE ALSO
+
+Travel::Status::DE::EFA(3pm).
+
+=head1 AUTHOR
+
+Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
+
+=head1 LICENSE
+
+This module is licensed under the same terms as Perl itself.