SpainZipCodes
With SpainZipCodes you can obtain Spain locations and provinces using a zip code and you can obtain zip codes for provinces and locations using their names!
Installation
Add this line to your application's Gemfile:
gem 'spain_zip_codes'
And then execute:
$ bundle
Or install it yourself as:
$ gem install spain_zip_codes
Require the gem:
require 'spain_zip_codes'Usage
Provinces
To get a province name from a zip code do:
SpainZipCodes.zip_to_province(zip)
> SpainZipCodes.zip_to_province('28001')
=> 'Madrid'To get a zip code prefix for a province do:
SpainZipCodes.province_to_zip(province)
> SpainZipCodes.province_to_zip('Madrid')
=> '28'Locations
To get a location name from a zip code do:
SpainZipCodes.zip_to_location(zip)
> SpainZipCodes.zip_to_location('28922')
=> 'Alcorcón'To get the zip codes from a location name do:
SpainZipCodes.location_to_zip(location)
> SpainZipCodes.location_to_zip('Alcorcón')
=> ['28920', '28921', '28922', '28923', '28924', '28925']
# A not found location will return an empty array
> SpainZipCodes.location_to_zip('Gallifrey')
=> []To get the location slug from a zip code do:
SpainZipCodes.zip_to_location_slug(zip)
> SpainZipCodes.zip_to_location_slug('28750')
=> 'san-agustin-de-guadalix'To get the zip codes from a location slug:
SpainZipCodes.location_slug_to_zip(location_slug)
> SpainZipCodes.location_slug_to_zip('alcorcon')
=> ['28920', '28921', '28922', '28923', '28924', '28925']Note:
Arguments need to be strings.
If you give a function an invalid argument or nothing is found it will always return false
Contributing
- Fork it ( https://github.com/luismiramirez/spain_zip_codes/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request