NAME

WWW::Google::Auth::ClientLogin - (DEPRECATED) Perl module to interact with Google's ClientLogin protocol

VERSION

version 0.07

SYNOPSIS

    use WWW::Google::Auth::ClientLogin;

    my $auth = WWW::Google::Auth::ClientLogin -> new(
      email    => 'user@gmail.com',
      password => 'UserPassword',
      source   => 'MyApp-0.8',
      type     => 'GOOGLE',
      service  => 'writely'
    );

    my $token = $auth -> authenticate;

    die $token -> {'error'} if $token -> {'status'} < 0;

DESCRIPTION

Google's ClientLogin is a programmatic method for getting authorized access to information exchanged with Google services and protected by an user account, implemented in the second version of the Google Data Protocol.

WWW::Google::Auth::ClientLogin implements the support to such method providing an easy-to-use object oriented interface.

For additional information see http://code.google.com/intl/it-IT/apis/accounts/docs/AuthForInstalledApps.html

Important: ClientLogin has been officially deprecated and will be discontinued in the future.

METHODS

new

Is the contructor for the WWW::Google::Auth::ClientLogin object. Takes as parameters the following variables:

email

Specifies the user's full email address..

password

Specifies the user's password.

source

Specifies a string identifying your application (optional).

type (default to HOSTED_OR_GOOGLE)

Specifies the type of the account to request authorization for (optional, default to HOSTED_OR_GOOGLE).

Possible values are GOOGLE, HOSTED or HOSTED_OR_GOOGLE (default).

service

Specifies the service to request authorization for. The following services are supported:

    Google Analytics Data APIs    analytics
    Google Apps APIs              apps
    Google Base Data API          gbase
    Google Custom Search API      cprose
    Google Sites Data API         jotspot
    Blogger Data API              blogger
    Book Search Data API          print
    Calendar Data API             cl
    Google Code Search Data API   codesearch
    Contacts Data API             cp
    Documents List Data API       writely
    Finance Data API              finance
    Gmail Atom feed               mail
    Health Data API               health
    Maps Data APIs                local
    Picasa Web Albums Data API    lh2
    Sidewiki Data API             annotateweb
    Spreadsheets Data API         wise
    Webmaster Tools API           sitemaps
    YouTube Data API              youtube

Additional info can be found at http://code.google.com/intl/en/apis/base/faq_gdata.html#clientlogin.

captcha_token

Specifies the CAPTCHA token received after a login failure with the error code 'CaptchaRequired' (optional).

captcha_login

Specifies the user's answer to the CAPTCHA challenge identified by "token" (optional).

authenticate( )

Send the authentication request.

It returns an anonymous hash containing the following values:

status

Set to 0 if authentication succeded, -1 if not.

auth_token

Authentication token (set if authentication succeded).

error

Error code (set if authentication failed).

A list of error codes can be found at http://code.google.com/intl/it-IT/apis/accounts/docs/AuthForInstalledApps.html#Errors.

captcha_token

The token specific to a CAPTCHA challenge (set if error code is 'CaptchaRequired').

captcha_url

Url pointing to the CAPTCHA image to be show n to user. Must be prefixed with 'http://www.google.com/accounts/' (set if error code is 'CaptchaRequired').

AUTHOR

Alessandro Ghedini <alexbio@cpan.org>

LICENSE AND COPYRIGHT

Copyright 2011 Alessandro Ghedini.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.