t/address_verification.t

#!/usr/bin/perl

# See http://www.usps.com/webtools/htm/Address-Information.htm for
# the test requirements. The headings ( "Good response #1", etc )
# correspond to the USPS test specification
#
# the sample requests are now at https://www.usps.com/business/web-tools-apis/general-api-developer-guide.htm#_Toc423593927
# but I haven't updated this. Some requests no longer appear there but
# they still work.

use Test::More;

my $class  = "Business::US::USPS::WebTools::AddressStandardization";
my $method = 'verify_address';

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
unless( $ENV{USPS_WEBTOOLS_USERID} and $ENV{USPS_WEBTOOLS_PASSWORD} )
	{
	plan skip_all =>
	"You must set the USPS_WEBTOOLS_USERID and USPS_WEBTOOLS_PASSWORD " .
	"environment variables to run these tests\n";
	}

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
use_ok( $class );

my $verifier;
my $base = qq|http://testing.shippingapis.com/ShippingAPITest.dll?API=Verify&XML=%3CAddressValidateRequest+USERID%3D%22$ENV{USPS_WEBTOOLS_USERID}%22+PASSWORD%3D%22$ENV{USPS_WEBTOOLS_PASSWORD}%22%3E%3CIncludeOptionalElements%3Etrue%3C%2FIncludeOptionalElements%3E%3CReturnCarrierRoute%3Etrue%3C%2FReturnCarrierRoute%3E|;

