File Coverage

blib/lib/Net/Facebook/Oauth2.pm

Criterion	Covered	Total	%
statement	80	136	58.8
branch	24	76	31.5
condition	3	32	9.3
subroutine	14	19	73.6
pod	8	10	80.0
total	129	273	47.2

package Net::Facebook::Oauth2;

use strict;
use warnings;
use LWP::UserAgent;
use URI;
use URI::Escape;
use JSON::MaybeXS;
use Carp;

our $VERSION = '0.11';

sub new {
    my ($class,%options) = @_;
    my $self = {};
    $self->{options} = \%options;

    my $api_version = defined $options{api_version} ? $options{api_version} : 'v3.1';

    if (!defined $options{access_token}){
        croak "You must provide your application id in new()\nNet::Facebook::Oauth2->new( application_id => '...' )" unless defined $self->{options}->{application_id};
        croak "You must provide your application secret in new()\nNet::Facebook::Oauth2->new( application_secret => '...' )" unless defined $self->{options}->{application_secret};
    }

    if (defined $options{access_token_url}) {
        croak "cannot pass access_token_url AND api_version" if defined $options{api_version};
        $self->{access_token_url} = $options{access_token_url};
    }
    else {
        $self->{access_token_url} = "https://graph.facebook.com/$api_version/oauth/access_token";
    }

    if (defined $options{authorize_url}) {
        croak "cannot pass authorize_url AND api_version" if defined $options{api_version};
        $self->{authorize_url} = $options{authorize_url};
    }
    else {
        $self->{authorize_url} = "https://www.facebook.com/$api_version/dialog/oauth";
    }

    if (defined $options{debug_token_url}) {
        croak "cannot pass debug_token_url AND api_version" if defined $options{api_version};
        $self->{debug_token_url} = $options{debug_token_url};
    }
    else {
        $self->{debug_token_url} = "https://graph.facebook.com/$api_version/debug_token";
    }

    $self->{browser}      = $options{browser} || LWP::UserAgent->new;
    $self->{display}      = $options{display} || 'page'; ## other values popup and wab
    $self->{access_token} = $options{access_token};

    return bless($self, $class);
}

sub get_authorization_url {
    my ($self,%params) = @_;

    $params{callback} ||= $self->{options}->{callback};
    croak "You must pass a callback parameter with Oauth v2.0" unless defined $params{callback};

    $params{display} = $self->{display} unless defined $params{display};
    $self->{options}->{callback} = $params{callback};

    my $url = $self->{authorize_url}
    ."?client_id="
    .uri_escape($self->{options}->{application_id})
    ."&redirect_uri="
    .uri_escape($params{callback});

    if ($params{scope}) {
        my $scope = join(',', @{$params{scope}});
        $url .= '&scope=' . $scope if $scope;
    }
    # state is now required:
    $url .= '&state=' . (defined $params{state} ? $params{state} : time);

    $url .= '&response_type=' . $params{response_type} if $params{response_type};
    $url .= '&auth_type=' . $params{auth_type}         if $params{auth_type};
    $url .= "&display=".$params{display};

    return $url;
}


sub get_access_token {
    my ($self,%params) = @_;
    $params{callback} ||= $self->{options}->{callback};
    $params{code} ||= $self->{options}->{code};

    croak "You must pass a code parameter with Oauth v2.0" unless defined $params{code};
    croak "You must pass callback URL" unless defined $params{callback};
    $self->{options}->{code} = $params{code};

    ###generating access token URL
    my $getURL = $self->{access_token_url}
    ."?client_id="
    .uri_escape($self->{options}->{application_id})
    ."&redirect_uri="
    .uri_escape($params{callback})
    ."&client_secret="
    .uri_escape($self->{options}->{application_secret})
    ."&code=$params{code}";

    my $response = $self->{browser}->get($getURL);
    my $json     = decode_json($response->content());

    if (!$response->is_success || exists $json->{error}){
        ##got an error response from facebook. die and display error message
        croak "'" . $json->{error}->{type}. "'" . " " .$json->{error}->{message};
    }
    elsif ($json->{access_token}) {
        ##everything is ok proccess response and extract access token
        return $self->{access_token} = $json->{access_token};
    }
    else {
        croak "can't get access token from " . $response->content();
    }
}

