/ 
Map-Tube-API-0.07
River stage one • 1 direct dependent • 1 total dependent
/ Map::Tube::API

NAME

Map::Tube::API - Interface to Map::Tube REST API.

VERSION

Version 0.07

DESCRIPTION

Map::Tube REST API is still in beta. No API key is required at the moment.

MAP NAMES

Barcelona
Beijing
Berlin
Bielefeld
Bucharest
Budapest
Delhi
Dnipropetrovsk
Glasgow
Kazan
Kharkiv
Kiev
KoelnBonn
Kolkatta
KualaLumpur
London
Lyon
Malaga
Minsk
Moscow
Nanjing
NizhnyNovgorod
Novosibirsk
Prague
SaintPetersburg
Samara
Singapore
Sofia
Tbilisi
Vienna
Warsaw
Yekaterinburg

CONSTRUCTOR

Optionally you can provide base_url of REST API and also the version. Default version is v1.

You can even set the environment variable MAP_BASE_URL and MAP_VERSION.

use strict; use warnings;
use Map::Tube::API;

my $api = Map::Tube::API->new;

METHODS

shortest_route(\%params)

Returns list of stations for the shortest route.The parameters should be as below

+-------+-------------------------------------------------------------------+
| Key   | Description                                                       |
+-------+-------------------------------------------------------------------+
| map   | A valid map name.                                                 |
| start | A valid start station name in the given map.                      |
| end   | A valid end station name in the give map.                         |
+-------+-------------------------------------------------------------------+

use strict; use warnings;
use Map::Tube::API;

my $api   = Map::Tube::API->new;
my $route = $api->shortest_route({ map => 'london', start => 'Baker Street', end => 'Wembley Park' });

line_stations(\%params)

Returns list of stations. The parameters should be as below:

+-------+-------------------------------------------------------------------+
| Key   | Description                                                       |
+-------+-------------------------------------------------------------------+
| map   | A valid map name.                                                 |
| line  | A valid line name in the given map.                               |
+-------+-------------------------------------------------------------------+

use strict; use warnings;
use Map::Tube::API;

my $api      = Map::Tube::API->new;
my $stations = $api->line_stations({ map => 'london', line => 'Metropolitan' });

map_stations(\%params)

Returns list of stations for the given map.

+-------+-------------------------------------------------------------------+
| Key   | Description                                                       |
+-------+-------------------------------------------------------------------+
| map   | A valid map name.                                                 |
+-------+-------------------------------------------------------------------+

use strict; use warnings;
use Map::Tube::API;

my $api      = Map::Tube::API->new;
my $stations = $api->map_stations({ map => 'london' });

available_maps()

Returns list of available maps.

use strict; use warnings;
use Map::Tube::API;

my $api  = Map::Tube::API->new;
my $maps = $api->available_maps({ map => 'london' });

AUTHOR

Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/Map-Tube-API

BUGS

Please report any bugs or feature requests to bug-map-tube-api at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Map-Tube-API. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Map::Tube::API

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2024 Mohammad Sajid Anwar.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.