subtest setup => sub {
	$verifier = $class->new( {
		UserID   => $ENV{USPS_WEBTOOLS_USERID},
		Password => $ENV{USPS_WEBTOOLS_PASSWORD},
		Testing  => 1,
		} );
	isa_ok( $verifier, 	$class );

	can_ok( $verifier, $method );
	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Good response #1
subtest good_response_1 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '6406 Ivy Lane',
		City     => 'Greenbelt',
		State    => 'MD',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E6406+Ivy+Lane%3C%2FAddress2%3E%3CCity%3EGreenbelt%3C%2FCity%3E%3CState%3EMD%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Ivy Lane is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( ! $verifier->is_error, "Response is not an error" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Address2>6406 IVY LN</Address2><City>GREENBELT</City><State>MD</State><Zip5>20770</Zip5><Zip4>1441</Zip4><DeliveryPoint>06</DeliveryPoint><CarrierRoute>C023</CarrierRoute></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	my $hash = $verifier->_parse_response;

	is( $hash->{FirmName}, '',                          'FirmName matches for Ivy Lane' );
	is( $hash->{Address1}, '',                          'Address1 matches for Ivy Lane' );
	is( $hash->{Address2}, '6406 IVY LN',               'Address2 matches for Ivy Lane' );
	is( $hash->{City},     'GREENBELT',                 'City matches for Ivy Lane' );
	is( $hash->{State},    'MD',                        'State matches for Ivy Lane' );
	is( $hash->{Zip5},     '20770',                     'Zip5 matches for Ivy Lane' );
	is( $hash->{Zip4},     '1441',                      'Zip4 matches for Ivy Lane' );
	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Good response #2
subtest good_response_1 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '8 Wildwood Drive',
		City     => 'Old Lyme',
		State    => 'CT',
		Zip5     => '06371',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E8+Wildwood+Drive%3C%2FAddress2%3E%3CCity%3EOld+Lyme%3C%2FCity%3E%3CState%3ECT%3C%2FState%3E%3CZip5%3E06371%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Wildwood Drive is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( ! $verifier->is_error, "Response is not an error" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Address2>8 WILDWOOD DR</Address2><City>OLD LYME</City><State>CT</State><Zip5>06371</Zip5><Zip4>1844</Zip4><DeliveryPoint>08</DeliveryPoint><CarrierRoute>R008</CarrierRoute></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	my $hash = $verifier->_parse_response;

	is( $hash->{FirmName}, '',                          'FirmName matches for Wildwood' );
	is( $hash->{Address1}, '',                          'Address1 matches for Wildwood' );
	is( $hash->{Address2}, '8 WILDWOOD DR',             'Address2 matches for Wildwood' );
	is( $hash->{City},     'OLD LYME',                  'City matches for Wildwood' );
	is( $hash->{State},    'CT',                        'State matches for Wildwood' );
	is( $hash->{Zip5},     '06371',                     'Zip5 matches for Wildwood' );
	is( $hash->{Zip4},     '1844',                      'Zip4 matches for Wildwood' );
	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Good response #3
subtest good_response_3 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '4411 Romlon Street',
		City     => 'Beltsville',
		State    => 'MD',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E4411+Romlon+Street%3C%2FAddress2%3E%3CCity%3EBeltsville%3C%2FCity%3E%3CState%3EMD%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Romlan Street is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( ! $verifier->is_error, "Response is not an error" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Address2>4411 ROMLON ST</Address2><City>BELTSVILLE</City><State>MD</State><Zip5>20705</Zip5><Zip4>2425</Zip4><ReturnText>Default address: The address you entered was found but more information is needed (such as an apartment, suite, or box number) to match to a specific address.</ReturnText><CarrierRoute>C017</CarrierRoute></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	my $hash = $verifier->_parse_response;

	is( $hash->{FirmName}, '',                          'FirmName matches for Romlan' );
	is( $hash->{Address1}, '',                          'Address1 matches for Romlan' );
	is( $hash->{Address2}, '4411 ROMLON ST',            'Address2 matches for Romlan' );
	is( $hash->{City},     'BELTSVILLE',                'City matches for Romlan' );
	is( $hash->{State},    'MD',                        'State matches for Romlan' );
	is( $hash->{Zip5},     '20705',                     'Zip5 matches for Romlan' );
	is( $hash->{Zip4},     '2425',                      'Zip4 matches for Romlan' );
	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Good response #4
subtest good_response_4 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '3527 Sharonwood Road Apt. 3C',
		City     => 'Laurel',
		State    => 'MD',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E3527+Sharonwood+Road+Apt.+3C%3C%2FAddress2%3E%3CCity%3ELaurel%3C%2FCity%3E%3CState%3EMD%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Sharonwood Road is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( ! $verifier->is_error, "Response is not an error" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Address2>3527 SHARONWOOD RD APT 3C</Address2><City>LAUREL</City><State>MD</State><Zip5>20724</Zip5><Zip4>5920</Zip4><DeliveryPoint>33</DeliveryPoint><CarrierRoute>R008</CarrierRoute></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	my $hash = $verifier->_parse_response;

	is( $hash->{FirmName}, '',                          'FirmName matches for Sharonwood' );
	is( $hash->{Address1}, '',                          'Address1 matches for Sharonwood' );
	is( $hash->{Address2}, '3527 SHARONWOOD RD APT 3C', 'Address2 matches for Sharonwood' );
	is( $hash->{City},     'LAUREL',                    'City matches for Sharonwood' );
	is( $hash->{State},    'MD',                        'State matches for Sharonwood' );
	is( $hash->{Zip5},     '20724',                     'Zip5 matches for Sharonwood' );
	is( $hash->{Zip4},     '5920',                      'Zip4 matches for Sharonwood' );

	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Error Requests
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Error response #1
subtest error_response_1 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '3527 Sharonwood Road Apt. 3C',
		City     => 'Wilmington',
		State    => 'DE',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E3527+Sharonwood+Road+Apt.+3C%3C%2FAddress2%3E%3CCity%3EWilmington%3C%2FCity%3E%3CState%3EDE%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Sharonwood Road Error is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( $verifier->is_error, "Error request gets an error response" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Error><Number>-2147219401</Number><Source>clsAMS</Source><Description>Address Not Found.  </Description><HelpFile/><HelpContext/></Error></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	is( $verifier->{error}{number},        -2147219401,            'Error number matches for Sharonwood error' );
	is( $verifier->{error}{source},        'clsAMS',               'Error source matches for Sharonwood error' );
	is( $verifier->{error}{description},   'Address Not Found.  ', 'Error description matches for Sharonwood error' );
	is( $verifier->{error}{help_file},     undef,                  'Error help file matches for Sharonwood error' );
	is( $verifier->{error}{help_context},  undef,                  'Error help context matches for Sharonwood error' );

	my $hash = $verifier->_parse_response;

	is( $hash->{FirmName}, '', 'FirmName is empty for Sharonwood error' );
	is( $hash->{Address1}, '', 'Address1 is empty for Sharonwood error' );
	is( $hash->{Address2}, '', 'Address2 is empty for Sharonwood error' );
	is( $hash->{City},     '', 'City is empty for Sharonwood error' );
	is( $hash->{State},    '', 'State is empty for Sharonwood error' );
	is( $hash->{Zip5},     '', 'Zip5 is empty for Sharonwood error' );
	is( $hash->{Zip4},     '', 'Zip4 is empty for Sharonwood error' );

	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Error response #2

=pod

# this works now
{
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '1600 Pennsylvania Avenue',
		City     => 'Washington',
		State    => 'DC',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E1600+Pennsylvania+Avenue%3C%2FAddress2%3E%3CCity%3EWashington%3C%2FCity%3E%3CState%3EDC%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Pennsylvania Avenue Error is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( $verifier->is_error, "Error request gets an error response" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Error><Number>-2147219403</Number><Source>SOLServerTest;SOLServerTest.CallAddressDll</Source><Description>Multiple responses found.  No default address.</Description><HelpFile></HelpFile><HelpContext></HelpContext></Error></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	is( $verifier->{error}{number},        -2147219403,                           'Error number matches for Pennsylvania Avenue error' );
	is( $verifier->{error}{source},        'clsAMS', 'Error source matches for Pennsylvania Avenue error' );
	is( $verifier->{error}{description},   'Multiple responses found.  No default address.',    'Error description matches for Pennsylvania Avenue error' );
	is( $verifier->{error}{help_file},     undef,                                    'Error help file matches for Pennsylvania Avenue error' );
	is( $verifier->{error}{help_context},  undef,                                    'Error help context matches for Pennsylvania Avenue error' );

	my $hash = $verifier->_parse_response;

	#	print STDERR "In _make_request:\n" . Dumper( $verifier ) . "\n";

	is( $hash->{FirmName}, '', 'FirmName is empty for Pennsylvania Avenue error' );
	is( $hash->{Address1}, '', 'Address1 is empty for Pennsylvania Avenue error' );
	is( $hash->{Address2}, '', 'Address2 is empty for Pennsylvania Avenue error' );
	is( $hash->{City},     '', 'City is empty for Pennsylvania Avenue error' );
	is( $hash->{State},    '', 'State is empty for Pennsylvania Avenue error' );
	is( $hash->{Zip5},     '', 'Zip5 is empty for Pennsylvania Avenue error' );
	is( $hash->{Zip4},     '', 'Zip4 is empty for Pennsylvania Avenue error' );

	};

=cut


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Error response #3
subtest error_response_3 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '123 Main Street',
		City     => 'Washington',
		State    => 'ZZ',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E123+Main+Street%3C%2FAddress2%3E%3CCity%3EWashington%3C%2FCity%3E%3CState%3EZZ%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Main Street Error is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( $verifier->is_error, "Error request gets an error response" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Error><Number>-2147219402</Number><Source>clsAMS</Source><Description>Invalid State Code.  </Description><HelpFile/><HelpContext/></Error></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	is( $verifier->{error}{number},        -2147219402,                           'Error number matches for Main Street error' );
	is( $verifier->{error}{source},        'clsAMS', 'Error source matches for Main Street error' );
	is( $verifier->{error}{description},   'Invalid State Code.  ',    'Error description matches for Main Street error' );
	is( $verifier->{error}{help_file},     undef,                                    'Error help file matches for Main Street error' );
	is( $verifier->{error}{help_context},  undef,                                    'Error help context matches for Main Street error' );

	my $hash = $verifier->_parse_response;

	#	print STDERR "In _make_request:\n" . Dumper( $verifier ) . "\n";

	is( $hash->{FirmName}, '', 'FirmName is empty for Main Street error' );
	is( $hash->{Address1}, '', 'Address1 is empty for Main Street error' );
	is( $hash->{Address2}, '', 'Address2 is empty for Main Street error' );
	is( $hash->{City},     '', 'City is empty for Main Street error' );
	is( $hash->{State},    '', 'State is empty for Main Street error' );
	is( $hash->{Zip5},     '', 'Zip5 is empty for Main Street error' );
	is( $hash->{Zip4},     '', 'Zip4 is empty for Main Street error' );

	};

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Error response #4
subtest error_response_4 => sub {
	my $url = $verifier->_make_url( {
		FirmName => '',
		Address1 => '',
		Address2 => '123 Main Street',
		City     => 'Trenton',
		State    => 'NJ',
		Zip5     => '',
		Zip4     => '',
		} );
	is(
		$url,
		qq|$base%3CAddress+ID%3D%220%22%3E%3CFirmName%3E%3C%2FFirmName%3E%3CAddress1%3E%3C%2FAddress1%3E%3CAddress2%3E123+Main+Street%3C%2FAddress2%3E%3CCity%3ETrenton%3C%2FCity%3E%3CState%3ENJ%3C%2FState%3E%3CZip5%3E%3C%2FZip5%3E%3CZip4%3E%3C%2FZip4%3E%3C%2FAddress%3E%3C%2FAddressValidateRequest%3E|,
		"URL for Trenton, NJ Error is correct",
		);

	my $response = $verifier->_make_request;
	ok( defined $response );
	ok( $verifier->is_error, "Error request gets an error response" );

	my $expected = <<"XML";
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidateResponse><Address ID="0"><Error><Number>-2147219401</Number><Source>clsAMS</Source><Description>Address Not Found.  </Description><HelpFile/><HelpContext/></Error></Address></AddressValidateResponse>
XML

	$response =~ s/\s+\z//;
	$expected =~ s/\s+\z//;

	is( $response, $expected );

	is( $verifier->{error}{number},        -2147219401,                           'Error number matches for Trenton, NJ error' );
	is( $verifier->{error}{source},        'clsAMS', 'Error source matches for Trenton, NJ error' );
	is( $verifier->{error}{description},   'Address Not Found.  ',    'Error description matches for Trenton, NJ error' );
	is( $verifier->{error}{help_file},     undef,                                    'Error help file matches for Trenton, NJ error' );
	is( $verifier->{error}{help_context},  undef,                                    'Error help context matches for Trenton, NJ error' );

	my $hash = $verifier->_parse_response;

	#	print STDERR "In _make_request:\n" . Dumper( $verifier ) . "\n";

	is( $hash->{FirmName}, '', 'FirmName is empty for Trenton, NJ error' );
	is( $hash->{Address1}, '', 'Address1 is empty for Trenton, NJ error' );
	is( $hash->{Address2}, '', 'Address2 is empty for Trenton, NJ error' );
	is( $hash->{City},     '', 'City is empty for Trenton, NJ error' );
	is( $hash->{State},    '', 'State is empty for Trenton, NJ error' );
	is( $hash->{Zip5},     '', 'Zip5 is empty for Trenton, NJ error' );
	is( $hash->{Zip4},     '', 'Zip4 is empty for Trenton, NJ error' );

	};

done_testing();
	Global
`s`	Focus search bar
`?`	Bring up this help dialog
	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)
	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse
	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)