/ 
Map-Tube-Server-0.05
River stage one • 1 direct dependent • 1 total dependent
/ Map::Tube::Server

NAME

Map::Tube::Server - Dancer2 based server for Map::Tube.

VERSION

Version 0.05

DESCRIPTION

Dancer2 based framework to build the Map::Tube public facing REST API. Currently it is being used by https://manwar.org to provide the service as REST API. It's still very much a beta version v1.

SETUP

You can install individual maps manually. For London Tube Map, just install the CPAN module Map::Tube::London.

Now the server server.psgi can be setup locally like below:

#!/usr/bin/env perl

use strict; use warnings;
use Map::Tube::Server;
use Plack::Builder;

builder { mount '/map-tube/v1' => Map::Tube::Server->to_app; };

Time to start the server like below:

$ plackup server.psgi
HTTP::Server::PSGI: Accepting connections at http://0:5000/

Open up another terminal and test the REST API call assuming you have just one map London installed on the server.

$ curl http://127.0.0.1:5000/map-tube/v1/maps
[ "London" ]

SUPPORTED MAPS

The supported maps are defined in Dancer2::Plugin::Map::Tube.

UNSUPPORTED MAPS

The following maps do not have complete map data yet.

Map::Tube::NYC
Map::Tube::Tokyo

ERROR MESSAGES

REACHED REQUEST LIMIT
MISSING MAP NAME
RECEIVED INVALID MAP NAME
RECEIVED UNSUPPORTED MAP NAME
MISSING START STATION NAME
RECEIVED INVALID START STATION NAME
MISSING END STATION NAME
RECEIVED INVALID END STATION NAME
MISSING LINE NAME
RECEIVED INVALID LINE NAME
MAP NOT INSTALLED

ROUTES

GET /map-tube/v1/shortest-route/:map/:start/:end

Return the shortest route from $start to $end in the $map.

Returns ref to an array of shortest route stations list in JSON format.

For example:

curl http://127.0.0.1:5000/map-tube/v1/shortest-route/london/baker%20street/wembley%20park

GET /map-tube/v1/stations/:map/:line

Returns ref to an array of stations list in JSON format for the given map and line. The map can be any of the supported maps. And the line can be any of lines within the map.For more details, please look into the relevant module for the map Map::Tube::*.

curl http://127.0.0.1:5000/map-tube/v1/stations/london/metropolitan

GET /map-tube/v1/stations/:map

Returns ref to an array of stations list in JSON format for the given map.

curl http://127.0.0.1:5000/map-tube/v1/stations/london

GET /map-tube/v1/maps

Returns ref to an array of supported maps.

curl http://127.0.0.1:5000/map-tube/v1/maps

AUTHOR

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

REPOSITORY

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

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/manwar/Map-Tube-Server/issues. 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::Server

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.