Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 849 Bytes

README.md

File metadata and controls

29 lines (18 loc) · 849 Bytes

zip-code-info

This gem returns the state and city of the Sectional Center Facility for a given zip code. It does not use an external API. It looks up the zip code in a yml file.

The zip code data has been taken from http://en.wikipedia.org/wiki/ZIP_code_prefixes

Usage

In your Gemfile

gem "zip-code-info"

The code runs out of a Singleton class. Right now you can call these two methods.

  ZipCodeInfo.instance.state_for '99163'
  #=> WA
  ZipCodeInfo.instance.scf_city_for '99163'
  #=> Spokane

Limitations

  • The city returned is the city where the USPS Sectional Center Facility (SCF) is located.
  • Sometimes the state that a zip code is bound to for USPS is different from the actual state the zip code is in. There are plans to provide both states.