cxj/validate.address

Simple USPS web API address validation

0.1.1 2020-07-18 02:16 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-dom: *
• ext-xml: *
• webmozart/assert: ^1.8

Requires (Dev)

• php-mock/php-mock-phpunit: ^2.6
• phpunit/phpunit: ^9.1

MIT

• Chris Johnson

README

The United States Postal Service (USPS) Address Standardization Web Tool corrects errors in street addresses, including abbreviations and missing information, and supplies ZIP Codes and ZIP Codes + 4.

This library provides a simple interface to using the above USPS API.

Installation and Autoloading

This package is installable and PSR-4 autoloadable via Composer as cxj/validate.address.

Alternatively, download a release, or clone this repository, then map the Cxj\ValidateAddress\ namespace to the package src/ directory.

Dependencies

This package requires PHP 7.4 or later. We recommend using the latest available version of PHP as a matter of principle.

Example Usage

<?php
$address = new Address(
    "8039 Beach Blvd",
    "",
    "Buena Park",
    "CA",
    "90620"
);

$user = YOUR_USER_NAME; // Obtained from the USPS website:
// https://www.usps.com/business/web-tools-apis/#developers

$validate = new ValidateAddress(new CurlPost($user), new DomParser());
$response = $validate->validate($address);

echo sprintf("Corrected ZIP+4 Code: %s-%s\n",
    $response->getAddress()->getZip5(),
    $response->getAddress()->getZip4()
);

The main API class for usage is ValidateAddress, the address to be validated or normalized is passed as a Parameter Object or Value Object to the validation method itself. The constructor requires has two other dependencies, defined by the CommunicationInteface (which handles the connection and exchange with the USPS server), and the ResponseParserInterface (which handles decoding the XML response from the server).

Three implementations of the CommunicationInterface are provided, using the PHP Curl extension to send the address request via either HTTP POST or GET, and a stream socket.

Two implementations of the ResponseParserInterface are provided. One requires the PHP DOM extension, and the other requires the PHP XML extension.

Quality

To run the unit tests at the command line, issue composer install and then ./vendor/bin/phpunit at the package root. This requires Composer to be available as composer, and PHPUnit to be available as phpunit.

This package attempts to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request.