sub get_long_lived_token {
    my ($self,%params) = @_;

    if (!$self->{access_token}) {
        croak "You must pass the access_token" unless defined $params{access_token};
    }

    my $getURL = $self->{access_token_url}
        . '?grant_type=fb_exchange_token'
        . '&client_id=' . uri_escape($self->{options}->{application_id})
        . '&client_secret=' . uri_escape($self->{options}->{application_secret})
        . '&fb_exchange_token=' . uri_escape($self->{access_token} || $params{access_token})
        ;
    my $response = $self->{browser}->get($getURL);
    my $json     = decode_json($response->content());
    if (!$response->is_success || exists $json->{error}) {
        croak "'" . $json->{error}->{type}. "'" . " " .$json->{error}->{message};
    }
    elsif ($json->{access_token}) {
        return $self->{access_token} = $json->{access_token};
    }
    else {
        croak "can't get long lived access token from " . $response->content();
    }
}

sub debug_token {
    my ($self,%params) = @_;
    croak "You must pass the 'input' access token to inspect"
        unless defined $params{input};

    # NOTE: according to FB's documentation, instead of passing an
    # app token we can simply pass access_token=app_id|app_secret:
    # https://developers.facebook.com/docs/facebook-login/access-tokens/#apptokens
    my $getURL = $self->{debug_token_url}
        . "?input_token=" . uri_escape($params{input})
        . "&access_token="
        . join('|',
            uri_escape($self->{options}->{application_id}),
            uri_escape($self->{options}->{application_secret})
        );

    my $response = $self->{browser}->get($getURL);
    my $json     = decode_json($response->content());
    if (!$response->is_success || exists $json->{error}){
        ##got an error response from facebook. die and display error message
        croak "'" . $json->{error}->{type}. "'" . " " .$json->{error}->{message};
    }
    elsif (!exists $json->{data}->{app_id} || !exists $json->{data}->{user_id}) {
        return;
    }
    elsif (!$params{skip_check} && (''.$json->{data}->{app_id}) ne (''.$self->{options}->{application_id}) ) {
        return;
    }
    return $json->{data};
}


sub get {
    my ($self,$url,$params) = @_;
    unless ($self->_has_access_token($url)) {
        croak "You must pass access_token" unless defined $self->{access_token};
        $url .= $self->{_has_query} ? '&' : '?';
        $url .= "access_token=" . $self->{access_token};
    }

    ##construct the new url
    my @array;

    while ( my ($key, $value) = each(%{$params})){
        $value = uri_escape($value);
        push(@array, "$key=$value");
    }

    my $string = join('&', @array);
    $url .= "&".$string if $string;

    my $response = $self->{browser}->get($url);
    my $content = $response->content();
    return $self->_content($content);
}

sub post {
    my ($self,$url,$params) = @_;
    unless ($self->_has_access_token($url)) {
        croak "You must pass access_token" unless defined $self->{access_token};
        $params->{access_token} = $self->{access_token};
    }
    my $response = $self->{browser}->post($url,$params);
    my $content = $response->content();
    return $self->_content($content);
}

sub delete {
    my ($self,$url,$params) = @_;
    unless ($self->_has_access_token($url)) {
        croak "You must pass access_token" unless defined $self->{access_token};
        $params->{access_token} = $self->{access_token};
    }
    my $response = $self->{browser}->delete($url,$params);
    my $content = $response->content();
    return $self->_content($content);
}

sub as_hash {
    my ($self) = @_;
    return decode_json($self->{content});
}

sub as_json {
    my ($self) = @_;
    return $self->{content};
}

sub _content {
    my ($self,$content) = @_;
    $self->{content} = $content;
    return $self;
}

sub _has_access_token {
    my ($self, $url) = @_;
    my $uri = URI->new($url);
    my %q = $uri->query_form;
    #also check if we have a query and save result
    $self->{_has_query} = $uri->query();
    if (grep { $_ eq 'access_token' } keys %q) {
        return 1;
    }
    return;
}

1;
__END__