File Coverage

blib/lib/WWW/IRail/API/Vehicle.pm

Criterion	Covered	Total	%
statement	21	23	91.3
branch			n/a
condition			n/a
subroutine	9	9	100.0
pod			n/a
total	30	32	93.7

package WWW::IRail::API::Vehicle;
BEGIN {
  $WWW::IRail::API::Vehicle::AUTHORITY = 'cpan:ESSELENS';
}
BEGIN {
  $WWW::IRail::API::Vehicle::VERSION = '0.003';
}
use strict;
use Carp qw/croak/;
use Date::Format;
use DateTime::Format::Natural;
use HTTP::Request::Common;
use JSON::XS;
use XML::Simple;
use YAML qw/freeze/;


sub make_request {
    my %attr = ref $_[0] eq 'HASH' ? %{$_[0]} : @_;

    croak 'id (or vehicle) is a required argument' unless defined $attr{id} || $attr{vehicle};

    $attr{id} ||= $attr{vehicle};

    my $url = 'http://dev.api.irail.be/vehicle/?'.
                join '&', map { $_.'='.$attr{$_} }
                qw/id/;

    my $req = new HTTP::Request(GET => $url);

    return $req;
}

sub parse_response {
    my ($http_response, $dataType) = @_;

    my $obj = XMLin($http_response->content,
        NoAttr => $dataType eq 'XML' ? 0 : 1,
        SuppressEmpty => '',
        NormaliseSpace => 2,
        ForceArray => [ 'stop' ],
        GroupTags => { stops => 'stop' },
        KeyAttr => [],
    );

    for ($dataType) {
        /xml/i and return XMLout $obj, RootName=>'vehicleinformation', GroupTags => { stops => 'stop' };
        /json/i and return JSON::XS->new->ascii->pretty->allow_nonref->encode($obj);
        /yaml/i and return freeze $obj;
        /perl/i and return $obj;
    }

    return $obj; # default to perl

}

42;



=pod

=head1 VERSION

version 0.003

=head1 NAME

WWW::IRail::API::Vehicle - HTTP::Request builder and HTTP::Response parser for the IRail API Vehicle data

=head1 SYNOPSIS

    make_request( id => 'BE.NMBS.CR2089' );

=head1 DESCRIPTION

This module builds a L and has a parser for the
L. It's up to you to transmit it over the wire. If don't want
to do that yourself, don't use this module directly and use L
instead.

=head1 METHODS

=head2 make_request( I 'val'> | I<{ key => 'val' }> )

C and C are the only arguments required, all time and date arguments default
to the current time and date on the iRail API side.

    make_request ( id => 'BE.NMBS.CR2089' );

=head2 parse_response( I<$http_response>, I )

parses the HTTP::Response you got back from the server, which if all went well contains XML.
That XML is then transformed into other data formats

=over 4

=item *

xml

=item *

XML

=item *

YAML

=item *

JSON

=item *

perl (default)

=back

=head3 example of output when dataType = 'xml'

=head1 METHODS

=for xml



















=head3 example of output when dataType = 'XML'

=for xml


          AALST
          1291053960


          EREMBODEGEM
          1291054200


          DENDERLEEUW
          1291054500


          LIEDEKERKE
          1291054740


          ESSENE LOMBEEK
          1291054860


          TERNAT
          1291055160


          SINT MARTENS BODEGEM
          1291055340


          DILBEEK
          1291055580


          GROOT BIJGAARDEN
          1291055760


          BERCHEM SAINTE AGATHE
          1291055880


          JETTE
          1291056120


          BOCKSTAEL
          1291056300


          BRUSSELS NORD
          1291056720


          BRUSSELS CENTRAL
          1291056960


          BRUSSELS MIDI
          1291057140


      BE.NMBS.CR2089


=head3 example of output when dataType = 'JSON'

