0.0
The project is in a healthy, maintained state
Provides region-based data (countries, states, cities) using the open dataset from github.com/dr5hn/countries-states-cities-database.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies
 Project Readme

RegionLookup

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/region_lookup. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'region_lookup'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install region_lookup

Usage

To get list of all countries

RegionLookup.countries

To get list of cities of specific country

RegionLookup.cities("PK")

To get list of states of specific country

RegionLookup.states("PK")

To get list of cities of specific state

RegionLookup.cities_based_on_state_name("PK", "Azad Kashmir")

To get list of cities of specific state

RegionLookup.get_city("PK", "Lahore")

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/region_lookup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the RegionLookup project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

🌍 Data Source Credits

This gem uses country, state, and city data from:

Special thanks to @dr5hn for maintaining this comprehensive dataset.