NAME
Net::API::RPX - Perl interface to Janrain's RPX service
VERSION
version 1.000001
SYNOPSIS
use Net::API::RPX;
my $rpx = Net::API::RPX->new({ api_key => '<your_api_key_here>' });
$rpx->auth_info({ token => $token });DESCRIPTION
This module is a simple wrapper around Janrain's RPX service. RPX provides a single method for dealing with third-party authentication.
See http://www.rpxnow.com for more details.
For specific information regarding the RPX API and method arguments, please refer to https://rpxnow.com/docs.
METHODS
auth_info
my $user_data = $rpx->auth_info({ token => $params{token} });Upon redirection back from RPX, you will be supplied a token to use for verification. Call auth_info to verify the authenticity of the token and gain user details.
'token' argument is required, 'extended' argument is optional.
map
$rpx->map({ identifier => 'yet.another.open.id', primary_key => 12 });This method allows you to map more than one 'identifier' to a user.
'identifier' argument is required, 'primary_key' argument is required, 'overwrite' is optional.
unmap
$rpx->unmap({ identifier => 'yet.another.open.id', primary_key => 12 });This is the inverse of 'map'.
'identifier' argument is required, 'primary_key' argument is required.
mappings
my $data = $rpx->mappings({ primary_key => 12 });This method returns information about the identifiers associated with a user.
'primary_key' argument is required.
ATTRIBUTES
api_key
This is the api_key provided by Janrain to interface with RPX. You will need to sign up to RPX to get one of these.
base_url
This is the base URL that is used to make API calls against. It defaults to the RPX v2 API.
ua
This is a LWP::UserAgent object. You may override it if you require more fine grain control over remote queries.
TEST COVERAGE
This distribution is heavily unit and system tested for compatibility with <Test::Builder>. If you come across any bugs, please send me or submit failing tests to Net-API-RPX RT queue. Please see the 'SUPPORT' section below on how to supply these.
---------------------------- ------ ------ ------ ------ ------ ------ ------
File stmt bran cond sub pod time total
---------------------------- ------ ------ ------ ------ ------ ------ ------
blib/lib/Net/API/RPX.pm 100.0 100.0 n/a 100.0 100.0 100.0 100.0
Total 100.0 100.0 n/a 100.0 100.0 100.0 100.0
---------------------------- ------ ------ ------ ------ ------ ------ ------SEE ALSO
http://www.janrain.com/, http://www.rpxnow.com/
AUTHORS
Scott McWhirter <konobi@cpan.org>
Kent Fredric <kentnl@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2017 by Cloudtone Studios.
This is free software, licensed under:
The (three-clause) BSD License