Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 1.07 KB

README.md

File metadata and controls

42 lines (32 loc) · 1.07 KB
Raw

GeoList is a very simple ruby gem to get a list of all countries, cities and suburbs.

Install

gem 'geolist', '~> 0.1.0'

Examples

List of countries:

GeoList.countries
# [{:name=>"Australia", :alpha2=>"AU", :alpha3=>"AUS"}, ...]

List of cities:

GeoList.cities('Australia')
# => ["Adak", "Akhiok", "Akiachak", "Akiak", "Akutan", "Alakanuk", ...]

List of suburbs (only for Hong Kong):

GeoList.suburbs('Hong Kong')
# ["Aberdeen", "Causeway Bay", "Central District","Cha Kwo Ling", "Chai Wan Kok", "Chek Chue", ...]

Simplified syntax with get method:

  • GeoList.get: list of countries (equivalent to GeoList.countries)
  • GeoList.get(country): list of cities (equivalent to GeoList.cities(country))
  • GeoList.get(country, city): list of suburbs (equivalent to GeoList.suburbs(city))

Geo data update

GeoList.update_data

# Will update data file to the latest version (using MaxMind free databases)
# Can be added to migration or in some scheduler

# Database is updated weekly, every Tuesday.