=for json     {
       "stops" : [
          { "station" : "AALST", "time" : "1291053960" },
          { "station" : "EREMBODEGEM", "time" : "1291054200" },
          { "station" : "DENDERLEEUW", "time" : "1291054500" },
          { "station" : "LIEDEKERKE", "time" : "1291054740" },
          { "station" : "ESSENE LOMBEEK", "time" : "1291054860" },
          { "station" : "TERNAT", "time" : "1291055160" },
          { "station" : "SINT MARTENS BODEGEM", "time" : "1291055340" },
          { "station" : "DILBEEK", "time" : "1291055580" },
          { "station" : "GROOT BIJGAARDEN", "time" : "1291055760" },
          { "station" : "BERCHEM SAINTE AGATHE", "time" : "1291055880" },
          { "station" : "JETTE", "time" : "1291056120" },
          { "station" : "BOCKSTAEL", "time" : "1291056300" },
          { "station" : "BRUSSELS NORD", "time" : "1291056720" },
          { "station" : "BRUSSELS CENTRAL", "time" : "1291056960" },
          { "station" : "BRUSSELS MIDI", "time" : "1291057140" }
       ],
       "vehicle" : "BE.NMBS.CR2089"
    }

=head3 example of output when dataType = 'YAML'

=for YAML     ---
    stops:
      - station: AALST
        time: 1291053960
      - station: EREMBODEGEM
        time: 1291054200
      - station: DENDERLEEUW
        time: 1291054500
      - station: LIEDEKERKE
        time: 1291054740
      - station: ESSENE LOMBEEK
        time: 1291054860
      - station: TERNAT
        time: 1291055160
      - station: SINT MARTENS BODEGEM
        time: 1291055340
      - station: DILBEEK
        time: 1291055580
      - station: GROOT BIJGAARDEN
        time: 1291055760
      - station: BERCHEM SAINTE AGATHE
        time: 1291055880
      - station: JETTE
        time: 1291056120
      - station: BOCKSTAEL
        time: 1291056300
      - station: BRUSSELS NORD
        time: 1291056720
      - station: BRUSSELS CENTRAL
        time: 1291056960
      - station: BRUSSELS MIDI
        time: 1291057140
    vehicle: BE.NMBS.CR2089

=head3 example of output when dataType="perl" (default)

=for perl     $VAR1 = {
          'stops' => [
                     {
                       'station' => 'AALST',
                       'time' => '1291053960'
                     },
                     {
                       'station' => 'EREMBODEGEM',
                       'time' => '1291054200'
                     },
                     {
                       'station' => 'DENDERLEEUW',
                       'time' => '1291054500'
                     },
                     {
                       'station' => 'LIEDEKERKE',
                       'time' => '1291054740'
                     },
                     {
                       'station' => 'ESSENE LOMBEEK',
                       'time' => '1291054860'
                     },
                     {
                       'station' => 'TERNAT',
                       'time' => '1291055160'
                     },
                     {
                       'station' => 'SINT MARTENS BODEGEM',
                       'time' => '1291055340'
                     },
                     {
                       'station' => 'DILBEEK',
                       'time' => '1291055580'
                     },
                     {
                       'station' => 'GROOT BIJGAARDEN',
                       'time' => '1291055760'
                     },
                     {
                       'station' => 'BERCHEM SAINTE AGATHE',
                       'time' => '1291055880'
                     },
                     {
                       'station' => 'JETTE',
                       'time' => '1291056120'
                     },
                     {
                       'station' => 'BOCKSTAEL',
                       'time' => '1291056300'
                     },
                     {
                       'station' => 'BRUSSELS NORD',
                       'time' => '1291056720'
                     },
                     {
                       'station' => 'BRUSSELS CENTRAL',
                       'time' => '1291056960'
                     },
                     {
                       'station' => 'BRUSSELS MIDI',
                       'time' => '1291057140'
                     }
                   ],
          'vehicle' => 'BE.NMBS.CR2089'
        };

=head1 INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests through the web interface at
L.

=head1 AUTHOR

Tim Esselens

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Tim Esselens.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut


__END__