File Coverage

blib/lib/WebService/SEOmoz/API.pm

Criterion	Covered	Total	%
statement	22	83	26.5
branch	0	30	0.0
condition	0	4	0.0
subroutine	8	15	53.3
pod	3	7	42.8
total	33	139	23.7

package WebService::SEOmoz::API;

BEGIN {
    $WebService::SEOmoz::API::VERSION = '0.02';
}

# ABSTRACT: SEOmoz API

use strict;
use warnings;
use LWP::UserAgent;
use URI::Escape qw/uri_escape/;
use Digest::SHA;
use JSON::Any;
use vars qw/$errstr/;

sub new {
    my $class = shift;
    my $args = scalar @_ % 2 ? shift : {@_};

    $args->{accessID}  or do { $errstr = 'accessID is required';  return; };
    $args->{secretKey} or do { $errstr = 'secretKey is required'; return; };

    $args->{expiresInterval} ||= 300;

    # we won't have space before/after accessID/secretKey
    $args->{accessID}  =~ s/(^\s+|\s+$)//g;
    $args->{secretKey} =~ s/(^\s+|\s+$)//g;

    unless ( $args->{ua} ) {
        my $ua_args = delete $args->{ua_args} || { timeout => 120 };
        $args->{ua} = LWP::UserAgent->new(%$ua_args);
    }
    unless ( $args->{json} ) {
        $args->{json} = JSON::Any->new;
    }

    bless $args, $class;
}

sub errstr { $errstr }

sub getAuthenticationStr {
    my ($self) = @_;

    my $expires      = time() + $self->{expiresInterval};
    my $stringToSign = $self->{accessID} . "\n" . $expires;

#    my $binarySignature = Digest::SHA::hmac_sha1($stringToSign, $self->{secretKey});
# We need to base64-encode it and then url-encode that.
#    my $urlSafeSignature = uri_escape(encode_base64($binarySignature));

    # no idea why we need append '%3D'
    my $urlSafeSignature =
      uri_escape(
        Digest::SHA::hmac_sha1_base64( $stringToSign, $self->{secretKey} ) )
      . '%3D';
    my $authenticationStr =
        "AccessID="
      . $self->{accessID}
      . "&Expires="
      . $expires
      . "&Signature="
      . $urlSafeSignature;

    return $authenticationStr;
}

sub makeRequest {
    my ( $self, $url ) = @_;

    #    print STDERR "# get $url\n";

    undef $errstr;

    my $resp = $self->{ua}->get($url);
    unless ( $resp->is_success ) {
        $errstr = $resp->status_line;
        return;
    }

    return $self->{json}->jsonToObj( $resp->content );
}

sub getUrlMetrics {
    my $self = shift;
    my $args = scalar @_ % 2 ? shift : {@_};

    my $objectURL = $args->{objectURL}
      or do { $errstr = 'objectURL is required'; return; };
    my $urlToFetch =
        "http://lsapi.seomoz.com/linkscape/url-metrics/"
      . uri_escape($objectURL) . "?"
      . $self->getAuthenticationStr();

    foreach my $k ('Cols') {
        if ( defined $args->{$k} ) {
            $urlToFetch .= "&" . "$k=" . $args->{$k};
        }
    }

    return $self->makeRequest($urlToFetch);
}

sub getLinks {
    my $self = shift;
    my $args = scalar @_ % 2 ? shift : {@_};

    my $objectURL = $args->{objectURL}
      or do { $errstr = 'objectURL is required'; return; };
    my $urlToFetch =
        "http://lsapi.seomoz.com/linkscape/links/"
      . uri_escape($objectURL) . "?"
      . $self->getAuthenticationStr();

    foreach my $k (
        'Scope',      'Filter',   'Sort',   'SourceCols',
        'TargetCols', 'LinkCols', 'Offset', 'Limit'
      )
    {
        if ( defined $args->{$k} ) {
            $urlToFetch .= "&" . "$k=" . $args->{$k};
        }
    }

    return $self->makeRequest($urlToFetch);
}

sub getAnchorText {
    my $self = shift;
    my $args = scalar @_ % 2 ? shift : {@_};

    my $objectURL = $args->{objectURL}
      or do { $errstr = 'objectURL is required'; return; };
    my $urlToFetch =
        "http://lsapi.seomoz.com/linkscape/anchor-text/"
      . uri_escape($objectURL) . "?"
      . $self->getAuthenticationStr();

    foreach my $k ( 'Scope', 'Sort', 'Cols', 'Offset', 'Limit' ) {
        if ( defined $args->{$k} ) {
            $urlToFetch .= "&" . "$k=" . $args->{$k};
        }
    }

    return $self->makeRequest($urlToFetch);
}

1;

__END__