Collection of data and utilities to lookup postal-code based location information. This gem is HEAVILY INSPIRED by Thomas Leen's zippity-do-dah (Node.js module that does pretty much the same thing).
Functions for looking up zipcode, city, state, latitude and longitude using a zipcode, city + state, or latitude + longitude. You can also get random sets of this data.
Data sourced from federalgovernmentzipcodes.us. This is primary data, meaning data that maps to multiple locations will return only the primary location.
NOTE: The data is self-contained inside the gem, so no internet connection is required in order to use it.
Add this line to your application's Gemfile:
gem 'ziptedu'And then execute:
$ bundle
Or install it yourself as:
$ gem install ziptedu
require('ziptedu')
puts Ziptedu.random(3)
puts Ziptedu.zipcode(21208).city
puts Ziptedu.random
puts Ziptedu.citystate("Baltimore", "MD")
puts Ziptedu.latlong('32.09', '-96.71')All lookups will return nil (if lookup was unsuccessful) or an instance of Ziptedu::Zipcode class with the following attributes:
- zipcode
- type (standard, military, po box)
- city
- state
- latitude
- longitude
These attributes may be empty if not applicable to the specific location returned.
Lookup data by 5 digit zipcode (the argument can be either an integer or a string)
Lookup data by city and state, capitalization does not matter.
Lookup date by latitude and longitude, lat/long must have two decimal digits only (-)xx.xx.
Will return a single random result, if number is specified and > 1 will return an array of random results.
Bug reports and pull requests are welcome on GitHub at https://github.com/kalmanh/ziptedu.
The gem is available as open source under the terms of the MIT License.