NAME

WWW::Desk::Auth::oAuth - Desk.com oAuth Authentication

ATTRIBUTES

api_key

REQUIRED - desk.com api key

secret_key

REQUIRED - desk.com api secret key

desk_url

REQUIRED - your desk url

callback_url

REQUIRED - desk.com oauth callback URI

It must be a URI object

debug

debug oAuth Requests - boolean type

api_version

desk.com api version

auth_client

Net::OAuth::Client OAuth protocol object wrapper

SYNOPSIS

    use WWW::Desk::Auth::oAuth;

    my $auth = WWW::Desk::Auth::oAuth->new(
        'api_key'      => 'api key',
        'secret_key'   => 'secret key',
        'desk_url'     => 'https://my.desk.com',
        'callback_url' => 'https://myapp.com/callback'
    );

    # Visit authorization_url, approve it
    $auth->authorization_url;

    my $params; # get params from cgi
    # Use the auth code to fetch the access token
    my $access_token =  $auth->request_access_token($params->{oauth_token}, $params->{oauth_verifier});

    # Use the access token to fetch a protected resource
    my $response = $access_token->get( $auth->build_api_url('/customers') );

NOTE: Checkout demo/oAuth_demo.pl for oauth demo application

SUBROUTINES/METHODS

authorization_url

Authorization url the user needs to visit to authorize

request_access_token

Request the access token and access token secret for this user.

The user must have authorized this app at the url given by authorization_url first.

Returns the access token and access token secret but also sets them internally so that after calling this method you can immediately call a restricted method.

It accept two parameters $oauth_token, $oauth_verifier.

build_api_url

It build the api abosulte url with the path your supplied

Takes path as input format

AUTHOR

binary.com, <rakesh at binary.com>

BUGS

Please report any bugs or feature requests to bug-www-desk at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Desk. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc WWW::Desk

You can also look for information at:

• RT: CPAN's request tracker (report bugs here)

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=WWW-Desk

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/WWW-Desk

• CPAN Ratings

  http://cpanratings.perl.org/d/WWW-Desk

• Search CPAN

  http://search.cpan.org/dist/WWW-Desk/

ACKNOWLEDGEMENTS