Lemonldap::NG::Handler::PSGI::Router(3) Base library for protected REST APIs of

SYNOPSIS


package My::PSGI;

use base Lemonldap::NG::Handler::PSGI::Router;

sub init {
my ($self,$args) = @_;
$self->protection('manager');
# See Lemonldap::NG::Common::PSGI::Router for more

# Declare REST routes (could be HTML templates or methods)
$self->addRoute ( 'index.html', undef, ['GET'] )
->addRoute ( books => { ':book' => 'booksMethod' }, ['GET', 'POST'] );

# Default route (ie: PATH_INFO == '/')
$self->defaultRoute('index.html');

# Return a boolean. If false, then error message has to be stored in
# $self->error
return 1;
}

sub booksMethod {
my ( $self, $req, @otherPathInfo ) = @_;
# Will be called only if authorisated
my $userId = $self->userId;
my $book = $req->params('book');
my $method = $req->method;
...
$self->sendJSONresponse(...);
}

This package could then be called as a CGI, using FastCGI,... 

  #!/usr/bin/env perl
  
  use My::PSGI;
  use Plack::Handler::FCGI; # or Plack::Handler::CGI
  Plack::Handler::FCGI->new->run( My::PSGI->run() );

DESCRIPTION

This package provides base class for Lemonldap::NG protected REST API.

METHODS

See Lemonldap::NG::Common::PSGI for logging methods, content sending,...

Accessors

See Lemonldap::NG::Common::PSGI::Router for inherited accessors.

protection

Level of protection. It can be one of:

'none': no protection
'authenticate': all authenticated users are granted
'manager': access is granted following Lemonldap::NG rules

Running methods

user

Returns user session datas. If empty (no protection), returns: 

  { _whatToTrace => 'anonymous' }

But if page is protected by server (Auth-Basic,...), it will return: 

  { _whatToTrace => $REMOTE_USER }

UserId

Returns user()->{'_whatToTrace'}.

group

Returns a list of groups to which user belongs.

AUTHORS

Clement Oudot, <[email protected]>
François-Xavier Deltombe, <[email protected].>
Xavier Guimard, <[email protected]>
Thomas Chemineau, <[email protected]>

BUG REPORT

Use OW2 system to report bug or ask for features: <http://jira.ow2.org>

DOWNLOAD

Lemonldap::NG is available at <http://forge.objectweb.org/project/showfiles.php?group_id=274>

COPYRIGHT AND LICENSE

Copyright (C) 2015-2016 by Xavier Guimard, <[email protected]>
Copyright (C) 2015-2016 by Clément Oudot, <[email protected]>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

LAST SEARCHED