File Coverage

blib/lib/Business/PayflowPro/Reporting.pm

Criterion	Covered	Total	%
statement	14	16	87.5
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod			n/a
total	20	22	90.9

package Business::PayflowPro::Reporting;

BEGIN {
    $Business::PayflowPro::Reporting::VERSION = '0.01';
}

# ABSTRACT: Payflow Pro Reporting API

use strict;
use warnings;
use LWP::UserAgent;
use XML::Writer;
use XML::Simple qw/XMLin XMLout/;
use vars qw/$errstr/;

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

    # validate
    defined $args->{user}    or do { $errstr = 'user is required';    return };
    defined $args->{vendor}  or do { $errstr = 'vendor is required';  return };
    defined $args->{partner} or do { $errstr = 'partner is required'; return };
    defined $args->{password}
      or do { $errstr = 'password is required'; return };

    if ( $args->{test_mode} ) {
        $args->{url} =
          'https://payments-reports.paypal.com/test-reportingengine';
    }
    else {
        $args->{url} = 'https://payments-reports.paypal.com/reportingengine';
    }

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

    bless $args, $class;
}

sub errstr { $errstr }

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

    # we use XML::Writer b/c element order is relevant
    my $xml;
    my $writer = XML::Writer->new( OUTPUT => \$xml );
    $writer->startTag('reportingEngineRequest');
    $writer->startTag('authRequest');
    foreach my $k ( 'user', 'vendor', 'partner', 'password' ) {
        $writer->dataElement( $k, $self->{$k} );
    }
    $writer->endTag('authRequest');
    $writer->startTag('runReportRequest');
    $writer->dataElement( 'reportName', $args->{reportName} );
    if ( $args->{reportName} eq 'DailyActivityReport' ) {
        $writer->startTag('reportParam');
        $writer->dataElement( 'paramName',  'report_date' );
        $writer->dataElement( 'paramValue', $args->{report_date} );
        $writer->endTag('reportParam');
    }
    elsif ( $args->{reportName} eq 'TransactionSummaryReport' ) {
        foreach my $k ( 'start_date', 'end_date' ) {
            $writer->startTag('reportParam');
            $writer->dataElement( 'paramName',  $k );
            $writer->dataElement( 'paramValue', $args->{$k} );
            $writer->endTag('reportParam');
        }
    }
    $writer->dataElement( 'pageSize', $args->{pageSize} || 50 );
    $writer->endTag('runReportRequest');
    $writer->endTag('reportingEngineRequest');

    $xml = '' . "\n" . $xml;
    print "\n\n" if $self->{debug};
    my $resp = $self->{ua}->post( $self->{url}, Content => $xml );
    print "\n\n" if $self->{debug};

    my $d = XMLin( $resp->content, SuppressEmpty => '' );
    if ( exists $d->{runReportResponse}->{reportId} ) {
        return $d->{runReportResponse}->{reportId};
    }
    else {
        $errstr = $d->{runReportResponse}->{statusMsg}
          || $d->{baseResponse}->{responseMsg};
        return;
    }
}

sub getResultsRequest {
    my $self = shift;
    my ($reportId) = @_;

    my $xml = $self->_make_reportId_xml( 'getResultsRequest', $reportId );
    my $resp = $self->{ua}->post( $self->{url}, Content => $xml );
    print "\n\n" if $self->{debug};

    my $d = XMLin( $resp->content, SuppressEmpty => '' );
    if ( $d->{baseResponse}->{responseCode} == 100 ) {
        return $d->{getResultsResponse}->{Results};
    }
    else {
        $errstr = $d->{getResultsResponse}->{Results}->{statusMsg}
          || $d->{baseResponse}->{responseMsg};
        return;
    }
}

sub getMetaDataRequest {
    my $self = shift;
    my ($reportId) = @_;

    my $xml = $self->_make_reportId_xml( 'getMetaDataRequest', $reportId );
    my $resp = $self->{ua}->post( $self->{url}, Content => $xml );
    print "\n\n" if $self->{debug};

    my $d = XMLin( $resp->content, SuppressEmpty => '' );
    if ( $d->{baseResponse}->{responseCode} == 100 ) {
        return $d->{getMetaDataResponse};
    }
    else {
        $errstr = $d->{baseResponse}->{responseMsg};
        return;
    }
}

sub _make_reportId_xml {
    my ( $self, $type, $reportId ) = @_;

    # we use XML::Writer b/c element order is relevant
    my $xml;
    my $writer = XML::Writer->new( OUTPUT => \$xml );
    $writer->startTag('reportingEngineRequest');
    $writer->startTag('authRequest');
    foreach my $k ( 'user', 'vendor', 'partner', 'password' ) {
        $writer->dataElement( $k, $self->{$k} );
    }
    $writer->endTag('authRequest');
    $writer->startTag($type);
    $writer->dataElement( 'reportId', $reportId );
    $writer->endTag($type);
    $writer->endTag('reportingEngineRequest');

    $xml = '' . "\n" . $xml;
    print "\n\n" if $self->{debug};
    return $xml;
}

sub getDataRequest {
    my $self = shift;
    my ( $reportId, $pageNum ) = @_;

    # we use XML::Writer b/c element order is relevant
    my $xml;
    my $writer = XML::Writer->new( OUTPUT => \$xml );
    $writer->startTag('reportingEngineRequest');
    $writer->startTag('authRequest');
    foreach my $k ( 'user', 'vendor', 'partner', 'password' ) {
        $writer->dataElement( $k, $self->{$k} );
    }
    $writer->endTag('authRequest');
    $writer->startTag('getDataRequest');
    $writer->dataElement( 'reportId', $reportId );
    $writer->dataElement( 'pageNum', $pageNum || 1 );
    $writer->endTag('getDataRequest');
    $writer->endTag('reportingEngineRequest');

    $xml = '' . "\n" . $xml;
    print "\n\n" if $self->{debug};
    my $resp = $self->{ua}->post( $self->{url}, Content => $xml );
    print "\n\n" if $self->{debug};

    my $d = XMLin( $resp->content, SuppressEmpty => '' );
    if ( $d->{baseResponse}->{responseCode} == 100 ) {
        my $reportDataRow = $d->{getDataResponse}->{reportDataRow};
        my @reportDataRow =
          ref($reportDataRow) eq 'ARRAY' ? @$reportDataRow : ($reportDataRow);
        return wantarray ? @reportDataRow : \@reportDataRow;
    }
    else {
        $errstr = $d->{baseResponse}->{responseMsg};
        return;
    }
}

1;
__END__