NAME

LWP::Authen::OAuth2::AccessToken - Access tokens for OAuth 2.

VERSION

Version 0.02;

SYNOPSIS

This is a base class for signing API requests with OAuth2 access tokens. A subclass should override the "request" method with something that knows how to make a request, detect the need to try to refresh, and attmpts to do that. See lWP::Authen::OAuth2::AccessToken::Bearer for an example.

Subclasses of this one are not directly useful. Please see LWP::Authen::OAuth2 for the interface that you should be using.

METHODS

"from_ref"

Construct an access token from a hash reference. The default implementation merely blesses it as an object, defaulting the "create_time" field to the current time.

    my $access_token = $class->from_ref($data);

If you roll your own, be aware that the fields "refresh_token" and "_class" get used for purposes out of this class' control. Any other fields may be used. Please die fatally if you cannot construct an object.

"to_ref"

Construct an unblessed data structure to represent the object that can be serialized as JSON. The default implementation just creates a shallow copy and assumes there are no blessed subobjects.

"expires_time"

Estimate expiration time. Not always correct, due to transit delays, clock skew, etc.

"expires_in"

Estimate the seconds until expiration. Not always correct, due to transit delays, clock skew, etc.

"should_refresh"

Boolean saying whether a refresh should be emitted now.

"for_refresh"

Returns key/value pairs for $oauth2 (and eventually the service provider class) to use in trying to refresh.

"copy_refresh_from"

Pass in a previous access token, copy anything needed to refresh.

"request"

Make a request. If expiration is detected, refreshing by the best available method (if any).

    my $response = $access_token->request($oauth2, @request_for_lwp);

"_request"

Make a request with no retry logic, and return a response, and a flag for whether it is possible the access token is expired..

    my ($response, $try_refresh)
        = $access_token->_request($oauth2, @request_for_lwp);

THIS IS THE ONLY METHOD A SUBCLASS MUST OVERRIDE!

AUTHOR

Ben Tilly, "<btilly at gmail.com>"

BUGS

We should support more kinds of access tokens.

ACKNOWLEDGEMENTS

Thanks to Rent.com <http://www.rent.com> for their generous support in letting me develop and release this module. My thanks also to Nick Wellnhofer <wellnhofer@aevum.de> for Net::Google::Analytics::OAuth2 which was very enlightening while I was trying to figure out the details of how to connect to Google with OAuth2.

LICENSE AND COPYRIGHT

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:

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