Update the test, fix i18n instructions and plugin name.
This commit is contained in:
Colin Kuskie
parent
4b252a2d67
commit
1ea5bf0800
3 changed files with 87 additions and 128 deletions
|
|
@ -1,7 +1,73 @@
|
|||
package WebGUI::Shop::ShipDriver::USPS;
|
||||
|
||||
use strict;
|
||||
use base qw/WebGUI::Shop::ShipDriver/;
|
||||
use Moose;
|
||||
use WebGUI::Definition::Shop;
|
||||
extends qw/WebGUI::Shop::ShipDriver/;
|
||||
define pluginName => ['United States Postal Service', 'ShipDriver_USPS'];
|
||||
property instructions => (
|
||||
fieldType => 'readOnly',
|
||||
label => ['instructions', 'ShipDriver_USPS'],
|
||||
builder => '_instructions_default',
|
||||
lazy => 1,
|
||||
noFormProcess => 1,
|
||||
);
|
||||
sub _instructions_default {
|
||||
my $session = shift->session;
|
||||
my $i18n = WebGUI::International->new($session, 'ShipDriver_USPS');
|
||||
return $i18n->get('instructions');
|
||||
}
|
||||
property userId => (
|
||||
fieldType => 'text',
|
||||
label => ['userid', 'ShipDriver_USPS'],
|
||||
hoverHelp => ['userid help', 'ShipDriver_USPS'],
|
||||
default => '',
|
||||
);
|
||||
property password => (
|
||||
fieldType => 'password',
|
||||
label => ['password', 'ShipDriver_USPS'],
|
||||
hoverHelp => ['password help', 'ShipDriver_USPS'],
|
||||
default => '',
|
||||
);
|
||||
property sourceZip => (
|
||||
fieldType => 'zipcode',
|
||||
label => ['source zipcode', 'ShipDriver_USPS'],
|
||||
hoverHelp => ['source zipcode help', 'ShipDriver_USPS'],
|
||||
default => '',
|
||||
);
|
||||
property shipType => (
|
||||
fieldType => 'selectBox',
|
||||
label => ['ship type', 'ShipDriver_USPS'],
|
||||
hoverHelp => ['ship type help', 'ShipDriver_USPS'],
|
||||
default => 'PARCEL',
|
||||
options => \&_shipType_options,
|
||||
);
|
||||
sub _shipType_options {
|
||||
my $session = shift->session;
|
||||
my $i18n = WebGUI::International->new($session, 'ShipDriver_USPS');
|
||||
tie my %shippingTypes, 'Tie::IxHash';
|
||||
##Note, these keys are used by buildXML
|
||||
$shippingTypes{'PRIORITY VARIABLE'} = $i18n->get('priority variable');
|
||||
$shippingTypes{'PRIORITY'} = $i18n->get('priority');
|
||||
$shippingTypes{'EXPRESS' } = $i18n->get('express');
|
||||
$shippingTypes{'PARCEL' } = $i18n->get('parcel post');
|
||||
return \%shippingTypes;
|
||||
}
|
||||
property addInsurance => (
|
||||
fieldType => 'yesNo',
|
||||
label => ['add insurance', 'ShipDriver_USPS'],
|
||||
hoverHelp => ['add insurance help', 'ShipDriver_USPS'],
|
||||
default => 0,
|
||||
);
|
||||
property insuranceRates => (
|
||||
fieldType => 'textarea',
|
||||
label => ['insurance rates', 'ShipDriver_USPS'],
|
||||
hoverHelp => ['insurance rates help', 'ShipDriver_USPS'],
|
||||
default => "50:1.75\n100:2.25",
|
||||
);
|
||||
|
||||
|
||||
|
||||
use WebGUI::Exception;
|
||||
use XML::Simple;
|
||||
use LWP;
|
||||
|
|
@ -50,15 +116,15 @@ sub buildXML {
|
|||
tie my %xmlHash, 'Tie::IxHash';
|
||||
%xmlHash = ( RateV3Request => {}, );
|
||||
my $xmlTop = $xmlHash{RateV3Request};
|
||||
$xmlTop->{USERID} = $self->get('userId');
|
||||
$xmlTop->{USERID} = $self->userId;
|
||||
$xmlTop->{Package} = [];
|
||||
##Do a request for each package.
|
||||
my $packageIndex;
|
||||
my $shipType = $self->get('shipType');
|
||||
my $shipType = $self->shipType;
|
||||
my $service = $shipType eq 'PRIORITY VARIABLE'
|
||||
? 'PRIORITY'
|
||||
: $shipType;
|
||||
my $sourceZip = $self->get('sourceZip');
|
||||
my $sourceZip = $self->sourceZip;
|
||||
$sourceZip =~ s/^(\d{5}).*$/$1/;
|
||||
PACKAGE: for(my $packageIndex = 0; $packageIndex < scalar @packages; $packageIndex++) {
|
||||
my $package = $packages[$packageIndex];
|
||||
|
|
@ -85,7 +151,7 @@ sub buildXML {
|
|||
$destZipCode =~ s/^(\d{5}).*$/$1/;
|
||||
$packageData{ID} = $packageIndex;
|
||||
$packageData{Service} = [ $service ];
|
||||
$packageData{ZipOrigination} = [ $self->get('sourceZip') ];
|
||||
$packageData{ZipOrigination} = [ $self->sourceZip ];
|
||||
$packageData{ZipDestination} = [ $destZipCode ];
|
||||
$packageData{Pounds} = [ $pounds ];
|
||||
$packageData{Ounces} = [ $ounces ];
|
||||
|
|
@ -128,10 +194,10 @@ costs are assessed.
|
|||
|
||||
sub calculate {
|
||||
my ($self, $cart) = @_;
|
||||
if (! $self->get('sourceZip')) {
|
||||
if (! $self->sourceZip) {
|
||||
WebGUI::Error::InvalidParam->throw(error => q{Driver configured without a source zipcode.});
|
||||
}
|
||||
if (! $self->get('userId')) {
|
||||
if (! $self->userId) {
|
||||
WebGUI::Error::InvalidParam->throw(error => q{Driver configured without a USPS userId.});
|
||||
}
|
||||
if ($cart->getShippingAddress->get('country') ne 'United States') {
|
||||
|
|
@ -146,7 +212,6 @@ sub calculate {
|
|||
}
|
||||
my $anyShippable = $packageCount > 0 ? 1 : 0;
|
||||
return $cost unless $anyShippable;
|
||||
#$cost = scalar @shippableUnits * $self->get('flatFee');
|
||||
##Build XML ($cart, @shippableUnits)
|
||||
my $xml = $self->buildXML($cart, @shippableUnits);
|
||||
##Do request ($xml)
|
||||
|
|
@ -238,8 +303,8 @@ The set of shippable units, which are required to do quantity and cost lookups.
|
|||
sub _calculateInsurance {
|
||||
my ($self, @shippableUnits) = @_;
|
||||
my $insuranceCost = 0;
|
||||
return $insuranceCost unless $self->get('addInsurance') && $self->get('insuranceRates');
|
||||
my @insuranceTable = _parseInsuranceRates($self->get('insuranceRates'));
|
||||
return $insuranceCost unless $self->addInsurance && $self->insuranceRates;
|
||||
my @insuranceTable = _parseInsuranceRates($self->insuranceRates);
|
||||
##Sort by decreasing value for easy post processing
|
||||
@insuranceTable = sort { $a->[0] <=> $b->[0] } @insuranceTable;
|
||||
foreach my $package (@shippableUnits) {
|
||||
|
|
@ -293,92 +358,6 @@ sub _parseInsuranceRates {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 definition ( $session )
|
||||
|
||||
This subroutine returns an arrayref of hashrefs, used to validate data put into
|
||||
the object by the user, and to automatically generate the edit form to show
|
||||
the user.
|
||||
|
||||
=cut
|
||||
|
||||
sub definition {
|
||||
my $class = shift;
|
||||
my $session = shift;
|
||||
WebGUI::Error::InvalidParam->throw(error => q{Must provide a session variable})
|
||||
unless ref $session eq 'WebGUI::Session';
|
||||
my $definition = shift || [];
|
||||
my $i18n = WebGUI::International->new($session, 'ShipDriver_USPS');
|
||||
tie my %shippingTypes, 'Tie::IxHash';
|
||||
##Note, these keys are used by buildXML
|
||||
$shippingTypes{'PRIORITY VARIABLE'} = $i18n->get('priority variable');
|
||||
$shippingTypes{'PRIORITY'} = $i18n->get('priority');
|
||||
$shippingTypes{'EXPRESS' } = $i18n->get('express');
|
||||
$shippingTypes{'PARCEL' } = $i18n->get('parcel post');
|
||||
tie my %fields, 'Tie::IxHash';
|
||||
%fields = (
|
||||
instructions => {
|
||||
fieldType => 'readOnly',
|
||||
label => $i18n->get('instructions'),
|
||||
defaultValue => $i18n->get('usps instructions'),
|
||||
noFormProcess => 1,
|
||||
},
|
||||
userId => {
|
||||
fieldType => 'text',
|
||||
label => $i18n->get('userid'),
|
||||
hoverHelp => $i18n->get('userid help'),
|
||||
defaultValue => '',
|
||||
},
|
||||
password => {
|
||||
fieldType => 'password',
|
||||
label => $i18n->get('password'),
|
||||
hoverHelp => $i18n->get('password help'),
|
||||
defaultValue => '',
|
||||
},
|
||||
sourceZip => {
|
||||
fieldType => 'zipcode',
|
||||
label => $i18n->get('source zipcode'),
|
||||
hoverHelp => $i18n->get('source zipcode help'),
|
||||
defaultValue => '',
|
||||
},
|
||||
shipType => {
|
||||
fieldType => 'selectBox',
|
||||
label => $i18n->get('ship type'),
|
||||
hoverHelp => $i18n->get('ship type help'),
|
||||
options => \%shippingTypes,
|
||||
defaultValue => 'PARCEL',
|
||||
},
|
||||
addInsurance => {
|
||||
fieldType => 'yesNo',
|
||||
label => $i18n->get('add insurance'),
|
||||
hoverHelp => $i18n->get('add insurance help'),
|
||||
defaultValue => 0,
|
||||
},
|
||||
insuranceRates => {
|
||||
fieldType => 'textarea',
|
||||
label => $i18n->get('insurance rates'),
|
||||
hoverHelp => $i18n->get('insurance rates help'),
|
||||
defaultValue => "50:1.75\n100:2.25",
|
||||
},
|
||||
##Note, if a flat fee is added to this driver, then according to the license
|
||||
##terms the website must display a note to the user (shop customer) that additional
|
||||
##fees have been added.
|
||||
# flatFee => {
|
||||
# fieldType => 'float',
|
||||
# label => $i18n->get('flatFee'),
|
||||
# hoverHelp => $i18n->get('flatFee help'),
|
||||
# defaultValue => 0,
|
||||
# },
|
||||
);
|
||||
my %properties = (
|
||||
name => 'U.S. Postal Service',
|
||||
properties => \%fields,
|
||||
);
|
||||
push @{ $definition }, \%properties;
|
||||
return $class->SUPER::definition($session, $definition);
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 _doXmlRequest ( $xml )
|
||||
|
||||
Contact the USPS website and submit the XML for a shipping rate lookup.
|
||||
|
|
|
|||
|
|
@ -118,6 +118,12 @@ our $I18N = {
|
|||
context => q|Help for the insurance rate field.|,
|
||||
},
|
||||
|
||||
'United States Postal Service' => {
|
||||
message => q|United States Postal Service|,
|
||||
lastUpdated => 1257369016,
|
||||
context => q|Label for the shipping driver.|,
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ use WebGUI::Test; # Must use this before any other WebGUI modules
|
|||
use WebGUI::Session;
|
||||
use WebGUI::Shop::ShipDriver::USPS;
|
||||
|
||||
plan tests => 69;
|
||||
plan tests => 66;
|
||||
|
||||
#----------------------------------------------------------------------------
|
||||
# Init
|
||||
|
|
@ -113,34 +113,7 @@ foreach my $asset ($bible, $rockHammer) {
|
|||
|
||||
#######################################################################
|
||||
#
|
||||
# definition
|
||||
#
|
||||
#######################################################################
|
||||
|
||||
my $definition;
|
||||
my $e; ##Exception variable, used throughout the file
|
||||
|
||||
eval { $definition = WebGUI::Shop::ShipDriver::USPS->definition(); };
|
||||
$e = Exception::Class->caught();
|
||||
isa_ok($e, 'WebGUI::Error::InvalidParam', 'definition takes an exception to not giving it a session variable');
|
||||
cmp_deeply(
|
||||
$e,
|
||||
methods(
|
||||
error => 'Must provide a session variable',
|
||||
),
|
||||
'... checking error message',
|
||||
);
|
||||
|
||||
|
||||
isa_ok(
|
||||
$definition = WebGUI::Shop::ShipDriver::USPS->definition($session),
|
||||
'ARRAY'
|
||||
);
|
||||
|
||||
|
||||
#######################################################################
|
||||
#
|
||||
# create
|
||||
# new
|
||||
#
|
||||
#######################################################################
|
||||
|
||||
|
|
@ -149,7 +122,7 @@ my $options = {
|
|||
enabled => 1,
|
||||
};
|
||||
|
||||
$driver2 = WebGUI::Shop::ShipDriver::USPS->create($session, $options);
|
||||
$driver2 = WebGUI::Shop::ShipDriver::USPS->new($session, $options);
|
||||
addToCleanup($driver2);
|
||||
|
||||
isa_ok($driver2, 'WebGUI::Shop::ShipDriver::USPS');
|
||||
|
|
@ -161,7 +134,7 @@ isa_ok($driver2, 'WebGUI::Shop::ShipDriver');
|
|||
#
|
||||
#######################################################################
|
||||
|
||||
is (WebGUI::Shop::ShipDriver::USPS->getName($session), 'U.S. Postal Service', 'getName returns the human readable name of this driver');
|
||||
is (WebGUI::Shop::ShipDriver::USPS->getName($session), 'United States Postal Service', 'getName returns the human readable name of this driver');
|
||||
|
||||
#######################################################################
|
||||
#
|
||||
|
|
@ -183,13 +156,14 @@ undef $driver2;
|
|||
#
|
||||
#######################################################################
|
||||
|
||||
my $driver = WebGUI::Shop::ShipDriver::USPS->create($session, {
|
||||
my $driver = WebGUI::Shop::ShipDriver::USPS->new($session, {
|
||||
label => 'Shipping from Shawshank',
|
||||
enabled => 1,
|
||||
shipType => 'PARCEL',
|
||||
});
|
||||
addToCleanup($driver);
|
||||
|
||||
my $e;
|
||||
eval { $driver->calculate() };
|
||||
$e = Exception::Class->caught();
|
||||
isa_ok($e, 'WebGUI::Error::InvalidParam', 'calculate throws an exception when no zipcode has been set');
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue