Fidget.Validation.Addresses

Address validation and metadata exploration via the Google Address Data Service. This is a third-party library that has no affiliation with Google.

Usage

Install the package from NuGet.

Using the service in your application can be accomplished three ways:

1. Use AddressService.Default directly.
2. Map the IAddressService interface to AddressService.Default in your DI container.
3. Map the IAddressService interface to AddressService.FactoryMethod() in your DI container.

Metadata Exploration

There are five methods for exploring metadata:

• GetGlobalAsync, which contains the list of country keys.
• GetCountryAsync, which returns country information and lists its contained provinces.
• GetProvinceAsync, which returns province information and lists its contained localities.
• GetLocalityAsync, which returns locality information and lists its contained sublocalities.
• GetSublocalityAsync, which returns sublocality information.

Synchronous versions of these methods are available as extension methods. At this time, the cancellationToken argument is unused, but is intended to be implemented in a future release.

Metadata responses from the remote service are cached for 12 hours.

The metadata classes contain field documentation.

Validation

The ValidateAsync method will validate an address against its metadata.

• Country is required to validate an address. This must be the key of the country (instead of the name) as defined in the global metadata.
• Language field will (optionally) control which language of the metadata to validate against. This has no effect on validation to my knowledge, but it is present if a country defines different rules based on language.
• Empty or whitespace elements will be treated as null.
• Translation of field and error values is not handled at this time.

A synchronous version of this method is available as an extension method. At this time, the cancellationToken argument is unused, but is intended to be implemented in a future release.

License

Copyright 2017 Sean Terry

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.