File Coverage

blib/lib/Business/UPS.pm

Criterion	Covered	Total	%
statement	91	91	100.0
branch	51	56	91.0
condition	12	13	92.3
subroutine	9	9	100.0
pod	2	2	100.0
total	165	171	96.4

package Business::UPS;

use strict;
use warnings;

use Carp;
use LWP::UserAgent;
use JSON::PP qw(decode_json encode_json);
use Exporter 'import';
use 5.014;

our @EXPORT = qw/ getUPS UPStrack /;

#	Copyright 2003 Justin Wheeler
#	Copyright 1998 Mark Solomon  (See GNU GPL)
#	Started 01/07/1998 Mark Solomon

our $VERSION = '2.04';

sub getUPS {

    warnings::warnif( 'deprecated',
        'getUPS() is deprecated: the UPS rate quoting endpoint (qcostcgi.cgi) '
        . 'has been retired by UPS. This function will be removed in a future '
        . 'release. See Business::UPS documentation for alternatives.' );

    my (
        $product, $origin, $dest,      $weight, $country, $rate_chart, $length,
        $width,   $height, $oversized, $cod
    ) = @_;

    $country ||= 'US';

    my $ups_cgi    = 'https://www.ups.com/using/services/rave/qcostcgi.cgi';
    my $workString = "?";
    $workString .= "accept_UPS_license_agreement=yes&";
    $workString .= "10_action=3&";
    $workString .= "13_product=" . $product . "&";
    $workString .= "15_origPostal=" . $origin . "&";
    $workString .= "19_destPostal=" . $dest . "&";
    $workString .= "23_weight=" . $weight;
    $workString .= "&22_destCountry=" . $country   if $country;
    $workString .= "&25_length=" . $length         if $length;
    $workString .= "&26_width=" . $width           if $width;
    $workString .= "&27_height=" . $height         if $height;
    $workString .= "&29_oversized=1"               if $oversized;
    $workString .= "&47_rate_chart=" . $rate_chart if $rate_chart;
    $workString .= "&30_cod=1"                     if $cod;
    $workString = "${ups_cgi}${workString}";

    my $lwp    = LWP::UserAgent->new(
        agent   => "Business-UPS/$VERSION",
        timeout => 30,
    );
    my $result = $lwp->get($workString);

    croak("Failed fetching data.") unless $result->is_success;

    my @ret = split( '%', $result->content );

    if ( !$ret[5] ) {

        # Error
        return ( undef, undef, $ret[1] );
    }
    else {
        # Good results
        my $total_shipping = $ret[10];
        my $ups_zone       = $ret[6];
        return ( $total_shipping, $ups_zone, undef );
    }
}

sub UPStrack {
    my $tracking_number = shift;
    my %retValue;

    $tracking_number || croak("No tracking number provided to UPStrack()");

    my $ups_url = 'https://www.ups.com/track/api/Track/GetStatus?loc=en_US';
    my $payload = encode_json( {
        Locale         => 'en_US',
        TrackingNumber => [$tracking_number],
    } );

    my $lwp = LWP::UserAgent->new(
        agent   => "Business-UPS/$VERSION",
        timeout => 30,
    );
    my $result = $lwp->post(
        $ups_url,
        'Content-Type' => 'application/json',
        Content        => $payload,
    );

    croak("Cannot get tracking data from UPS") unless $result->is_success();

    my $json;
    eval { $json = decode_json( $result->content() ) };
    croak("Cannot parse JSON response from UPS: $@") if $@;

    my $details = $json->{trackDetails};
    croak("No tracking details returned from UPS") unless $details && ref($details) eq 'ARRAY' && @$details;

    my $track = $details->[0];

    $retValue{'Current Status'} = $track->{packageStatus} if $track->{packageStatus};
    $retValue{'Service Type'}   = $track->{service}        if $track->{service};

    if ( my $w = $track->{weight} ) {
        if ( $w->{weight} ) {
            my $unit = $w->{unitOfMeasurement} || '';
            $retValue{'Weight'} = length($unit) ? "$w->{weight} $unit" : $w->{weight};
        }
    }

    if ( my $addr = $track->{shipToAddress} ) {
        my @parts = grep { $_ } @{$addr}{qw(city state country)};
        $retValue{'Shipped To'} = join( ', ', @parts ) if @parts;
    }

    my $delivery_date = $track->{scheduledDeliveryDate} || $track->{deliveredDate};
    $retValue{'Delivery Date'} = $delivery_date if $delivery_date;
    $retValue{'Signed By'}     = $track->{receivedBy}  if $track->{receivedBy};
    $retValue{'Location'}      = $track->{leftAt}      if $track->{leftAt};

    my %scanning;
    my $count = 0;

    if ( my $activities = $track->{shipmentProgressActivities} ) {
        for my $act (@$activities) {
            $count++;
            $scanning{$count}{'date'}     = $act->{date}         if $act->{date};
            $scanning{$count}{'time'}     = $act->{time}         if $act->{time};
            $scanning{$count}{'location'} = $act->{location}     if $act->{location};
            $scanning{$count}{'activity'} = $act->{activityScan} if $act->{activityScan};
        }
    }

    $retValue{'Scanning'}       = \%scanning;
    $retValue{'Activity Count'} = $count;
    $retValue{'Notice'}         = "UPS authorizes you to use UPS tracking systems solely to track shipments tendered by or for you to UPS for delivery and for no other purpose. Any other use of UPS tracking systems and information is strictly prohibited.";

    return %retValue;
}

1;

__END__