Dancer::Plugin::Auth::Facebook - Authenticate with Facebook OAuth
version 0.02
package plugin::test; use Dancer ':syntax'; use Dancer::Plugin::Auth::Facebook;
our $VERSION = '0.1';
auth_fb_init();
hook before => sub { #we don't want a redirect loop here. return if request->path =~ m{/auth/facebook/callback}; if (not session('fb_username')) { redirect auth_fb_authenticate_url; }
};
get '/' => sub { "welcome, ".session('fb_name'); };
get '/fail' => sub { "FAIL" };
true;
...
This plugin provides a simple way to authenticate your users through Facebook's OAuth API. It provides you with a helper to build easily a redirect to the authentication URL, defines automatically a callback route handler and saves the authenticated user to your session when done.
In order for this plugin to work, you need the following:
Facebook application
Anyone can register a application at https://developers.facebook.com/. When done, make sure to configure the application as a Web application.
Configuration
You need to configure the plugin first: copy your application_id and application_secret (provided by Facebook) to your Dancer's configuration under plugins/Auth::Facebook:
application_id
application_secret
plugins/Auth::Facebook
# config.yml ... plugins: Auth::Facebook application_id: "1234" application_secret: "abcd" callback_url: "http://localhost:3000/auth/facebook/callback" callback_success: "/" callback_fail: "/fail" scope: "email friends"
callback_success , callback_fail and <scope> are optional and default to '/' , '/fail', and default respectively.
callback_success
callback_fail
Note that you also need to provide your callback url, whose route handler is automatically created by the plugin.
Session backend
For the authentication process to work, you need a session backend, in order for the plugin to store the authenticated user's information.
Use the session backend of your choice, it doesn't make a difference, see Dancer::Session for details about supported session engines, or search the CPAN for new ones.
The plugin exports the following symbols to your application's namespace:
The plugin uses a Net::Facebook::Oauth2 object to do its job. You can access this object with the FaceBook symbol, exported by the plugin.
FaceBook
This function should be called before your route handlers, in order to initialize the underlying Net::Facebook::Oauth2 object. It will read your configuration and create a new Net::Facebook::Oauth2 instance.
this function returns an authentication URL for redirecting unauthenticated users.
hook before => sub { # we don't want a redirect loop here. return if request->path =~ m{/auth/facebook/callback}; if (not session('fb_username')) { redirect auth_fb_authenticate_url(); }
The plugin defines the following route handler automatically
This route handler is responsible for catching back a user that has just authenticated herself with Facebook's OAuth. The route handler saves tokens and user information such as email,username and name in the session and then redirects the user to the URI specified by callback_success.
If the validation of the token returned by Facebook failed or was denied, the user will be redirect to the URI specified by callback_fail.
This project is a port of Dancer::Plugin::Auth::Twitter written by Alexis Sukrieh which itself is a port of Catalyst::Authentication::Credential::Twitter written by Jesse Stay.
Prajith Ndimensionz <prajith@ndimensionz>
This software is copyright (c) 2014 by Prajith Ndimensionz.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dancer::Plugin::Auth::Facebook, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dancer::Plugin::Auth::Facebook
CPAN shell
perl -MCPAN -e shell install Dancer::Plugin::Auth::Facebook
For more information on module installation, please visit the detailed CPAN module installation guide.