Tom Harrison > WWW-FastPass > WWW::FastPass

Download:
WWW-FastPass-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

WWW::FastPass - Get Satisfaction FastPass functions

SYNOPSIS ^

  use WWW::FastPass;

  my $url = WWW::FastPass::url($key, $secret,
                               $user_email,
                               $user_name,
                               $user_uid);

DESCRIPTION ^

This is a very simple wrapper around Net::OAuth for constructing URLs for use with Get Satisfaction's (http://getsatisfaction.com) FastPass service. It provides the same functions as the example libraries on the FastPass implementation page (http://getsatisfaction.com/developers/fastpass-implementation).

PUBLIC FUNCTIONS ^

url

Takes five mandatory arguments and two optional arguments: consumer_key, consumer_secret, user_email, user_name, user_uid, is_secure and extra_fields. consumer_key and consumer_secret are available on the Admin/FastPass page, once you have logged in to Get Satisfaction. user_uid must uniquely identify the relevant user, and must not change while the user account exists in the system. is_secure defaults to false - if true, the https Get Satisfaction domain will be used when constructing the FastPass URL. extra_fields is an optional hashref of user data, which data will be present in the returned URL.

Returns a FastPass URL (as a string) that can in turn be used as the fastpass argument when constructing your community site's URL.

script

Takes the same arguments as url. Returns a HTML script fragment - once executed, this will add extra script tags to the head section of the page, that will in turn allow you to use the GSFN.goto_gsfn JavaScript function to create links to your Get Satisfaction community. Alternatively, you can use the value returned by url as the src attribute of a script tag, and that will have the same effect. See the FastPass implementation page for more details.

ACKNOWLEDGMENTS ^

This module is basically a direct port of the libraries available for download on the FastPass implementation page.

AUTHOR ^

Tom Harrison, <tomh5908@gmail.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2011, 2012 by Tom Harrison

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: