Dancer-Plugin-Auth-Github

ABOUT

This module is a simple plugin for the dancer web framework. It easily enables you to add github authentication into your application. Additionally it adds two session objects (github_user and github_access_token) into your app.

USAGE 

This is a sample of what your application should look like with this plugin

	package YourDancerApplication;

	use Dancer ':syntax';
	use Dancer::Plugin::Auth::Github;

	#You must use a session backend. 
	#You should be able to use any backend support by dancer.
	set 'session'      => 'Simple';

	#make sure you call this first.
	#initializes the config
	auth_github_init();

	hook before => sub {
	    #we don't want to be in a redirect loop
	    return if request->path =~ m{/auth/github/callback};
	    if (not session('github_user')) {
	        redirect auth_github_authenticate_url;
	    }
	};

	#by default success will redirect to this route
	get '/' => sub {
	    "Hello, ".session('github_user')->{'login'};
	    #For all the github_user properties
	    #look at http://developer.github.com/v3/users/
	    #See the Response for "Get the authenticated user"
	};

	#additionally the plugin adds session('github_access_token')
	#so you can use it if you're doing other things with GitHub Api.

	#by default authentication failure will redirect to this route
	get '/auth/github/failed' => sub { return "Github authentication Failed" };




INSTALLATION

To install this module, run the following commands:

	perl Makefile.PL
	make
	make test
	make install

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this module with the
perldoc command.

    perldoc Dancer::Plugin::Auth::Github

You can also look for information at:

    RT, CPAN's request tracker (report bugs here)
        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dancer-Plugin-Auth-Github

    AnnoCPAN, Annotated CPAN documentation
        http://annocpan.org/dist/Dancer-Plugin-Auth-Github

    CPAN Ratings
        http://cpanratings.perl.org/d/Dancer-Plugin-Auth-Github

    Search CPAN
        http://search.cpan.org/dist/Dancer-Plugin-Auth-Github/


LICENSE AND COPYRIGHT

Copyright (C) 2013 Gideon Israel Dsouza

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:

L<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.