/ 
CatalystX-Controller-Auth-0.05
River stage zero No dependents
/ CatalystX::Controller::Auth

NAME

CatalystX::Controller::Auth - A config-driven Catalyst authentication controller base class.

VERSION

Version 0.05

SYNOPSIS

This is a Catalyst controller for dealing with all instances of logging in, forgotten password, changing passwords, etc.

package MyApp::Controller::Auth;

use Moose;
use namespace::autoclean;

BEGIN { extends 'CatalystX::Controller::Auth'; }

__PACKAGE__->meta->make_immutable;

1;

CHAINS

base ( mid-point: / )

sub base :Chained('/base') :PathPart('') :CaptureArgs(0)

authenticated ( mid-point: / )

Chain off this action to make sure people are logged in.

sub authenticated :Chained('base') :PathPart('') :CaptureArgs(0)

login ( end-point: /login )

Login, redirect if already logged in.

sub login :Chained('base') :PathPart :Args(0)

logout ( end-point: /logout )

Logs out, and redirects back to /login.

sub logout :Chained('base') :PathPart :Args(0)

get ( mid-point: /auth/*/ )

Gets a user and puts them in the stash.

sub get :Chained('base') :PathPart('auth') :CaptureArgs(1)

change_password ( end-point: /auth/*/change-password/ )

Change your password.

sub change_password :Chained('get') :PathPart('change-password') :Args(0)

forgot_password ( end-point: /auth/*/forgot-password/ )

Send a forgotten password toekn to reset it.

sub forgot_password :Chained('base') :PathPart('forgot-password') :Args(0)

reset_password ( end-point: /auth/*/reset-password/ )

Reset password using a token sent in an username.

sub reset_password :Chained('base') :PathPart('reset-password') :Args(0)

AUTHOR

Rob Brown, <rob at intelcompute.com>

BUGS

Please report any bugs or feature requests to bug-catalystx-controller-auth at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CatalystX-Controller-Auth. I will be notified, and then you will 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 CatalystX::Controller::Auth

You can also look for information at:

ACKNOWLEDGEMENTS

t0m: Tomas Doran <bobtfish@bobtfish.net>

LICENSE AND COPYRIGHT

Copyright 2012 Rob Brown.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.